yellowgrid-api-ts 3.2.93-dev.0 → 3.2.95-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/.openapi-generator/FILES +1 -0
- package/README.md +2 -0
- package/api.ts +110 -14
- package/dist/api.d.ts +68 -8
- package/dist/api.js +93 -15
- package/dist/models/PortStatusEnum.d.ts +5 -0
- package/dist/models/PortStatusEnum.js +5 -0
- package/docs/AdminNumberPortDTO.md +4 -0
- package/docs/NumberPortingApi.md +60 -5
- package/docs/OrderDetailsDTO.md +2 -0
- package/docs/PostAddAdminNoteRequest.md +20 -0
- package/models/PortStatusEnum.ts +5 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -122,6 +122,7 @@ docs/PatchSetTcxWizardCnameRequest.md
|
|
|
122
122
|
docs/PatchUpdateAccountContactPasswordRequest.md
|
|
123
123
|
docs/PortalAccountModel.md
|
|
124
124
|
docs/PortalLoginModel.md
|
|
125
|
+
docs/PostAddAdminNoteRequest.md
|
|
125
126
|
docs/PostAddOrderNoteRequest.md
|
|
126
127
|
docs/PostAddWebhook200Response.md
|
|
127
128
|
docs/PostGetClientCredentialsRequest.md
|
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 |
|
|
@@ -372,6 +373,7 @@ Class | Method | HTTP request | Description
|
|
|
372
373
|
- [PatchUpdateAccountContactPasswordRequest](docs/PatchUpdateAccountContactPasswordRequest.md)
|
|
373
374
|
- [PortalAccountModel](docs/PortalAccountModel.md)
|
|
374
375
|
- [PortalLoginModel](docs/PortalLoginModel.md)
|
|
376
|
+
- [PostAddAdminNoteRequest](docs/PostAddAdminNoteRequest.md)
|
|
375
377
|
- [PostAddOrderNoteRequest](docs/PostAddOrderNoteRequest.md)
|
|
376
378
|
- [PostAddWebhook200Response](docs/PostAddWebhook200Response.md)
|
|
377
379
|
- [PostGetClientCredentialsRequest](docs/PostGetClientCredentialsRequest.md)
|
package/api.ts
CHANGED
|
@@ -777,6 +777,18 @@ export interface AdminNumberPortDTO {
|
|
|
777
777
|
* @memberof AdminNumberPortDTO
|
|
778
778
|
*/
|
|
779
779
|
'notes'?: Array<NumberPortNoteDTO>;
|
|
780
|
+
/**
|
|
781
|
+
* Attachments
|
|
782
|
+
* @type {Array<AttachmentModel>}
|
|
783
|
+
* @memberof AdminNumberPortDTO
|
|
784
|
+
*/
|
|
785
|
+
'cloas'?: Array<AttachmentModel>;
|
|
786
|
+
/**
|
|
787
|
+
* Created At
|
|
788
|
+
* @type {string}
|
|
789
|
+
* @memberof AdminNumberPortDTO
|
|
790
|
+
*/
|
|
791
|
+
'createdAt'?: string;
|
|
780
792
|
}
|
|
781
793
|
/**
|
|
782
794
|
* Admin Order Request
|
|
@@ -4732,6 +4744,12 @@ export interface OrderDetailsDTO {
|
|
|
4732
4744
|
* @memberof OrderDetailsDTO
|
|
4733
4745
|
*/
|
|
4734
4746
|
'customerEmail'?: string;
|
|
4747
|
+
/**
|
|
4748
|
+
*
|
|
4749
|
+
* @type {OrderTotalModel}
|
|
4750
|
+
* @memberof OrderDetailsDTO
|
|
4751
|
+
*/
|
|
4752
|
+
'totals'?: OrderTotalModel;
|
|
4735
4753
|
}
|
|
4736
4754
|
/**
|
|
4737
4755
|
* OrdersEntity
|
|
@@ -5936,6 +5954,19 @@ export interface PortalLoginModel {
|
|
|
5936
5954
|
*/
|
|
5937
5955
|
'redirect_uri'?: string;
|
|
5938
5956
|
}
|
|
5957
|
+
/**
|
|
5958
|
+
*
|
|
5959
|
+
* @export
|
|
5960
|
+
* @interface PostAddAdminNoteRequest
|
|
5961
|
+
*/
|
|
5962
|
+
export interface PostAddAdminNoteRequest {
|
|
5963
|
+
/**
|
|
5964
|
+
* Note
|
|
5965
|
+
* @type {string}
|
|
5966
|
+
* @memberof PostAddAdminNoteRequest
|
|
5967
|
+
*/
|
|
5968
|
+
'note'?: string;
|
|
5969
|
+
}
|
|
5939
5970
|
/**
|
|
5940
5971
|
*
|
|
5941
5972
|
* @export
|
|
@@ -18395,6 +18426,39 @@ export const NumberPortingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
18395
18426
|
|
|
18396
18427
|
|
|
18397
18428
|
|
|
18429
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18430
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18431
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
18432
|
+
|
|
18433
|
+
return {
|
|
18434
|
+
url: toPathString(localVarUrlObj),
|
|
18435
|
+
options: localVarRequestOptions,
|
|
18436
|
+
};
|
|
18437
|
+
},
|
|
18438
|
+
/**
|
|
18439
|
+
*
|
|
18440
|
+
* @param {number} id Number Port ID
|
|
18441
|
+
* @param {*} [options] Override http request option.
|
|
18442
|
+
* @throws {RequiredError}
|
|
18443
|
+
*/
|
|
18444
|
+
patchCancelAdminNumberPort: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
18445
|
+
// verify required parameter 'id' is not null or undefined
|
|
18446
|
+
assertParamExists('patchCancelAdminNumberPort', 'id', id)
|
|
18447
|
+
const localVarPath = `/admin/sip/numbers/ports/{id}/cancel`
|
|
18448
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
18449
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18450
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18451
|
+
let baseOptions;
|
|
18452
|
+
if (configuration) {
|
|
18453
|
+
baseOptions = configuration.baseOptions;
|
|
18454
|
+
}
|
|
18455
|
+
|
|
18456
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
18457
|
+
const localVarHeaderParameter = {} as any;
|
|
18458
|
+
const localVarQueryParameter = {} as any;
|
|
18459
|
+
|
|
18460
|
+
|
|
18461
|
+
|
|
18398
18462
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18399
18463
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18400
18464
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -18440,15 +18504,15 @@ export const NumberPortingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
18440
18504
|
/**
|
|
18441
18505
|
*
|
|
18442
18506
|
* @param {number} id Number Port ID
|
|
18443
|
-
* @param {
|
|
18507
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
18444
18508
|
* @param {*} [options] Override http request option.
|
|
18445
18509
|
* @throws {RequiredError}
|
|
18446
18510
|
*/
|
|
18447
|
-
postAddAdminNote: async (id: number,
|
|
18511
|
+
postAddAdminNote: async (id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
18448
18512
|
// verify required parameter 'id' is not null or undefined
|
|
18449
18513
|
assertParamExists('postAddAdminNote', 'id', id)
|
|
18450
|
-
// verify required parameter '
|
|
18451
|
-
assertParamExists('postAddAdminNote', '
|
|
18514
|
+
// verify required parameter 'postAddAdminNoteRequest' is not null or undefined
|
|
18515
|
+
assertParamExists('postAddAdminNote', 'postAddAdminNoteRequest', postAddAdminNoteRequest)
|
|
18452
18516
|
const localVarPath = `/admin/sip/numbers/ports/{id}/notes`
|
|
18453
18517
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
18454
18518
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -18469,7 +18533,7 @@ export const NumberPortingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
18469
18533
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18470
18534
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18471
18535
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
18472
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
18536
|
+
localVarRequestOptions.data = serializeDataIfNeeded(postAddAdminNoteRequest, localVarRequestOptions, configuration)
|
|
18473
18537
|
|
|
18474
18538
|
return {
|
|
18475
18539
|
url: toPathString(localVarUrlObj),
|
|
@@ -18876,6 +18940,18 @@ export const NumberPortingApiFp = function(configuration?: Configuration) {
|
|
|
18876
18940
|
const localVarOperationServerBasePath = operationServerMap['NumberPortingApi.getUpdateNumberPort']?.[localVarOperationServerIndex]?.url;
|
|
18877
18941
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18878
18942
|
},
|
|
18943
|
+
/**
|
|
18944
|
+
*
|
|
18945
|
+
* @param {number} id Number Port ID
|
|
18946
|
+
* @param {*} [options] Override http request option.
|
|
18947
|
+
* @throws {RequiredError}
|
|
18948
|
+
*/
|
|
18949
|
+
async patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>> {
|
|
18950
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchCancelAdminNumberPort(id, options);
|
|
18951
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
18952
|
+
const localVarOperationServerBasePath = operationServerMap['NumberPortingApi.patchCancelAdminNumberPort']?.[localVarOperationServerIndex]?.url;
|
|
18953
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18954
|
+
},
|
|
18879
18955
|
/**
|
|
18880
18956
|
*
|
|
18881
18957
|
* @param {number} id Number Port ID
|
|
@@ -18891,12 +18967,12 @@ export const NumberPortingApiFp = function(configuration?: Configuration) {
|
|
|
18891
18967
|
/**
|
|
18892
18968
|
*
|
|
18893
18969
|
* @param {number} id Number Port ID
|
|
18894
|
-
* @param {
|
|
18970
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
18895
18971
|
* @param {*} [options] Override http request option.
|
|
18896
18972
|
* @throws {RequiredError}
|
|
18897
18973
|
*/
|
|
18898
|
-
async postAddAdminNote(id: number,
|
|
18899
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.postAddAdminNote(id,
|
|
18974
|
+
async postAddAdminNote(id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>> {
|
|
18975
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postAddAdminNote(id, postAddAdminNoteRequest, options);
|
|
18900
18976
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
18901
18977
|
const localVarOperationServerBasePath = operationServerMap['NumberPortingApi.postAddAdminNote']?.[localVarOperationServerIndex]?.url;
|
|
18902
18978
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -19044,6 +19120,15 @@ export const NumberPortingApiFactory = function (configuration?: Configuration,
|
|
|
19044
19120
|
getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<NumberPortDTO> {
|
|
19045
19121
|
return localVarFp.getUpdateNumberPort(id, options).then((request) => request(axios, basePath));
|
|
19046
19122
|
},
|
|
19123
|
+
/**
|
|
19124
|
+
*
|
|
19125
|
+
* @param {number} id Number Port ID
|
|
19126
|
+
* @param {*} [options] Override http request option.
|
|
19127
|
+
* @throws {RequiredError}
|
|
19128
|
+
*/
|
|
19129
|
+
patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO> {
|
|
19130
|
+
return localVarFp.patchCancelAdminNumberPort(id, options).then((request) => request(axios, basePath));
|
|
19131
|
+
},
|
|
19047
19132
|
/**
|
|
19048
19133
|
*
|
|
19049
19134
|
* @param {number} id Number Port ID
|
|
@@ -19056,12 +19141,12 @@ export const NumberPortingApiFactory = function (configuration?: Configuration,
|
|
|
19056
19141
|
/**
|
|
19057
19142
|
*
|
|
19058
19143
|
* @param {number} id Number Port ID
|
|
19059
|
-
* @param {
|
|
19144
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
19060
19145
|
* @param {*} [options] Override http request option.
|
|
19061
19146
|
* @throws {RequiredError}
|
|
19062
19147
|
*/
|
|
19063
|
-
postAddAdminNote(id: number,
|
|
19064
|
-
return localVarFp.postAddAdminNote(id,
|
|
19148
|
+
postAddAdminNote(id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO> {
|
|
19149
|
+
return localVarFp.postAddAdminNote(id, postAddAdminNoteRequest, options).then((request) => request(axios, basePath));
|
|
19065
19150
|
},
|
|
19066
19151
|
/**
|
|
19067
19152
|
*
|
|
@@ -19204,6 +19289,17 @@ export class NumberPortingApi extends BaseAPI {
|
|
|
19204
19289
|
return NumberPortingApiFp(this.configuration).getUpdateNumberPort(id, options).then((request) => request(this.axios, this.basePath));
|
|
19205
19290
|
}
|
|
19206
19291
|
|
|
19292
|
+
/**
|
|
19293
|
+
*
|
|
19294
|
+
* @param {number} id Number Port ID
|
|
19295
|
+
* @param {*} [options] Override http request option.
|
|
19296
|
+
* @throws {RequiredError}
|
|
19297
|
+
* @memberof NumberPortingApi
|
|
19298
|
+
*/
|
|
19299
|
+
public patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig) {
|
|
19300
|
+
return NumberPortingApiFp(this.configuration).patchCancelAdminNumberPort(id, options).then((request) => request(this.axios, this.basePath));
|
|
19301
|
+
}
|
|
19302
|
+
|
|
19207
19303
|
/**
|
|
19208
19304
|
*
|
|
19209
19305
|
* @param {number} id Number Port ID
|
|
@@ -19218,13 +19314,13 @@ export class NumberPortingApi extends BaseAPI {
|
|
|
19218
19314
|
/**
|
|
19219
19315
|
*
|
|
19220
19316
|
* @param {number} id Number Port ID
|
|
19221
|
-
* @param {
|
|
19317
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
19222
19318
|
* @param {*} [options] Override http request option.
|
|
19223
19319
|
* @throws {RequiredError}
|
|
19224
19320
|
* @memberof NumberPortingApi
|
|
19225
19321
|
*/
|
|
19226
|
-
public postAddAdminNote(id: number,
|
|
19227
|
-
return NumberPortingApiFp(this.configuration).postAddAdminNote(id,
|
|
19322
|
+
public postAddAdminNote(id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig) {
|
|
19323
|
+
return NumberPortingApiFp(this.configuration).postAddAdminNote(id, postAddAdminNoteRequest, options).then((request) => request(this.axios, this.basePath));
|
|
19228
19324
|
}
|
|
19229
19325
|
|
|
19230
19326
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -767,6 +767,18 @@ export interface AdminNumberPortDTO {
|
|
|
767
767
|
* @memberof AdminNumberPortDTO
|
|
768
768
|
*/
|
|
769
769
|
'notes'?: Array<NumberPortNoteDTO>;
|
|
770
|
+
/**
|
|
771
|
+
* Attachments
|
|
772
|
+
* @type {Array<AttachmentModel>}
|
|
773
|
+
* @memberof AdminNumberPortDTO
|
|
774
|
+
*/
|
|
775
|
+
'cloas'?: Array<AttachmentModel>;
|
|
776
|
+
/**
|
|
777
|
+
* Created At
|
|
778
|
+
* @type {string}
|
|
779
|
+
* @memberof AdminNumberPortDTO
|
|
780
|
+
*/
|
|
781
|
+
'createdAt'?: string;
|
|
770
782
|
}
|
|
771
783
|
/**
|
|
772
784
|
* Admin Order Request
|
|
@@ -4697,6 +4709,12 @@ export interface OrderDetailsDTO {
|
|
|
4697
4709
|
* @memberof OrderDetailsDTO
|
|
4698
4710
|
*/
|
|
4699
4711
|
'customerEmail'?: string;
|
|
4712
|
+
/**
|
|
4713
|
+
*
|
|
4714
|
+
* @type {OrderTotalModel}
|
|
4715
|
+
* @memberof OrderDetailsDTO
|
|
4716
|
+
*/
|
|
4717
|
+
'totals'?: OrderTotalModel;
|
|
4700
4718
|
}
|
|
4701
4719
|
/**
|
|
4702
4720
|
* OrdersEntity
|
|
@@ -5894,6 +5912,19 @@ export interface PortalLoginModel {
|
|
|
5894
5912
|
*/
|
|
5895
5913
|
'redirect_uri'?: string;
|
|
5896
5914
|
}
|
|
5915
|
+
/**
|
|
5916
|
+
*
|
|
5917
|
+
* @export
|
|
5918
|
+
* @interface PostAddAdminNoteRequest
|
|
5919
|
+
*/
|
|
5920
|
+
export interface PostAddAdminNoteRequest {
|
|
5921
|
+
/**
|
|
5922
|
+
* Note
|
|
5923
|
+
* @type {string}
|
|
5924
|
+
* @memberof PostAddAdminNoteRequest
|
|
5925
|
+
*/
|
|
5926
|
+
'note'?: string;
|
|
5927
|
+
}
|
|
5897
5928
|
/**
|
|
5898
5929
|
*
|
|
5899
5930
|
* @export
|
|
@@ -14813,6 +14844,13 @@ export declare const NumberPortingApiAxiosParamCreator: (configuration?: Configu
|
|
|
14813
14844
|
* @throws {RequiredError}
|
|
14814
14845
|
*/
|
|
14815
14846
|
getUpdateNumberPort: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14847
|
+
/**
|
|
14848
|
+
*
|
|
14849
|
+
* @param {number} id Number Port ID
|
|
14850
|
+
* @param {*} [options] Override http request option.
|
|
14851
|
+
* @throws {RequiredError}
|
|
14852
|
+
*/
|
|
14853
|
+
patchCancelAdminNumberPort: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14816
14854
|
/**
|
|
14817
14855
|
*
|
|
14818
14856
|
* @param {number} id Number Port ID
|
|
@@ -14823,11 +14861,11 @@ export declare const NumberPortingApiAxiosParamCreator: (configuration?: Configu
|
|
|
14823
14861
|
/**
|
|
14824
14862
|
*
|
|
14825
14863
|
* @param {number} id Number Port ID
|
|
14826
|
-
* @param {
|
|
14864
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
14827
14865
|
* @param {*} [options] Override http request option.
|
|
14828
14866
|
* @throws {RequiredError}
|
|
14829
14867
|
*/
|
|
14830
|
-
postAddAdminNote: (id: number,
|
|
14868
|
+
postAddAdminNote: (id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14831
14869
|
/**
|
|
14832
14870
|
*
|
|
14833
14871
|
* @param {string | null} [companyName] Company Name
|
|
@@ -14937,6 +14975,13 @@ export declare const NumberPortingApiFp: (configuration?: Configuration) => {
|
|
|
14937
14975
|
* @throws {RequiredError}
|
|
14938
14976
|
*/
|
|
14939
14977
|
getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NumberPortDTO>>;
|
|
14978
|
+
/**
|
|
14979
|
+
*
|
|
14980
|
+
* @param {number} id Number Port ID
|
|
14981
|
+
* @param {*} [options] Override http request option.
|
|
14982
|
+
* @throws {RequiredError}
|
|
14983
|
+
*/
|
|
14984
|
+
patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>>;
|
|
14940
14985
|
/**
|
|
14941
14986
|
*
|
|
14942
14987
|
* @param {number} id Number Port ID
|
|
@@ -14947,11 +14992,11 @@ export declare const NumberPortingApiFp: (configuration?: Configuration) => {
|
|
|
14947
14992
|
/**
|
|
14948
14993
|
*
|
|
14949
14994
|
* @param {number} id Number Port ID
|
|
14950
|
-
* @param {
|
|
14995
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
14951
14996
|
* @param {*} [options] Override http request option.
|
|
14952
14997
|
* @throws {RequiredError}
|
|
14953
14998
|
*/
|
|
14954
|
-
postAddAdminNote(id: number,
|
|
14999
|
+
postAddAdminNote(id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>>;
|
|
14955
15000
|
/**
|
|
14956
15001
|
*
|
|
14957
15002
|
* @param {string | null} [companyName] Company Name
|
|
@@ -15061,6 +15106,13 @@ export declare const NumberPortingApiFactory: (configuration?: Configuration, ba
|
|
|
15061
15106
|
* @throws {RequiredError}
|
|
15062
15107
|
*/
|
|
15063
15108
|
getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<NumberPortDTO>;
|
|
15109
|
+
/**
|
|
15110
|
+
*
|
|
15111
|
+
* @param {number} id Number Port ID
|
|
15112
|
+
* @param {*} [options] Override http request option.
|
|
15113
|
+
* @throws {RequiredError}
|
|
15114
|
+
*/
|
|
15115
|
+
patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO>;
|
|
15064
15116
|
/**
|
|
15065
15117
|
*
|
|
15066
15118
|
* @param {number} id Number Port ID
|
|
@@ -15071,11 +15123,11 @@ export declare const NumberPortingApiFactory: (configuration?: Configuration, ba
|
|
|
15071
15123
|
/**
|
|
15072
15124
|
*
|
|
15073
15125
|
* @param {number} id Number Port ID
|
|
15074
|
-
* @param {
|
|
15126
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
15075
15127
|
* @param {*} [options] Override http request option.
|
|
15076
15128
|
* @throws {RequiredError}
|
|
15077
15129
|
*/
|
|
15078
|
-
postAddAdminNote(id: number,
|
|
15130
|
+
postAddAdminNote(id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO>;
|
|
15079
15131
|
/**
|
|
15080
15132
|
*
|
|
15081
15133
|
* @param {string | null} [companyName] Company Name
|
|
@@ -15192,6 +15244,14 @@ export declare class NumberPortingApi extends BaseAPI {
|
|
|
15192
15244
|
* @memberof NumberPortingApi
|
|
15193
15245
|
*/
|
|
15194
15246
|
getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NumberPortDTO, any, {}>>;
|
|
15247
|
+
/**
|
|
15248
|
+
*
|
|
15249
|
+
* @param {number} id Number Port ID
|
|
15250
|
+
* @param {*} [options] Override http request option.
|
|
15251
|
+
* @throws {RequiredError}
|
|
15252
|
+
* @memberof NumberPortingApi
|
|
15253
|
+
*/
|
|
15254
|
+
patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminNumberPortDTO, any, {}>>;
|
|
15195
15255
|
/**
|
|
15196
15256
|
*
|
|
15197
15257
|
* @param {number} id Number Port ID
|
|
@@ -15203,12 +15263,12 @@ export declare class NumberPortingApi extends BaseAPI {
|
|
|
15203
15263
|
/**
|
|
15204
15264
|
*
|
|
15205
15265
|
* @param {number} id Number Port ID
|
|
15206
|
-
* @param {
|
|
15266
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
15207
15267
|
* @param {*} [options] Override http request option.
|
|
15208
15268
|
* @throws {RequiredError}
|
|
15209
15269
|
* @memberof NumberPortingApi
|
|
15210
15270
|
*/
|
|
15211
|
-
postAddAdminNote(id: number,
|
|
15271
|
+
postAddAdminNote(id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminNumberPortDTO, any, {}>>;
|
|
15212
15272
|
/**
|
|
15213
15273
|
*
|
|
15214
15274
|
* @param {string | null} [companyName] Company Name
|
package/dist/api.js
CHANGED
|
@@ -8138,6 +8138,42 @@ var NumberPortingApiAxiosParamCreator = function (configuration) {
|
|
|
8138
8138
|
});
|
|
8139
8139
|
});
|
|
8140
8140
|
},
|
|
8141
|
+
/**
|
|
8142
|
+
*
|
|
8143
|
+
* @param {number} id Number Port ID
|
|
8144
|
+
* @param {*} [options] Override http request option.
|
|
8145
|
+
* @throws {RequiredError}
|
|
8146
|
+
*/
|
|
8147
|
+
patchCancelAdminNumberPort: function (id_1) {
|
|
8148
|
+
var args_1 = [];
|
|
8149
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
8150
|
+
args_1[_i - 1] = arguments[_i];
|
|
8151
|
+
}
|
|
8152
|
+
return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
|
|
8153
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
8154
|
+
if (options === void 0) { options = {}; }
|
|
8155
|
+
return __generator(this, function (_a) {
|
|
8156
|
+
// verify required parameter 'id' is not null or undefined
|
|
8157
|
+
(0, common_1.assertParamExists)('patchCancelAdminNumberPort', 'id', id);
|
|
8158
|
+
localVarPath = "/admin/sip/numbers/ports/{id}/cancel"
|
|
8159
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
8160
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
8161
|
+
if (configuration) {
|
|
8162
|
+
baseOptions = configuration.baseOptions;
|
|
8163
|
+
}
|
|
8164
|
+
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
8165
|
+
localVarHeaderParameter = {};
|
|
8166
|
+
localVarQueryParameter = {};
|
|
8167
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
8168
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8169
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
8170
|
+
return [2 /*return*/, {
|
|
8171
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
8172
|
+
options: localVarRequestOptions,
|
|
8173
|
+
}];
|
|
8174
|
+
});
|
|
8175
|
+
});
|
|
8176
|
+
},
|
|
8141
8177
|
/**
|
|
8142
8178
|
*
|
|
8143
8179
|
* @param {number} id Number Port ID
|
|
@@ -8177,23 +8213,23 @@ var NumberPortingApiAxiosParamCreator = function (configuration) {
|
|
|
8177
8213
|
/**
|
|
8178
8214
|
*
|
|
8179
8215
|
* @param {number} id Number Port ID
|
|
8180
|
-
* @param {
|
|
8216
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
8181
8217
|
* @param {*} [options] Override http request option.
|
|
8182
8218
|
* @throws {RequiredError}
|
|
8183
8219
|
*/
|
|
8184
|
-
postAddAdminNote: function (id_1,
|
|
8220
|
+
postAddAdminNote: function (id_1, postAddAdminNoteRequest_1) {
|
|
8185
8221
|
var args_1 = [];
|
|
8186
8222
|
for (var _i = 2; _i < arguments.length; _i++) {
|
|
8187
8223
|
args_1[_i - 2] = arguments[_i];
|
|
8188
8224
|
}
|
|
8189
|
-
return __awaiter(_this, __spreadArray([id_1,
|
|
8225
|
+
return __awaiter(_this, __spreadArray([id_1, postAddAdminNoteRequest_1], args_1, true), void 0, function (id, postAddAdminNoteRequest, options) {
|
|
8190
8226
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
8191
8227
|
if (options === void 0) { options = {}; }
|
|
8192
8228
|
return __generator(this, function (_a) {
|
|
8193
8229
|
// verify required parameter 'id' is not null or undefined
|
|
8194
8230
|
(0, common_1.assertParamExists)('postAddAdminNote', 'id', id);
|
|
8195
|
-
// verify required parameter '
|
|
8196
|
-
(0, common_1.assertParamExists)('postAddAdminNote', '
|
|
8231
|
+
// verify required parameter 'postAddAdminNoteRequest' is not null or undefined
|
|
8232
|
+
(0, common_1.assertParamExists)('postAddAdminNote', 'postAddAdminNoteRequest', postAddAdminNoteRequest);
|
|
8197
8233
|
localVarPath = "/admin/sip/numbers/ports/{id}/notes"
|
|
8198
8234
|
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
8199
8235
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -8207,7 +8243,7 @@ var NumberPortingApiAxiosParamCreator = function (configuration) {
|
|
|
8207
8243
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
8208
8244
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8209
8245
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
8210
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
8246
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(postAddAdminNoteRequest, localVarRequestOptions, configuration);
|
|
8211
8247
|
return [2 /*return*/, {
|
|
8212
8248
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
8213
8249
|
options: localVarRequestOptions,
|
|
@@ -8637,6 +8673,28 @@ var NumberPortingApiFp = function (configuration) {
|
|
|
8637
8673
|
});
|
|
8638
8674
|
});
|
|
8639
8675
|
},
|
|
8676
|
+
/**
|
|
8677
|
+
*
|
|
8678
|
+
* @param {number} id Number Port ID
|
|
8679
|
+
* @param {*} [options] Override http request option.
|
|
8680
|
+
* @throws {RequiredError}
|
|
8681
|
+
*/
|
|
8682
|
+
patchCancelAdminNumberPort: function (id, options) {
|
|
8683
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
8684
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
8685
|
+
var _a, _b, _c;
|
|
8686
|
+
return __generator(this, function (_d) {
|
|
8687
|
+
switch (_d.label) {
|
|
8688
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchCancelAdminNumberPort(id, options)];
|
|
8689
|
+
case 1:
|
|
8690
|
+
localVarAxiosArgs = _d.sent();
|
|
8691
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8692
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['NumberPortingApi.patchCancelAdminNumberPort']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8693
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
8694
|
+
}
|
|
8695
|
+
});
|
|
8696
|
+
});
|
|
8697
|
+
},
|
|
8640
8698
|
/**
|
|
8641
8699
|
*
|
|
8642
8700
|
* @param {number} id Number Port ID
|
|
@@ -8662,17 +8720,17 @@ var NumberPortingApiFp = function (configuration) {
|
|
|
8662
8720
|
/**
|
|
8663
8721
|
*
|
|
8664
8722
|
* @param {number} id Number Port ID
|
|
8665
|
-
* @param {
|
|
8723
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
8666
8724
|
* @param {*} [options] Override http request option.
|
|
8667
8725
|
* @throws {RequiredError}
|
|
8668
8726
|
*/
|
|
8669
|
-
postAddAdminNote: function (id,
|
|
8727
|
+
postAddAdminNote: function (id, postAddAdminNoteRequest, options) {
|
|
8670
8728
|
return __awaiter(this, void 0, void 0, function () {
|
|
8671
8729
|
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
8672
8730
|
var _a, _b, _c;
|
|
8673
8731
|
return __generator(this, function (_d) {
|
|
8674
8732
|
switch (_d.label) {
|
|
8675
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postAddAdminNote(id,
|
|
8733
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postAddAdminNote(id, postAddAdminNoteRequest, options)];
|
|
8676
8734
|
case 1:
|
|
8677
8735
|
localVarAxiosArgs = _d.sent();
|
|
8678
8736
|
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
@@ -8865,6 +8923,15 @@ var NumberPortingApiFactory = function (configuration, basePath, axios) {
|
|
|
8865
8923
|
getUpdateNumberPort: function (id, options) {
|
|
8866
8924
|
return localVarFp.getUpdateNumberPort(id, options).then(function (request) { return request(axios, basePath); });
|
|
8867
8925
|
},
|
|
8926
|
+
/**
|
|
8927
|
+
*
|
|
8928
|
+
* @param {number} id Number Port ID
|
|
8929
|
+
* @param {*} [options] Override http request option.
|
|
8930
|
+
* @throws {RequiredError}
|
|
8931
|
+
*/
|
|
8932
|
+
patchCancelAdminNumberPort: function (id, options) {
|
|
8933
|
+
return localVarFp.patchCancelAdminNumberPort(id, options).then(function (request) { return request(axios, basePath); });
|
|
8934
|
+
},
|
|
8868
8935
|
/**
|
|
8869
8936
|
*
|
|
8870
8937
|
* @param {number} id Number Port ID
|
|
@@ -8877,12 +8944,12 @@ var NumberPortingApiFactory = function (configuration, basePath, axios) {
|
|
|
8877
8944
|
/**
|
|
8878
8945
|
*
|
|
8879
8946
|
* @param {number} id Number Port ID
|
|
8880
|
-
* @param {
|
|
8947
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
8881
8948
|
* @param {*} [options] Override http request option.
|
|
8882
8949
|
* @throws {RequiredError}
|
|
8883
8950
|
*/
|
|
8884
|
-
postAddAdminNote: function (id,
|
|
8885
|
-
return localVarFp.postAddAdminNote(id,
|
|
8951
|
+
postAddAdminNote: function (id, postAddAdminNoteRequest, options) {
|
|
8952
|
+
return localVarFp.postAddAdminNote(id, postAddAdminNoteRequest, options).then(function (request) { return request(axios, basePath); });
|
|
8886
8953
|
},
|
|
8887
8954
|
/**
|
|
8888
8955
|
*
|
|
@@ -9029,6 +9096,17 @@ var NumberPortingApi = /** @class */ (function (_super) {
|
|
|
9029
9096
|
var _this = this;
|
|
9030
9097
|
return (0, exports.NumberPortingApiFp)(this.configuration).getUpdateNumberPort(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
9031
9098
|
};
|
|
9099
|
+
/**
|
|
9100
|
+
*
|
|
9101
|
+
* @param {number} id Number Port ID
|
|
9102
|
+
* @param {*} [options] Override http request option.
|
|
9103
|
+
* @throws {RequiredError}
|
|
9104
|
+
* @memberof NumberPortingApi
|
|
9105
|
+
*/
|
|
9106
|
+
NumberPortingApi.prototype.patchCancelAdminNumberPort = function (id, options) {
|
|
9107
|
+
var _this = this;
|
|
9108
|
+
return (0, exports.NumberPortingApiFp)(this.configuration).patchCancelAdminNumberPort(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
9109
|
+
};
|
|
9032
9110
|
/**
|
|
9033
9111
|
*
|
|
9034
9112
|
* @param {number} id Number Port ID
|
|
@@ -9043,14 +9121,14 @@ var NumberPortingApi = /** @class */ (function (_super) {
|
|
|
9043
9121
|
/**
|
|
9044
9122
|
*
|
|
9045
9123
|
* @param {number} id Number Port ID
|
|
9046
|
-
* @param {
|
|
9124
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
9047
9125
|
* @param {*} [options] Override http request option.
|
|
9048
9126
|
* @throws {RequiredError}
|
|
9049
9127
|
* @memberof NumberPortingApi
|
|
9050
9128
|
*/
|
|
9051
|
-
NumberPortingApi.prototype.postAddAdminNote = function (id,
|
|
9129
|
+
NumberPortingApi.prototype.postAddAdminNote = function (id, postAddAdminNoteRequest, options) {
|
|
9052
9130
|
var _this = this;
|
|
9053
|
-
return (0, exports.NumberPortingApiFp)(this.configuration).postAddAdminNote(id,
|
|
9131
|
+
return (0, exports.NumberPortingApiFp)(this.configuration).postAddAdminNote(id, postAddAdminNoteRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
9054
9132
|
};
|
|
9055
9133
|
/**
|
|
9056
9134
|
*
|
|
@@ -14,5 +14,10 @@ export declare const PortStatusEnum: {
|
|
|
14
14
|
readonly value: 2;
|
|
15
15
|
readonly publicValue: "Closed";
|
|
16
16
|
};
|
|
17
|
+
readonly CANCELLED: {
|
|
18
|
+
readonly name: "CANCELLED";
|
|
19
|
+
readonly value: 3;
|
|
20
|
+
readonly publicValue: "Cancelled";
|
|
21
|
+
};
|
|
17
22
|
};
|
|
18
23
|
export type PortStatusEnum = typeof PortStatusEnum;
|
|
@@ -25,6 +25,8 @@ Name | Type | Description | Notes
|
|
|
25
25
|
**statusText** | **string** | Status Text | [optional] [default to undefined]
|
|
26
26
|
**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
|
|
27
27
|
**notes** | [**Array<NumberPortNoteDTO>**](NumberPortNoteDTO.md) | Notes | [optional] [default to undefined]
|
|
28
|
+
**cloas** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [optional] [default to undefined]
|
|
29
|
+
**createdAt** | **string** | Created At | [optional] [default to undefined]
|
|
28
30
|
|
|
29
31
|
## Example
|
|
30
32
|
|
|
@@ -51,6 +53,8 @@ const instance: AdminNumberPortDTO = {
|
|
|
51
53
|
statusText,
|
|
52
54
|
ticketId,
|
|
53
55
|
notes,
|
|
56
|
+
cloas,
|
|
57
|
+
createdAt,
|
|
54
58
|
};
|
|
55
59
|
```
|
|
56
60
|
|
package/docs/NumberPortingApi.md
CHANGED
|
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
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
|
|-------------|-------------|------------------|
|
|
@@ -347,7 +401,7 @@ No authorization required
|
|
|
347
401
|
[[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)
|
|
348
402
|
|
|
349
403
|
# **postAddAdminNote**
|
|
350
|
-
> AdminNumberPortDTO postAddAdminNote(
|
|
404
|
+
> AdminNumberPortDTO postAddAdminNote(postAddAdminNoteRequest)
|
|
351
405
|
|
|
352
406
|
|
|
353
407
|
### Example
|
|
@@ -355,18 +409,19 @@ No authorization required
|
|
|
355
409
|
```typescript
|
|
356
410
|
import {
|
|
357
411
|
NumberPortingApi,
|
|
358
|
-
Configuration
|
|
412
|
+
Configuration,
|
|
413
|
+
PostAddAdminNoteRequest
|
|
359
414
|
} from 'yellowgrid-api-ts';
|
|
360
415
|
|
|
361
416
|
const configuration = new Configuration();
|
|
362
417
|
const apiInstance = new NumberPortingApi(configuration);
|
|
363
418
|
|
|
364
419
|
let id: number; //Number Port ID (default to undefined)
|
|
365
|
-
let
|
|
420
|
+
let postAddAdminNoteRequest: PostAddAdminNoteRequest; //
|
|
366
421
|
|
|
367
422
|
const { status, data } = await apiInstance.postAddAdminNote(
|
|
368
423
|
id,
|
|
369
|
-
|
|
424
|
+
postAddAdminNoteRequest
|
|
370
425
|
);
|
|
371
426
|
```
|
|
372
427
|
|
|
@@ -374,7 +429,7 @@ const { status, data } = await apiInstance.postAddAdminNote(
|
|
|
374
429
|
|
|
375
430
|
|Name | Type | Description | Notes|
|
|
376
431
|
|------------- | ------------- | ------------- | -------------|
|
|
377
|
-
| **
|
|
432
|
+
| **postAddAdminNoteRequest** | **PostAddAdminNoteRequest**| | |
|
|
378
433
|
| **id** | [**number**] | Number Port ID | defaults to undefined|
|
|
379
434
|
|
|
380
435
|
|
package/docs/OrderDetailsDTO.md
CHANGED
|
@@ -28,6 +28,7 @@ Name | Type | Description | Notes
|
|
|
28
28
|
**paymentLink** | **string** | Card Payment Link | [optional] [default to undefined]
|
|
29
29
|
**credits** | [**Array<CreditNoteModel>**](CreditNoteModel.md) | Credits | [optional] [default to undefined]
|
|
30
30
|
**customerEmail** | **string** | Customer Email | [optional] [default to undefined]
|
|
31
|
+
**totals** | [**OrderTotalModel**](OrderTotalModel.md) | | [optional] [default to undefined]
|
|
31
32
|
|
|
32
33
|
## Example
|
|
33
34
|
|
|
@@ -57,6 +58,7 @@ const instance: OrderDetailsDTO = {
|
|
|
57
58
|
paymentLink,
|
|
58
59
|
credits,
|
|
59
60
|
customerEmail,
|
|
61
|
+
totals,
|
|
60
62
|
};
|
|
61
63
|
```
|
|
62
64
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PostAddAdminNoteRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**note** | **string** | Note | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PostAddAdminNoteRequest } from 'yellowgrid-api-ts';
|
|
14
|
+
|
|
15
|
+
const instance: PostAddAdminNoteRequest = {
|
|
16
|
+
note,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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/models/PortStatusEnum.ts
CHANGED