@cobo/cobo-waas2 1.12.0 → 1.13.0

package/dist/model/SwapTokenPair.js

@@ -1,100 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
-function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
-function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
-function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
-function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
-function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
-function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
- * Cobo Wallet as a Service 2.0
- *
- * Contact: help@cobo.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- *
- */
-/**
- * The SwapTokenPair model module.
- * @module model/SwapTokenPair
- */
-var SwapTokenPair = /*#__PURE__*/function () {
-  /**
-   * Constructs a new <code>SwapTokenPair</code>.
-   * @alias module:model/SwapTokenPair
-   */
-  function SwapTokenPair() {
-    _classCallCheck(this, SwapTokenPair);
-    SwapTokenPair.initialize(this);
-  }
-
-  /**
-   * Initializes the fields of this object.
-   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
-   * Only for internal use.
-   */
-  return _createClass(SwapTokenPair, null, [{
-    key: "initialize",
-    value: function initialize(obj) {}
-
-    /**
-     * Constructs a <code>SwapTokenPair</code> from a plain JavaScript object, optionally creating a new instance.
-     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
-     * @param {Object} data The plain JavaScript object bearing properties of interest.
-     * @param {module:model/SwapTokenPair} obj Optional instance to populate.
-     * @return {module:model/SwapTokenPair} The populated <code>SwapTokenPair</code> instance.
-     */
-  }, {
-    key: "constructFromObject",
-    value: function constructFromObject(data, obj) {
-      if (data) {
-        obj = obj || new SwapTokenPair();
-        if (data.hasOwnProperty('pay_token_id')) {
-          obj['pay_token_id'] = _ApiClient["default"].convertToType(data['pay_token_id'], 'String');
-        }
-        if (data.hasOwnProperty('receive_token_id')) {
-          obj['receive_token_id'] = _ApiClient["default"].convertToType(data['receive_token_id'], 'String');
-        }
-      }
-      return obj;
-    }
-
-    /**
-     * Validates the JSON data with respect to <code>SwapTokenPair</code>.
-     * @param {Object} data The plain JavaScript object bearing properties of interest.
-     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>SwapTokenPair</code>.
-     */
-  }, {
-    key: "validateJSON",
-    value: function validateJSON(data) {
-      // ensure the json data is a string
-      if (data['pay_token_id'] && !(typeof data['pay_token_id'] === 'string' || data['pay_token_id'] instanceof String)) {
-        throw new Error("Expected the field `pay_token_id` to be a primitive type in the JSON string but got " + data['pay_token_id']);
-      }
-      // ensure the json data is a string
-      if (data['receive_token_id'] && !(typeof data['receive_token_id'] === 'string' || data['receive_token_id'] instanceof String)) {
-        throw new Error("Expected the field `receive_token_id` to be a primitive type in the JSON string but got " + data['receive_token_id']);
-      }
-      return true;
-    }
-  }]);
-}();
-/**
- * The source token symbol.
- * @member {String} pay_token_id
- */
-SwapTokenPair.prototype['pay_token_id'] = undefined;
-
-/**
- * The target token symbol.
- * @member {String} receive_token_id
- */
-SwapTokenPair.prototype['receive_token_id'] = undefined;
-var _default = exports["default"] = SwapTokenPair;

package/docs/CreateSwapActivityRequest.md

@@ -1,12 +0,0 @@
-# CoboWaas2.CreateSwapActivityRequest
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**wallet_id** | **String** | The unique identifier of the wallet. | 
-**quote_id** | **String** | The unique identifier of the quote. | 
-**slippage_tolerance** | **String** | The slippage tolerance for the swap. | 
-**app_initiator** | **String** | The initiator of the app activity. If you do not specify this property, the WaaS service will automatically designate the API key as the initiator. | [optional] 
-
-

package/docs/CreateSwapQuote201Response.md

@@ -1,17 +0,0 @@
-# CoboWaas2.CreateSwapQuote201Response
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pay_amount** | **String** | The amount of tokens to pay. | 
-**receive_amount** | **String** | The amount of tokens to receive. | 
-**fee_amount** | **String** | The amount of tokens to pay for fee. | 
-**min_pay_amount** | **String** | The minimum amount of tokens to pay. | [optional] 
-**max_pay_amount** | **String** | The maximum amount of tokens to pay. | [optional] 
-**min_receive_amount** | **String** | The minimum amount of tokens to receive. | [optional] 
-**max_receive_amount** | **String** | The maximum amount of tokens to receive. | [optional] 
-**quote_expired_timestamp** | **Number** | The time when the quote will expire, in Unix timestamp format, measured in milliseconds. | 
-**quote_id** | **String** | The unique identifier of this quote. | 
-
-

package/docs/CreateSwapQuoteRequest.md

@@ -1,13 +0,0 @@
-# CoboWaas2.CreateSwapQuoteRequest
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**wallet_id** | **String** | The unique identifier of the wallet. | 
-**pay_token_id** | **String** | Unique id of the token to pay. | 
-**receive_token_id** | **String** | Unique id of the token to receive. | 
-**pay_amount** | **String** | Amount of tokens to pay. For example \"0.5 BTC\". Note: Either pay_amount or receive_amount must be provided, but not both.  | [optional] 
-**receive_amount** | **String** | Amount of tokens to receive. For example \"0.5 ETH_WBTC\". Note: Either pay_amount or receive_amount must be provided, but not both.  | [optional] 
-
-

package/docs/ListEnableTokenPairs200Response.md

@@ -1,10 +0,0 @@
-# CoboWaas2.ListEnableTokenPairs200Response
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**[SwapTokenPair]**](SwapTokenPair.md) |  | [optional] 
-**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
-
-

package/docs/ListSwapActivities200Response.md

@@ -1,10 +0,0 @@
-# CoboWaas2.ListSwapActivities200Response
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**[SwapActivity]**](SwapActivity.md) |  | [optional] 
-**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
-
-

package/docs/SwapTokenPair.md

@@ -1,10 +0,0 @@
-# CoboWaas2.SwapTokenPair
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pay_token_id** | **String** | The source token symbol. | [optional] 
-**receive_token_id** | **String** | The target token symbol. | [optional] 
-
-

package/docs/SwapsApi.md

@@ -1,348 +0,0 @@
-# CoboWaas2.SwapsApi
-
-All URIs are relative to *https://api.dev.cobo.com/v2*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**createSwapActivity**](SwapsApi.md#createSwapActivity) | **POST** /swaps/swap | Create Swap Activity
-[**createSwapQuote**](SwapsApi.md#createSwapQuote) | **POST** /swaps/quote | Create Swap Quote
-[**getSwapActivity**](SwapsApi.md#getSwapActivity) | **GET** /swaps/activities/{activity_id} | Get Swap Activity Details
-[**getSwapQuote**](SwapsApi.md#getSwapQuote) | **GET** /swaps/quote | Get Current Swap Rate
-[**listEnableTokenPairs**](SwapsApi.md#listEnableTokenPairs) | **GET** /swaps/enabled_pairs | List Supported Token Pairs
-[**listSwapActivities**](SwapsApi.md#listSwapActivities) | **GET** /swaps/activities | List Swap Activities
-
-
-
-## createSwapActivity
-
-> SwapActivity createSwapActivity(CreateSwapActivityRequest)
-
-Create Swap Activity
-
-This operation to create a swap activity. 
-
-### Example
-
-```javascript
-const CoboWaas2 = require('@cobo/cobo-waas2');
-// Initialize the API client
-const apiClient = CoboWaas2.ApiClient.instance
-// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
-apiClient.setEnv(CoboWaas2.Env.DEV);
-// Replace `<YOUR_PRIVATE_KEY>` with your private key
-apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
-// Call the API
-const apiInstance = new CoboWaas2.SwapsApi();
-const CreateSwapActivityRequest = new CoboWaas2.CreateSwapActivityRequest();
-apiInstance.createSwapActivity(CreateSwapActivityRequest).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **CreateSwapActivityRequest** | [**CreateSwapActivityRequest**](CreateSwapActivityRequest.md)| The request body for creating a swap activity. | 
-
-### Return type
-
-[**SwapActivity**](SwapActivity.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## createSwapQuote
-
-> CreateSwapQuote201Response createSwapQuote(CreateSwapQuoteRequest)
-
-Create Swap Quote
-
-This operation retrieves a quote for swapping between two tokens. Either pay_amount or receive_amount must be provided. 
-
-### Example
-
-```javascript
-const CoboWaas2 = require('@cobo/cobo-waas2');
-// Initialize the API client
-const apiClient = CoboWaas2.ApiClient.instance
-// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
-apiClient.setEnv(CoboWaas2.Env.DEV);
-// Replace `<YOUR_PRIVATE_KEY>` with your private key
-apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
-// Call the API
-const apiInstance = new CoboWaas2.SwapsApi();
-const CreateSwapQuoteRequest = new CoboWaas2.CreateSwapQuoteRequest();
-apiInstance.createSwapQuote(CreateSwapQuoteRequest).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **CreateSwapQuoteRequest** | [**CreateSwapQuoteRequest**](CreateSwapQuoteRequest.md)| The request body for creating a swap activity. | 
-
-### Return type
-
-[**CreateSwapQuote201Response**](CreateSwapQuote201Response.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## getSwapActivity
-
-> SwapActivity getSwapActivity(activity_id)
-
-Get Swap Activity Details
-
-This operation retrieves the details of a swap activity. 
-
-### Example
-
-```javascript
-const CoboWaas2 = require('@cobo/cobo-waas2');
-// Initialize the API client
-const apiClient = CoboWaas2.ApiClient.instance
-// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
-apiClient.setEnv(CoboWaas2.Env.DEV);
-// Replace `<YOUR_PRIVATE_KEY>` with your private key
-apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
-// Call the API
-const apiInstance = new CoboWaas2.SwapsApi();
-const activity_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
-apiInstance.getSwapActivity(activity_id).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **activity_id** | **String**| The unique id of the activity. | 
-
-### Return type
-
-[**SwapActivity**](SwapActivity.md)
-
-### Authorization
-
-[CoboAuth](../README.md#CoboAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getSwapQuote
-
-> SwapQuote getSwapQuote(wallet_id, pay_token_id, receive_token_id, opts)
-
-Get Current Swap Rate
-
-This operation retrieves the current market exchange rate and estimated amount for swapping between two tokens. Either pay_amount or receive_amount must be provided. 
-
-### Example
-
-```javascript
-const CoboWaas2 = require('@cobo/cobo-waas2');
-// Initialize the API client
-const apiClient = CoboWaas2.ApiClient.instance
-// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
-apiClient.setEnv(CoboWaas2.Env.DEV);
-// Replace `<YOUR_PRIVATE_KEY>` with your private key
-apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
-// Call the API
-const apiInstance = new CoboWaas2.SwapsApi();
-const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
-const pay_token_id = "ETH";
-const receive_token_id = "USDT";
-const opts = {
-  'pay_amount': "1.5",
-  'receive_amount': "2000"
-};
-apiInstance.getSwapQuote(wallet_id, pay_token_id, receive_token_id, opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **wallet_id** | **String**| The wallet ID. | 
- **pay_token_id** | **String**| Unique id of the token to pay. | 
- **receive_token_id** | **String**| Unique id of the token to receive. | 
- **pay_amount** | **String**| The amount of pay token to swap. | [optional] 
- **receive_amount** | **String**| The amount of token to receive. | [optional] 
-
-### Return type
-
-[**SwapQuote**](SwapQuote.md)
-
-### Authorization
-
-[CoboAuth](../README.md#CoboAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## listEnableTokenPairs
-
-> ListEnableTokenPairs200Response listEnableTokenPairs(opts)
-
-List Supported Token Pairs
-
-This operation retrieves all supported token pairs for swaps in a specified wallet. 
-
-### Example
-
-```javascript
-const CoboWaas2 = require('@cobo/cobo-waas2');
-// Initialize the API client
-const apiClient = CoboWaas2.ApiClient.instance
-// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
-apiClient.setEnv(CoboWaas2.Env.DEV);
-// Replace `<YOUR_PRIVATE_KEY>` with your private key
-apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
-// Call the API
-const apiInstance = new CoboWaas2.SwapsApi();
-const opts = {
-  'limit': 10,
-  'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
-  'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
-};
-apiInstance.listEnableTokenPairs(opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
- **before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset.    Suppose the current data is ordered as Object A, Object B, and Object C.  If you set &#x60;before&#x60; to the ID of Object C (&#x60;RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk&#x60;), the response will include Object B and Object A.    **Notes**:   - If you set both &#x60;after&#x60; and &#x60;before&#x60;, an error will occur. - If you leave both &#x60;before&#x60; and &#x60;after&#x60; empty, the first page of data is returned. - If you set it to &#x60;infinity&#x60;, the last page of data is returned.  | [optional] 
- **after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset.    Suppose the current data is ordered as Object A, Object B, and Object C. If you set &#x60;after&#x60; to the ID of Object A (&#x60;RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk&#x60;), the response will include Object B and Object C.    **Notes**:   - If you set both &#x60;after&#x60; and &#x60;before&#x60;, an error will occur. - If you leave both &#x60;before&#x60; and &#x60;after&#x60; empty, the first page of data is returned.  | [optional] 
-
-### Return type
-
-[**ListEnableTokenPairs200Response**](ListEnableTokenPairs200Response.md)
-
-### Authorization
-
-[CoboAuth](../README.md#CoboAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## listSwapActivities
-
-> ListSwapActivities200Response listSwapActivities(opts)
-
-List Swap Activities
-
-This operation retrieves a list of swap activities. 
-
-### Example
-
-```javascript
-const CoboWaas2 = require('@cobo/cobo-waas2');
-// Initialize the API client
-const apiClient = CoboWaas2.ApiClient.instance
-// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
-apiClient.setEnv(CoboWaas2.Env.DEV);
-// Replace `<YOUR_PRIVATE_KEY>` with your private key
-apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
-// Call the API
-const apiInstance = new CoboWaas2.SwapsApi();
-const opts = {
-  'status': "Success",
-  'min_updated_timestamp': 1635744000000,
-  'max_updated_timestamp': 1635744000000,
-  'initiator': "steve@example.com",
-  'limit': 10,
-  'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
-  'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
-  'sort_by': "timestamp",
-  'direction': "ASC"
-};
-apiInstance.listSwapActivities(opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **status** | **String**|  | [optional] 
- **min_updated_timestamp** | **Number**| The start time of the query. All staking activities updated after the specified time will be retrieved. The time is in Unix timestamp format, measured in milliseconds. | [optional] 
- **max_updated_timestamp** | **Number**| The end time of the query. All staking activities updated before the specified time will be retrieved. The time is in Unix timestamp format, measured in milliseconds. | [optional] 
- **initiator** | **String**| The activity initiator, which is your API key by default. You can also specify the initiator when creating the activity. | [optional] 
- **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
- **before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset.    Suppose the current data is ordered as Object A, Object B, and Object C.  If you set &#x60;before&#x60; to the ID of Object C (&#x60;RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk&#x60;), the response will include Object B and Object A.    **Notes**:   - If you set both &#x60;after&#x60; and &#x60;before&#x60;, an error will occur. - If you leave both &#x60;before&#x60; and &#x60;after&#x60; empty, the first page of data is returned. - If you set it to &#x60;infinity&#x60;, the last page of data is returned.  | [optional] 
- **after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset.    Suppose the current data is ordered as Object A, Object B, and Object C. If you set &#x60;after&#x60; to the ID of Object A (&#x60;RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk&#x60;), the response will include Object B and Object C.    **Notes**:   - If you set both &#x60;after&#x60; and &#x60;before&#x60;, an error will occur. - If you leave both &#x60;before&#x60; and &#x60;after&#x60; empty, the first page of data is returned.  | [optional] 
- **sort_by** | **String**| The field used for sorting. | [optional] [default to &#39;&#39;]
- **direction** | **String**| The sort direction. Possible values include:   - &#x60;ASC&#x60;: Sort the results in ascending order.   - &#x60;DESC&#x60;: Sort the results in descending order.  | [optional] [default to &#39;&#39;]
-
-### Return type
-
-[**ListSwapActivities200Response**](ListSwapActivities200Response.md)
-
-### Authorization
-
-[CoboAuth](../README.md#CoboAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-