yellowgrid-api-ts 3.2.49-dev.0 → 3.2.51-dev.0

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
@@ -127,6 +127,7 @@ Class | Method | HTTP request | Description
127
127
  *Class3CXIntegrationsApi* | [**postOrderEdTechPro**](docs/Class3CXIntegrationsApi.md#postorderedtechpro) | **POST** /tcx/integrations/edtechpro/orders |
128
128
  *Class3CXIntegrationsApi* | [**postUpgradeEdTechPro**](docs/Class3CXIntegrationsApi.md#postupgradeedtechpro) | **POST** /tcx/integrations/edtechpro/upgrades |
129
129
  *Class3CXMultiTenantApi* | [**deleteGetTenant**](docs/Class3CXMultiTenantApi.md#deletegettenant) | **DELETE** /tcx/mt/tenants/{reference} | Delete 3CX MT Tenant
130
+ *Class3CXMultiTenantApi* | [**getGetAdminTenants**](docs/Class3CXMultiTenantApi.md#getgetadmintenants) | **GET** /tcx/mt/admin/tenants | Get 3CX MT Tenants
130
131
  *Class3CXMultiTenantApi* | [**getGetTenant**](docs/Class3CXMultiTenantApi.md#getgettenant) | **GET** /tcx/mt/tenants/{reference} | Get 3CX MT Tenant
131
132
  *Class3CXMultiTenantApi* | [**getGetTenants**](docs/Class3CXMultiTenantApi.md#getgettenants) | **GET** /tcx/mt/tenants | Get 3CX MT Tenants
132
133
  *Class3CXMultiTenantApi* | [**postAddMtDdi**](docs/Class3CXMultiTenantApi.md#postaddmtddi) | **POST** /tcx/mt/ddis | Add 3CX MT DDI
package/api.ts CHANGED
@@ -2576,6 +2576,10 @@ export interface NumberPortDTO {
2576
2576
  * Number Port ID
2577
2577
  */
2578
2578
  'id'?: number;
2579
+ /**
2580
+ * Reseller ID
2581
+ */
2582
+ 'customerId'?: number;
2579
2583
  /**
2580
2584
  * Customer Name
2581
2585
  */
@@ -12403,6 +12407,43 @@ export const Class3CXMultiTenantApiAxiosParamCreator = function (configuration?:
12403
12407
  const localVarQueryParameter = {} as any;
12404
12408
 
12405
12409
 
12410
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
12411
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12412
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12413
+
12414
+ return {
12415
+ url: toPathString(localVarUrlObj),
12416
+ options: localVarRequestOptions,
12417
+ };
12418
+ },
12419
+ /**
12420
+ * Get 3CX Starter Bundle Tenants
12421
+ * @summary Get 3CX MT Tenants
12422
+ * @param {number} customerId
12423
+ * @param {*} [options] Override http request option.
12424
+ * @throws {RequiredError}
12425
+ */
12426
+ getGetAdminTenants: async (customerId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12427
+ // verify required parameter 'customerId' is not null or undefined
12428
+ assertParamExists('getGetAdminTenants', 'customerId', customerId)
12429
+ const localVarPath = `/tcx/mt/admin/tenants`;
12430
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
12431
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
12432
+ let baseOptions;
12433
+ if (configuration) {
12434
+ baseOptions = configuration.baseOptions;
12435
+ }
12436
+
12437
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
12438
+ const localVarHeaderParameter = {} as any;
12439
+ const localVarQueryParameter = {} as any;
12440
+
12441
+ if (customerId !== undefined) {
12442
+ localVarQueryParameter['customerId'] = customerId;
12443
+ }
12444
+
12445
+ localVarHeaderParameter['Accept'] = 'application/json';
12446
+
12406
12447
  setSearchParams(localVarUrlObj, localVarQueryParameter);
12407
12448
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12408
12449
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -12654,6 +12695,19 @@ export const Class3CXMultiTenantApiFp = function(configuration?: Configuration)
12654
12695
  const localVarOperationServerBasePath = operationServerMap['Class3CXMultiTenantApi.deleteGetTenant']?.[localVarOperationServerIndex]?.url;
12655
12696
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12656
12697
  },
12698
+ /**
12699
+ * Get 3CX Starter Bundle Tenants
12700
+ * @summary Get 3CX MT Tenants
12701
+ * @param {number} customerId
12702
+ * @param {*} [options] Override http request option.
12703
+ * @throws {RequiredError}
12704
+ */
12705
+ async getGetAdminTenants(customerId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxMultiTenantsModel>> {
12706
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getGetAdminTenants(customerId, options);
12707
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12708
+ const localVarOperationServerBasePath = operationServerMap['Class3CXMultiTenantApi.getGetAdminTenants']?.[localVarOperationServerIndex]?.url;
12709
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12710
+ },
12657
12711
  /**
12658
12712
  * Get 3CX Starter Bundle Tenant
12659
12713
  * @summary Get 3CX MT Tenant
@@ -12754,6 +12808,16 @@ export const Class3CXMultiTenantApiFactory = function (configuration?: Configura
12754
12808
  deleteGetTenant(reference: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
12755
12809
  return localVarFp.deleteGetTenant(reference, options).then((request) => request(axios, basePath));
12756
12810
  },
12811
+ /**
12812
+ * Get 3CX Starter Bundle Tenants
12813
+ * @summary Get 3CX MT Tenants
12814
+ * @param {number} customerId
12815
+ * @param {*} [options] Override http request option.
12816
+ * @throws {RequiredError}
12817
+ */
12818
+ getGetAdminTenants(customerId: number, options?: RawAxiosRequestConfig): AxiosPromise<TcxMultiTenantsModel> {
12819
+ return localVarFp.getGetAdminTenants(customerId, options).then((request) => request(axios, basePath));
12820
+ },
12757
12821
  /**
12758
12822
  * Get 3CX Starter Bundle Tenant
12759
12823
  * @summary Get 3CX MT Tenant
@@ -12835,6 +12899,17 @@ export class Class3CXMultiTenantApi extends BaseAPI {
12835
12899
  return Class3CXMultiTenantApiFp(this.configuration).deleteGetTenant(reference, options).then((request) => request(this.axios, this.basePath));
12836
12900
  }
12837
12901
 
12902
+ /**
12903
+ * Get 3CX Starter Bundle Tenants
12904
+ * @summary Get 3CX MT Tenants
12905
+ * @param {number} customerId
12906
+ * @param {*} [options] Override http request option.
12907
+ * @throws {RequiredError}
12908
+ */
12909
+ public getGetAdminTenants(customerId: number, options?: RawAxiosRequestConfig) {
12910
+ return Class3CXMultiTenantApiFp(this.configuration).getGetAdminTenants(customerId, options).then((request) => request(this.axios, this.basePath));
12911
+ }
12912
+
12838
12913
  /**
12839
12914
  * Get 3CX Starter Bundle Tenant
12840
12915
  * @summary Get 3CX MT Tenant
package/dist/api.d.ts CHANGED
@@ -2545,6 +2545,10 @@ export interface NumberPortDTO {
2545
2545
  * Number Port ID
2546
2546
  */
2547
2547
  'id'?: number;
2548
+ /**
2549
+ * Reseller ID
2550
+ */
2551
+ 'customerId'?: number;
2548
2552
  /**
2549
2553
  * Customer Name
2550
2554
  */
@@ -9393,6 +9397,14 @@ export declare const Class3CXMultiTenantApiAxiosParamCreator: (configuration?: C
9393
9397
  * @throws {RequiredError}
9394
9398
  */
9395
9399
  deleteGetTenant: (reference: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9400
+ /**
9401
+ * Get 3CX Starter Bundle Tenants
9402
+ * @summary Get 3CX MT Tenants
9403
+ * @param {number} customerId
9404
+ * @param {*} [options] Override http request option.
9405
+ * @throws {RequiredError}
9406
+ */
9407
+ getGetAdminTenants: (customerId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9396
9408
  /**
9397
9409
  * Get 3CX Starter Bundle Tenant
9398
9410
  * @summary Get 3CX MT Tenant
@@ -9457,6 +9469,14 @@ export declare const Class3CXMultiTenantApiFp: (configuration?: Configuration) =
9457
9469
  * @throws {RequiredError}
9458
9470
  */
9459
9471
  deleteGetTenant(reference: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
9472
+ /**
9473
+ * Get 3CX Starter Bundle Tenants
9474
+ * @summary Get 3CX MT Tenants
9475
+ * @param {number} customerId
9476
+ * @param {*} [options] Override http request option.
9477
+ * @throws {RequiredError}
9478
+ */
9479
+ getGetAdminTenants(customerId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxMultiTenantsModel>>;
9460
9480
  /**
9461
9481
  * Get 3CX Starter Bundle Tenant
9462
9482
  * @summary Get 3CX MT Tenant
@@ -9521,6 +9541,14 @@ export declare const Class3CXMultiTenantApiFactory: (configuration?: Configurati
9521
9541
  * @throws {RequiredError}
9522
9542
  */
9523
9543
  deleteGetTenant(reference: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9544
+ /**
9545
+ * Get 3CX Starter Bundle Tenants
9546
+ * @summary Get 3CX MT Tenants
9547
+ * @param {number} customerId
9548
+ * @param {*} [options] Override http request option.
9549
+ * @throws {RequiredError}
9550
+ */
9551
+ getGetAdminTenants(customerId: number, options?: RawAxiosRequestConfig): AxiosPromise<TcxMultiTenantsModel>;
9524
9552
  /**
9525
9553
  * Get 3CX Starter Bundle Tenant
9526
9554
  * @summary Get 3CX MT Tenant
@@ -9585,6 +9613,14 @@ export declare class Class3CXMultiTenantApi extends BaseAPI {
9585
9613
  * @throws {RequiredError}
9586
9614
  */
9587
9615
  deleteGetTenant(reference: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
9616
+ /**
9617
+ * Get 3CX Starter Bundle Tenants
9618
+ * @summary Get 3CX MT Tenants
9619
+ * @param {number} customerId
9620
+ * @param {*} [options] Override http request option.
9621
+ * @throws {RequiredError}
9622
+ */
9623
+ getGetAdminTenants(customerId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxMultiTenantsModel, any, {}>>;
9588
9624
  /**
9589
9625
  * Get 3CX Starter Bundle Tenant
9590
9626
  * @summary Get 3CX MT Tenant
package/dist/api.js CHANGED
@@ -6913,6 +6913,46 @@ var Class3CXMultiTenantApiAxiosParamCreator = function (configuration) {
6913
6913
  });
6914
6914
  });
6915
6915
  },
6916
+ /**
6917
+ * Get 3CX Starter Bundle Tenants
6918
+ * @summary Get 3CX MT Tenants
6919
+ * @param {number} customerId
6920
+ * @param {*} [options] Override http request option.
6921
+ * @throws {RequiredError}
6922
+ */
6923
+ getGetAdminTenants: function (customerId_1) {
6924
+ var args_1 = [];
6925
+ for (var _i = 1; _i < arguments.length; _i++) {
6926
+ args_1[_i - 1] = arguments[_i];
6927
+ }
6928
+ return __awaiter(_this, __spreadArray([customerId_1], args_1, true), void 0, function (customerId, options) {
6929
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
6930
+ if (options === void 0) { options = {}; }
6931
+ return __generator(this, function (_a) {
6932
+ // verify required parameter 'customerId' is not null or undefined
6933
+ (0, common_1.assertParamExists)('getGetAdminTenants', 'customerId', customerId);
6934
+ localVarPath = "/tcx/mt/admin/tenants";
6935
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
6936
+ if (configuration) {
6937
+ baseOptions = configuration.baseOptions;
6938
+ }
6939
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
6940
+ localVarHeaderParameter = {};
6941
+ localVarQueryParameter = {};
6942
+ if (customerId !== undefined) {
6943
+ localVarQueryParameter['customerId'] = customerId;
6944
+ }
6945
+ localVarHeaderParameter['Accept'] = 'application/json';
6946
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
6947
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6948
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
6949
+ return [2 /*return*/, {
6950
+ url: (0, common_1.toPathString)(localVarUrlObj),
6951
+ options: localVarRequestOptions,
6952
+ }];
6953
+ });
6954
+ });
6955
+ },
6916
6956
  /**
6917
6957
  * Get 3CX Starter Bundle Tenant
6918
6958
  * @summary Get 3CX MT Tenant
@@ -7184,6 +7224,29 @@ var Class3CXMultiTenantApiFp = function (configuration) {
7184
7224
  });
7185
7225
  });
7186
7226
  },
7227
+ /**
7228
+ * Get 3CX Starter Bundle Tenants
7229
+ * @summary Get 3CX MT Tenants
7230
+ * @param {number} customerId
7231
+ * @param {*} [options] Override http request option.
7232
+ * @throws {RequiredError}
7233
+ */
7234
+ getGetAdminTenants: function (customerId, options) {
7235
+ return __awaiter(this, void 0, void 0, function () {
7236
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
7237
+ var _a, _b, _c;
7238
+ return __generator(this, function (_d) {
7239
+ switch (_d.label) {
7240
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetAdminTenants(customerId, options)];
7241
+ case 1:
7242
+ localVarAxiosArgs = _d.sent();
7243
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
7244
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXMultiTenantApi.getGetAdminTenants']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
7245
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
7246
+ }
7247
+ });
7248
+ });
7249
+ },
7187
7250
  /**
7188
7251
  * Get 3CX Starter Bundle Tenant
7189
7252
  * @summary Get 3CX MT Tenant
@@ -7344,6 +7407,16 @@ var Class3CXMultiTenantApiFactory = function (configuration, basePath, axios) {
7344
7407
  deleteGetTenant: function (reference, options) {
7345
7408
  return localVarFp.deleteGetTenant(reference, options).then(function (request) { return request(axios, basePath); });
7346
7409
  },
7410
+ /**
7411
+ * Get 3CX Starter Bundle Tenants
7412
+ * @summary Get 3CX MT Tenants
7413
+ * @param {number} customerId
7414
+ * @param {*} [options] Override http request option.
7415
+ * @throws {RequiredError}
7416
+ */
7417
+ getGetAdminTenants: function (customerId, options) {
7418
+ return localVarFp.getGetAdminTenants(customerId, options).then(function (request) { return request(axios, basePath); });
7419
+ },
7347
7420
  /**
7348
7421
  * Get 3CX Starter Bundle Tenant
7349
7422
  * @summary Get 3CX MT Tenant
@@ -7429,6 +7502,17 @@ var Class3CXMultiTenantApi = /** @class */ (function (_super) {
7429
7502
  var _this = this;
7430
7503
  return (0, exports.Class3CXMultiTenantApiFp)(this.configuration).deleteGetTenant(reference, options).then(function (request) { return request(_this.axios, _this.basePath); });
7431
7504
  };
7505
+ /**
7506
+ * Get 3CX Starter Bundle Tenants
7507
+ * @summary Get 3CX MT Tenants
7508
+ * @param {number} customerId
7509
+ * @param {*} [options] Override http request option.
7510
+ * @throws {RequiredError}
7511
+ */
7512
+ Class3CXMultiTenantApi.prototype.getGetAdminTenants = function (customerId, options) {
7513
+ var _this = this;
7514
+ return (0, exports.Class3CXMultiTenantApiFp)(this.configuration).getGetAdminTenants(customerId, options).then(function (request) { return request(_this.axios, _this.basePath); });
7515
+ };
7432
7516
  /**
7433
7517
  * Get 3CX Starter Bundle Tenant
7434
7518
  * @summary Get 3CX MT Tenant
@@ -5,6 +5,7 @@ All URIs are relative to *http://api.yellowgrid.local*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**deleteGetTenant**](#deletegettenant) | **DELETE** /tcx/mt/tenants/{reference} | Delete 3CX MT Tenant|
8
+ |[**getGetAdminTenants**](#getgetadmintenants) | **GET** /tcx/mt/admin/tenants | Get 3CX MT Tenants|
8
9
  |[**getGetTenant**](#getgettenant) | **GET** /tcx/mt/tenants/{reference} | Get 3CX MT Tenant|
9
10
  |[**getGetTenants**](#getgettenants) | **GET** /tcx/mt/tenants | Get 3CX MT Tenants|
10
11
  |[**postAddMtDdi**](#postaddmtddi) | **POST** /tcx/mt/ddis | Add 3CX MT DDI|
@@ -66,6 +67,60 @@ No authorization required
66
67
 
67
68
  [[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)
68
69
 
70
+ # **getGetAdminTenants**
71
+ > TcxMultiTenantsModel getGetAdminTenants()
72
+
73
+ Get 3CX Starter Bundle Tenants
74
+
75
+ ### Example
76
+
77
+ ```typescript
78
+ import {
79
+ Class3CXMultiTenantApi,
80
+ Configuration
81
+ } from 'yellowgrid-api-ts';
82
+
83
+ const configuration = new Configuration();
84
+ const apiInstance = new Class3CXMultiTenantApi(configuration);
85
+
86
+ let customerId: number; // (default to undefined)
87
+
88
+ const { status, data } = await apiInstance.getGetAdminTenants(
89
+ customerId
90
+ );
91
+ ```
92
+
93
+ ### Parameters
94
+
95
+ |Name | Type | Description | Notes|
96
+ |------------- | ------------- | ------------- | -------------|
97
+ | **customerId** | [**number**] | | defaults to undefined|
98
+
99
+
100
+ ### Return type
101
+
102
+ **TcxMultiTenantsModel**
103
+
104
+ ### Authorization
105
+
106
+ No authorization required
107
+
108
+ ### HTTP request headers
109
+
110
+ - **Content-Type**: Not defined
111
+ - **Accept**: application/json
112
+
113
+
114
+ ### HTTP response details
115
+ | Status code | Description | Response headers |
116
+ |-------------|-------------|------------------|
117
+ |**200** | 3CX Starter Bundle Tenant | - |
118
+ |**400** | Bad Request | - |
119
+ |**401** | Unauthorised | - |
120
+ |**403** | Access Denied | - |
121
+
122
+ [[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)
123
+
69
124
  # **getGetTenant**
70
125
  > TcxMultiTenantModel getGetTenant()
71
126
 
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
17
17
  **asap** | **boolean** | Port Date ASAP | [optional] [default to undefined]
18
18
  **comment** | **string** | Comment | [optional] [default to undefined]
19
19
  **id** | **number** | Number Port ID | [optional] [default to undefined]
20
+ **customerId** | **number** | Reseller ID | [optional] [default to undefined]
20
21
  **customerName** | **string** | Customer Name | [optional] [default to undefined]
21
22
  **portDate** | **string** | Porting Date | [optional] [default to undefined]
22
23
  **numberRanges** | [**Array&lt;NumberPortRangeDTO&gt;**](NumberPortRangeDTO.md) | Number Ranges | [optional] [default to undefined]
@@ -40,6 +41,7 @@ const instance: NumberPortDTO = {
40
41
  asap,
41
42
  comment,
42
43
  id,
44
+ customerId,
43
45
  customerName,
44
46
  portDate,
45
47
  numberRanges,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.49-dev.0",
3
+ "version": "3.2.51-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {