yellowgrid-api-ts 3.2.93 → 3.2.94

package/README.md

@@ -125,6 +125,7 @@ Class | Method | HTTP request | Description
 *Class3CXInstallationsApi* | [**postTestLoginCredentials**](docs/Class3CXInstallationsApi.md#posttestlogincredentials) | **POST** /tcx/installations/{instance_id}/tests/login | Test 3CX Login Credentials
 *Class3CXInstallationsApi* | [**postUnsuspendInstance**](docs/Class3CXInstallationsApi.md#postunsuspendinstance) | **POST** /tcx/installations/{instance_id}/unsuspend | Unsuspend 3CX Instance
 *Class3CXInstallationsApi* | [**postUpgradeDebian**](docs/Class3CXInstallationsApi.md#postupgradedebian) | **POST** /tcx/installations/{instance_id}/debian/upgrade | Install OS update on 3CX Instance
+*Class3CXInstallationsApi* | [**putGetDetails**](docs/Class3CXInstallationsApi.md#putgetdetails) | **PUT** /tcx/installations/{wizard_id}/details | Update 3CX Installation Details
 *Class3CXIntegrationsApi* | [**getGetPrice**](docs/Class3CXIntegrationsApi.md#getgetprice) | **GET** /tcx/integrations/edtechpro/prices | 
 *Class3CXIntegrationsApi* | [**getGetSchools**](docs/Class3CXIntegrationsApi.md#getgetschools) | **GET** /tcx/integrations/edtechpro/schools | 
 *Class3CXIntegrationsApi* | [**getGetTrusts**](docs/Class3CXIntegrationsApi.md#getgettrusts) | **GET** /tcx/integrations/edtechpro/trusts | 

package/api.ts

@@ -12563,6 +12563,43 @@ export const Class3CXInstallationsApiAxiosParamCreator = function (configuration
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Update 3CX Installation Details
+         * @summary Update 3CX Installation Details
+         * @param {number} wizardId Wizard ID
+         * @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putGetDetails: async (wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'wizardId' is not null or undefined
+            assertParamExists('putGetDetails', 'wizardId', wizardId)
+            const localVarPath = `/tcx/installations/{wizard_id}/details`
+                .replace(`{${"wizard_id"}}`, encodeURIComponent(String(wizardId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(installationDetailsDTO, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -12831,6 +12868,20 @@ export const Class3CXInstallationsApiFp = function(configuration?: Configuration
             const localVarOperationServerBasePath = operationServerMap['Class3CXInstallationsApi.postUpgradeDebian']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Update 3CX Installation Details
+         * @summary Update 3CX Installation Details
+         * @param {number} wizardId Wizard ID
+         * @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async putGetDetails(wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InstallationDetailsDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.putGetDetails(wizardId, installationDetailsDTO, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['Class3CXInstallationsApi.putGetDetails']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -13040,6 +13091,17 @@ export const Class3CXInstallationsApiFactory = function (configuration?: Configu
         postUpgradeDebian(instanceId: string, schedule: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
             return localVarFp.postUpgradeDebian(instanceId, schedule, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Update 3CX Installation Details
+         * @summary Update 3CX Installation Details
+         * @param {number} wizardId Wizard ID
+         * @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putGetDetails(wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options?: RawAxiosRequestConfig): AxiosPromise<InstallationDetailsDTO> {
+            return localVarFp.putGetDetails(wizardId, installationDetailsDTO, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -13264,6 +13326,18 @@ export class Class3CXInstallationsApi extends BaseAPI {
     public postUpgradeDebian(instanceId: string, schedule: string, options?: RawAxiosRequestConfig) {
         return Class3CXInstallationsApiFp(this.configuration).postUpgradeDebian(instanceId, schedule, options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * Update 3CX Installation Details
+     * @summary Update 3CX Installation Details
+     * @param {number} wizardId Wizard ID
+     * @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public putGetDetails(wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options?: RawAxiosRequestConfig) {
+        return Class3CXInstallationsApiFp(this.configuration).putGetDetails(wizardId, installationDetailsDTO, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 
 export const GetGetInstallationsStatusEnum = {

package/dist/api.d.ts

@@ -9811,6 +9811,15 @@ export declare const Class3CXInstallationsApiAxiosParamCreator: (configuration?:
      * @throws {RequiredError}
      */
     postUpgradeDebian: (instanceId: string, schedule: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update 3CX Installation Details
+     * @summary Update 3CX Installation Details
+     * @param {number} wizardId Wizard ID
+     * @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putGetDetails: (wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * Class3CXInstallationsApi - functional programming interface
@@ -9980,6 +9989,15 @@ export declare const Class3CXInstallationsApiFp: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     postUpgradeDebian(instanceId: string, schedule: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Update 3CX Installation Details
+     * @summary Update 3CX Installation Details
+     * @param {number} wizardId Wizard ID
+     * @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putGetDetails(wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InstallationDetailsDTO>>;
 };
 /**
  * Class3CXInstallationsApi - factory interface
@@ -10149,6 +10167,15 @@ export declare const Class3CXInstallationsApiFactory: (configuration?: Configura
      * @throws {RequiredError}
      */
     postUpgradeDebian(instanceId: string, schedule: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Update 3CX Installation Details
+     * @summary Update 3CX Installation Details
+     * @param {number} wizardId Wizard ID
+     * @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putGetDetails(wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options?: RawAxiosRequestConfig): AxiosPromise<InstallationDetailsDTO>;
 };
 /**
  * Class3CXInstallationsApi - object-oriented interface
@@ -10318,6 +10345,15 @@ export declare class Class3CXInstallationsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     postUpgradeDebian(instanceId: string, schedule: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Update 3CX Installation Details
+     * @summary Update 3CX Installation Details
+     * @param {number} wizardId Wizard ID
+     * @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putGetDetails(wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InstallationDetailsDTO, any, {}>>;
 }
 export declare const GetGetInstallationsStatusEnum: {
     readonly Completed: "Completed";

package/dist/api.js

@@ -5953,6 +5953,47 @@ var Class3CXInstallationsApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Update 3CX Installation Details
+         * @summary Update 3CX Installation Details
+         * @param {number} wizardId Wizard ID
+         * @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putGetDetails: function (wizardId_1, installationDetailsDTO_1) {
+            var args_1 = [];
+            for (var _i = 2; _i < arguments.length; _i++) {
+                args_1[_i - 2] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([wizardId_1, installationDetailsDTO_1], args_1, true), void 0, function (wizardId, installationDetailsDTO, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    // verify required parameter 'wizardId' is not null or undefined
+                    (0, common_1.assertParamExists)('putGetDetails', 'wizardId', wizardId);
+                    localVarPath = "/tcx/installations/{wizard_id}/details"
+                        .replace("{".concat("wizard_id", "}"), encodeURIComponent(String(wizardId)));
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'PUT' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    localVarHeaderParameter['Content-Type'] = 'application/json';
+                    localVarHeaderParameter['Accept'] = 'application/json';
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                    localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(installationDetailsDTO, localVarRequestOptions, configuration);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
     };
 };
 exports.Class3CXInstallationsApiAxiosParamCreator = Class3CXInstallationsApiAxiosParamCreator;
@@ -6396,6 +6437,30 @@ var Class3CXInstallationsApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Update 3CX Installation Details
+         * @summary Update 3CX Installation Details
+         * @param {number} wizardId Wizard ID
+         * @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putGetDetails: function (wizardId, installationDetailsDTO, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
+                var _a, _b, _c;
+                return __generator(this, function (_d) {
+                    switch (_d.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.putGetDetails(wizardId, installationDetailsDTO, options)];
+                        case 1:
+                            localVarAxiosArgs = _d.sent();
+                            localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                            localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXInstallationsApi.putGetDetails']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                            return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
+                    }
+                });
+            });
+        },
     };
 };
 exports.Class3CXInstallationsApiFp = Class3CXInstallationsApiFp;
@@ -6605,6 +6670,17 @@ var Class3CXInstallationsApiFactory = function (configuration, basePath, axios)
         postUpgradeDebian: function (instanceId, schedule, options) {
             return localVarFp.postUpgradeDebian(instanceId, schedule, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Update 3CX Installation Details
+         * @summary Update 3CX Installation Details
+         * @param {number} wizardId Wizard ID
+         * @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putGetDetails: function (wizardId, installationDetailsDTO, options) {
+            return localVarFp.putGetDetails(wizardId, installationDetailsDTO, options).then(function (request) { return request(axios, basePath); });
+        },
     };
 };
 exports.Class3CXInstallationsApiFactory = Class3CXInstallationsApiFactory;
@@ -6834,6 +6910,18 @@ var Class3CXInstallationsApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.Class3CXInstallationsApiFp)(this.configuration).postUpgradeDebian(instanceId, schedule, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Update 3CX Installation Details
+     * @summary Update 3CX Installation Details
+     * @param {number} wizardId Wizard ID
+     * @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    Class3CXInstallationsApi.prototype.putGetDetails = function (wizardId, installationDetailsDTO, options) {
+        var _this = this;
+        return (0, exports.Class3CXInstallationsApiFp)(this.configuration).putGetDetails(wizardId, installationDetailsDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     return Class3CXInstallationsApi;
 }(base_1.BaseAPI));
 exports.Class3CXInstallationsApi = Class3CXInstallationsApi;

package/docs/Class3CXInstallationsApi.md

@@ -22,6 +22,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**postTestLoginCredentials**](#posttestlogincredentials) | **POST** /tcx/installations/{instance_id}/tests/login | Test 3CX Login Credentials|
 |[**postUnsuspendInstance**](#postunsuspendinstance) | **POST** /tcx/installations/{instance_id}/unsuspend | Unsuspend 3CX Instance|
 |[**postUpgradeDebian**](#postupgradedebian) | **POST** /tcx/installations/{instance_id}/debian/upgrade | Install OS update on 3CX Instance|
+|[**putGetDetails**](#putgetdetails) | **PUT** /tcx/installations/{wizard_id}/details | Update 3CX Installation Details|
 
 # **getGetDetails**
 > InstallationDetailsDTO getGetDetails()
@@ -1052,3 +1053,61 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **putGetDetails**
+> InstallationDetailsDTO putGetDetails()
+
+Update 3CX Installation Details
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationsApi,
+    Configuration,
+    InstallationDetailsDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationsApi(configuration);
+
+let wizardId: number; //Wizard ID (default to undefined)
+let installationDetailsDTO: InstallationDetailsDTO; //Installation Details (optional)
+
+const { status, data } = await apiInstance.putGetDetails(
+    wizardId,
+    installationDetailsDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **installationDetailsDTO** | **InstallationDetailsDTO**| Installation Details | |
+| **wizardId** | [**number**] | Wizard ID | defaults to undefined|
+
+
+### Return type
+
+**InstallationDetailsDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Installation Details |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.93",
+  "version": "3.2.94",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {