Auto-generate wrapper from updated spec

Author: actions-user

README.md

@@ -132,6 +132,7 @@ Class | Method | HTTP request | Description
 *BuiltByBitApi.AnalyticsApi* | [**getV2Analytics**](docs/AnalyticsApi.md#getV2Analytics) | **GET** /v2/analytics | Fetch a list of analytics definitions
 *BuiltByBitApi.AnalyticsApi* | [**getV2AnalyticsGraph**](docs/AnalyticsApi.md#getV2AnalyticsGraph) | **GET** /v2/analytics/graph | Fetch analytics graph data
 *BuiltByBitApi.AnalyticsApi* | [**getV2AnalyticsSingle**](docs/AnalyticsApi.md#getV2AnalyticsSingle) | **GET** /v2/analytics/single | Fetch a single analytics value
+*BuiltByBitApi.DeploymentsApi* | [**postV2DeploymentsUpgrade**](docs/DeploymentsApi.md#postV2DeploymentsUpgrade) | **POST** /v2/deployments/upgrade | Upgrade a short-lived token
 *BuiltByBitApi.EventsApi* | [**getV2Events**](docs/EventsApi.md#getV2Events) | **GET** /v2/events | Fetch a list of pending events
 *BuiltByBitApi.EventsApi* | [**postV2EventsComplete**](docs/EventsApi.md#postV2EventsComplete) | **POST** /v2/events/complete | Mark events as complete
 *BuiltByBitApi.HealthApi* | [**getV2Health**](docs/HealthApi.md#getV2Health) | **GET** /v2/health | Retrieve a health status
@@ -248,6 +249,10 @@ Class | Method | HTTP request | Description
  - [BuiltByBitApi.License](docs/License.md)
  - [BuiltByBitApi.ListStats](docs/ListStats.md)
  - [BuiltByBitApi.Member](docs/Member.md)
+ - [BuiltByBitApi.PostV2DeploymentsUpgrade200Response](docs/PostV2DeploymentsUpgrade200Response.md)
+ - [BuiltByBitApi.PostV2DeploymentsUpgrade200ResponseData](docs/PostV2DeploymentsUpgrade200ResponseData.md)
+ - [BuiltByBitApi.PostV2DeploymentsUpgrade200ResponseDataPreauthorize](docs/PostV2DeploymentsUpgrade200ResponseDataPreauthorize.md)
+ - [BuiltByBitApi.PostV2DeploymentsUpgradeRequest](docs/PostV2DeploymentsUpgradeRequest.md)
  - [BuiltByBitApi.PostV2EventsComplete200Response](docs/PostV2EventsComplete200Response.md)
  - [BuiltByBitApi.PostV2EventsCompleteRequest](docs/PostV2EventsCompleteRequest.md)
  - [BuiltByBitApi.PostV2ResourcesCreatorBatch200Response](docs/PostV2ResourcesCreatorBatch200Response.md)

docs/DeploymentsApi.md

@@ -0,0 +1,62 @@
+# BuiltByBitApi.DeploymentsApi
+
+All URIs are relative to *https://api.builtbybit.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**postV2DeploymentsUpgrade**](DeploymentsApi.md#postV2DeploymentsUpgrade) | **POST** /v2/deployments/upgrade | Upgrade a short-lived token
+
+
+
+## postV2DeploymentsUpgrade
+
+> PostV2DeploymentsUpgrade200Response postV2DeploymentsUpgrade(opts)
+
+Upgrade a short-lived token
+
+
+
+### Example
+
+```javascript
+import BuiltByBitApi from 'built_by_bit_api';
+let defaultClient = BuiltByBitApi.ApiClient.instance;
+// Configure API key authorization: token
+let token = defaultClient.authentications['token'];
+token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//token.apiKeyPrefix = 'Token';
+
+let apiInstance = new BuiltByBitApi.DeploymentsApi();
+let opts = {
+  'postV2DeploymentsUpgradeRequest': new BuiltByBitApi.PostV2DeploymentsUpgradeRequest() // PostV2DeploymentsUpgradeRequest | 
+};
+apiInstance.postV2DeploymentsUpgrade(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **postV2DeploymentsUpgradeRequest** | [**PostV2DeploymentsUpgradeRequest**](PostV2DeploymentsUpgradeRequest.md)|  | [optional] 
+
+### Return type
+
+[**PostV2DeploymentsUpgrade200Response**](PostV2DeploymentsUpgrade200Response.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

docs/PostV2DeploymentsUpgrade200Response.md

@@ -0,0 +1,19 @@
+# BuiltByBitApi.PostV2DeploymentsUpgrade200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result** | **String** |  | [optional] 
+**data** | [**PostV2DeploymentsUpgrade200ResponseData**](PostV2DeploymentsUpgrade200ResponseData.md) |  | [optional] 
+
+
+
+## Enum: ResultEnum
+
+
+* `success` (value: `"success"`)
+
+
+
+

docs/PostV2DeploymentsUpgrade200ResponseData.md

@@ -0,0 +1,12 @@
+# BuiltByBitApi.PostV2DeploymentsUpgrade200ResponseData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **String** |  | [optional] 
+**oauth2Client** | **String** |  | [optional] 
+**oauth2Secret** | **String** |  | [optional] 
+**preauthorize** | [**PostV2DeploymentsUpgrade200ResponseDataPreauthorize**](PostV2DeploymentsUpgrade200ResponseDataPreauthorize.md) |  | [optional] 
+
+

docs/PostV2DeploymentsUpgrade200ResponseDataPreauthorize.md

@@ -0,0 +1,13 @@
+# BuiltByBitApi.PostV2DeploymentsUpgrade200ResponseDataPreauthorize
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accessToken** | **String** |  | [optional] 
+**expiresIn** | **Number** |  | [optional] 
+**refreshToken** | **String** |  | [optional] 
+**scope** | **String** |  | [optional] 
+**tokenType** | **String** |  | [optional] 
+
+

docs/PostV2DeploymentsUpgradeRequest.md

@@ -0,0 +1,10 @@
+# BuiltByBitApi.PostV2DeploymentsUpgradeRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**preauthorize** | **Boolean** | Whether or not to pre-authorize OAuth2 credentials for the deployment token owner. | [optional] [default to false]
+**scopes** | **String** | A space-separated list of scopes to request if pre-authorizing. | [optional] 
+
+

src/api/DeploymentsApi.js

@@ -0,0 +1,79 @@
+/**
+ * BuiltByBit API
+ * All operations not tagged 'free' require an active [Ultimate](https://builtbybit.com/account/ultimate) subscription or invite-only permissions.    V2 documentation: https://builtbybit.com/wiki/api-v2/ \\  OAuth2 documentation: https://builtbybit.com/wiki/oauth2/
+ *
+ * The version of the OpenAPI document: v2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+
+
+import ApiClient from "../ApiClient";
+import PostV2DeploymentsUpgrade200Response from '../model/PostV2DeploymentsUpgrade200Response';
+import PostV2DeploymentsUpgradeRequest from '../model/PostV2DeploymentsUpgradeRequest';
+
+/**
+* Deployments service.
+* @module api/DeploymentsApi
+* @version v2
+*/
+export default class DeploymentsApi {
+
+    /**
+    * Constructs a new DeploymentsApi. 
+    * @alias module:api/DeploymentsApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient) {
+        this.apiClient = apiClient || ApiClient.instance;
+    }
+
+
+    /**
+     * Callback function to receive the result of the postV2DeploymentsUpgrade operation.
+     * @callback module:api/DeploymentsApi~postV2DeploymentsUpgradeCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/PostV2DeploymentsUpgrade200Response} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Upgrade a short-lived token
+     * 
+     * @param {Object} opts Optional parameters
+     * @param {module:model/PostV2DeploymentsUpgradeRequest} [postV2DeploymentsUpgradeRequest] 
+     * @param {module:api/DeploymentsApi~postV2DeploymentsUpgradeCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/PostV2DeploymentsUpgrade200Response}
+     */
+    postV2DeploymentsUpgrade(opts, callback) {
+      opts = opts || {};
+      let postBody = opts['postV2DeploymentsUpgradeRequest'];
+
+      let pathParams = {
+      };
+      let queryParams = {
+      };
+      let headerParams = {
+      };
+      let formParams = {
+      };
+
+      let authNames = ['token'];
+      let contentTypes = ['application/json'];
+      let accepts = ['application/json'];
+      let returnType = PostV2DeploymentsUpgrade200Response;
+      return this.apiClient.callApi(
+        '/v2/deployments/upgrade', 'POST',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null, callback
+      );
+    }
+
+
+}

src/index.js

@@ -87,6 +87,10 @@ import GetV2ResourcesDiscoverLicenses200ResponseData from './model/GetV2Resource
 import License from './model/License';
 import ListStats from './model/ListStats';
 import Member from './model/Member';
+import PostV2DeploymentsUpgrade200Response from './model/PostV2DeploymentsUpgrade200Response';
+import PostV2DeploymentsUpgrade200ResponseData from './model/PostV2DeploymentsUpgrade200ResponseData';
+import PostV2DeploymentsUpgrade200ResponseDataPreauthorize from './model/PostV2DeploymentsUpgrade200ResponseDataPreauthorize';
+import PostV2DeploymentsUpgradeRequest from './model/PostV2DeploymentsUpgradeRequest';
 import PostV2EventsComplete200Response from './model/PostV2EventsComplete200Response';
 import PostV2EventsCompleteRequest from './model/PostV2EventsCompleteRequest';
 import PostV2ResourcesCreatorBatch200Response from './model/PostV2ResourcesCreatorBatch200Response';
@@ -122,6 +126,7 @@ import Store from './model/Store';
 import Update from './model/Update';
 import Version from './model/Version';
 import AnalyticsApi from './api/AnalyticsApi';
+import DeploymentsApi from './api/DeploymentsApi';
 import EventsApi from './api/EventsApi';
 import HealthApi from './api/HealthApi';
 import Oauth2Api from './api/Oauth2Api';
@@ -615,6 +620,30 @@ export {
      */
     Member,
 
+    /**
+     * The PostV2DeploymentsUpgrade200Response model constructor.
+     * @property {module:model/PostV2DeploymentsUpgrade200Response}
+     */
+    PostV2DeploymentsUpgrade200Response,
+
+    /**
+     * The PostV2DeploymentsUpgrade200ResponseData model constructor.
+     * @property {module:model/PostV2DeploymentsUpgrade200ResponseData}
+     */
+    PostV2DeploymentsUpgrade200ResponseData,
+
+    /**
+     * The PostV2DeploymentsUpgrade200ResponseDataPreauthorize model constructor.
+     * @property {module:model/PostV2DeploymentsUpgrade200ResponseDataPreauthorize}
+     */
+    PostV2DeploymentsUpgrade200ResponseDataPreauthorize,
+
+    /**
+     * The PostV2DeploymentsUpgradeRequest model constructor.
+     * @property {module:model/PostV2DeploymentsUpgradeRequest}
+     */
+    PostV2DeploymentsUpgradeRequest,
+
     /**
      * The PostV2EventsComplete200Response model constructor.
      * @property {module:model/PostV2EventsComplete200Response}
@@ -825,6 +854,12 @@ export {
     */
     AnalyticsApi,
 
+    /**
+    * The DeploymentsApi service constructor.
+    * @property {module:api/DeploymentsApi}
+    */
+    DeploymentsApi,
+
     /**
     * The EventsApi service constructor.
     * @property {module:api/EventsApi}

src/model/PostV2DeploymentsUpgrade200Response.js

@@ -0,0 +1,115 @@
+/**
+ * BuiltByBit API
+ * All operations not tagged 'free' require an active [Ultimate](https://builtbybit.com/account/ultimate) subscription or invite-only permissions.    V2 documentation: https://builtbybit.com/wiki/api-v2/ \\  OAuth2 documentation: https://builtbybit.com/wiki/oauth2/
+ *
+ * The version of the OpenAPI document: v2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+
+import ApiClient from '../ApiClient';
+import PostV2DeploymentsUpgrade200ResponseData from './PostV2DeploymentsUpgrade200ResponseData';
+
+/**
+ * The PostV2DeploymentsUpgrade200Response model module.
+ * @module model/PostV2DeploymentsUpgrade200Response
+ * @version v2
+ */
+class PostV2DeploymentsUpgrade200Response {
+    /**
+     * Constructs a new <code>PostV2DeploymentsUpgrade200Response</code>.
+     * @alias module:model/PostV2DeploymentsUpgrade200Response
+     */
+    constructor() { 
+        
+        PostV2DeploymentsUpgrade200Response.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.
+     */
+    static initialize(obj) { 
+    }
+
+    /**
+     * Constructs a <code>PostV2DeploymentsUpgrade200Response</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/PostV2DeploymentsUpgrade200Response} obj Optional instance to populate.
+     * @return {module:model/PostV2DeploymentsUpgrade200Response} The populated <code>PostV2DeploymentsUpgrade200Response</code> instance.
+     */
+    static constructFromObject(data, obj) {
+        if (data) {
+            obj = obj || new PostV2DeploymentsUpgrade200Response();
+
+            if (data.hasOwnProperty('result')) {
+                obj['result'] = ApiClient.convertToType(data['result'], 'String');
+            }
+            if (data.hasOwnProperty('data')) {
+                obj['data'] = PostV2DeploymentsUpgrade200ResponseData.constructFromObject(data['data']);
+            }
+        }
+        return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>PostV2DeploymentsUpgrade200Response</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>PostV2DeploymentsUpgrade200Response</code>.
+     */
+    static validateJSON(data) {
+        // ensure the json data is a string
+        if (data['result'] && !(typeof data['result'] === 'string' || data['result'] instanceof String)) {
+            throw new Error("Expected the field `result` to be a primitive type in the JSON string but got " + data['result']);
+        }
+        // validate the optional field `data`
+        if (data['data']) { // data not null
+          PostV2DeploymentsUpgrade200ResponseData.validateJSON(data['data']);
+        }
+
+        return true;
+    }
+
+
+}
+
+
+
+/**
+ * @member {module:model/PostV2DeploymentsUpgrade200Response.ResultEnum} result
+ */
+PostV2DeploymentsUpgrade200Response.prototype['result'] = undefined;
+
+/**
+ * @member {module:model/PostV2DeploymentsUpgrade200ResponseData} data
+ */
+PostV2DeploymentsUpgrade200Response.prototype['data'] = undefined;
+
+
+
+
+
+/**
+ * Allowed values for the <code>result</code> property.
+ * @enum {String}
+ * @readonly
+ */
+PostV2DeploymentsUpgrade200Response['ResultEnum'] = {
+
+    /**
+     * value: "success"
+     * @const
+     */
+    "success": "success"
+};
+
+
+
+export default PostV2DeploymentsUpgrade200Response;
+