fix: sync SDK to OpenAPI doc v2.6.1 (#93)

circlefin · Oct 16, 2023 · 3b64e46 · 3b64e46
1 parent 4408def
commit 3b64e46
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 14 deletions.
diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION
@@ -1 +1 @@
-2.6.0
+2.6.1
diff --git a/sdk.json b/sdk.json
@@ -6,7 +6,7 @@
     }
   ],
   "info": {
-    "version": "2.6.0",
+    "version": "2.6.1",
     "title": "All Circle APIs",
     "description": "Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification."
   },
@@ -1578,7 +1578,7 @@
           }
         ],
         "summary": "Create a deposit address",
-        "description": "Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you're requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit.\n",
+        "description": "Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you're requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. \n",
         "operationId": "createBusinessDepositAddress",
         "tags": ["Addresses"],
         "requestBody": {
@@ -1692,7 +1692,7 @@
           }
         ],
         "summary": "Create a recipient address",
-        "description": "Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address.\n",
+        "description": "Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status.\n",
         "operationId": "createBusinessRecipientAddress",
         "tags": ["Addresses"],
         "requestBody": {
@@ -10919,7 +10919,7 @@
             "example": "0x4cebf8f90c9243a23c77e4ae20df691469e4b933b295a73376292843968f7a63"
           },
           "status": {
-            "description": "Status of the transfer. Status `pending` indicates that the transfer is in the process of running; `complete` indicates it finished successfully; `failed` indicates it failed.",
+            "description": "Status of the transfer. Status `pending` indicates that the transfer is in the process of running; `complete` indicates it finished successfully; `failed` indicates it failed. Circle Mint Singapore customers may have transfers in the `pending` status if the recipient addresses are not verified.",
             "type": "string",
             "enum": ["pending", "complete", "failed"]
           },

diff --git a/src/generated/apis/addresses-api.ts b/src/generated/apis/addresses-api.ts
@@ -56,7 +56,7 @@ export const AddressesApiAxiosParamCreator = function (
 ) {
   return {
     /**
-     * Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you\'re requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit.
+     * Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you\'re requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status.
      * @summary Create a deposit address
      * @param {BusinessGenerateAddressRequest} [businessGenerateAddressRequest]
      * @param {*} [options] Override http request option.
@@ -108,7 +108,7 @@ export const AddressesApiAxiosParamCreator = function (
       };
     },
     /**
-     * Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address.
+     * Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status.
      * @summary Create a recipient address
      * @param {BusinessRecipientAddressCreationRequest} [businessRecipientAddressCreationRequest]
      * @param {*} [options] Override http request option.
@@ -289,7 +289,7 @@ export const AddressesApiFp = function (configuration?: Configuration) {
     AddressesApiAxiosParamCreator(configuration);
   return {
     /**
-     * Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you\'re requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit.
+     * Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you\'re requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status.
      * @summary Create a deposit address
      * @param {BusinessGenerateAddressRequest} [businessGenerateAddressRequest]
      * @param {*} [options] Override http request option.
@@ -317,7 +317,7 @@ export const AddressesApiFp = function (configuration?: Configuration) {
       );
     },
     /**
-     * Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address.
+     * Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status.
      * @summary Create a recipient address
      * @param {BusinessRecipientAddressCreationRequest} [businessRecipientAddressCreationRequest]
      * @param {*} [options] Override http request option.
@@ -422,7 +422,7 @@ export const AddressesApiFactory = function (
   const localVarFp = AddressesApiFp(configuration);
   return {
     /**
-     * Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you\'re requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit.
+     * Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you\'re requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status.
      * @summary Create a deposit address
      * @param {BusinessGenerateAddressRequest} [businessGenerateAddressRequest]
      * @param {*} [options] Override http request option.
@@ -437,7 +437,7 @@ export const AddressesApiFactory = function (
         .then((request) => request(axios, basePath));
     },
     /**
-     * Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address.
+     * Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status.
      * @summary Create a recipient address
      * @param {BusinessRecipientAddressCreationRequest} [businessRecipientAddressCreationRequest]
      * @param {*} [options] Override http request option.
@@ -508,7 +508,7 @@ export const AddressesApiFactory = function (
  */
 export class AddressesApi extends BaseAPI {
   /**
-   * Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you\'re requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit.
+   * Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you\'re requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status.
    * @summary Create a deposit address
    * @param {BusinessGenerateAddressRequest} [businessGenerateAddressRequest]
    * @param {*} [options] Override http request option.
@@ -525,7 +525,7 @@ export class AddressesApi extends BaseAPI {
   }
 
   /**
-   * Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address.
+   * Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status.
    * @summary Create a recipient address
    * @param {BusinessRecipientAddressCreationRequest} [businessRecipientAddressCreationRequest]
    * @param {*} [options] Override http request option.

diff --git a/src/generated/models/transfer.ts b/src/generated/models/transfer.ts
@@ -65,7 +65,7 @@ export interface Transfer {
    */
   transactionHash?: string;
   /**
-   * Status of the transfer. Status `pending` indicates that the transfer is in the process of running; `complete` indicates it finished successfully; `failed` indicates it failed.
+   * Status of the transfer. Status `pending` indicates that the transfer is in the process of running; `complete` indicates it finished successfully; `failed` indicates it failed. Circle Mint Singapore customers may have transfers in the `pending` status if the recipient addresses are not verified.
    * @type {string}
    * @memberof Transfer
    */