yellowgrid-api-ts 3.2.175 → 3.2.176

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -104,6 +104,7 @@ Class | Method | HTTP request | Description
104
104
  *Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
105
105
  *Class3CXApi* | [**getGetTcxCreditStatus**](docs/Class3CXApi.md#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status
106
106
  *Class3CXApi* | [**getGetTcxExpiringKeys**](docs/Class3CXApi.md#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys
107
+ *Class3CXApi* | [**getGetTcxPartners**](docs/Class3CXApi.md#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners
107
108
  *Class3CXApi* | [**postGetBulkLicenceDetails**](docs/Class3CXApi.md#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details
108
109
  *Class3CXInstallationWizardApi* | [**deleteAddExtensions**](docs/Class3CXInstallationWizardApi.md#deleteaddextensions) | **DELETE** /tcx/wizards/extensions | Delete 3CX Installation Wizard Extensions
109
110
  *Class3CXInstallationWizardApi* | [**deleteAddNumbers**](docs/Class3CXInstallationWizardApi.md#deleteaddnumbers) | **DELETE** /tcx/wizards/numbers | Delete 3CX Installation Wizard Numbers
package/api.ts CHANGED
@@ -4372,6 +4372,10 @@ export interface PartnerDTO {
4372
4372
  * Aligned
4373
4373
  */
4374
4374
  'aligned'?: boolean;
4375
+ /**
4376
+ * Customer
4377
+ */
4378
+ 'customer'?: AccountSummaryDTO | null;
4375
4379
  }
4376
4380
  export interface PatchUpdateAccountCnameRequest {
4377
4381
  /**
@@ -12299,6 +12303,36 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
12299
12303
  options: localVarRequestOptions,
12300
12304
  };
12301
12305
  },
12306
+ /**
12307
+ * Get 3CX Partners
12308
+ * @summary Get 3CX Partners
12309
+ * @param {*} [options] Override http request option.
12310
+ * @throws {RequiredError}
12311
+ */
12312
+ getGetTcxPartners: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12313
+ const localVarPath = `/tcx/admin/partners`;
12314
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
12315
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
12316
+ let baseOptions;
12317
+ if (configuration) {
12318
+ baseOptions = configuration.baseOptions;
12319
+ }
12320
+
12321
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
12322
+ const localVarHeaderParameter = {} as any;
12323
+ const localVarQueryParameter = {} as any;
12324
+
12325
+ localVarHeaderParameter['Accept'] = 'application/json';
12326
+
12327
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
12328
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12329
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12330
+
12331
+ return {
12332
+ url: toPathString(localVarUrlObj),
12333
+ options: localVarRequestOptions,
12334
+ };
12335
+ },
12302
12336
  /**
12303
12337
  * Get Bulk 3CX Licence Details
12304
12338
  * @summary Get bulk 3CX Licence Details
@@ -12378,6 +12412,18 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
12378
12412
  const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetTcxExpiringKeys']?.[localVarOperationServerIndex]?.url;
12379
12413
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12380
12414
  },
12415
+ /**
12416
+ * Get 3CX Partners
12417
+ * @summary Get 3CX Partners
12418
+ * @param {*} [options] Override http request option.
12419
+ * @throws {RequiredError}
12420
+ */
12421
+ async getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PartnerDTO>>> {
12422
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getGetTcxPartners(options);
12423
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12424
+ const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetTcxPartners']?.[localVarOperationServerIndex]?.url;
12425
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12426
+ },
12381
12427
  /**
12382
12428
  * Get Bulk 3CX Licence Details
12383
12429
  * @summary Get bulk 3CX Licence Details
@@ -12428,6 +12474,15 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
12428
12474
  getGetTcxExpiringKeys(options?: RawAxiosRequestConfig): AxiosPromise<string> {
12429
12475
  return localVarFp.getGetTcxExpiringKeys(options).then((request) => request(axios, basePath));
12430
12476
  },
12477
+ /**
12478
+ * Get 3CX Partners
12479
+ * @summary Get 3CX Partners
12480
+ * @param {*} [options] Override http request option.
12481
+ * @throws {RequiredError}
12482
+ */
12483
+ getGetTcxPartners(options?: RawAxiosRequestConfig): AxiosPromise<Array<PartnerDTO>> {
12484
+ return localVarFp.getGetTcxPartners(options).then((request) => request(axios, basePath));
12485
+ },
12431
12486
  /**
12432
12487
  * Get Bulk 3CX Licence Details
12433
12488
  * @summary Get bulk 3CX Licence Details
@@ -12476,6 +12531,16 @@ export class Class3CXApi extends BaseAPI {
12476
12531
  return Class3CXApiFp(this.configuration).getGetTcxExpiringKeys(options).then((request) => request(this.axios, this.basePath));
12477
12532
  }
12478
12533
 
12534
+ /**
12535
+ * Get 3CX Partners
12536
+ * @summary Get 3CX Partners
12537
+ * @param {*} [options] Override http request option.
12538
+ * @throws {RequiredError}
12539
+ */
12540
+ public getGetTcxPartners(options?: RawAxiosRequestConfig) {
12541
+ return Class3CXApiFp(this.configuration).getGetTcxPartners(options).then((request) => request(this.axios, this.basePath));
12542
+ }
12543
+
12479
12544
  /**
12480
12545
  * Get Bulk 3CX Licence Details
12481
12546
  * @summary Get bulk 3CX Licence Details
package/dist/api.d.ts CHANGED
@@ -4324,6 +4324,10 @@ export interface PartnerDTO {
4324
4324
  * Aligned
4325
4325
  */
4326
4326
  'aligned'?: boolean;
4327
+ /**
4328
+ * Customer
4329
+ */
4330
+ 'customer'?: AccountSummaryDTO | null;
4327
4331
  }
4328
4332
  export interface PatchUpdateAccountCnameRequest {
4329
4333
  /**
@@ -10227,6 +10231,13 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
10227
10231
  * @throws {RequiredError}
10228
10232
  */
10229
10233
  getGetTcxExpiringKeys: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10234
+ /**
10235
+ * Get 3CX Partners
10236
+ * @summary Get 3CX Partners
10237
+ * @param {*} [options] Override http request option.
10238
+ * @throws {RequiredError}
10239
+ */
10240
+ getGetTcxPartners: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10230
10241
  /**
10231
10242
  * Get Bulk 3CX Licence Details
10232
10243
  * @summary Get bulk 3CX Licence Details
@@ -10262,6 +10273,13 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
10262
10273
  * @throws {RequiredError}
10263
10274
  */
10264
10275
  getGetTcxExpiringKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
10276
+ /**
10277
+ * Get 3CX Partners
10278
+ * @summary Get 3CX Partners
10279
+ * @param {*} [options] Override http request option.
10280
+ * @throws {RequiredError}
10281
+ */
10282
+ getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PartnerDTO>>>;
10265
10283
  /**
10266
10284
  * Get Bulk 3CX Licence Details
10267
10285
  * @summary Get bulk 3CX Licence Details
@@ -10297,6 +10315,13 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
10297
10315
  * @throws {RequiredError}
10298
10316
  */
10299
10317
  getGetTcxExpiringKeys(options?: RawAxiosRequestConfig): AxiosPromise<string>;
10318
+ /**
10319
+ * Get 3CX Partners
10320
+ * @summary Get 3CX Partners
10321
+ * @param {*} [options] Override http request option.
10322
+ * @throws {RequiredError}
10323
+ */
10324
+ getGetTcxPartners(options?: RawAxiosRequestConfig): AxiosPromise<Array<PartnerDTO>>;
10300
10325
  /**
10301
10326
  * Get Bulk 3CX Licence Details
10302
10327
  * @summary Get bulk 3CX Licence Details
@@ -10332,6 +10357,13 @@ export declare class Class3CXApi extends BaseAPI {
10332
10357
  * @throws {RequiredError}
10333
10358
  */
10334
10359
  getGetTcxExpiringKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
10360
+ /**
10361
+ * Get 3CX Partners
10362
+ * @summary Get 3CX Partners
10363
+ * @param {*} [options] Override http request option.
10364
+ * @throws {RequiredError}
10365
+ */
10366
+ getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerDTO[], any, {}>>;
10335
10367
  /**
10336
10368
  * Get Bulk 3CX Licence Details
10337
10369
  * @summary Get bulk 3CX Licence Details
package/dist/api.js CHANGED
@@ -4828,6 +4828,40 @@ var Class3CXApiAxiosParamCreator = function (configuration) {
4828
4828
  });
4829
4829
  });
4830
4830
  },
4831
+ /**
4832
+ * Get 3CX Partners
4833
+ * @summary Get 3CX Partners
4834
+ * @param {*} [options] Override http request option.
4835
+ * @throws {RequiredError}
4836
+ */
4837
+ getGetTcxPartners: function () {
4838
+ var args_1 = [];
4839
+ for (var _i = 0; _i < arguments.length; _i++) {
4840
+ args_1[_i] = arguments[_i];
4841
+ }
4842
+ return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
4843
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
4844
+ if (options === void 0) { options = {}; }
4845
+ return __generator(this, function (_a) {
4846
+ localVarPath = "/tcx/admin/partners";
4847
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
4848
+ if (configuration) {
4849
+ baseOptions = configuration.baseOptions;
4850
+ }
4851
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
4852
+ localVarHeaderParameter = {};
4853
+ localVarQueryParameter = {};
4854
+ localVarHeaderParameter['Accept'] = 'application/json';
4855
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
4856
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4857
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
4858
+ return [2 /*return*/, {
4859
+ url: (0, common_1.toPathString)(localVarUrlObj),
4860
+ options: localVarRequestOptions,
4861
+ }];
4862
+ });
4863
+ });
4864
+ },
4831
4865
  /**
4832
4866
  * Get Bulk 3CX Licence Details
4833
4867
  * @summary Get bulk 3CX Licence Details
@@ -4941,6 +4975,28 @@ var Class3CXApiFp = function (configuration) {
4941
4975
  });
4942
4976
  });
4943
4977
  },
4978
+ /**
4979
+ * Get 3CX Partners
4980
+ * @summary Get 3CX Partners
4981
+ * @param {*} [options] Override http request option.
4982
+ * @throws {RequiredError}
4983
+ */
4984
+ getGetTcxPartners: function (options) {
4985
+ return __awaiter(this, void 0, void 0, function () {
4986
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
4987
+ var _a, _b, _c;
4988
+ return __generator(this, function (_d) {
4989
+ switch (_d.label) {
4990
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetTcxPartners(options)];
4991
+ case 1:
4992
+ localVarAxiosArgs = _d.sent();
4993
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
4994
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXApi.getGetTcxPartners']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
4995
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
4996
+ }
4997
+ });
4998
+ });
4999
+ },
4944
5000
  /**
4945
5001
  * Get Bulk 3CX Licence Details
4946
5002
  * @summary Get bulk 3CX Licence Details
@@ -5001,6 +5057,15 @@ var Class3CXApiFactory = function (configuration, basePath, axios) {
5001
5057
  getGetTcxExpiringKeys: function (options) {
5002
5058
  return localVarFp.getGetTcxExpiringKeys(options).then(function (request) { return request(axios, basePath); });
5003
5059
  },
5060
+ /**
5061
+ * Get 3CX Partners
5062
+ * @summary Get 3CX Partners
5063
+ * @param {*} [options] Override http request option.
5064
+ * @throws {RequiredError}
5065
+ */
5066
+ getGetTcxPartners: function (options) {
5067
+ return localVarFp.getGetTcxPartners(options).then(function (request) { return request(axios, basePath); });
5068
+ },
5004
5069
  /**
5005
5070
  * Get Bulk 3CX Licence Details
5006
5071
  * @summary Get bulk 3CX Licence Details
@@ -5053,6 +5118,16 @@ var Class3CXApi = /** @class */ (function (_super) {
5053
5118
  var _this = this;
5054
5119
  return (0, exports.Class3CXApiFp)(this.configuration).getGetTcxExpiringKeys(options).then(function (request) { return request(_this.axios, _this.basePath); });
5055
5120
  };
5121
+ /**
5122
+ * Get 3CX Partners
5123
+ * @summary Get 3CX Partners
5124
+ * @param {*} [options] Override http request option.
5125
+ * @throws {RequiredError}
5126
+ */
5127
+ Class3CXApi.prototype.getGetTcxPartners = function (options) {
5128
+ var _this = this;
5129
+ return (0, exports.Class3CXApiFp)(this.configuration).getGetTcxPartners(options).then(function (request) { return request(_this.axios, _this.basePath); });
5130
+ };
5056
5131
  /**
5057
5132
  * Get Bulk 3CX Licence Details
5058
5133
  * @summary Get bulk 3CX Licence Details
@@ -7,6 +7,7 @@ All URIs are relative to *https://bitbucket.org*
7
7
  |[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
8
8
  |[**getGetTcxCreditStatus**](#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status|
9
9
  |[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys|
10
+ |[**getGetTcxPartners**](#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners|
10
11
  |[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
11
12
 
12
13
  # **getGetLicenceDetails**
@@ -103,7 +104,7 @@ No authorization required
103
104
  ### HTTP response details
104
105
  | Status code | Description | Response headers |
105
106
  |-------------|-------------|------------------|
106
- |**200** | 3CX Expiring Key CSV | - |
107
+ |**200** | 3CX Credit Status | - |
107
108
  |**400** | Bad Request | - |
108
109
  |**401** | Unauthorised | - |
109
110
  |**403** | Access Denied | - |
@@ -157,6 +158,53 @@ No authorization required
157
158
 
158
159
  [[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)
159
160
 
161
+ # **getGetTcxPartners**
162
+ > Array<PartnerDTO> getGetTcxPartners()
163
+
164
+ Get 3CX Partners
165
+
166
+ ### Example
167
+
168
+ ```typescript
169
+ import {
170
+ Class3CXApi,
171
+ Configuration
172
+ } from 'yellowgrid-api-ts';
173
+
174
+ const configuration = new Configuration();
175
+ const apiInstance = new Class3CXApi(configuration);
176
+
177
+ const { status, data } = await apiInstance.getGetTcxPartners();
178
+ ```
179
+
180
+ ### Parameters
181
+ This endpoint does not have any parameters.
182
+
183
+
184
+ ### Return type
185
+
186
+ **Array<PartnerDTO>**
187
+
188
+ ### Authorization
189
+
190
+ No authorization required
191
+
192
+ ### HTTP request headers
193
+
194
+ - **Content-Type**: Not defined
195
+ - **Accept**: application/json
196
+
197
+
198
+ ### HTTP response details
199
+ | Status code | Description | Response headers |
200
+ |-------------|-------------|------------------|
201
+ |**200** | 3CX Partners | - |
202
+ |**400** | Bad Request | - |
203
+ |**401** | Unauthorised | - |
204
+ |**403** | Access Denied | - |
205
+
206
+ [[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)
207
+
160
208
  # **postGetBulkLicenceDetails**
161
209
  > TcxBulkLicenceDetailsModel postGetBulkLicenceDetails()
162
210
 
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
17
17
  **hostingPriceListId** | **number** | 3CX Hosting Price List ID | [optional] [default to undefined]
18
18
  **installationUrl** | **string** | 3CX Installation URL | [optional] [default to undefined]
19
19
  **aligned** | **boolean** | Aligned | [optional] [default to undefined]
20
+ **customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | Customer | [optional] [default to undefined]
20
21
 
21
22
  ## Example
22
23
 
@@ -35,6 +36,7 @@ const instance: PartnerDTO = {
35
36
  hostingPriceListId,
36
37
  installationUrl,
37
38
  aligned,
39
+ customer,
38
40
  };
39
41
  ```
40
42
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.175",
3
+ "version": "3.2.176",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {