@imtbl/sdk 1.26.2-alpha.2 → 1.26.3

package/dist/x.d.ts

@@ -4932,12 +4932,6 @@ interface GetPrimarySaleOKBody {
  * @interface Project
  */
 interface Project {
-    /**
-     * API key for the project. This is only for zkevm project. This API is not for increasing rate limit yet.
-     * @type {string}
-     * @memberof Project
-     */
-    'api_key'?: string;
     /**
      * The project ChainType
      * @type {string}
@@ -4945,73 +4939,13 @@ interface Project {
      */
     'chain_type'?: string;
     /**
-     * The current period expiry date for collection limit
-     * @type {string}
-     * @memberof Project
-     */
-    'collection_limit_expires_at': string;
-    /**
-     * The total monthly collection limit
-     * @type {number}
-     * @memberof Project
-     */
-    'collection_monthly_limit': number;
-    /**
-     * The number of collection remaining in the current period
-     * @type {number}
-     * @memberof Project
-     */
-    'collection_remaining': number;
-    /**
-     * The company name
-     * @type {string}
-     * @memberof Project
-     */
-    'company_name': string;
-    /**
-     * The project contact email (must be registered as a developer account with Immutable at https://hub.immutable.com)
+     * The project group ID
      * @type {string}
      * @memberof Project
      */
-    'contact_email': string;
-    /**
-     * The environment ID
-     * @type {string}
-     * @memberof Project
-     */
-    'environment_id'?: string;
-    /**
-     * The user environment name correlating to this project
-     * @type {string}
-     * @memberof Project
-     */
-    'environment_name'?: string;
-    /**
-     * The project ID
-     * @type {number}
-     * @memberof Project
-     */
-    'id': number;
-    /**
-     * The current period expiry date for mint operation limit
-     * @type {string}
-     * @memberof Project
-     */
-    'mint_limit_expires_at': string;
-    /**
-     * The total monthly mint operation limit
-     * @type {number}
-     * @memberof Project
-     */
-    'mint_monthly_limit': number;
-    /**
-     * The number of mint operation remaining in the current period
-     * @type {number}
-     * @memberof Project
-     */
-    'mint_remaining': number;
+    'id': string;
     /**
-     * The project name
+     * The project group name
      * @type {string}
      * @memberof Project
      */
@@ -5022,24 +4956,6 @@ interface Project {
      * @memberof Project
      */
     'org_id'?: string;
-    /**
-     * Project group id
-     * @type {string}
-     * @memberof Project
-     */
-    'project_group_id'?: string;
-    /**
-     * The public publishable_key for the project
-     * @type {string}
-     * @memberof Project
-     */
-    'publishable_key'?: string;
-    /**
-     * The public publishable_key created time
-     * @type {string}
-     * @memberof Project
-     */
-    'publishable_key_created_at'?: string;
 }
 
 /**
@@ -6462,7 +6378,7 @@ interface GetSignableWithdrawalResponseV2 {
      */
     'asset_id': string;
     /**
-     * Token in request to match in SDK implementation
+     * Expiration timestamp for this withdrawal
      * @type {number}
      * @memberof GetSignableWithdrawalResponseV2
      */
@@ -6763,6 +6679,25 @@ interface ListDepositsResponse {
  */
 type MintToken = Token;
 
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * @type MintTokenOAIGen
+ * Details of the asset which has been minted
+ * @export
+ */
+type MintTokenOAIGen = MintToken;
+
 /**
  * Immutable X API
  * Immutable X API
@@ -6801,10 +6736,10 @@ interface Mint {
     'timestamp': string;
     /**
      *
-     * @type {MintToken}
+     * @type {MintTokenOAIGen}
      * @memberof Mint
      */
-    'token': MintToken;
+    'token': MintTokenOAIGen;
     /**
      * Sequential ID of transaction in Immutable X
      * @type {number}
@@ -12456,8 +12391,8 @@ interface WithdrawalsApiListWithdrawalsRequest$1 {
  */
 declare class WithdrawalsApi$1 extends BaseAPI {
     /**
-     * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
-     * @summary Creates a withdrawal of a token
+     * Creates a withdrawal. Use https://docs.x.immutable.com/reference/#/operations/getSignableWithdrawal to get request body params. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/createWithdrawalV2.
+     * @summary Creates a withdrawal
      * @param {WithdrawalsApiCreateWithdrawalRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -12465,8 +12400,8 @@ declare class WithdrawalsApi$1 extends BaseAPI {
      */
     createWithdrawal(requestParameters: WithdrawalsApiCreateWithdrawalRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateWithdrawalResponse, any>>;
     /**
-     * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
-     * @summary Creates a withdrawal of a token for starkex contracts that are higher than v3
+     * Creates a withdrawal. Use https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2 to get request body params.
+     * @summary Creates a withdrawal of a token for when StarkEx contract that is higher than v3
      * @param {WithdrawalsApiCreateWithdrawalV2Request} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -12474,7 +12409,7 @@ declare class WithdrawalsApi$1 extends BaseAPI {
      */
     createWithdrawalV2(requestParameters: WithdrawalsApiCreateWithdrawalV2Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateWithdrawalResponse, any>>;
     /**
-     * Gets details of a signable withdrawal
+     * Gets details of a signable withdrawal. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2.
      * @summary Gets details of a signable withdrawal
      * @param {WithdrawalsApiGetSignableWithdrawalRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/x.js

@@ -31,7 +31,7 @@ import detectEthereumProvider from '@metamask/detect-provider';
  */
 // Some imports not used depending on template conditions
 // @ts-ignore
-const BASE_PATH$1 = "https://api.sandbox.x.immutable.com".replace(/\/+$/, "");
+const BASE_PATH$1 = "https://api.immutable.com".replace(/\/+$/, "");
 /**
  *
  * @export
@@ -6334,8 +6334,8 @@ let UsersApi$1 = class UsersApi extends BaseAPI$1 {
 const WithdrawalsApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
-         * @summary Creates a withdrawal of a token
+         * Creates a withdrawal. Use https://docs.x.immutable.com/reference/#/operations/getSignableWithdrawal to get request body params. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/createWithdrawalV2.
+         * @summary Creates a withdrawal
          * @param {string} xImxEthAddress eth address
          * @param {string} xImxEthSignature eth signature
          * @param {CreateWithdrawalRequest} createWithdrawalRequest create a withdrawal
@@ -6376,8 +6376,8 @@ const WithdrawalsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
-         * @summary Creates a withdrawal of a token for starkex contracts that are higher than v3
+         * Creates a withdrawal. Use https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2 to get request body params.
+         * @summary Creates a withdrawal of a token for when StarkEx contract that is higher than v3
          * @param {string} xImxEthAddress eth address
          * @param {string} xImxEthSignature eth signature
          * @param {CreateWithdrawalRequestV2} createWithdrawalRequestV2 create a withdrawal
@@ -6418,7 +6418,7 @@ const WithdrawalsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Gets details of a signable withdrawal
+         * Gets details of a signable withdrawal. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2.
          * @summary Gets details of a signable withdrawal
          * @param {GetSignableWithdrawalRequest} getSignableWithdrawalRequest get details of signable withdrawal
          * @param {*} [options] Override http request option.
@@ -6613,8 +6613,8 @@ const WithdrawalsApiFp = function (configuration) {
     const localVarAxiosParamCreator = WithdrawalsApiAxiosParamCreator(configuration);
     return {
         /**
-         * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
-         * @summary Creates a withdrawal of a token
+         * Creates a withdrawal. Use https://docs.x.immutable.com/reference/#/operations/getSignableWithdrawal to get request body params. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/createWithdrawalV2.
+         * @summary Creates a withdrawal
          * @param {string} xImxEthAddress eth address
          * @param {string} xImxEthSignature eth signature
          * @param {CreateWithdrawalRequest} createWithdrawalRequest create a withdrawal
@@ -6626,8 +6626,8 @@ const WithdrawalsApiFp = function (configuration) {
             return createRequestFunction$1(localVarAxiosArgs, globalAxios, BASE_PATH$1, configuration);
         },
         /**
-         * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
-         * @summary Creates a withdrawal of a token for starkex contracts that are higher than v3
+         * Creates a withdrawal. Use https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2 to get request body params.
+         * @summary Creates a withdrawal of a token for when StarkEx contract that is higher than v3
          * @param {string} xImxEthAddress eth address
          * @param {string} xImxEthSignature eth signature
          * @param {CreateWithdrawalRequestV2} createWithdrawalRequestV2 create a withdrawal
@@ -6639,7 +6639,7 @@ const WithdrawalsApiFp = function (configuration) {
             return createRequestFunction$1(localVarAxiosArgs, globalAxios, BASE_PATH$1, configuration);
         },
         /**
-         * Gets details of a signable withdrawal
+         * Gets details of a signable withdrawal. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2.
          * @summary Gets details of a signable withdrawal
          * @param {GetSignableWithdrawalRequest} getSignableWithdrawalRequest get details of signable withdrawal
          * @param {*} [options] Override http request option.
@@ -6709,8 +6709,8 @@ const WithdrawalsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = WithdrawalsApiFp(configuration);
     return {
         /**
-         * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
-         * @summary Creates a withdrawal of a token
+         * Creates a withdrawal. Use https://docs.x.immutable.com/reference/#/operations/getSignableWithdrawal to get request body params. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/createWithdrawalV2.
+         * @summary Creates a withdrawal
          * @param {string} xImxEthAddress eth address
          * @param {string} xImxEthSignature eth signature
          * @param {CreateWithdrawalRequest} createWithdrawalRequest create a withdrawal
@@ -6721,8 +6721,8 @@ const WithdrawalsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.createWithdrawal(xImxEthAddress, xImxEthSignature, createWithdrawalRequest, options).then((request) => request(axios, basePath));
         },
         /**
-         * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
-         * @summary Creates a withdrawal of a token for starkex contracts that are higher than v3
+         * Creates a withdrawal. Use https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2 to get request body params.
+         * @summary Creates a withdrawal of a token for when StarkEx contract that is higher than v3
          * @param {string} xImxEthAddress eth address
          * @param {string} xImxEthSignature eth signature
          * @param {CreateWithdrawalRequestV2} createWithdrawalRequestV2 create a withdrawal
@@ -6733,7 +6733,7 @@ const WithdrawalsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.createWithdrawalV2(xImxEthAddress, xImxEthSignature, createWithdrawalRequestV2, options).then((request) => request(axios, basePath));
         },
         /**
-         * Gets details of a signable withdrawal
+         * Gets details of a signable withdrawal. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2.
          * @summary Gets details of a signable withdrawal
          * @param {GetSignableWithdrawalRequest} getSignableWithdrawalRequest get details of signable withdrawal
          * @param {*} [options] Override http request option.
@@ -6799,8 +6799,8 @@ const WithdrawalsApiFactory = function (configuration, basePath, axios) {
  */
 let WithdrawalsApi$1 = class WithdrawalsApi extends BaseAPI$1 {
     /**
-     * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
-     * @summary Creates a withdrawal of a token
+     * Creates a withdrawal. Use https://docs.x.immutable.com/reference/#/operations/getSignableWithdrawal to get request body params. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/createWithdrawalV2.
+     * @summary Creates a withdrawal
      * @param {WithdrawalsApiCreateWithdrawalRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -6810,8 +6810,8 @@ let WithdrawalsApi$1 = class WithdrawalsApi extends BaseAPI$1 {
         return WithdrawalsApiFp(this.configuration).createWithdrawal(requestParameters.xImxEthAddress, requestParameters.xImxEthSignature, requestParameters.createWithdrawalRequest, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
-     * @summary Creates a withdrawal of a token for starkex contracts that are higher than v3
+     * Creates a withdrawal. Use https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2 to get request body params.
+     * @summary Creates a withdrawal of a token for when StarkEx contract that is higher than v3
      * @param {WithdrawalsApiCreateWithdrawalV2Request} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -6821,7 +6821,7 @@ let WithdrawalsApi$1 = class WithdrawalsApi extends BaseAPI$1 {
         return WithdrawalsApiFp(this.configuration).createWithdrawalV2(requestParameters.xImxEthAddress, requestParameters.xImxEthSignature, requestParameters.createWithdrawalRequestV2, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Gets details of a signable withdrawal
+     * Gets details of a signable withdrawal. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2.
      * @summary Gets details of a signable withdrawal
      * @param {WithdrawalsApiGetSignableWithdrawalRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -8954,7 +8954,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.26.2-alpha.2';
+const SDK_VERSION = '1.26.3';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -9197,7 +9197,7 @@ const addKeysToHeadersOverride = (baseConfig, overrides) => {
 /* eslint-disable @typescript-eslint/naming-convention */
 class ApiConfiguration extends index$2.Configuration {
 }
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.26.2-alpha.2' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.26.3' };
 /**
  * @dev use createImmutableXConfiguration instead
  */
@@ -9236,7 +9236,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.26.2-alpha.2',
+    sdkVersion: 'ts-immutable-sdk-1.26.3',
     baseConfig,
 });
 const production = ({ baseConfig }) => createImmutableXConfiguration({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "1.26.2-alpha.2",
+  "version": "1.26.3",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",