yellowgrid-api-ts 3.2.72 → 3.2.73

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
@@ -140,6 +140,7 @@ Class | Method | HTTP request | Description
140
140
  *NumberPortingApi* | [**getGetAdminNumberPort**](docs/NumberPortingApi.md#getgetadminnumberport) | **GET** /admin/sip/numbers/ports/{id} |
141
141
  *NumberPortingApi* | [**getGetAdminNumberPorts**](docs/NumberPortingApi.md#getgetadminnumberports) | **GET** /admin/sip/numbers/ports |
142
142
  *NumberPortingApi* | [**getUpdateNumberPort**](docs/NumberPortingApi.md#getupdatenumberport) | **GET** /sip/numbers/ports/{id} |
143
+ *NumberPortingApi* | [**patchCancelAdminNumberPort**](docs/NumberPortingApi.md#patchcanceladminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/cancel |
143
144
  *NumberPortingApi* | [**patchCloseAdminNumberPort**](docs/NumberPortingApi.md#patchcloseadminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/close |
144
145
  *NumberPortingApi* | [**postAddAdminNote**](docs/NumberPortingApi.md#postaddadminnote) | **POST** /admin/sip/numbers/ports/{id}/notes |
145
146
  *NumberPortingApi* | [**postCreateNumberPort**](docs/NumberPortingApi.md#postcreatenumberport) | **POST** /sip/numbers/ports |
package/api.ts CHANGED
@@ -13419,6 +13419,39 @@ export const NumberPortingApiAxiosParamCreator = function (configuration?: Confi
13419
13419
  options: localVarRequestOptions,
13420
13420
  };
13421
13421
  },
13422
+ /**
13423
+ *
13424
+ * @param {number} id Number Port ID
13425
+ * @param {*} [options] Override http request option.
13426
+ * @throws {RequiredError}
13427
+ */
13428
+ patchCancelAdminNumberPort: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13429
+ // verify required parameter 'id' is not null or undefined
13430
+ assertParamExists('patchCancelAdminNumberPort', 'id', id)
13431
+ const localVarPath = `/admin/sip/numbers/ports/{id}/cancel`
13432
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
13433
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
13434
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13435
+ let baseOptions;
13436
+ if (configuration) {
13437
+ baseOptions = configuration.baseOptions;
13438
+ }
13439
+
13440
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
13441
+ const localVarHeaderParameter = {} as any;
13442
+ const localVarQueryParameter = {} as any;
13443
+
13444
+ localVarHeaderParameter['Accept'] = 'application/json';
13445
+
13446
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
13447
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13448
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
13449
+
13450
+ return {
13451
+ url: toPathString(localVarUrlObj),
13452
+ options: localVarRequestOptions,
13453
+ };
13454
+ },
13422
13455
  /**
13423
13456
  *
13424
13457
  * @param {number} id Number Port ID
@@ -13885,6 +13918,18 @@ export const NumberPortingApiFp = function(configuration?: Configuration) {
13885
13918
  const localVarOperationServerBasePath = operationServerMap['NumberPortingApi.getUpdateNumberPort']?.[localVarOperationServerIndex]?.url;
13886
13919
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13887
13920
  },
13921
+ /**
13922
+ *
13923
+ * @param {number} id Number Port ID
13924
+ * @param {*} [options] Override http request option.
13925
+ * @throws {RequiredError}
13926
+ */
13927
+ async patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>> {
13928
+ const localVarAxiosArgs = await localVarAxiosParamCreator.patchCancelAdminNumberPort(id, options);
13929
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13930
+ const localVarOperationServerBasePath = operationServerMap['NumberPortingApi.patchCancelAdminNumberPort']?.[localVarOperationServerIndex]?.url;
13931
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13932
+ },
13888
13933
  /**
13889
13934
  *
13890
13935
  * @param {number} id Number Port ID
@@ -14052,6 +14097,15 @@ export const NumberPortingApiFactory = function (configuration?: Configuration,
14052
14097
  getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<NumberPortDTO> {
14053
14098
  return localVarFp.getUpdateNumberPort(id, options).then((request) => request(axios, basePath));
14054
14099
  },
14100
+ /**
14101
+ *
14102
+ * @param {number} id Number Port ID
14103
+ * @param {*} [options] Override http request option.
14104
+ * @throws {RequiredError}
14105
+ */
14106
+ patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO> {
14107
+ return localVarFp.patchCancelAdminNumberPort(id, options).then((request) => request(axios, basePath));
14108
+ },
14055
14109
  /**
14056
14110
  *
14057
14111
  * @param {number} id Number Port ID
@@ -14204,6 +14258,16 @@ export class NumberPortingApi extends BaseAPI {
14204
14258
  return NumberPortingApiFp(this.configuration).getUpdateNumberPort(id, options).then((request) => request(this.axios, this.basePath));
14205
14259
  }
14206
14260
 
14261
+ /**
14262
+ *
14263
+ * @param {number} id Number Port ID
14264
+ * @param {*} [options] Override http request option.
14265
+ * @throws {RequiredError}
14266
+ */
14267
+ public patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig) {
14268
+ return NumberPortingApiFp(this.configuration).patchCancelAdminNumberPort(id, options).then((request) => request(this.axios, this.basePath));
14269
+ }
14270
+
14207
14271
  /**
14208
14272
  *
14209
14273
  * @param {number} id Number Port ID
package/dist/api.d.ts CHANGED
@@ -9900,6 +9900,13 @@ export declare const NumberPortingApiAxiosParamCreator: (configuration?: Configu
9900
9900
  * @throws {RequiredError}
9901
9901
  */
9902
9902
  getUpdateNumberPort: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9903
+ /**
9904
+ *
9905
+ * @param {number} id Number Port ID
9906
+ * @param {*} [options] Override http request option.
9907
+ * @throws {RequiredError}
9908
+ */
9909
+ patchCancelAdminNumberPort: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9903
9910
  /**
9904
9911
  *
9905
9912
  * @param {number} id Number Port ID
@@ -10023,6 +10030,13 @@ export declare const NumberPortingApiFp: (configuration?: Configuration) => {
10023
10030
  * @throws {RequiredError}
10024
10031
  */
10025
10032
  getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NumberPortDTO>>;
10033
+ /**
10034
+ *
10035
+ * @param {number} id Number Port ID
10036
+ * @param {*} [options] Override http request option.
10037
+ * @throws {RequiredError}
10038
+ */
10039
+ patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>>;
10026
10040
  /**
10027
10041
  *
10028
10042
  * @param {number} id Number Port ID
@@ -10146,6 +10160,13 @@ export declare const NumberPortingApiFactory: (configuration?: Configuration, ba
10146
10160
  * @throws {RequiredError}
10147
10161
  */
10148
10162
  getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<NumberPortDTO>;
10163
+ /**
10164
+ *
10165
+ * @param {number} id Number Port ID
10166
+ * @param {*} [options] Override http request option.
10167
+ * @throws {RequiredError}
10168
+ */
10169
+ patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO>;
10149
10170
  /**
10150
10171
  *
10151
10172
  * @param {number} id Number Port ID
@@ -10269,6 +10290,13 @@ export declare class NumberPortingApi extends BaseAPI {
10269
10290
  * @throws {RequiredError}
10270
10291
  */
10271
10292
  getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NumberPortDTO, any, {}>>;
10293
+ /**
10294
+ *
10295
+ * @param {number} id Number Port ID
10296
+ * @param {*} [options] Override http request option.
10297
+ * @throws {RequiredError}
10298
+ */
10299
+ patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminNumberPortDTO, any, {}>>;
10272
10300
  /**
10273
10301
  *
10274
10302
  * @param {number} id Number Port ID
package/dist/api.js CHANGED
@@ -7938,6 +7938,43 @@ var NumberPortingApiAxiosParamCreator = function (configuration) {
7938
7938
  });
7939
7939
  });
7940
7940
  },
7941
+ /**
7942
+ *
7943
+ * @param {number} id Number Port ID
7944
+ * @param {*} [options] Override http request option.
7945
+ * @throws {RequiredError}
7946
+ */
7947
+ patchCancelAdminNumberPort: function (id_1) {
7948
+ var args_1 = [];
7949
+ for (var _i = 1; _i < arguments.length; _i++) {
7950
+ args_1[_i - 1] = arguments[_i];
7951
+ }
7952
+ return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
7953
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
7954
+ if (options === void 0) { options = {}; }
7955
+ return __generator(this, function (_a) {
7956
+ // verify required parameter 'id' is not null or undefined
7957
+ (0, common_1.assertParamExists)('patchCancelAdminNumberPort', 'id', id);
7958
+ localVarPath = "/admin/sip/numbers/ports/{id}/cancel"
7959
+ .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
7960
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
7961
+ if (configuration) {
7962
+ baseOptions = configuration.baseOptions;
7963
+ }
7964
+ localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
7965
+ localVarHeaderParameter = {};
7966
+ localVarQueryParameter = {};
7967
+ localVarHeaderParameter['Accept'] = 'application/json';
7968
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
7969
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7970
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
7971
+ return [2 /*return*/, {
7972
+ url: (0, common_1.toPathString)(localVarUrlObj),
7973
+ options: localVarRequestOptions,
7974
+ }];
7975
+ });
7976
+ });
7977
+ },
7941
7978
  /**
7942
7979
  *
7943
7980
  * @param {number} id Number Port ID
@@ -8442,6 +8479,28 @@ var NumberPortingApiFp = function (configuration) {
8442
8479
  });
8443
8480
  });
8444
8481
  },
8482
+ /**
8483
+ *
8484
+ * @param {number} id Number Port ID
8485
+ * @param {*} [options] Override http request option.
8486
+ * @throws {RequiredError}
8487
+ */
8488
+ patchCancelAdminNumberPort: function (id, options) {
8489
+ return __awaiter(this, void 0, void 0, function () {
8490
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
8491
+ var _a, _b, _c;
8492
+ return __generator(this, function (_d) {
8493
+ switch (_d.label) {
8494
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchCancelAdminNumberPort(id, options)];
8495
+ case 1:
8496
+ localVarAxiosArgs = _d.sent();
8497
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
8498
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['NumberPortingApi.patchCancelAdminNumberPort']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
8499
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
8500
+ }
8501
+ });
8502
+ });
8503
+ },
8445
8504
  /**
8446
8505
  *
8447
8506
  * @param {number} id Number Port ID
@@ -8669,6 +8728,15 @@ var NumberPortingApiFactory = function (configuration, basePath, axios) {
8669
8728
  getUpdateNumberPort: function (id, options) {
8670
8729
  return localVarFp.getUpdateNumberPort(id, options).then(function (request) { return request(axios, basePath); });
8671
8730
  },
8731
+ /**
8732
+ *
8733
+ * @param {number} id Number Port ID
8734
+ * @param {*} [options] Override http request option.
8735
+ * @throws {RequiredError}
8736
+ */
8737
+ patchCancelAdminNumberPort: function (id, options) {
8738
+ return localVarFp.patchCancelAdminNumberPort(id, options).then(function (request) { return request(axios, basePath); });
8739
+ },
8672
8740
  /**
8673
8741
  *
8674
8742
  * @param {number} id Number Port ID
@@ -8825,6 +8893,16 @@ var NumberPortingApi = /** @class */ (function (_super) {
8825
8893
  var _this = this;
8826
8894
  return (0, exports.NumberPortingApiFp)(this.configuration).getUpdateNumberPort(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
8827
8895
  };
8896
+ /**
8897
+ *
8898
+ * @param {number} id Number Port ID
8899
+ * @param {*} [options] Override http request option.
8900
+ * @throws {RequiredError}
8901
+ */
8902
+ NumberPortingApi.prototype.patchCancelAdminNumberPort = function (id, options) {
8903
+ var _this = this;
8904
+ return (0, exports.NumberPortingApiFp)(this.configuration).patchCancelAdminNumberPort(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
8905
+ };
8828
8906
  /**
8829
8907
  *
8830
8908
  * @param {number} id Number Port ID
@@ -9,6 +9,7 @@ All URIs are relative to *https://bitbucket.org*
9
9
  |[**getGetAdminNumberPort**](#getgetadminnumberport) | **GET** /admin/sip/numbers/ports/{id} | |
10
10
  |[**getGetAdminNumberPorts**](#getgetadminnumberports) | **GET** /admin/sip/numbers/ports | |
11
11
  |[**getUpdateNumberPort**](#getupdatenumberport) | **GET** /sip/numbers/ports/{id} | |
12
+ |[**patchCancelAdminNumberPort**](#patchcanceladminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/cancel | |
12
13
  |[**patchCloseAdminNumberPort**](#patchcloseadminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/close | |
13
14
  |[**postAddAdminNote**](#postaddadminnote) | **POST** /admin/sip/numbers/ports/{id}/notes | |
14
15
  |[**postCreateNumberPort**](#postcreatenumberport) | **POST** /sip/numbers/ports | |
@@ -283,6 +284,59 @@ No authorization required
283
284
  - **Accept**: application/json
284
285
 
285
286
 
287
+ ### HTTP response details
288
+ | Status code | Description | Response headers |
289
+ |-------------|-------------|------------------|
290
+ |**200** | NumberPortResponseDTO | - |
291
+ |**400** | Bad Request | - |
292
+ |**401** | Unauthorised | - |
293
+ |**403** | Access Denied | - |
294
+
295
+ [[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)
296
+
297
+ # **patchCancelAdminNumberPort**
298
+ > AdminNumberPortDTO patchCancelAdminNumberPort()
299
+
300
+
301
+ ### Example
302
+
303
+ ```typescript
304
+ import {
305
+ NumberPortingApi,
306
+ Configuration
307
+ } from 'yellowgrid-api-ts';
308
+
309
+ const configuration = new Configuration();
310
+ const apiInstance = new NumberPortingApi(configuration);
311
+
312
+ let id: number; //Number Port ID (default to undefined)
313
+
314
+ const { status, data } = await apiInstance.patchCancelAdminNumberPort(
315
+ id
316
+ );
317
+ ```
318
+
319
+ ### Parameters
320
+
321
+ |Name | Type | Description | Notes|
322
+ |------------- | ------------- | ------------- | -------------|
323
+ | **id** | [**number**] | Number Port ID | defaults to undefined|
324
+
325
+
326
+ ### Return type
327
+
328
+ **AdminNumberPortDTO**
329
+
330
+ ### Authorization
331
+
332
+ No authorization required
333
+
334
+ ### HTTP request headers
335
+
336
+ - **Content-Type**: Not defined
337
+ - **Accept**: application/json
338
+
339
+
286
340
  ### HTTP response details
287
341
  | Status code | Description | Response headers |
288
342
  |-------------|-------------|------------------|
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.72",
3
+ "version": "3.2.73",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {