From 88eae40f6bff1b00b99f041a3d22c5223b797f3e Mon Sep 17 00:00:00 2001 From: circle-github-action-bot Date: Thu, 28 Mar 2024 12:03:48 -0700 Subject: [PATCH] feat: sync SDK to OpenAPI doc v2.9.0 (#110) Automated pull request triggered by OpenAPI document update. SDK Code generated using [OpenAPI generator](https://openapi-generator.tech/) Co-authored-by: Ashutosh Ukey --- OPENAPI_VERSION | 2 +- sdk.json | 15 +++++++++++---- src/generated/apis/addresses-api.ts | 16 ++++++++-------- .../models/business-recipient-address-object.ts | 15 +++++++++++++++ 4 files changed, 35 insertions(+), 13 deletions(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 834f262..c8e38b6 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -2.8.0 +2.9.0 diff --git a/sdk.json b/sdk.json index 3612576..a673ca1 100644 --- a/sdk.json +++ b/sdk.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.8.0", + "version": "2.9.0", "title": "All Circle APIs", "description": "Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification." }, @@ -1731,7 +1731,8 @@ "addressTag": "123456789", "chain": "ALGO", "currency": "USD", - "description": "My USDC address at a cryptocurrency exchange" + "description": "My USDC address at a cryptocurrency exchange", + "status": "active" } } } @@ -1771,7 +1772,7 @@ } ], "summary": "List all recipient addresses", - "description": "Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending verification are not included in the response.\n", + "description": "Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending administrator verification are not included in the response.\n", "operationId": "listBusinessRecipientAddresses", "tags": ["Addresses"], "responses": { @@ -1805,7 +1806,8 @@ "addressTag": "123456789", "chain": "ALGO", "currency": "USD", - "description": "My USDC address at a cryptocurrency exchange" + "description": "My USDC address at a cryptocurrency exchange", + "status": "active" } ] } @@ -1833,6 +1835,7 @@ } ], "summary": "Delete a recipient address", + "description": "Deletes an external blockchain address. The recipient address must be in an 'active' or 'pending' state in order to be deleted successfully.\n", "operationId": "deleteBusinessRecipientAddress", "tags": ["Addresses"], "responses": { @@ -8401,6 +8404,10 @@ }, "description": { "$ref": "#/components/schemas/AddressDescription" + }, + "status": { + "type": "string", + "enum": ["active", "pending_verification", "verification_succeeded"] } } }, diff --git a/src/generated/apis/addresses-api.ts b/src/generated/apis/addresses-api.ts index 26b8a9b..2a5ec12 100644 --- a/src/generated/apis/addresses-api.ts +++ b/src/generated/apis/addresses-api.ts @@ -162,7 +162,7 @@ export const AddressesApiAxiosParamCreator = function ( }; }, /** - * + * Deletes an external blockchain address. The recipient address must be in an \'active\' or \'pending\' state in order to be deleted successfully. * @summary Delete a recipient address * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. @@ -256,7 +256,7 @@ export const AddressesApiAxiosParamCreator = function ( }; }, /** - * Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending verification are not included in the response. + * Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending administrator verification are not included in the response. * @summary List all recipient addresses * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). @@ -398,7 +398,7 @@ export const AddressesApiFp = function (configuration?: Configuration) { ); }, /** - * + * Deletes an external blockchain address. The recipient address must be in an \'active\' or \'pending\' state in order to be deleted successfully. * @summary Delete a recipient address * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. @@ -446,7 +446,7 @@ export const AddressesApiFp = function (configuration?: Configuration) { ); }, /** - * Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending verification are not included in the response. + * Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending administrator verification are not included in the response. * @summary List all recipient addresses * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). @@ -533,7 +533,7 @@ export const AddressesApiFactory = function ( .then((request) => request(axios, basePath)); }, /** - * + * Deletes an external blockchain address. The recipient address must be in an \'active\' or \'pending\' state in order to be deleted successfully. * @summary Delete a recipient address * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. @@ -561,7 +561,7 @@ export const AddressesApiFactory = function ( .then((request) => request(axios, basePath)); }, /** - * Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending verification are not included in the response. + * Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending administrator verification are not included in the response. * @summary List all recipient addresses * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). @@ -638,7 +638,7 @@ export class AddressesApi extends BaseAPI { } /** - * + * Deletes an external blockchain address. The recipient address must be in an \'active\' or \'pending\' state in order to be deleted successfully. * @summary Delete a recipient address * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. @@ -668,7 +668,7 @@ export class AddressesApi extends BaseAPI { } /** - * Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending verification are not included in the response. + * Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending administrator verification are not included in the response. * @summary List all recipient addresses * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). diff --git a/src/generated/models/business-recipient-address-object.ts b/src/generated/models/business-recipient-address-object.ts index f7ded05..2948001 100644 --- a/src/generated/models/business-recipient-address-object.ts +++ b/src/generated/models/business-recipient-address-object.ts @@ -55,4 +55,19 @@ export interface BusinessRecipientAddressObject { * @memberof BusinessRecipientAddressObject */ description?: string; + /** + * + * @type {string} + * @memberof BusinessRecipientAddressObject + */ + status?: BusinessRecipientAddressObjectStatusEnum; } + +export const BusinessRecipientAddressObjectStatusEnum = { + Active: "active", + PendingVerification: "pending_verification", + VerificationSucceeded: "verification_succeeded" +} as const; + +export type BusinessRecipientAddressObjectStatusEnum = + typeof BusinessRecipientAddressObjectStatusEnum[keyof typeof BusinessRecipientAddressObjectStatusEnum];