yellowgrid-api-ts 3.2.94-dev.0 → 3.2.95-dev.0

package/README.md

@@ -140,6 +140,7 @@ Class | Method | HTTP request | Description
 *NumberPortingApi* | [**getGetAdminNumberPort**](docs/NumberPortingApi.md#getgetadminnumberport) | **GET** /admin/sip/numbers/ports/{id} | 
 *NumberPortingApi* | [**getGetAdminNumberPorts**](docs/NumberPortingApi.md#getgetadminnumberports) | **GET** /admin/sip/numbers/ports | 
 *NumberPortingApi* | [**getUpdateNumberPort**](docs/NumberPortingApi.md#getupdatenumberport) | **GET** /sip/numbers/ports/{id} | 
+*NumberPortingApi* | [**patchCancelAdminNumberPort**](docs/NumberPortingApi.md#patchcanceladminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/cancel | 
 *NumberPortingApi* | [**patchCloseAdminNumberPort**](docs/NumberPortingApi.md#patchcloseadminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/close | 
 *NumberPortingApi* | [**postAddAdminNote**](docs/NumberPortingApi.md#postaddadminnote) | **POST** /admin/sip/numbers/ports/{id}/notes | 
 *NumberPortingApi* | [**postCreateNumberPort**](docs/NumberPortingApi.md#postcreatenumberport) | **POST** /sip/numbers/ports | 

package/api.ts

@@ -783,6 +783,12 @@ export interface AdminNumberPortDTO {
      * @memberof AdminNumberPortDTO
      */
     'cloas'?: Array<AttachmentModel>;
+    /**
+     * Created At
+     * @type {string}
+     * @memberof AdminNumberPortDTO
+     */
+    'createdAt'?: string;
 }
 /**
  * Admin Order Request
@@ -18420,6 +18426,39 @@ export const NumberPortingApiAxiosParamCreator = function (configuration?: Confi
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @param {number} id Number Port ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchCancelAdminNumberPort: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('patchCancelAdminNumberPort', 'id', id)
+            const localVarPath = `/admin/sip/numbers/ports/{id}/cancel`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // 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: 'PATCH', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -18901,6 +18940,18 @@ export const NumberPortingApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['NumberPortingApi.getUpdateNumberPort']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 
+         * @param {number} id Number Port ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.patchCancelAdminNumberPort(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['NumberPortingApi.patchCancelAdminNumberPort']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @param {number} id Number Port ID
@@ -19069,6 +19120,15 @@ export const NumberPortingApiFactory = function (configuration?: Configuration,
         getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<NumberPortDTO> {
             return localVarFp.getUpdateNumberPort(id, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 
+         * @param {number} id Number Port ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO> {
+            return localVarFp.patchCancelAdminNumberPort(id, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @param {number} id Number Port ID
@@ -19229,6 +19289,17 @@ export class NumberPortingApi extends BaseAPI {
         return NumberPortingApiFp(this.configuration).getUpdateNumberPort(id, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 
+     * @param {number} id Number Port ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NumberPortingApi
+     */
+    public patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig) {
+        return NumberPortingApiFp(this.configuration).patchCancelAdminNumberPort(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @param {number} id Number Port ID

package/dist/api.d.ts

@@ -773,6 +773,12 @@ export interface AdminNumberPortDTO {
      * @memberof AdminNumberPortDTO
      */
     'cloas'?: Array<AttachmentModel>;
+    /**
+     * Created At
+     * @type {string}
+     * @memberof AdminNumberPortDTO
+     */
+    'createdAt'?: string;
 }
 /**
  * Admin Order Request
@@ -14838,6 +14844,13 @@ export declare const NumberPortingApiAxiosParamCreator: (configuration?: Configu
      * @throws {RequiredError}
      */
     getUpdateNumberPort: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {number} id Number Port ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchCancelAdminNumberPort: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @param {number} id Number Port ID
@@ -14962,6 +14975,13 @@ export declare const NumberPortingApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NumberPortDTO>>;
+    /**
+     *
+     * @param {number} id Number Port ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>>;
     /**
      *
      * @param {number} id Number Port ID
@@ -15086,6 +15106,13 @@ export declare const NumberPortingApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<NumberPortDTO>;
+    /**
+     *
+     * @param {number} id Number Port ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO>;
     /**
      *
      * @param {number} id Number Port ID
@@ -15217,6 +15244,14 @@ export declare class NumberPortingApi extends BaseAPI {
      * @memberof NumberPortingApi
      */
     getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NumberPortDTO, any, {}>>;
+    /**
+     *
+     * @param {number} id Number Port ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NumberPortingApi
+     */
+    patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminNumberPortDTO, any, {}>>;
     /**
      *
      * @param {number} id Number Port ID

package/dist/api.js

@@ -8138,6 +8138,42 @@ var NumberPortingApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         *
+         * @param {number} id Number Port ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchCancelAdminNumberPort: function (id_1) {
+            var args_1 = [];
+            for (var _i = 1; _i < arguments.length; _i++) {
+                args_1[_i - 1] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    // verify required parameter 'id' is not null or undefined
+                    (0, common_1.assertParamExists)('patchCancelAdminNumberPort', 'id', id);
+                    localVarPath = "/admin/sip/numbers/ports/{id}/cancel"
+                        .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
         /**
          *
          * @param {number} id Number Port ID
@@ -8637,6 +8673,28 @@ var NumberPortingApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         *
+         * @param {number} id Number Port ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchCancelAdminNumberPort: function (id, 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.patchCancelAdminNumberPort(id, 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['NumberPortingApi.patchCancelAdminNumberPort']) === 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); }];
+                    }
+                });
+            });
+        },
         /**
          *
          * @param {number} id Number Port ID
@@ -8865,6 +8923,15 @@ var NumberPortingApiFactory = function (configuration, basePath, axios) {
         getUpdateNumberPort: function (id, options) {
             return localVarFp.getUpdateNumberPort(id, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         *
+         * @param {number} id Number Port ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchCancelAdminNumberPort: function (id, options) {
+            return localVarFp.patchCancelAdminNumberPort(id, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          *
          * @param {number} id Number Port ID
@@ -9029,6 +9096,17 @@ var NumberPortingApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.NumberPortingApiFp)(this.configuration).getUpdateNumberPort(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     *
+     * @param {number} id Number Port ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NumberPortingApi
+     */
+    NumberPortingApi.prototype.patchCancelAdminNumberPort = function (id, options) {
+        var _this = this;
+        return (0, exports.NumberPortingApiFp)(this.configuration).patchCancelAdminNumberPort(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      *
      * @param {number} id Number Port ID

package/dist/models/PortStatusEnum.d.ts

@@ -14,5 +14,10 @@ export declare const PortStatusEnum: {
         readonly value: 2;
         readonly publicValue: "Closed";
     };
+    readonly CANCELLED: {
+        readonly name: "CANCELLED";
+        readonly value: 3;
+        readonly publicValue: "Cancelled";
+    };
 };
 export type PortStatusEnum = typeof PortStatusEnum;

package/dist/models/PortStatusEnum.js

@@ -16,5 +16,10 @@ exports.PortStatusEnum = {
         "name": "CLOSED",
         "value": 2,
         "publicValue": "Closed"
+    },
+    "CANCELLED": {
+        "name": "CANCELLED",
+        "value": 3,
+        "publicValue": "Cancelled"
     }
 };

package/docs/AdminNumberPortDTO.md

@@ -26,6 +26,7 @@ Name | Type | Description | Notes
 **ticketId** | **number** | Ticket ID | [optional] [default to undefined]
 **notes** | [**Array<NumberPortNoteDTO>**](NumberPortNoteDTO.md) | Notes | [optional] [default to undefined]
 **cloas** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [optional] [default to undefined]
+**createdAt** | **string** | Created At | [optional] [default to undefined]
 
 ## Example
 
@@ -53,6 +54,7 @@ const instance: AdminNumberPortDTO = {
     ticketId,
     notes,
     cloas,
+    createdAt,
 };
 ```
 

package/docs/NumberPortingApi.md

@@ -9,6 +9,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**getGetAdminNumberPort**](#getgetadminnumberport) | **GET** /admin/sip/numbers/ports/{id} | |
 |[**getGetAdminNumberPorts**](#getgetadminnumberports) | **GET** /admin/sip/numbers/ports | |
 |[**getUpdateNumberPort**](#getupdatenumberport) | **GET** /sip/numbers/ports/{id} | |
+|[**patchCancelAdminNumberPort**](#patchcanceladminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/cancel | |
 |[**patchCloseAdminNumberPort**](#patchcloseadminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/close | |
 |[**postAddAdminNote**](#postaddadminnote) | **POST** /admin/sip/numbers/ports/{id}/notes | |
 |[**postCreateNumberPort**](#postcreatenumberport) | **POST** /sip/numbers/ports | |
@@ -283,6 +284,59 @@ No authorization required
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | NumberPortResponseDTO |  -  |
+|**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)
+
+# **patchCancelAdminNumberPort**
+> AdminNumberPortDTO patchCancelAdminNumberPort()
+
+
+### Example
+
+```typescript
+import {
+    NumberPortingApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new NumberPortingApi(configuration);
+
+let id: number; //Number Port ID (default to undefined)
+
+const { status, data } = await apiInstance.patchCancelAdminNumberPort(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Number Port ID | defaults to undefined|
+
+
+### Return type
+
+**AdminNumberPortDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/models/PortStatusEnum.ts

@@ -13,6 +13,11 @@ export const PortStatusEnum = {
         "name": "CLOSED",
         "value": 2,
         "publicValue": "Closed"
+    },
+    "CANCELLED": {
+        "name": "CANCELLED",
+        "value": 3,
+        "publicValue": "Cancelled"
     }
 } as const;
 

package/package.json

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