Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Nullable state & added new types on status #257

Merged
merged 3 commits into from
Jan 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 56 additions & 8 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -814,6 +814,7 @@ paths:
- payments.v3
summary: Show server information
operationId: v3GetInfo
x-speakeasy-name-override: GetInfo
responses:
"200":
description: OK
Expand All @@ -837,6 +838,7 @@ paths:
summary: |
Create a formance account object. This object will not be forwarded to the connector. It is only used for internal purposes.
operationId: v3CreateAccount
x-speakeasy-name-override: CreateAccount
requestBody:
content:
application/json:
Expand All @@ -863,6 +865,7 @@ paths:
- payments.v3
summary: List all accounts
operationId: v3ListAccounts
x-speakeasy-name-override: ListAccounts
parameters:
- $ref: '#/components/parameters/V3PageSize'
- $ref: '#/components/parameters/V3Cursor'
Expand Down Expand Up @@ -893,6 +896,7 @@ paths:
- payments.v3
summary: Get an account by ID
operationId: v3GetAccount
x-speakeasy-name-override: GetAccount
parameters:
- $ref: '#/components/parameters/V3AccountID'
responses:
Expand All @@ -917,6 +921,7 @@ paths:
- payments.v3
summary: Get account balances
operationId: v3GetAccountBalances
x-speakeasy-name-override: GetAccountBalances
parameters:
- $ref: '#/components/parameters/V3AccountID'
- $ref: '#/components/parameters/V3Asset'
Expand Down Expand Up @@ -947,6 +952,7 @@ paths:
summary: |
Create a formance bank account object. This object will not be forwarded to the connector until you called the forwardBankAccount method.
operationId: v3CreateBankAccount
x-speakeasy-name-override: CreateBankAccount
requestBody:
content:
application/json:
Expand All @@ -973,6 +979,7 @@ paths:
- payments.v3
summary: List all bank accounts
operationId: v3ListBankAccounts
x-speakeasy-name-override: ListBankAccounts
parameters:
- $ref: '#/components/parameters/V3PageSize'
- $ref: '#/components/parameters/V3Cursor'
Expand Down Expand Up @@ -1003,6 +1010,7 @@ paths:
- payments.v3
summary: Get a Bank Account by ID
operationId: v3GetBankAccount
x-speakeasy-name-override: GetBankAccount
parameters:
- $ref: '#/components/parameters/V3BankAccountID'
responses:
Expand All @@ -1024,6 +1032,7 @@ paths:
- payments.v3
summary: Update a bank account's metadata
operationId: v3UpdateBankAccountMetadata
x-speakeasy-name-override: UpdateBankAccountMetadata
parameters:
- $ref: '#/components/parameters/V3BankAccountID'
requestBody:
Expand All @@ -1046,6 +1055,7 @@ paths:
- payments.v3
summary: Forward a Bank Account to a PSP for creation
operationId: v3ForwardBankAccount
x-speakeasy-name-override: ForwardBankAccount
parameters:
- $ref: '#/components/parameters/V3BankAccountID'
requestBody:
Expand All @@ -1072,6 +1082,7 @@ paths:
- payments.v3
summary: List all connectors
operationId: v3ListConnectors
x-speakeasy-name-override: ListConnectors
parameters:
- $ref: '#/components/parameters/V3PageSize'
- $ref: '#/components/parameters/V3Cursor'
Expand All @@ -1097,6 +1108,7 @@ paths:
- payments.v3
summary: Install a connector
operationId: v3InstallConnector
x-speakeasy-name-override: InstallConnector
parameters:
- $ref: '#/components/parameters/V3Connector'
requestBody:
Expand Down Expand Up @@ -1126,6 +1138,7 @@ paths:
- payments.v3
summary: List all connector configurations
operationId: v3ListConnectorConfigs
x-speakeasy-name-override: ListConnectorConfigs
responses:
"200":
description: OK
Expand All @@ -1148,6 +1161,7 @@ paths:
- payments.v3
summary: Uninstall a connector
operationId: v3UninstallConnector
x-speakeasy-name-override: UninstallConnector
parameters:
- $ref: '#/components/parameters/V3ConnectorID'
responses:
Expand All @@ -1172,6 +1186,7 @@ paths:
- payments.v3
summary: Get a connector configuration by ID
operationId: v3GetConnectorConfig
x-speakeasy-name-override: GetConnectorConfig
parameters:
- $ref: '#/components/parameters/V3ConnectorID'
responses:
Expand All @@ -1194,8 +1209,9 @@ paths:
post:
tags:
- payments.v3
summary: Reset a connector
summary: Reset a connector. Be aware that this will delete all data and stop all existing tasks like payment initiations and bank account creations.
operationId: v3ResetConnector
x-speakeasy-name-override: ResetConnector
parameters:
- $ref: '#/components/parameters/V3ConnectorID'
responses:
Expand All @@ -1220,6 +1236,7 @@ paths:
- payments.v3
summary: List all connector schedules
operationId: v3ListConnectorSchedules
x-speakeasy-name-override: ListConnectorSchedules
parameters:
- $ref: '#/components/parameters/V3ConnectorID'
- $ref: '#/components/parameters/V3PageSize'
Expand All @@ -1246,6 +1263,7 @@ paths:
- payments.v3
summary: List all connector schedule instances
operationId: v3ListConnectorScheduleInstances
x-speakeasy-name-override: ListConnectorScheduleInstances
parameters:
- $ref: '#/components/parameters/V3ConnectorID'
- $ref: '#/components/parameters/V3ScheduleID'
Expand Down Expand Up @@ -1274,6 +1292,7 @@ paths:
summary: |
Create a formance payment object. This object will not be forwarded to the connector. It is only used for internal purposes.
operationId: v3CreatePayment
x-speakeasy-name-override: CreatePayment
requestBody:
content:
application/json:
Expand All @@ -1300,6 +1319,7 @@ paths:
- payments.v3
summary: List all payments
operationId: v3ListPayments
x-speakeasy-name-override: ListPayments
parameters:
- $ref: '#/components/parameters/V3PageSize'
- $ref: '#/components/parameters/V3Cursor'
Expand Down Expand Up @@ -1330,6 +1350,7 @@ paths:
- payments.v3
summary: Get a payment by ID
operationId: v3GetPayment
x-speakeasy-name-override: GetPayment
parameters:
- $ref: '#/components/parameters/V3PaymentID'
responses:
Expand All @@ -1354,6 +1375,7 @@ paths:
- payments.v3
summary: Update a payment's metadata
operationId: v3UpdatePaymentMetadata
x-speakeasy-name-override: UpdatePaymentMetadata
parameters:
- $ref: '#/components/parameters/V3PaymentID'
requestBody:
Expand All @@ -1379,6 +1401,7 @@ paths:
- payments.v3
summary: Initiate a payment
operationId: v3InitiatePayment
x-speakeasy-name-override: InitiatePayment
parameters:
- $ref: '#/components/parameters/V3NoValidation'
requestBody:
Expand Down Expand Up @@ -1407,6 +1430,7 @@ paths:
- payments.v3
summary: List all payment initiations
operationId: v3ListPaymentInitiations
x-speakeasy-name-override: ListPaymentInitiations
parameters:
- $ref: '#/components/parameters/V3PageSize'
- $ref: '#/components/parameters/V3Cursor'
Expand Down Expand Up @@ -1437,6 +1461,7 @@ paths:
- payments.v3
summary: Delete a payment initiation by ID
operationId: v3DeletePaymentInitiation
x-speakeasy-name-override: DeletePaymentInitiation
parameters:
- $ref: '#/components/parameters/V3PaymentInitiationID'
responses:
Expand All @@ -1456,6 +1481,7 @@ paths:
- payments.v3
summary: Get a payment initiation by ID
operationId: v3GetPaymentInitiation
x-speakeasy-name-override: GetPaymentInitiation
parameters:
- $ref: '#/components/parameters/V3PaymentInitiationID'
responses:
Expand All @@ -1480,6 +1506,7 @@ paths:
- payments.v3
summary: Retry a payment initiation
operationId: v3RetryPaymentInitiation
x-speakeasy-name-override: RetryPaymentInitiation
parameters:
- $ref: '#/components/parameters/V3PaymentInitiationID'
responses:
Expand All @@ -1504,6 +1531,7 @@ paths:
- payments.v3
summary: Approve a payment initiation
operationId: v3ApprovePaymentInitiation
x-speakeasy-name-override: ApprovePaymentInitiation
parameters:
- $ref: '#/components/parameters/V3PaymentInitiationID'
responses:
Expand All @@ -1528,6 +1556,7 @@ paths:
- payments.v3
summary: Reject a payment initiation
operationId: v3RejectPaymentInitiation
x-speakeasy-name-override: RejectPaymentInitiation
parameters:
- $ref: '#/components/parameters/V3PaymentInitiationID'
responses:
Expand All @@ -1548,6 +1577,7 @@ paths:
- payments.v3
summary: Reverse a payment initiation
operationId: v3ReversePaymentInitiation
x-speakeasy-name-override: ReversePaymentInitiation
parameters:
- $ref: '#/components/parameters/V3PaymentInitiationID'
requestBody:
Expand Down Expand Up @@ -1577,6 +1607,7 @@ paths:
- payments.v3
summary: List all payment initiation adjustments
operationId: v3ListPaymentInitiationAdjustments
x-speakeasy-name-override: ListPaymentInitiationAdjustments
parameters:
- $ref: '#/components/parameters/V3PaymentInitiationID'
- $ref: '#/components/parameters/V3PageSize'
Expand All @@ -1603,6 +1634,7 @@ paths:
- payments.v3
summary: List all payments related to a payment initiation
operationId: v3ListPaymentInitiationRelatedPayments
x-speakeasy-name-override: ListPaymentInitiationRelatedPayments
parameters:
- $ref: '#/components/parameters/V3PaymentInitiationID'
- $ref: '#/components/parameters/V3PageSize'
Expand All @@ -1629,6 +1661,7 @@ paths:
- payments.v3
summary: Create a formance pool object
operationId: v3CreatePool
x-speakeasy-name-override: CreatePool
requestBody:
content:
application/json:
Expand All @@ -1655,6 +1688,7 @@ paths:
- payments.v3
summary: List all pools
operationId: v3ListPools
x-speakeasy-name-override: ListPools
parameters:
- $ref: '#/components/parameters/V3PageSize'
- $ref: '#/components/parameters/V3Cursor'
Expand Down Expand Up @@ -1685,6 +1719,7 @@ paths:
- payments.v3
summary: Get a pool by ID
operationId: v3GetPool
x-speakeasy-name-override: GetPool
parameters:
- $ref: '#/components/parameters/V3PoolID'
responses:
Expand All @@ -1708,6 +1743,7 @@ paths:
- payments.v3
summary: Delete a pool by ID
operationId: v3DeletePool
x-speakeasy-name-override: DeletePool
parameters:
- $ref: '#/components/parameters/V3PoolID'
responses:
Expand All @@ -1728,6 +1764,7 @@ paths:
- payments.v3
summary: Get pool balances
operationId: v3GetPoolBalances
x-speakeasy-name-override: GetPoolBalances
parameters:
- $ref: '#/components/parameters/V3PoolID'
- $ref: '#/components/parameters/V3At'
Expand All @@ -1753,6 +1790,7 @@ paths:
- payments.v3
summary: Add an account to a pool
operationId: v3AddAccountToPool
x-speakeasy-name-override: AddAccountToPool
parameters:
- $ref: '#/components/parameters/V3PoolID'
- $ref: '#/components/parameters/V3AccountID'
Expand All @@ -1773,6 +1811,7 @@ paths:
- payments.v3
summary: Remove an account from a pool
operationId: v3RemoveAccountFromPool
x-speakeasy-name-override: RemoveAccountFromPool
parameters:
- $ref: '#/components/parameters/V3PoolID'
- $ref: '#/components/parameters/V3AccountID'
Expand All @@ -1794,6 +1833,7 @@ paths:
- payments.v3
summary: Get a task and its result by ID
operationId: v3GetTask
x-speakeasy-name-override: GetTask
parameters:
- $ref: '#/components/parameters/V3TaskID'
responses:
Expand Down Expand Up @@ -2812,7 +2852,6 @@ components:
- updatedAt
- descriptor
- status
- state
properties:
id:
type: string
Expand All @@ -2826,11 +2865,20 @@ components:
type: string
format: date-time
status:
$ref: '#/components/schemas/PaymentStatus'
$ref: '#/components/schemas/TaskStatus'
state:
nullable: true
type: object
error:
type: string
TaskStatus:
type: string
enum:
- PENDING
- ACTIVE
- STOPPED
- TERMINATED
- FAILED
TaskStripe:
allOf:
- $ref: '#/components/schemas/TaskBase'
Expand Down Expand Up @@ -4514,12 +4562,12 @@ components:
type: object
required:
- name
- username
- password
- endpoint
- authorizationEndpoint
- userCertificate
- userCertificateKey
- username
- password
- endpoint
properties:
authorizationEndpoint:
type: string
Expand Down Expand Up @@ -4602,9 +4650,9 @@ components:
type: object
required:
- name
- endpoint
- clientID
- apiKey
- endpoint
properties:
apiKey:
type: string
Expand Down Expand Up @@ -4684,8 +4732,8 @@ components:
type: object
required:
- name
- apiKey
- webhookPublicKey
- apiKey
properties:
apiKey:
type: string
Expand Down
Loading
Loading