yellowgrid-api-ts 3.2.63 → 3.2.64
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/.openapi-generator/FILES +2 -1
- package/README.md +3 -1
- package/api.ts +170 -61
- package/dist/api.d.ts +133 -64
- package/dist/api.js +86 -0
- package/docs/{NumberPortModel.md → AdminNumberPortDTO.md} +23 -17
- package/docs/NumberPortNoteDTO.md +29 -0
- package/docs/NumberPortingApi.md +63 -6
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -17,6 +17,7 @@ docs/AccountsApi.md
|
|
|
17
17
|
docs/AccountsResponseModel.md
|
|
18
18
|
docs/AddressModel.md
|
|
19
19
|
docs/AddressRequestModel.md
|
|
20
|
+
docs/AdminNumberPortDTO.md
|
|
20
21
|
docs/AdminOrderRequestDTO.md
|
|
21
22
|
docs/AdminUserModel.md
|
|
22
23
|
docs/AgentHoursGraphModel.md
|
|
@@ -94,7 +95,7 @@ docs/MultiTenantChangeResponseModel.md
|
|
|
94
95
|
docs/MyPBXToolsApi.md
|
|
95
96
|
docs/NavigationModel.md
|
|
96
97
|
docs/NumberPortDTO.md
|
|
97
|
-
docs/
|
|
98
|
+
docs/NumberPortNoteDTO.md
|
|
98
99
|
docs/NumberPortRangeDTO.md
|
|
99
100
|
docs/NumberPortRangeRequestDTO.md
|
|
100
101
|
docs/NumberPortingApi.md
|
package/README.md
CHANGED
|
@@ -141,6 +141,7 @@ Class | Method | HTTP request | Description
|
|
|
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
143
|
*NumberPortingApi* | [**patchCloseAdminNumberPort**](docs/NumberPortingApi.md#patchcloseadminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/close |
|
|
144
|
+
*NumberPortingApi* | [**postAddAdminNote**](docs/NumberPortingApi.md#postaddadminnote) | **POST** /admin/sip/numbers/ports/{id}/notes |
|
|
144
145
|
*NumberPortingApi* | [**postCreateNumberPort**](docs/NumberPortingApi.md#postcreatenumberport) | **POST** /sip/numbers/ports |
|
|
145
146
|
*NumberPortingApi* | [**postSubmitNumberPort**](docs/NumberPortingApi.md#postsubmitnumberport) | **POST** /sip/numbers/ports/{id}/submit |
|
|
146
147
|
*NumberPortingApi* | [**postUpdateNumberPort**](docs/NumberPortingApi.md#postupdatenumberport) | **POST** /sip/numbers/ports/{id} |
|
|
@@ -256,6 +257,7 @@ Class | Method | HTTP request | Description
|
|
|
256
257
|
- [AccountsResponseModel](docs/AccountsResponseModel.md)
|
|
257
258
|
- [AddressModel](docs/AddressModel.md)
|
|
258
259
|
- [AddressRequestModel](docs/AddressRequestModel.md)
|
|
260
|
+
- [AdminNumberPortDTO](docs/AdminNumberPortDTO.md)
|
|
259
261
|
- [AdminOrderRequestDTO](docs/AdminOrderRequestDTO.md)
|
|
260
262
|
- [AdminUserModel](docs/AdminUserModel.md)
|
|
261
263
|
- [AgentHoursGraphModel](docs/AgentHoursGraphModel.md)
|
|
@@ -326,7 +328,7 @@ Class | Method | HTTP request | Description
|
|
|
326
328
|
- [MultiTenantChangeResponseModel](docs/MultiTenantChangeResponseModel.md)
|
|
327
329
|
- [NavigationModel](docs/NavigationModel.md)
|
|
328
330
|
- [NumberPortDTO](docs/NumberPortDTO.md)
|
|
329
|
-
- [
|
|
331
|
+
- [NumberPortNoteDTO](docs/NumberPortNoteDTO.md)
|
|
330
332
|
- [NumberPortRangeDTO](docs/NumberPortRangeDTO.md)
|
|
331
333
|
- [NumberPortRangeRequestDTO](docs/NumberPortRangeRequestDTO.md)
|
|
332
334
|
- [NumberPortsModel](docs/NumberPortsModel.md)
|
package/api.ts
CHANGED
|
@@ -440,6 +440,87 @@ export interface AddressRequestModel {
|
|
|
440
440
|
*/
|
|
441
441
|
'addressPostcode'?: string;
|
|
442
442
|
}
|
|
443
|
+
/**
|
|
444
|
+
* Admin Number Port Response
|
|
445
|
+
*/
|
|
446
|
+
export interface AdminNumberPortDTO {
|
|
447
|
+
/**
|
|
448
|
+
* Company Name
|
|
449
|
+
*/
|
|
450
|
+
'companyName'?: string | null;
|
|
451
|
+
/**
|
|
452
|
+
* Address Line 1
|
|
453
|
+
*/
|
|
454
|
+
'addressLine1'?: string | null;
|
|
455
|
+
/**
|
|
456
|
+
* Address Line 2
|
|
457
|
+
*/
|
|
458
|
+
'addressLine2'?: string | null;
|
|
459
|
+
/**
|
|
460
|
+
* City
|
|
461
|
+
*/
|
|
462
|
+
'city'?: string | null;
|
|
463
|
+
/**
|
|
464
|
+
* Post Code
|
|
465
|
+
*/
|
|
466
|
+
'postCode'?: string | null;
|
|
467
|
+
/**
|
|
468
|
+
* Trunk ID
|
|
469
|
+
*/
|
|
470
|
+
'trunkId'?: number | null;
|
|
471
|
+
/**
|
|
472
|
+
* Starter Bundle ID
|
|
473
|
+
*/
|
|
474
|
+
'tenantId'?: string | null;
|
|
475
|
+
/**
|
|
476
|
+
* Requested Port Date
|
|
477
|
+
*/
|
|
478
|
+
'requestedPortDate'?: string | null;
|
|
479
|
+
/**
|
|
480
|
+
* Port Date ASAP
|
|
481
|
+
*/
|
|
482
|
+
'asap'?: boolean | null;
|
|
483
|
+
/**
|
|
484
|
+
* Comment
|
|
485
|
+
*/
|
|
486
|
+
'comment'?: string | null;
|
|
487
|
+
/**
|
|
488
|
+
* Number Port ID
|
|
489
|
+
*/
|
|
490
|
+
'id'?: number;
|
|
491
|
+
/**
|
|
492
|
+
* Reseller ID
|
|
493
|
+
*/
|
|
494
|
+
'customerId'?: number;
|
|
495
|
+
/**
|
|
496
|
+
* Customer Name
|
|
497
|
+
*/
|
|
498
|
+
'customerName'?: string;
|
|
499
|
+
/**
|
|
500
|
+
* Porting Date
|
|
501
|
+
*/
|
|
502
|
+
'portDate'?: string;
|
|
503
|
+
/**
|
|
504
|
+
* Number Ranges
|
|
505
|
+
*/
|
|
506
|
+
'numberRanges'?: Array<NumberPortRangeDTO>;
|
|
507
|
+
/**
|
|
508
|
+
* Status
|
|
509
|
+
*/
|
|
510
|
+
'status'?: number;
|
|
511
|
+
/**
|
|
512
|
+
* Status Text
|
|
513
|
+
*/
|
|
514
|
+
'statusText'?: string;
|
|
515
|
+
/**
|
|
516
|
+
* Ticket ID
|
|
517
|
+
*/
|
|
518
|
+
'ticketId'?: number | null;
|
|
519
|
+
/**
|
|
520
|
+
* Notes
|
|
521
|
+
*/
|
|
522
|
+
'notes'?: Array<NumberPortNoteDTO>;
|
|
523
|
+
}
|
|
443
524
|
/**
|
|
444
525
|
* Admin Order Request
|
|
445
526
|
*/
|
|
@@ -2606,73 +2687,29 @@ export interface NumberPortDTO {
|
|
|
2606
2687
|
'ticketId'?: number | null;
|
|
2607
2688
|
}
|
|
2608
2689
|
/**
|
|
2609
|
-
* Number Port
|
|
2690
|
+
* Number Port Note DTO
|
|
2610
2691
|
*/
|
|
2611
|
-
export interface
|
|
2692
|
+
export interface NumberPortNoteDTO {
|
|
2612
2693
|
/**
|
|
2613
|
-
*
|
|
2694
|
+
* id
|
|
2614
2695
|
*/
|
|
2615
2696
|
'id'?: number;
|
|
2616
2697
|
/**
|
|
2617
|
-
*
|
|
2618
|
-
*/
|
|
2619
|
-
'customerId'?: number;
|
|
2620
|
-
/**
|
|
2621
|
-
* End User
|
|
2622
|
-
*/
|
|
2623
|
-
'endUser'?: string | null;
|
|
2624
|
-
/**
|
|
2625
|
-
* Address Line 1
|
|
2626
|
-
*/
|
|
2627
|
-
'addressLine1'?: string | null;
|
|
2628
|
-
/**
|
|
2629
|
-
* Address Line 2
|
|
2630
|
-
*/
|
|
2631
|
-
'addressLine2'?: string | null;
|
|
2632
|
-
/**
|
|
2633
|
-
* City
|
|
2634
|
-
*/
|
|
2635
|
-
'city'?: string | null;
|
|
2636
|
-
/**
|
|
2637
|
-
* Post Code
|
|
2638
|
-
*/
|
|
2639
|
-
'postCode'?: string | null;
|
|
2640
|
-
/**
|
|
2641
|
-
* Trunk ID
|
|
2642
|
-
*/
|
|
2643
|
-
'trunkId'?: number | null;
|
|
2644
|
-
/**
|
|
2645
|
-
* Tenant ID
|
|
2646
|
-
*/
|
|
2647
|
-
'tenantId'?: string | null;
|
|
2648
|
-
/**
|
|
2649
|
-
* Requested Port Date
|
|
2650
|
-
*/
|
|
2651
|
-
'requestedPortDate'?: string | null;
|
|
2652
|
-
/**
|
|
2653
|
-
* Port Date
|
|
2654
|
-
*/
|
|
2655
|
-
'portDate'?: string | null;
|
|
2656
|
-
/**
|
|
2657
|
-
* Comment
|
|
2698
|
+
* portId
|
|
2658
2699
|
*/
|
|
2659
|
-
'
|
|
2660
|
-
/**
|
|
2661
|
-
* Status
|
|
2662
|
-
*/
|
|
2663
|
-
'status'?: number | null;
|
|
2700
|
+
'portId'?: number;
|
|
2664
2701
|
/**
|
|
2665
|
-
*
|
|
2702
|
+
* note
|
|
2666
2703
|
*/
|
|
2667
|
-
'
|
|
2704
|
+
'note'?: string;
|
|
2668
2705
|
/**
|
|
2669
|
-
*
|
|
2706
|
+
* user
|
|
2670
2707
|
*/
|
|
2671
|
-
'
|
|
2708
|
+
'user'?: string;
|
|
2672
2709
|
/**
|
|
2673
|
-
*
|
|
2710
|
+
* timestamp
|
|
2674
2711
|
*/
|
|
2675
|
-
'
|
|
2712
|
+
'timestamp'?: string;
|
|
2676
2713
|
}
|
|
2677
2714
|
/**
|
|
2678
2715
|
* Number Port Range Response
|
|
@@ -13331,6 +13368,44 @@ export const NumberPortingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
13331
13368
|
options: localVarRequestOptions,
|
|
13332
13369
|
};
|
|
13333
13370
|
},
|
|
13371
|
+
/**
|
|
13372
|
+
*
|
|
13373
|
+
* @param {number} id Number Port ID
|
|
13374
|
+
* @param {string} body
|
|
13375
|
+
* @param {*} [options] Override http request option.
|
|
13376
|
+
* @throws {RequiredError}
|
|
13377
|
+
*/
|
|
13378
|
+
postAddAdminNote: async (id: number, body: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13379
|
+
// verify required parameter 'id' is not null or undefined
|
|
13380
|
+
assertParamExists('postAddAdminNote', 'id', id)
|
|
13381
|
+
// verify required parameter 'body' is not null or undefined
|
|
13382
|
+
assertParamExists('postAddAdminNote', 'body', body)
|
|
13383
|
+
const localVarPath = `/admin/sip/numbers/ports/{id}/notes`
|
|
13384
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
13385
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
13386
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13387
|
+
let baseOptions;
|
|
13388
|
+
if (configuration) {
|
|
13389
|
+
baseOptions = configuration.baseOptions;
|
|
13390
|
+
}
|
|
13391
|
+
|
|
13392
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
13393
|
+
const localVarHeaderParameter = {} as any;
|
|
13394
|
+
const localVarQueryParameter = {} as any;
|
|
13395
|
+
|
|
13396
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
13397
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
13398
|
+
|
|
13399
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13400
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13401
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
13402
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
|
|
13403
|
+
|
|
13404
|
+
return {
|
|
13405
|
+
url: toPathString(localVarUrlObj),
|
|
13406
|
+
options: localVarRequestOptions,
|
|
13407
|
+
};
|
|
13408
|
+
},
|
|
13334
13409
|
/**
|
|
13335
13410
|
*
|
|
13336
13411
|
* @param {string | null} [companyName] Company Name
|
|
@@ -13694,7 +13769,7 @@ export const NumberPortingApiFp = function(configuration?: Configuration) {
|
|
|
13694
13769
|
* @param {*} [options] Override http request option.
|
|
13695
13770
|
* @throws {RequiredError}
|
|
13696
13771
|
*/
|
|
13697
|
-
async getGetAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
13772
|
+
async getGetAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>> {
|
|
13698
13773
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getGetAdminNumberPort(id, options);
|
|
13699
13774
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13700
13775
|
const localVarOperationServerBasePath = operationServerMap['NumberPortingApi.getGetAdminNumberPort']?.[localVarOperationServerIndex]?.url;
|
|
@@ -13732,12 +13807,25 @@ export const NumberPortingApiFp = function(configuration?: Configuration) {
|
|
|
13732
13807
|
* @param {*} [options] Override http request option.
|
|
13733
13808
|
* @throws {RequiredError}
|
|
13734
13809
|
*/
|
|
13735
|
-
async patchCloseAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
13810
|
+
async patchCloseAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>> {
|
|
13736
13811
|
const localVarAxiosArgs = await localVarAxiosParamCreator.patchCloseAdminNumberPort(id, options);
|
|
13737
13812
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13738
13813
|
const localVarOperationServerBasePath = operationServerMap['NumberPortingApi.patchCloseAdminNumberPort']?.[localVarOperationServerIndex]?.url;
|
|
13739
13814
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13740
13815
|
},
|
|
13816
|
+
/**
|
|
13817
|
+
*
|
|
13818
|
+
* @param {number} id Number Port ID
|
|
13819
|
+
* @param {string} body
|
|
13820
|
+
* @param {*} [options] Override http request option.
|
|
13821
|
+
* @throws {RequiredError}
|
|
13822
|
+
*/
|
|
13823
|
+
async postAddAdminNote(id: number, body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>> {
|
|
13824
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postAddAdminNote(id, body, options);
|
|
13825
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13826
|
+
const localVarOperationServerBasePath = operationServerMap['NumberPortingApi.postAddAdminNote']?.[localVarOperationServerIndex]?.url;
|
|
13827
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13828
|
+
},
|
|
13741
13829
|
/**
|
|
13742
13830
|
*
|
|
13743
13831
|
* @param {string | null} [companyName] Company Name
|
|
@@ -13816,7 +13904,7 @@ export const NumberPortingApiFp = function(configuration?: Configuration) {
|
|
|
13816
13904
|
* @param {*} [options] Override http request option.
|
|
13817
13905
|
* @throws {RequiredError}
|
|
13818
13906
|
*/
|
|
13819
|
-
async putGetAdminNumberPort(id: number, numberPortDTO: NumberPortDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
13907
|
+
async putGetAdminNumberPort(id: number, numberPortDTO: NumberPortDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>> {
|
|
13820
13908
|
const localVarAxiosArgs = await localVarAxiosParamCreator.putGetAdminNumberPort(id, numberPortDTO, options);
|
|
13821
13909
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13822
13910
|
const localVarOperationServerBasePath = operationServerMap['NumberPortingApi.putGetAdminNumberPort']?.[localVarOperationServerIndex]?.url;
|
|
@@ -13857,7 +13945,7 @@ export const NumberPortingApiFactory = function (configuration?: Configuration,
|
|
|
13857
13945
|
* @param {*} [options] Override http request option.
|
|
13858
13946
|
* @throws {RequiredError}
|
|
13859
13947
|
*/
|
|
13860
|
-
getGetAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
13948
|
+
getGetAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO> {
|
|
13861
13949
|
return localVarFp.getGetAdminNumberPort(id, options).then((request) => request(axios, basePath));
|
|
13862
13950
|
},
|
|
13863
13951
|
/**
|
|
@@ -13886,9 +13974,19 @@ export const NumberPortingApiFactory = function (configuration?: Configuration,
|
|
|
13886
13974
|
* @param {*} [options] Override http request option.
|
|
13887
13975
|
* @throws {RequiredError}
|
|
13888
13976
|
*/
|
|
13889
|
-
patchCloseAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
13977
|
+
patchCloseAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO> {
|
|
13890
13978
|
return localVarFp.patchCloseAdminNumberPort(id, options).then((request) => request(axios, basePath));
|
|
13891
13979
|
},
|
|
13980
|
+
/**
|
|
13981
|
+
*
|
|
13982
|
+
* @param {number} id Number Port ID
|
|
13983
|
+
* @param {string} body
|
|
13984
|
+
* @param {*} [options] Override http request option.
|
|
13985
|
+
* @throws {RequiredError}
|
|
13986
|
+
*/
|
|
13987
|
+
postAddAdminNote(id: number, body: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO> {
|
|
13988
|
+
return localVarFp.postAddAdminNote(id, body, options).then((request) => request(axios, basePath));
|
|
13989
|
+
},
|
|
13892
13990
|
/**
|
|
13893
13991
|
*
|
|
13894
13992
|
* @param {string | null} [companyName] Company Name
|
|
@@ -13958,7 +14056,7 @@ export const NumberPortingApiFactory = function (configuration?: Configuration,
|
|
|
13958
14056
|
* @param {*} [options] Override http request option.
|
|
13959
14057
|
* @throws {RequiredError}
|
|
13960
14058
|
*/
|
|
13961
|
-
putGetAdminNumberPort(id: number, numberPortDTO: NumberPortDTO, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
14059
|
+
putGetAdminNumberPort(id: number, numberPortDTO: NumberPortDTO, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO> {
|
|
13962
14060
|
return localVarFp.putGetAdminNumberPort(id, numberPortDTO, options).then((request) => request(axios, basePath));
|
|
13963
14061
|
},
|
|
13964
14062
|
};
|
|
@@ -14032,6 +14130,17 @@ export class NumberPortingApi extends BaseAPI {
|
|
|
14032
14130
|
return NumberPortingApiFp(this.configuration).patchCloseAdminNumberPort(id, options).then((request) => request(this.axios, this.basePath));
|
|
14033
14131
|
}
|
|
14034
14132
|
|
|
14133
|
+
/**
|
|
14134
|
+
*
|
|
14135
|
+
* @param {number} id Number Port ID
|
|
14136
|
+
* @param {string} body
|
|
14137
|
+
* @param {*} [options] Override http request option.
|
|
14138
|
+
* @throws {RequiredError}
|
|
14139
|
+
*/
|
|
14140
|
+
public postAddAdminNote(id: number, body: string, options?: RawAxiosRequestConfig) {
|
|
14141
|
+
return NumberPortingApiFp(this.configuration).postAddAdminNote(id, body, options).then((request) => request(this.axios, this.basePath));
|
|
14142
|
+
}
|
|
14143
|
+
|
|
14035
14144
|
/**
|
|
14036
14145
|
*
|
|
14037
14146
|
* @param {string | null} [companyName] Company Name
|
package/dist/api.d.ts
CHANGED
|
@@ -430,6 +430,87 @@ export interface AddressRequestModel {
|
|
|
430
430
|
*/
|
|
431
431
|
'addressPostcode'?: string;
|
|
432
432
|
}
|
|
433
|
+
/**
|
|
434
|
+
* Admin Number Port Response
|
|
435
|
+
*/
|
|
436
|
+
export interface AdminNumberPortDTO {
|
|
437
|
+
/**
|
|
438
|
+
* Company Name
|
|
439
|
+
*/
|
|
440
|
+
'companyName'?: string | null;
|
|
441
|
+
/**
|
|
442
|
+
* Address Line 1
|
|
443
|
+
*/
|
|
444
|
+
'addressLine1'?: string | null;
|
|
445
|
+
/**
|
|
446
|
+
* Address Line 2
|
|
447
|
+
*/
|
|
448
|
+
'addressLine2'?: string | null;
|
|
449
|
+
/**
|
|
450
|
+
* City
|
|
451
|
+
*/
|
|
452
|
+
'city'?: string | null;
|
|
453
|
+
/**
|
|
454
|
+
* Post Code
|
|
455
|
+
*/
|
|
456
|
+
'postCode'?: string | null;
|
|
457
|
+
/**
|
|
458
|
+
* Trunk ID
|
|
459
|
+
*/
|
|
460
|
+
'trunkId'?: number | null;
|
|
461
|
+
/**
|
|
462
|
+
* Starter Bundle ID
|
|
463
|
+
*/
|
|
464
|
+
'tenantId'?: string | null;
|
|
465
|
+
/**
|
|
466
|
+
* Requested Port Date
|
|
467
|
+
*/
|
|
468
|
+
'requestedPortDate'?: string | null;
|
|
469
|
+
/**
|
|
470
|
+
* Port Date ASAP
|
|
471
|
+
*/
|
|
472
|
+
'asap'?: boolean | null;
|
|
473
|
+
/**
|
|
474
|
+
* Comment
|
|
475
|
+
*/
|
|
476
|
+
'comment'?: string | null;
|
|
477
|
+
/**
|
|
478
|
+
* Number Port ID
|
|
479
|
+
*/
|
|
480
|
+
'id'?: number;
|
|
481
|
+
/**
|
|
482
|
+
* Reseller ID
|
|
483
|
+
*/
|
|
484
|
+
'customerId'?: number;
|
|
485
|
+
/**
|
|
486
|
+
* Customer Name
|
|
487
|
+
*/
|
|
488
|
+
'customerName'?: string;
|
|
489
|
+
/**
|
|
490
|
+
* Porting Date
|
|
491
|
+
*/
|
|
492
|
+
'portDate'?: string;
|
|
493
|
+
/**
|
|
494
|
+
* Number Ranges
|
|
495
|
+
*/
|
|
496
|
+
'numberRanges'?: Array<NumberPortRangeDTO>;
|
|
497
|
+
/**
|
|
498
|
+
* Status
|
|
499
|
+
*/
|
|
500
|
+
'status'?: number;
|
|
501
|
+
/**
|
|
502
|
+
* Status Text
|
|
503
|
+
*/
|
|
504
|
+
'statusText'?: string;
|
|
505
|
+
/**
|
|
506
|
+
* Ticket ID
|
|
507
|
+
*/
|
|
508
|
+
'ticketId'?: number | null;
|
|
509
|
+
/**
|
|
510
|
+
* Notes
|
|
511
|
+
*/
|
|
512
|
+
'notes'?: Array<NumberPortNoteDTO>;
|
|
513
|
+
}
|
|
433
514
|
/**
|
|
434
515
|
* Admin Order Request
|
|
435
516
|
*/
|
|
@@ -2575,73 +2656,29 @@ export interface NumberPortDTO {
|
|
|
2575
2656
|
'ticketId'?: number | null;
|
|
2576
2657
|
}
|
|
2577
2658
|
/**
|
|
2578
|
-
* Number Port
|
|
2659
|
+
* Number Port Note DTO
|
|
2579
2660
|
*/
|
|
2580
|
-
export interface
|
|
2661
|
+
export interface NumberPortNoteDTO {
|
|
2581
2662
|
/**
|
|
2582
|
-
*
|
|
2663
|
+
* id
|
|
2583
2664
|
*/
|
|
2584
2665
|
'id'?: number;
|
|
2585
2666
|
/**
|
|
2586
|
-
*
|
|
2587
|
-
*/
|
|
2588
|
-
'customerId'?: number;
|
|
2589
|
-
/**
|
|
2590
|
-
* End User
|
|
2591
|
-
*/
|
|
2592
|
-
'endUser'?: string | null;
|
|
2593
|
-
/**
|
|
2594
|
-
* Address Line 1
|
|
2595
|
-
*/
|
|
2596
|
-
'addressLine1'?: string | null;
|
|
2597
|
-
/**
|
|
2598
|
-
* Address Line 2
|
|
2599
|
-
*/
|
|
2600
|
-
'addressLine2'?: string | null;
|
|
2601
|
-
/**
|
|
2602
|
-
* City
|
|
2603
|
-
*/
|
|
2604
|
-
'city'?: string | null;
|
|
2605
|
-
/**
|
|
2606
|
-
* Post Code
|
|
2607
|
-
*/
|
|
2608
|
-
'postCode'?: string | null;
|
|
2609
|
-
/**
|
|
2610
|
-
* Trunk ID
|
|
2611
|
-
*/
|
|
2612
|
-
'trunkId'?: number | null;
|
|
2613
|
-
/**
|
|
2614
|
-
* Tenant ID
|
|
2615
|
-
*/
|
|
2616
|
-
'tenantId'?: string | null;
|
|
2617
|
-
/**
|
|
2618
|
-
* Requested Port Date
|
|
2619
|
-
*/
|
|
2620
|
-
'requestedPortDate'?: string | null;
|
|
2621
|
-
/**
|
|
2622
|
-
* Port Date
|
|
2623
|
-
*/
|
|
2624
|
-
'portDate'?: string | null;
|
|
2625
|
-
/**
|
|
2626
|
-
* Comment
|
|
2667
|
+
* portId
|
|
2627
2668
|
*/
|
|
2628
|
-
'
|
|
2629
|
-
/**
|
|
2630
|
-
* Status
|
|
2631
|
-
*/
|
|
2632
|
-
'status'?: number | null;
|
|
2669
|
+
'portId'?: number;
|
|
2633
2670
|
/**
|
|
2634
|
-
*
|
|
2671
|
+
* note
|
|
2635
2672
|
*/
|
|
2636
|
-
'
|
|
2673
|
+
'note'?: string;
|
|
2637
2674
|
/**
|
|
2638
|
-
*
|
|
2675
|
+
* user
|
|
2639
2676
|
*/
|
|
2640
|
-
'
|
|
2677
|
+
'user'?: string;
|
|
2641
2678
|
/**
|
|
2642
|
-
*
|
|
2679
|
+
* timestamp
|
|
2643
2680
|
*/
|
|
2644
|
-
'
|
|
2681
|
+
'timestamp'?: string;
|
|
2645
2682
|
}
|
|
2646
2683
|
/**
|
|
2647
2684
|
* Number Port Range Response
|
|
@@ -9790,6 +9827,14 @@ export declare const NumberPortingApiAxiosParamCreator: (configuration?: Configu
|
|
|
9790
9827
|
* @throws {RequiredError}
|
|
9791
9828
|
*/
|
|
9792
9829
|
patchCloseAdminNumberPort: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9830
|
+
/**
|
|
9831
|
+
*
|
|
9832
|
+
* @param {number} id Number Port ID
|
|
9833
|
+
* @param {string} body
|
|
9834
|
+
* @param {*} [options] Override http request option.
|
|
9835
|
+
* @throws {RequiredError}
|
|
9836
|
+
*/
|
|
9837
|
+
postAddAdminNote: (id: number, body: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9793
9838
|
/**
|
|
9794
9839
|
*
|
|
9795
9840
|
* @param {string | null} [companyName] Company Name
|
|
@@ -9881,7 +9926,7 @@ export declare const NumberPortingApiFp: (configuration?: Configuration) => {
|
|
|
9881
9926
|
* @param {*} [options] Override http request option.
|
|
9882
9927
|
* @throws {RequiredError}
|
|
9883
9928
|
*/
|
|
9884
|
-
getGetAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
9929
|
+
getGetAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>>;
|
|
9885
9930
|
/**
|
|
9886
9931
|
*
|
|
9887
9932
|
* @param {number} [pageSize] Number Of Results
|
|
@@ -9904,7 +9949,15 @@ export declare const NumberPortingApiFp: (configuration?: Configuration) => {
|
|
|
9904
9949
|
* @param {*} [options] Override http request option.
|
|
9905
9950
|
* @throws {RequiredError}
|
|
9906
9951
|
*/
|
|
9907
|
-
patchCloseAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
9952
|
+
patchCloseAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>>;
|
|
9953
|
+
/**
|
|
9954
|
+
*
|
|
9955
|
+
* @param {number} id Number Port ID
|
|
9956
|
+
* @param {string} body
|
|
9957
|
+
* @param {*} [options] Override http request option.
|
|
9958
|
+
* @throws {RequiredError}
|
|
9959
|
+
*/
|
|
9960
|
+
postAddAdminNote(id: number, body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>>;
|
|
9908
9961
|
/**
|
|
9909
9962
|
*
|
|
9910
9963
|
* @param {string | null} [companyName] Company Name
|
|
@@ -9968,7 +10021,7 @@ export declare const NumberPortingApiFp: (configuration?: Configuration) => {
|
|
|
9968
10021
|
* @param {*} [options] Override http request option.
|
|
9969
10022
|
* @throws {RequiredError}
|
|
9970
10023
|
*/
|
|
9971
|
-
putGetAdminNumberPort(id: number, numberPortDTO: NumberPortDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10024
|
+
putGetAdminNumberPort(id: number, numberPortDTO: NumberPortDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>>;
|
|
9972
10025
|
};
|
|
9973
10026
|
/**
|
|
9974
10027
|
* NumberPortingApi - factory interface
|
|
@@ -9996,7 +10049,7 @@ export declare const NumberPortingApiFactory: (configuration?: Configuration, ba
|
|
|
9996
10049
|
* @param {*} [options] Override http request option.
|
|
9997
10050
|
* @throws {RequiredError}
|
|
9998
10051
|
*/
|
|
9999
|
-
getGetAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
10052
|
+
getGetAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO>;
|
|
10000
10053
|
/**
|
|
10001
10054
|
*
|
|
10002
10055
|
* @param {number} [pageSize] Number Of Results
|
|
@@ -10019,7 +10072,15 @@ export declare const NumberPortingApiFactory: (configuration?: Configuration, ba
|
|
|
10019
10072
|
* @param {*} [options] Override http request option.
|
|
10020
10073
|
* @throws {RequiredError}
|
|
10021
10074
|
*/
|
|
10022
|
-
patchCloseAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
10075
|
+
patchCloseAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO>;
|
|
10076
|
+
/**
|
|
10077
|
+
*
|
|
10078
|
+
* @param {number} id Number Port ID
|
|
10079
|
+
* @param {string} body
|
|
10080
|
+
* @param {*} [options] Override http request option.
|
|
10081
|
+
* @throws {RequiredError}
|
|
10082
|
+
*/
|
|
10083
|
+
postAddAdminNote(id: number, body: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO>;
|
|
10023
10084
|
/**
|
|
10024
10085
|
*
|
|
10025
10086
|
* @param {string | null} [companyName] Company Name
|
|
@@ -10083,7 +10144,7 @@ export declare const NumberPortingApiFactory: (configuration?: Configuration, ba
|
|
|
10083
10144
|
* @param {*} [options] Override http request option.
|
|
10084
10145
|
* @throws {RequiredError}
|
|
10085
10146
|
*/
|
|
10086
|
-
putGetAdminNumberPort(id: number, numberPortDTO: NumberPortDTO, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
10147
|
+
putGetAdminNumberPort(id: number, numberPortDTO: NumberPortDTO, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO>;
|
|
10087
10148
|
};
|
|
10088
10149
|
/**
|
|
10089
10150
|
* NumberPortingApi - object-oriented interface
|
|
@@ -10111,7 +10172,7 @@ export declare class NumberPortingApi extends BaseAPI {
|
|
|
10111
10172
|
* @param {*} [options] Override http request option.
|
|
10112
10173
|
* @throws {RequiredError}
|
|
10113
10174
|
*/
|
|
10114
|
-
getGetAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
10175
|
+
getGetAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminNumberPortDTO, any, {}>>;
|
|
10115
10176
|
/**
|
|
10116
10177
|
*
|
|
10117
10178
|
* @param {number} [pageSize] Number Of Results
|
|
@@ -10134,7 +10195,15 @@ export declare class NumberPortingApi extends BaseAPI {
|
|
|
10134
10195
|
* @param {*} [options] Override http request option.
|
|
10135
10196
|
* @throws {RequiredError}
|
|
10136
10197
|
*/
|
|
10137
|
-
patchCloseAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
10198
|
+
patchCloseAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminNumberPortDTO, any, {}>>;
|
|
10199
|
+
/**
|
|
10200
|
+
*
|
|
10201
|
+
* @param {number} id Number Port ID
|
|
10202
|
+
* @param {string} body
|
|
10203
|
+
* @param {*} [options] Override http request option.
|
|
10204
|
+
* @throws {RequiredError}
|
|
10205
|
+
*/
|
|
10206
|
+
postAddAdminNote(id: number, body: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminNumberPortDTO, any, {}>>;
|
|
10138
10207
|
/**
|
|
10139
10208
|
*
|
|
10140
10209
|
* @param {string | null} [companyName] Company Name
|
|
@@ -10198,7 +10267,7 @@ export declare class NumberPortingApi extends BaseAPI {
|
|
|
10198
10267
|
* @param {*} [options] Override http request option.
|
|
10199
10268
|
* @throws {RequiredError}
|
|
10200
10269
|
*/
|
|
10201
|
-
putGetAdminNumberPort(id: number, numberPortDTO: NumberPortDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
10270
|
+
putGetAdminNumberPort(id: number, numberPortDTO: NumberPortDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminNumberPortDTO, any, {}>>;
|
|
10202
10271
|
}
|
|
10203
10272
|
/**
|
|
10204
10273
|
* OAuth20Api - axios parameter creator
|
package/dist/api.js
CHANGED
|
@@ -7965,6 +7965,48 @@ var NumberPortingApiAxiosParamCreator = function (configuration) {
|
|
|
7965
7965
|
});
|
|
7966
7966
|
});
|
|
7967
7967
|
},
|
|
7968
|
+
/**
|
|
7969
|
+
*
|
|
7970
|
+
* @param {number} id Number Port ID
|
|
7971
|
+
* @param {string} body
|
|
7972
|
+
* @param {*} [options] Override http request option.
|
|
7973
|
+
* @throws {RequiredError}
|
|
7974
|
+
*/
|
|
7975
|
+
postAddAdminNote: function (id_1, body_1) {
|
|
7976
|
+
var args_1 = [];
|
|
7977
|
+
for (var _i = 2; _i < arguments.length; _i++) {
|
|
7978
|
+
args_1[_i - 2] = arguments[_i];
|
|
7979
|
+
}
|
|
7980
|
+
return __awaiter(_this, __spreadArray([id_1, body_1], args_1, true), void 0, function (id, body, options) {
|
|
7981
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
7982
|
+
if (options === void 0) { options = {}; }
|
|
7983
|
+
return __generator(this, function (_a) {
|
|
7984
|
+
// verify required parameter 'id' is not null or undefined
|
|
7985
|
+
(0, common_1.assertParamExists)('postAddAdminNote', 'id', id);
|
|
7986
|
+
// verify required parameter 'body' is not null or undefined
|
|
7987
|
+
(0, common_1.assertParamExists)('postAddAdminNote', 'body', body);
|
|
7988
|
+
localVarPath = "/admin/sip/numbers/ports/{id}/notes"
|
|
7989
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
7990
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
7991
|
+
if (configuration) {
|
|
7992
|
+
baseOptions = configuration.baseOptions;
|
|
7993
|
+
}
|
|
7994
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
7995
|
+
localVarHeaderParameter = {};
|
|
7996
|
+
localVarQueryParameter = {};
|
|
7997
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7998
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
7999
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
8000
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8001
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
8002
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
8003
|
+
return [2 /*return*/, {
|
|
8004
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
8005
|
+
options: localVarRequestOptions,
|
|
8006
|
+
}];
|
|
8007
|
+
});
|
|
8008
|
+
});
|
|
8009
|
+
},
|
|
7968
8010
|
/**
|
|
7969
8011
|
*
|
|
7970
8012
|
* @param {string | null} [companyName] Company Name
|
|
@@ -8412,6 +8454,29 @@ var NumberPortingApiFp = function (configuration) {
|
|
|
8412
8454
|
});
|
|
8413
8455
|
});
|
|
8414
8456
|
},
|
|
8457
|
+
/**
|
|
8458
|
+
*
|
|
8459
|
+
* @param {number} id Number Port ID
|
|
8460
|
+
* @param {string} body
|
|
8461
|
+
* @param {*} [options] Override http request option.
|
|
8462
|
+
* @throws {RequiredError}
|
|
8463
|
+
*/
|
|
8464
|
+
postAddAdminNote: function (id, body, options) {
|
|
8465
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
8466
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
8467
|
+
var _a, _b, _c;
|
|
8468
|
+
return __generator(this, function (_d) {
|
|
8469
|
+
switch (_d.label) {
|
|
8470
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postAddAdminNote(id, body, options)];
|
|
8471
|
+
case 1:
|
|
8472
|
+
localVarAxiosArgs = _d.sent();
|
|
8473
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8474
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['NumberPortingApi.postAddAdminNote']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8475
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
8476
|
+
}
|
|
8477
|
+
});
|
|
8478
|
+
});
|
|
8479
|
+
},
|
|
8415
8480
|
/**
|
|
8416
8481
|
*
|
|
8417
8482
|
* @param {string | null} [companyName] Company Name
|
|
@@ -8603,6 +8668,16 @@ var NumberPortingApiFactory = function (configuration, basePath, axios) {
|
|
|
8603
8668
|
patchCloseAdminNumberPort: function (id, options) {
|
|
8604
8669
|
return localVarFp.patchCloseAdminNumberPort(id, options).then(function (request) { return request(axios, basePath); });
|
|
8605
8670
|
},
|
|
8671
|
+
/**
|
|
8672
|
+
*
|
|
8673
|
+
* @param {number} id Number Port ID
|
|
8674
|
+
* @param {string} body
|
|
8675
|
+
* @param {*} [options] Override http request option.
|
|
8676
|
+
* @throws {RequiredError}
|
|
8677
|
+
*/
|
|
8678
|
+
postAddAdminNote: function (id, body, options) {
|
|
8679
|
+
return localVarFp.postAddAdminNote(id, body, options).then(function (request) { return request(axios, basePath); });
|
|
8680
|
+
},
|
|
8606
8681
|
/**
|
|
8607
8682
|
*
|
|
8608
8683
|
* @param {string | null} [companyName] Company Name
|
|
@@ -8750,6 +8825,17 @@ var NumberPortingApi = /** @class */ (function (_super) {
|
|
|
8750
8825
|
var _this = this;
|
|
8751
8826
|
return (0, exports.NumberPortingApiFp)(this.configuration).patchCloseAdminNumberPort(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
8752
8827
|
};
|
|
8828
|
+
/**
|
|
8829
|
+
*
|
|
8830
|
+
* @param {number} id Number Port ID
|
|
8831
|
+
* @param {string} body
|
|
8832
|
+
* @param {*} [options] Override http request option.
|
|
8833
|
+
* @throws {RequiredError}
|
|
8834
|
+
*/
|
|
8835
|
+
NumberPortingApi.prototype.postAddAdminNote = function (id, body, options) {
|
|
8836
|
+
var _this = this;
|
|
8837
|
+
return (0, exports.NumberPortingApiFp)(this.configuration).postAddAdminNote(id, body, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
8838
|
+
};
|
|
8753
8839
|
/**
|
|
8754
8840
|
*
|
|
8755
8841
|
* @param {string | null} [companyName] Company Name
|
|
@@ -1,37 +1,38 @@
|
|
|
1
|
-
#
|
|
1
|
+
# AdminNumberPortDTO
|
|
2
2
|
|
|
3
|
-
Number Port
|
|
3
|
+
Admin Number Port Response
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**
|
|
10
|
-
**customerId** | **number** | Customer ID | [optional] [default to undefined]
|
|
11
|
-
**endUser** | **string** | End User | [optional] [default to undefined]
|
|
9
|
+
**companyName** | **string** | Company Name | [optional] [default to undefined]
|
|
12
10
|
**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
|
|
13
11
|
**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
|
|
14
12
|
**city** | **string** | City | [optional] [default to undefined]
|
|
15
13
|
**postCode** | **string** | Post Code | [optional] [default to undefined]
|
|
16
14
|
**trunkId** | **number** | Trunk ID | [optional] [default to undefined]
|
|
17
|
-
**tenantId** | **string** |
|
|
15
|
+
**tenantId** | **string** | Starter Bundle ID | [optional] [default to undefined]
|
|
18
16
|
**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
|
|
19
|
-
**
|
|
17
|
+
**asap** | **boolean** | Port Date ASAP | [optional] [default to undefined]
|
|
20
18
|
**comment** | **string** | Comment | [optional] [default to undefined]
|
|
19
|
+
**id** | **number** | Number Port ID | [optional] [default to undefined]
|
|
20
|
+
**customerId** | **number** | Reseller ID | [optional] [default to undefined]
|
|
21
|
+
**customerName** | **string** | Customer Name | [optional] [default to undefined]
|
|
22
|
+
**portDate** | **string** | Porting Date | [optional] [default to undefined]
|
|
23
|
+
**numberRanges** | [**Array<NumberPortRangeDTO>**](NumberPortRangeDTO.md) | Number Ranges | [optional] [default to undefined]
|
|
21
24
|
**status** | **number** | Status | [optional] [default to undefined]
|
|
25
|
+
**statusText** | **string** | Status Text | [optional] [default to undefined]
|
|
22
26
|
**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
|
|
23
|
-
**
|
|
24
|
-
**customerName** | **string** | Customer Company Name | [optional] [default to undefined]
|
|
27
|
+
**notes** | [**Array<NumberPortNoteDTO>**](NumberPortNoteDTO.md) | Notes | [optional] [default to undefined]
|
|
25
28
|
|
|
26
29
|
## Example
|
|
27
30
|
|
|
28
31
|
```typescript
|
|
29
|
-
import {
|
|
32
|
+
import { AdminNumberPortDTO } from 'yellowgrid-api-ts';
|
|
30
33
|
|
|
31
|
-
const instance:
|
|
32
|
-
|
|
33
|
-
customerId,
|
|
34
|
-
endUser,
|
|
34
|
+
const instance: AdminNumberPortDTO = {
|
|
35
|
+
companyName,
|
|
35
36
|
addressLine1,
|
|
36
37
|
addressLine2,
|
|
37
38
|
city,
|
|
@@ -39,12 +40,17 @@ const instance: NumberPortModel = {
|
|
|
39
40
|
trunkId,
|
|
40
41
|
tenantId,
|
|
41
42
|
requestedPortDate,
|
|
42
|
-
|
|
43
|
+
asap,
|
|
43
44
|
comment,
|
|
45
|
+
id,
|
|
46
|
+
customerId,
|
|
47
|
+
customerName,
|
|
48
|
+
portDate,
|
|
49
|
+
numberRanges,
|
|
44
50
|
status,
|
|
51
|
+
statusText,
|
|
45
52
|
ticketId,
|
|
46
|
-
|
|
47
|
-
customerName,
|
|
53
|
+
notes,
|
|
48
54
|
};
|
|
49
55
|
```
|
|
50
56
|
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# NumberPortNoteDTO
|
|
2
|
+
|
|
3
|
+
Number Port Note DTO
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | id | [optional] [default to undefined]
|
|
10
|
+
**portId** | **number** | portId | [optional] [default to undefined]
|
|
11
|
+
**note** | **string** | note | [optional] [default to undefined]
|
|
12
|
+
**user** | **string** | user | [optional] [default to undefined]
|
|
13
|
+
**timestamp** | **string** | timestamp | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { NumberPortNoteDTO } from 'yellowgrid-api-ts';
|
|
19
|
+
|
|
20
|
+
const instance: NumberPortNoteDTO = {
|
|
21
|
+
id,
|
|
22
|
+
portId,
|
|
23
|
+
note,
|
|
24
|
+
user,
|
|
25
|
+
timestamp,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/NumberPortingApi.md
CHANGED
|
@@ -10,6 +10,7 @@ All URIs are relative to *https://bitbucket.org*
|
|
|
10
10
|
|[**getGetAdminNumberPorts**](#getgetadminnumberports) | **GET** /admin/sip/numbers/ports | |
|
|
11
11
|
|[**getUpdateNumberPort**](#getupdatenumberport) | **GET** /sip/numbers/ports/{id} | |
|
|
12
12
|
|[**patchCloseAdminNumberPort**](#patchcloseadminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/close | |
|
|
13
|
+
|[**postAddAdminNote**](#postaddadminnote) | **POST** /admin/sip/numbers/ports/{id}/notes | |
|
|
13
14
|
|[**postCreateNumberPort**](#postcreatenumberport) | **POST** /sip/numbers/ports | |
|
|
14
15
|
|[**postSubmitNumberPort**](#postsubmitnumberport) | **POST** /sip/numbers/ports/{id}/submit | |
|
|
15
16
|
|[**postUpdateNumberPort**](#postupdatenumberport) | **POST** /sip/numbers/ports/{id} | |
|
|
@@ -128,7 +129,7 @@ No authorization required
|
|
|
128
129
|
[[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)
|
|
129
130
|
|
|
130
131
|
# **getGetAdminNumberPort**
|
|
131
|
-
>
|
|
132
|
+
> AdminNumberPortDTO getGetAdminNumberPort()
|
|
132
133
|
|
|
133
134
|
|
|
134
135
|
### Example
|
|
@@ -158,7 +159,7 @@ const { status, data } = await apiInstance.getGetAdminNumberPort(
|
|
|
158
159
|
|
|
159
160
|
### Return type
|
|
160
161
|
|
|
161
|
-
**
|
|
162
|
+
**AdminNumberPortDTO**
|
|
162
163
|
|
|
163
164
|
### Authorization
|
|
164
165
|
|
|
@@ -293,7 +294,7 @@ No authorization required
|
|
|
293
294
|
[[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)
|
|
294
295
|
|
|
295
296
|
# **patchCloseAdminNumberPort**
|
|
296
|
-
>
|
|
297
|
+
> AdminNumberPortDTO patchCloseAdminNumberPort()
|
|
297
298
|
|
|
298
299
|
|
|
299
300
|
### Example
|
|
@@ -323,7 +324,7 @@ const { status, data } = await apiInstance.patchCloseAdminNumberPort(
|
|
|
323
324
|
|
|
324
325
|
### Return type
|
|
325
326
|
|
|
326
|
-
**
|
|
327
|
+
**AdminNumberPortDTO**
|
|
327
328
|
|
|
328
329
|
### Authorization
|
|
329
330
|
|
|
@@ -345,6 +346,62 @@ No authorization required
|
|
|
345
346
|
|
|
346
347
|
[[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)
|
|
347
348
|
|
|
349
|
+
# **postAddAdminNote**
|
|
350
|
+
> AdminNumberPortDTO postAddAdminNote(body)
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
### Example
|
|
354
|
+
|
|
355
|
+
```typescript
|
|
356
|
+
import {
|
|
357
|
+
NumberPortingApi,
|
|
358
|
+
Configuration
|
|
359
|
+
} from 'yellowgrid-api-ts';
|
|
360
|
+
|
|
361
|
+
const configuration = new Configuration();
|
|
362
|
+
const apiInstance = new NumberPortingApi(configuration);
|
|
363
|
+
|
|
364
|
+
let id: number; //Number Port ID (default to undefined)
|
|
365
|
+
let body: string; //
|
|
366
|
+
|
|
367
|
+
const { status, data } = await apiInstance.postAddAdminNote(
|
|
368
|
+
id,
|
|
369
|
+
body
|
|
370
|
+
);
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
### Parameters
|
|
374
|
+
|
|
375
|
+
|Name | Type | Description | Notes|
|
|
376
|
+
|------------- | ------------- | ------------- | -------------|
|
|
377
|
+
| **body** | **string**| | |
|
|
378
|
+
| **id** | [**number**] | Number Port ID | defaults to undefined|
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
### Return type
|
|
382
|
+
|
|
383
|
+
**AdminNumberPortDTO**
|
|
384
|
+
|
|
385
|
+
### Authorization
|
|
386
|
+
|
|
387
|
+
No authorization required
|
|
388
|
+
|
|
389
|
+
### HTTP request headers
|
|
390
|
+
|
|
391
|
+
- **Content-Type**: application/json
|
|
392
|
+
- **Accept**: application/json
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
### HTTP response details
|
|
396
|
+
| Status code | Description | Response headers |
|
|
397
|
+
|-------------|-------------|------------------|
|
|
398
|
+
|**200** | Admin Number Port | - |
|
|
399
|
+
|**400** | Bad Request | - |
|
|
400
|
+
|**401** | Unauthorised | - |
|
|
401
|
+
|**403** | Access Denied | - |
|
|
402
|
+
|
|
403
|
+
[[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)
|
|
404
|
+
|
|
348
405
|
# **postCreateNumberPort**
|
|
349
406
|
> NumberPortDTO postCreateNumberPort()
|
|
350
407
|
|
|
@@ -610,7 +667,7 @@ No authorization required
|
|
|
610
667
|
[[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)
|
|
611
668
|
|
|
612
669
|
# **putGetAdminNumberPort**
|
|
613
|
-
>
|
|
670
|
+
> AdminNumberPortDTO putGetAdminNumberPort(numberPortDTO)
|
|
614
671
|
|
|
615
672
|
|
|
616
673
|
### Example
|
|
@@ -644,7 +701,7 @@ const { status, data } = await apiInstance.putGetAdminNumberPort(
|
|
|
644
701
|
|
|
645
702
|
### Return type
|
|
646
703
|
|
|
647
|
-
**
|
|
704
|
+
**AdminNumberPortDTO**
|
|
648
705
|
|
|
649
706
|
### Authorization
|
|
650
707
|
|