Skip to content

Commit

Permalink
feat: sync SDK to OpenAPI doc v1.8.0 (#71)
Browse files Browse the repository at this point in the history
  • Loading branch information
@circle-github-action-bot
circle-github-action-bot authored Apr 5, 2023
1 parent b2648e5 commit 18a0b7d
Show file tree
Hide file tree
Showing 14 changed files with 1,040 additions and 2 deletions.
2 changes: 1 addition & 1 deletion OPENAPI_VERSION
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.7.3
1.8.0
302 changes: 301 additions & 1 deletion sdk.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
}
],
"info": {
"version": "1.7.3",
"version": "1.8.0",
"title": "All Circle APIs",
"description": "Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification."
},
Expand Down Expand Up @@ -103,6 +103,10 @@
"name": "Signet",
"description": "Create and get information on Signet accounts."
},
{
"name": "CBIT",
"description": "Create and get information on CBIT accounts."
},
{
"name": "Stablecoins",
"description": "Retrieve stablecoins and their respective names, symbols, circulating total and per-chain amounts."
Expand Down Expand Up @@ -2452,6 +2456,238 @@
}
}
},
"/v1/businessAccount/banks/cbit": {
"post": {
"security": [
{
"bearerAuth": []
}
],
"summary": "Create a CBIT bank account",
"operationId": "createBusinessCbitAccount",
"tags": ["CBIT"],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CbitFiatAccountCreationRequest"
}
}
}
},
"responses": {
"201": {
"description": "Successfully created a bank account for CBIT transfers.",
"headers": {
"X-Request-Id": {
"$ref": "#/components/headers/XRequestId"
}
},
"content": {
"application/json": {
"schema": {
"title": "CreateBusinessCbitAccountResponse",
"properties": {
"data": {
"$ref": "#/components/schemas/CbitFiatAccountResponse"
}
}
},
"examples": {
"response": {
"value": {
"data": {
"id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
"status": "pending",
"trackingRef": "CIR25XSXT8",
"walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e",
"createDate": "2020-04-10T02:13:30.000Z",
"updateDate": "2020-04-10T02:13:30.000Z"
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/NotAuthorized"
}
}
},
"get": {
"security": [
{
"bearerAuth": []
}
],
"summary": "List all CBIT bank accounts.",
"operationId": "listBusinessCbitAccounts",
"tags": ["CBIT"],
"responses": {
"200": {
"description": "Successfully retrieved all bank accounts for CBIT transfers.",
"headers": {
"X-Request-Id": {
"$ref": "#/components/headers/XRequestId"
}
},
"content": {
"application/json": {
"schema": {
"title": "ListBusinessCbitAccountsResponse",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CbitFiatAccountResponse"
}
}
}
},
"examples": {
"response": {
"value": {
"data": [
{
"id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
"status": "pending",
"trackingRef": "CIR25XSXT8",
"walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e",
"createDate": "2020-04-10T02:13:30.000Z",
"updateDate": "2020-04-10T02:13:30.000Z"
}
]
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/NotAuthorized"
}
}
}
},
"/v1/businessAccount/banks/cbit/{id}": {
"get": {
"parameters": [
{
"$ref": "#/components/parameters/IdPath"
}
],
"security": [
{
"bearerAuth": []
}
],
"summary": "Get a CBIT bank account",
"operationId": "getBusinessCbitAccount",
"tags": ["CBIT"],
"responses": {
"200": {
"description": "Successfully retrieved a bank account for CBIT transfers.",
"headers": {
"X-Request-Id": {
"$ref": "#/components/headers/XRequestId"
}
},
"content": {
"application/json": {
"schema": {
"title": "GetBusinessCbitAccountResponse",
"properties": {
"data": {
"$ref": "#/components/schemas/CbitFiatAccountResponse"
}
}
},
"examples": {
"response": {
"value": {
"data": {
"id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
"status": "pending",
"trackingRef": "CIR25XSXT8",
"walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e",
"createDate": "2020-04-10T02:13:30.000Z",
"updateDate": "2020-04-10T02:13:30.000Z"
}
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/NotAuthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
}
}
}
},
"/v1/businessAccount/banks/cbit/{id}/instructions": {
"get": {
"parameters": [
{
"$ref": "#/components/parameters/IdPath"
}
],
"security": [
{
"bearerAuth": []
}
],
"summary": "Get CBIT instructions",
"description": "Get the CBIT transfer instructions into the Circle bank account given your bank account id.",
"operationId": "getBusinessCbitAccountInstructions",
"tags": ["CBIT"],
"responses": {
"200": {
"description": "Successfully retrieved CBIT transfer instructions for the bank account.",
"headers": {
"X-Request-Id": {
"$ref": "#/components/headers/XRequestId"
}
},
"content": {
"application/json": {
"schema": {
"title": "ListBusinessCbitAccountInstructionsResponse",
"properties": {
"data": {
"$ref": "#/components/schemas/CbitInstruction"
}
}
},
"examples": {
"response": {
"value": {
"data": {
"trackingRef": "CIR25XSXT8",
"walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e"
}
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/NotAuthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
}
}
}
},
"/v1/businessAccount/wallets/addresses/deposit": {
"post": {
"security": [
Expand Down Expand Up @@ -10078,6 +10314,70 @@
}
}
},
"CbitFiatAccountResponse": {
"type": "object",
"required": [
"id",
"status",
"trackingRef",
"walletAddress",
"createDate",
"updateDate"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"status": {
"$ref": "#/components/schemas/ExternalFiatAccountStatus"
},
"trackingRef": {
"type": "string",
"description": "Tracking ref that needs to be set in the public description field when you send the funds to Circle CBIT wallet.",
"example": "CIR25XSXT8"
},
"walletAddress": {
"type": "string",
"description": "Your CBIT wallet address.",
"example": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e"
},
"createDate": {
"$ref": "#/components/schemas/UtcTimestamp"
},
"updateDate": {
"$ref": "#/components/schemas/UtcTimestamp"
}
}
},
"CbitFiatAccountCreationRequest": {
"type": "object",
"required": ["idempotencyKey", "walletAddress"],
"properties": {
"idempotencyKey": {
"$ref": "#/components/schemas/IdempotencyKey"
},
"walletAddress": {
"type": "string",
"description": "CBIT wallet address.",
"example": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e"
}
}
},
"CbitInstruction": {
"type": "object",
"properties": {
"trackingRef": {
"type": "string",
"description": "Circle tracking reference that needs to be set in the CBIT public description field.",
"example": "CIR25XSXT8"
},
"walletAddress": {
"type": "string",
"description": "Circle wallet address that needs to be set in the CBIT recipient wallet field.",
"example": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e"
}
}
},
"Address": {
"type": "string",
"description": "An alphanumeric string representing a blockchain address. Will be in different formats for different chains. It is important to preserve the exact formatting and capitalization of the address.",
Expand Down
8 changes: 8 additions & 0 deletions src/generated/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ apis/achapi.ts
apis/addresses-api.ts
apis/balances-api.ts
apis/cards-api.ts
apis/cbitapi.ts
apis/channels-api.ts
apis/chargebacks-api.ts
apis/checkout-sessions-api.ts
Expand Down Expand Up @@ -73,6 +74,9 @@ models/card-creation-request.ts
models/card-update.ts
models/card-verification-response.ts
models/card.ts
models/cbit-fiat-account-creation-request.ts
models/cbit-fiat-account-response.ts
models/cbit-instruction.ts
models/chain.ts
models/channel-response.ts
models/chargeback-categories.ts
Expand All @@ -86,6 +90,7 @@ models/continuous-payment-intent-creation-request.ts
models/continuous-payment-intent.ts
models/create-ach-account-response.ts
models/create-address-book-recipient-response.ts
models/create-business-cbit-account-response.ts
models/create-business-deposit-address-response.ts
models/create-business-payout-response.ts
models/create-business-recipient-address-response.ts
Expand Down Expand Up @@ -163,6 +168,7 @@ models/generate-address-request.ts
models/generate-address-response.ts
models/get-ach-account-response.ts
models/get-address-book-recipient-response.ts
models/get-business-cbit-account-response.ts
models/get-business-deposit-address-response.ts
models/get-business-payout-response.ts
models/get-business-sen-account-instructions-response.ts
Expand Down Expand Up @@ -199,6 +205,8 @@ models/list-address-book-recipients-response.ts
models/list-addresses-response.ts
models/list-balances-response.ts
models/list-business-balances-response.ts
models/list-business-cbit-account-instructions-response.ts
models/list-business-cbit-accounts-response.ts
models/list-business-deposits-response.ts
models/list-business-payouts-response.ts
models/list-business-recipient-addresses-response.ts
Expand Down
1 change: 1 addition & 0 deletions src/generated/api.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
export * from "./apis/achapi";
export * from "./apis/addresses-api";
export * from "./apis/balances-api";
export * from "./apis/cbitapi";
export * from "./apis/cards-api";
export * from "./apis/channels-api";
export * from "./apis/chargebacks-api";
Expand Down
Loading

0 comments on commit 18a0b7d

Please sign in to comment.