From 3d4b38e58b6035b8de224bc7d3b72c26e144ac42 Mon Sep 17 00:00:00 2001 From: Frank Li Date: Tue, 27 Feb 2024 14:40:42 +1100 Subject: [PATCH] TD1286 Remove experimental flag (#434) diff Signed-off-by: Frank Li --- CHANGELOG.md | 6 +- openapi.json | 48 ++++++------ src/api/base.ts | 2 +- src/api/domain/primary-sales-api.ts | 112 ++++++++++++++-------------- 4 files changed, 86 insertions(+), 82 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 59b77761..1b37a65b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## Unreleased + +- Remove experimental flag for primary sales functions + ## [3.0.0] - 2024-02-26 ### Added @@ -12,7 +17,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `completeWithdrawal` has been updated to use V2 withdrawal logic for StarkEx V4 contract. - [BREAKING CHANGE] `completeWithdrawal` now requires `WalletConnection` instead of Eth Signer. - ## [2.6.1] - 2024-02-26 ### Added diff --git a/openapi.json b/openapi.json index 396b73da..dc72a87b 100644 --- a/openapi.json +++ b/openapi.json @@ -11,9 +11,9 @@ "url": "https://support.immutable.com", "email": "support@immutable.com" }, - "version": "3.0" + "version": "3.0.0" }, - "host": "api.sandbox.x.immutable.com", + "host": "api.sandbox.immutable.com", "basePath": "/", "paths": { "/v1/assets": { @@ -1666,7 +1666,7 @@ "ImxEthSignature": [] } ], - "description": "[Experimental] Create Primary Sale. This endpoint is experimental and may change in the future.", + "description": "Create Primary Sale. This endpoint is experimental and may change in the future.", "consumes": [ "application/json" ], @@ -1676,7 +1676,7 @@ "tags": [ "primary-sales" ], - "summary": "[Experimental] Create Primary Sale", + "summary": "Create Primary Sale", "operationId": "CreatePrimarySale", "parameters": [ { @@ -1735,7 +1735,7 @@ }, "/v1/primary_sales/signable-primary-sale-details": { "post": { - "description": "[Experimental] Signable Create Primary Sale. This endpoint is experimental and may change in the future.", + "description": "Signable Create Primary Sale. This endpoint is experimental and may change in the future.", "consumes": [ "application/json" ], @@ -1745,7 +1745,7 @@ "tags": [ "primary-sales" ], - "summary": "[Experimental] Signable Create Primary Sale", + "summary": "Signable Create Primary Sale", "operationId": "SignableCreatePrimarySale", "parameters": [ { @@ -1792,14 +1792,14 @@ }, "/v1/primary_sales/{id}": { "get": { - "description": "[Experimental] Get a single primary sale by ID. This endpoint is experimental and may change in the future.", + "description": "Get a single primary sale by ID. This endpoint is experimental and may change in the future.", "produces": [ "application/json" ], "tags": [ "primary-sales" ], - "summary": "[Experimental] Get a single primary sale by ID", + "summary": "Get a single primary sale by ID", "operationId": "GetPrimarySale", "parameters": [ { @@ -1853,14 +1853,14 @@ "ImxEthSignature": [] } ], - "description": "[Experimental] Accept Primary Sale. This endpoint is experimental and may change in the future.", + "description": "Accept Primary Sale. This endpoint is experimental and may change in the future.", "produces": [ "application/json" ], "tags": [ "primary-sales" ], - "summary": "[Experimental] Accept Primary Sale", + "summary": "Accept Primary Sale", "operationId": "AcceptPrimarySale", "parameters": [ { @@ -1932,14 +1932,14 @@ "ImxEthSignature": [] } ], - "description": "[Experimental] Reject Primary Sale. This endpoint is experimental and may change in the future.", + "description": "Reject Primary Sale. This endpoint is experimental and may change in the future.", "produces": [ "application/json" ], "tags": [ "primary-sales" ], - "summary": "[Experimental] Reject Primary Sale", + "summary": "Reject Primary Sale", "operationId": "RejectPrimarySale", "parameters": [ { @@ -2005,14 +2005,14 @@ }, "/v1/primary_sales/{id}/signable-accept-details": { "post": { - "description": "[Experimental] Signable Accept Primary Sale. This endpoint is experimental and may change in the future.", + "description": "Signable Accept Primary Sale. This endpoint is experimental and may change in the future.", "produces": [ "application/json" ], "tags": [ "primary-sales" ], - "summary": "[Experimental] Signable Accept Primary Sale", + "summary": "Signable Accept Primary Sale", "operationId": "SignableAcceptPrimarySale", "parameters": [ { @@ -2066,14 +2066,14 @@ }, "/v1/primary_sales/{id}/signable-reject-details": { "post": { - "description": "[Experimental] Signable Reject Primary Sale. This endpoint is experimental and may change in the future.", + "description": "Signable Reject Primary Sale. This endpoint is experimental and may change in the future.", "produces": [ "application/json" ], "tags": [ "primary-sales" ], - "summary": "[Experimental] Signable Reject Primary Sale", + "summary": "Signable Reject Primary Sale", "operationId": "SignableRejectPrimarySale", "parameters": [ { @@ -14003,7 +14003,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/definitions/APIError" + "$ref": "../../../../common/openapi/errors/api_errors_v2.yaml#/definitions/APIError400" } } }, @@ -14013,7 +14013,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/definitions/APIError" + "$ref": "../../../../common/openapi/errors/api_errors_v2.yaml#/definitions/APIError403" } } }, @@ -14023,7 +14023,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/definitions/APIError" + "$ref": "../../../../common/openapi/errors/api_errors_v2.yaml#/definitions/APIError500" } } }, @@ -14033,7 +14033,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/definitions/APIError" + "$ref": "../../../../common/openapi/errors/api_errors_v2.yaml#/definitions/APIError404" } } }, @@ -14043,7 +14043,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/definitions/APIError" + "$ref": "../../../../common/openapi/errors/api_errors_v2.yaml#/definitions/APIError501" } } }, @@ -14053,7 +14053,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/definitions/APIError" + "$ref": "../../../../common/openapi/errors/api_errors_v2.yaml#/definitions/APIError429" } } }, @@ -14063,7 +14063,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/definitions/APIError" + "$ref": "../../../../common/openapi/errors/api_errors_v2.yaml#/definitions/APIError401" } } }, @@ -14073,7 +14073,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/definitions/APIError" + "$ref": "../../../../common/openapi/errors/api_errors_v2.yaml#/definitions/APIError422" } } }, diff --git a/src/api/base.ts b/src/api/base.ts index 7cab2211..8f1c9a6d 100644 --- a/src/api/base.ts +++ b/src/api/base.ts @@ -18,7 +18,7 @@ import { Configuration } from "./configuration"; // @ts-ignore import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; -export const BASE_PATH = "https://api.sandbox.x.immutable.com".replace(/\/+$/, ""); +export const BASE_PATH = "https://api.sandbox.immutable.com".replace(/\/+$/, ""); /** * diff --git a/src/api/domain/primary-sales-api.ts b/src/api/domain/primary-sales-api.ts index 6a16f3ae..df80047d 100644 --- a/src/api/domain/primary-sales-api.ts +++ b/src/api/domain/primary-sales-api.ts @@ -121,8 +121,8 @@ import { SignableRejectPrimarySaleUnprocessableEntityBody } from '../models'; export const PrimarySalesApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * [Experimental] Accept Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Accept Primary Sale + * Accept Primary Sale. This endpoint is experimental and may change in the future. + * @summary Accept Primary Sale * @param {number} id Global Primary Sale identifier * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -161,8 +161,8 @@ export const PrimarySalesApiAxiosParamCreator = function (configuration?: Config }; }, /** - * [Experimental] Create Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Create Primary Sale + * Create Primary Sale. This endpoint is experimental and may change in the future. + * @summary Create Primary Sale * @param {CreatePrimarySaleParamsBody} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -201,8 +201,8 @@ export const PrimarySalesApiAxiosParamCreator = function (configuration?: Config }; }, /** - * [Experimental] Get a single primary sale by ID. This endpoint is experimental and may change in the future. - * @summary [Experimental] Get a single primary sale by ID + * Get a single primary sale by ID. This endpoint is experimental and may change in the future. + * @summary Get a single primary sale by ID * @param {number} id Global Primary Sale identifier * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -235,8 +235,8 @@ export const PrimarySalesApiAxiosParamCreator = function (configuration?: Config }; }, /** - * [Experimental] Reject Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Reject Primary Sale + * Reject Primary Sale. This endpoint is experimental and may change in the future. + * @summary Reject Primary Sale * @param {number} id Global Primary Sale identifier * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -275,8 +275,8 @@ export const PrimarySalesApiAxiosParamCreator = function (configuration?: Config }; }, /** - * [Experimental] Signable Accept Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Signable Accept Primary Sale + * Signable Accept Primary Sale. This endpoint is experimental and may change in the future. + * @summary Signable Accept Primary Sale * @param {number} id Global Primary Sale identifier * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -309,8 +309,8 @@ export const PrimarySalesApiAxiosParamCreator = function (configuration?: Config }; }, /** - * [Experimental] Signable Create Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Signable Create Primary Sale + * Signable Create Primary Sale. This endpoint is experimental and may change in the future. + * @summary Signable Create Primary Sale * @param {SignableCreatePrimarySaleParamsBody} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -343,8 +343,8 @@ export const PrimarySalesApiAxiosParamCreator = function (configuration?: Config }; }, /** - * [Experimental] Signable Reject Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Signable Reject Primary Sale + * Signable Reject Primary Sale. This endpoint is experimental and may change in the future. + * @summary Signable Reject Primary Sale * @param {number} id Global Primary Sale identifier * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -387,8 +387,8 @@ export const PrimarySalesApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PrimarySalesApiAxiosParamCreator(configuration) return { /** - * [Experimental] Accept Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Accept Primary Sale + * Accept Primary Sale. This endpoint is experimental and may change in the future. + * @summary Accept Primary Sale * @param {number} id Global Primary Sale identifier * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -398,8 +398,8 @@ export const PrimarySalesApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * [Experimental] Create Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Create Primary Sale + * Create Primary Sale. This endpoint is experimental and may change in the future. + * @summary Create Primary Sale * @param {CreatePrimarySaleParamsBody} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -409,8 +409,8 @@ export const PrimarySalesApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * [Experimental] Get a single primary sale by ID. This endpoint is experimental and may change in the future. - * @summary [Experimental] Get a single primary sale by ID + * Get a single primary sale by ID. This endpoint is experimental and may change in the future. + * @summary Get a single primary sale by ID * @param {number} id Global Primary Sale identifier * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -420,8 +420,8 @@ export const PrimarySalesApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * [Experimental] Reject Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Reject Primary Sale + * Reject Primary Sale. This endpoint is experimental and may change in the future. + * @summary Reject Primary Sale * @param {number} id Global Primary Sale identifier * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -431,8 +431,8 @@ export const PrimarySalesApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * [Experimental] Signable Accept Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Signable Accept Primary Sale + * Signable Accept Primary Sale. This endpoint is experimental and may change in the future. + * @summary Signable Accept Primary Sale * @param {number} id Global Primary Sale identifier * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -442,8 +442,8 @@ export const PrimarySalesApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * [Experimental] Signable Create Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Signable Create Primary Sale + * Signable Create Primary Sale. This endpoint is experimental and may change in the future. + * @summary Signable Create Primary Sale * @param {SignableCreatePrimarySaleParamsBody} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -453,8 +453,8 @@ export const PrimarySalesApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * [Experimental] Signable Reject Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Signable Reject Primary Sale + * Signable Reject Primary Sale. This endpoint is experimental and may change in the future. + * @summary Signable Reject Primary Sale * @param {number} id Global Primary Sale identifier * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -474,8 +474,8 @@ export const PrimarySalesApiFactory = function (configuration?: Configuration, b const localVarFp = PrimarySalesApiFp(configuration) return { /** - * [Experimental] Accept Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Accept Primary Sale + * Accept Primary Sale. This endpoint is experimental and may change in the future. + * @summary Accept Primary Sale * @param {number} id Global Primary Sale identifier * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -484,8 +484,8 @@ export const PrimarySalesApiFactory = function (configuration?: Configuration, b return localVarFp.acceptPrimarySale(id, options).then((request) => request(axios, basePath)); }, /** - * [Experimental] Create Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Create Primary Sale + * Create Primary Sale. This endpoint is experimental and may change in the future. + * @summary Create Primary Sale * @param {CreatePrimarySaleParamsBody} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -494,8 +494,8 @@ export const PrimarySalesApiFactory = function (configuration?: Configuration, b return localVarFp.createPrimarySale(body, options).then((request) => request(axios, basePath)); }, /** - * [Experimental] Get a single primary sale by ID. This endpoint is experimental and may change in the future. - * @summary [Experimental] Get a single primary sale by ID + * Get a single primary sale by ID. This endpoint is experimental and may change in the future. + * @summary Get a single primary sale by ID * @param {number} id Global Primary Sale identifier * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -504,8 +504,8 @@ export const PrimarySalesApiFactory = function (configuration?: Configuration, b return localVarFp.getPrimarySale(id, options).then((request) => request(axios, basePath)); }, /** - * [Experimental] Reject Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Reject Primary Sale + * Reject Primary Sale. This endpoint is experimental and may change in the future. + * @summary Reject Primary Sale * @param {number} id Global Primary Sale identifier * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -514,8 +514,8 @@ export const PrimarySalesApiFactory = function (configuration?: Configuration, b return localVarFp.rejectPrimarySale(id, options).then((request) => request(axios, basePath)); }, /** - * [Experimental] Signable Accept Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Signable Accept Primary Sale + * Signable Accept Primary Sale. This endpoint is experimental and may change in the future. + * @summary Signable Accept Primary Sale * @param {number} id Global Primary Sale identifier * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -524,8 +524,8 @@ export const PrimarySalesApiFactory = function (configuration?: Configuration, b return localVarFp.signableAcceptPrimarySale(id, options).then((request) => request(axios, basePath)); }, /** - * [Experimental] Signable Create Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Signable Create Primary Sale + * Signable Create Primary Sale. This endpoint is experimental and may change in the future. + * @summary Signable Create Primary Sale * @param {SignableCreatePrimarySaleParamsBody} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -534,8 +534,8 @@ export const PrimarySalesApiFactory = function (configuration?: Configuration, b return localVarFp.signableCreatePrimarySale(body, options).then((request) => request(axios, basePath)); }, /** - * [Experimental] Signable Reject Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Signable Reject Primary Sale + * Signable Reject Primary Sale. This endpoint is experimental and may change in the future. + * @summary Signable Reject Primary Sale * @param {number} id Global Primary Sale identifier * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -652,8 +652,8 @@ export interface PrimarySalesApiSignableRejectPrimarySaleRequest { */ export class PrimarySalesApi extends BaseAPI { /** - * [Experimental] Accept Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Accept Primary Sale + * Accept Primary Sale. This endpoint is experimental and may change in the future. + * @summary Accept Primary Sale * @param {PrimarySalesApiAcceptPrimarySaleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -664,8 +664,8 @@ export class PrimarySalesApi extends BaseAPI { } /** - * [Experimental] Create Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Create Primary Sale + * Create Primary Sale. This endpoint is experimental and may change in the future. + * @summary Create Primary Sale * @param {PrimarySalesApiCreatePrimarySaleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -676,8 +676,8 @@ export class PrimarySalesApi extends BaseAPI { } /** - * [Experimental] Get a single primary sale by ID. This endpoint is experimental and may change in the future. - * @summary [Experimental] Get a single primary sale by ID + * Get a single primary sale by ID. This endpoint is experimental and may change in the future. + * @summary Get a single primary sale by ID * @param {PrimarySalesApiGetPrimarySaleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -688,8 +688,8 @@ export class PrimarySalesApi extends BaseAPI { } /** - * [Experimental] Reject Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Reject Primary Sale + * Reject Primary Sale. This endpoint is experimental and may change in the future. + * @summary Reject Primary Sale * @param {PrimarySalesApiRejectPrimarySaleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -700,8 +700,8 @@ export class PrimarySalesApi extends BaseAPI { } /** - * [Experimental] Signable Accept Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Signable Accept Primary Sale + * Signable Accept Primary Sale. This endpoint is experimental and may change in the future. + * @summary Signable Accept Primary Sale * @param {PrimarySalesApiSignableAcceptPrimarySaleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -712,8 +712,8 @@ export class PrimarySalesApi extends BaseAPI { } /** - * [Experimental] Signable Create Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Signable Create Primary Sale + * Signable Create Primary Sale. This endpoint is experimental and may change in the future. + * @summary Signable Create Primary Sale * @param {PrimarySalesApiSignableCreatePrimarySaleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -724,8 +724,8 @@ export class PrimarySalesApi extends BaseAPI { } /** - * [Experimental] Signable Reject Primary Sale. This endpoint is experimental and may change in the future. - * @summary [Experimental] Signable Reject Primary Sale + * Signable Reject Primary Sale. This endpoint is experimental and may change in the future. + * @summary Signable Reject Primary Sale * @param {PrimarySalesApiSignableRejectPrimarySaleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError}