yellowgrid-api-ts 3.2.149-dev.0 → 3.2.151-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 +4 -0
- package/README.md +5 -0
- package/api.ts +181 -0
- package/dist/api.d.ts +143 -0
- package/dist/api.js +89 -4
- package/docs/AdminOrderRequestDTO.md +2 -0
- package/docs/OrderDTO.md +25 -0
- package/docs/OrderResponseDTO.md +25 -0
- package/docs/OrdersApi.md +56 -0
- package/docs/SbcDTO.md +35 -0
- package/docs/ShippingAddressDTO.md +35 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -119,10 +119,12 @@ docs/NumberPortingApi.md
|
|
|
119
119
|
docs/NumberPortsModel.md
|
|
120
120
|
docs/OAuth20Api.md
|
|
121
121
|
docs/OfflineInstancesEntity.md
|
|
122
|
+
docs/OrderDTO.md
|
|
122
123
|
docs/OrderDetailsDTO.md
|
|
123
124
|
docs/OrderEntity.md
|
|
124
125
|
docs/OrderItemDTO.md
|
|
125
126
|
docs/OrderRequestModel.md
|
|
127
|
+
docs/OrderResponseDTO.md
|
|
126
128
|
docs/OrderSummariesModel.md
|
|
127
129
|
docs/OrderSummaryDTO.md
|
|
128
130
|
docs/OrderTotalModel.md
|
|
@@ -175,6 +177,7 @@ docs/RootAccessModel.md
|
|
|
175
177
|
docs/S3BucketEntity.md
|
|
176
178
|
docs/SIPTrunksApi.md
|
|
177
179
|
docs/SMSApi.md
|
|
180
|
+
docs/SbcDTO.md
|
|
178
181
|
docs/ScannedItemModel.md
|
|
179
182
|
docs/ScopeModel.md
|
|
180
183
|
docs/ServiceHealthDTO.md
|
|
@@ -188,6 +191,7 @@ docs/ShipmentItemEntity.md
|
|
|
188
191
|
docs/ShipmentItemModel.md
|
|
189
192
|
docs/ShipmentModel.md
|
|
190
193
|
docs/ShipmentRequestDTO.md
|
|
194
|
+
docs/ShippingAddressDTO.md
|
|
191
195
|
docs/ShippingApi.md
|
|
192
196
|
docs/ShippingConsignmentModel.md
|
|
193
197
|
docs/ShippingInformationDTO.md
|
package/README.md
CHANGED
|
@@ -198,6 +198,7 @@ Class | Method | HTTP request | Description
|
|
|
198
198
|
*OrdersApi* | [**postAddOrderNote**](docs/OrdersApi.md#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note
|
|
199
199
|
*OrdersApi* | [**postCreateAdminOrder**](docs/OrdersApi.md#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)
|
|
200
200
|
*OrdersApi* | [**postCreateConsignment**](docs/OrdersApi.md#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment
|
|
201
|
+
*OrdersApi* | [**postCreatePortalOrderLegacy**](docs/OrdersApi.md#postcreateportalorderlegacy) | **POST** /orders/portal/legacy | Create an order via the legacy portal
|
|
201
202
|
*OrdersApi* | [**postCreateShipment**](docs/OrdersApi.md#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)
|
|
202
203
|
*OrdersApi* | [**postGetOrders**](docs/OrdersApi.md#postgetorders) | **POST** /orders | Create An Order (Beta)
|
|
203
204
|
*OrdersApi* | [**postIssueCredit**](docs/OrdersApi.md#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)
|
|
@@ -410,10 +411,12 @@ Class | Method | HTTP request | Description
|
|
|
410
411
|
- [NumberPortRangeRequestDTO](docs/NumberPortRangeRequestDTO.md)
|
|
411
412
|
- [NumberPortsModel](docs/NumberPortsModel.md)
|
|
412
413
|
- [OfflineInstancesEntity](docs/OfflineInstancesEntity.md)
|
|
414
|
+
- [OrderDTO](docs/OrderDTO.md)
|
|
413
415
|
- [OrderDetailsDTO](docs/OrderDetailsDTO.md)
|
|
414
416
|
- [OrderEntity](docs/OrderEntity.md)
|
|
415
417
|
- [OrderItemDTO](docs/OrderItemDTO.md)
|
|
416
418
|
- [OrderRequestModel](docs/OrderRequestModel.md)
|
|
419
|
+
- [OrderResponseDTO](docs/OrderResponseDTO.md)
|
|
417
420
|
- [OrderSummariesModel](docs/OrderSummariesModel.md)
|
|
418
421
|
- [OrderSummaryDTO](docs/OrderSummaryDTO.md)
|
|
419
422
|
- [OrderTotalModel](docs/OrderTotalModel.md)
|
|
@@ -459,6 +462,7 @@ Class | Method | HTTP request | Description
|
|
|
459
462
|
- [ResourceNotReadyException](docs/ResourceNotReadyException.md)
|
|
460
463
|
- [RootAccessModel](docs/RootAccessModel.md)
|
|
461
464
|
- [S3BucketEntity](docs/S3BucketEntity.md)
|
|
465
|
+
- [SbcDTO](docs/SbcDTO.md)
|
|
462
466
|
- [ScannedItemModel](docs/ScannedItemModel.md)
|
|
463
467
|
- [ScopeModel](docs/ScopeModel.md)
|
|
464
468
|
- [ServiceHealthDTO](docs/ServiceHealthDTO.md)
|
|
@@ -471,6 +475,7 @@ Class | Method | HTTP request | Description
|
|
|
471
475
|
- [ShipmentItemModel](docs/ShipmentItemModel.md)
|
|
472
476
|
- [ShipmentModel](docs/ShipmentModel.md)
|
|
473
477
|
- [ShipmentRequestDTO](docs/ShipmentRequestDTO.md)
|
|
478
|
+
- [ShippingAddressDTO](docs/ShippingAddressDTO.md)
|
|
474
479
|
- [ShippingConsignmentModel](docs/ShippingConsignmentModel.md)
|
|
475
480
|
- [ShippingInformationDTO](docs/ShippingInformationDTO.md)
|
|
476
481
|
- [ShippingRequestDTO](docs/ShippingRequestDTO.md)
|
package/api.ts
CHANGED
|
@@ -695,7 +695,19 @@ export interface AdminOrderRequestDTO {
|
|
|
695
695
|
* Send Order Email
|
|
696
696
|
*/
|
|
697
697
|
'sendOrderEmail'?: boolean | null;
|
|
698
|
+
/**
|
|
699
|
+
* Payment Method
|
|
700
|
+
*/
|
|
701
|
+
'paymentMethod'?: AdminOrderRequestDTOPaymentMethodEnum | null;
|
|
698
702
|
}
|
|
703
|
+
|
|
704
|
+
export const AdminOrderRequestDTOPaymentMethodEnum = {
|
|
705
|
+
Card: 'card',
|
|
706
|
+
Bacs: 'bacs'
|
|
707
|
+
} as const;
|
|
708
|
+
|
|
709
|
+
export type AdminOrderRequestDTOPaymentMethodEnum = typeof AdminOrderRequestDTOPaymentMethodEnum[keyof typeof AdminOrderRequestDTOPaymentMethodEnum];
|
|
710
|
+
|
|
699
711
|
/**
|
|
700
712
|
* Admin User
|
|
701
713
|
*/
|
|
@@ -3448,6 +3460,17 @@ export interface OfflineInstancesEntity {
|
|
|
3448
3460
|
*/
|
|
3449
3461
|
'alerted'?: number;
|
|
3450
3462
|
}
|
|
3463
|
+
/**
|
|
3464
|
+
* Legacy Portal Order
|
|
3465
|
+
*/
|
|
3466
|
+
export interface OrderDTO {
|
|
3467
|
+
/**
|
|
3468
|
+
* Basket
|
|
3469
|
+
*/
|
|
3470
|
+
'basket'?: Array<ItemDTO>;
|
|
3471
|
+
'shippingAddress'?: ShippingAddressDTO;
|
|
3472
|
+
'orderDetails'?: OrderDetailsDTO;
|
|
3473
|
+
}
|
|
3451
3474
|
/**
|
|
3452
3475
|
* Order Details
|
|
3453
3476
|
*/
|
|
@@ -3922,6 +3945,23 @@ export const OrderRequestModelSchoolTypeEnum = {
|
|
|
3922
3945
|
|
|
3923
3946
|
export type OrderRequestModelSchoolTypeEnum = typeof OrderRequestModelSchoolTypeEnum[keyof typeof OrderRequestModelSchoolTypeEnum];
|
|
3924
3947
|
|
|
3948
|
+
/**
|
|
3949
|
+
* Legacy Portal Response
|
|
3950
|
+
*/
|
|
3951
|
+
export interface OrderResponseDTO {
|
|
3952
|
+
/**
|
|
3953
|
+
* URL
|
|
3954
|
+
*/
|
|
3955
|
+
'url'?: string | null;
|
|
3956
|
+
/**
|
|
3957
|
+
* Order ID
|
|
3958
|
+
*/
|
|
3959
|
+
'orderID'?: string | null;
|
|
3960
|
+
/**
|
|
3961
|
+
* Unique ID
|
|
3962
|
+
*/
|
|
3963
|
+
'uniqueID'?: string | null;
|
|
3964
|
+
}
|
|
3925
3965
|
/**
|
|
3926
3966
|
* Sales Orders
|
|
3927
3967
|
*/
|
|
@@ -5040,6 +5080,43 @@ export interface S3BucketEntity {
|
|
|
5040
5080
|
*/
|
|
5041
5081
|
'secretAccessKey'?: string;
|
|
5042
5082
|
}
|
|
5083
|
+
/**
|
|
5084
|
+
* Legacy Portal SBC
|
|
5085
|
+
*/
|
|
5086
|
+
export interface SbcDTO {
|
|
5087
|
+
/**
|
|
5088
|
+
* No Config
|
|
5089
|
+
*/
|
|
5090
|
+
'noConfig'?: boolean | null;
|
|
5091
|
+
/**
|
|
5092
|
+
* DHCP
|
|
5093
|
+
*/
|
|
5094
|
+
'dhcp'?: boolean | null;
|
|
5095
|
+
/**
|
|
5096
|
+
* 3CX URL
|
|
5097
|
+
*/
|
|
5098
|
+
'url'?: boolean | null;
|
|
5099
|
+
/**
|
|
5100
|
+
* 3CX SBC Auth Key
|
|
5101
|
+
*/
|
|
5102
|
+
'authKey'?: boolean | null;
|
|
5103
|
+
/**
|
|
5104
|
+
* LAN IP Address
|
|
5105
|
+
*/
|
|
5106
|
+
'ipAddress'?: boolean | null;
|
|
5107
|
+
/**
|
|
5108
|
+
* LAN Subnet Mask
|
|
5109
|
+
*/
|
|
5110
|
+
'subnetMask'?: boolean | null;
|
|
5111
|
+
/**
|
|
5112
|
+
* LAN Default Gateway
|
|
5113
|
+
*/
|
|
5114
|
+
'defaultGateway'?: boolean | null;
|
|
5115
|
+
/**
|
|
5116
|
+
* DNS
|
|
5117
|
+
*/
|
|
5118
|
+
'dns'?: boolean | null;
|
|
5119
|
+
}
|
|
5043
5120
|
/**
|
|
5044
5121
|
* Item MAC & Serial Details
|
|
5045
5122
|
*/
|
|
@@ -5432,6 +5509,43 @@ export const ShipmentRequestDTOCourierEnum = {
|
|
|
5432
5509
|
|
|
5433
5510
|
export type ShipmentRequestDTOCourierEnum = typeof ShipmentRequestDTOCourierEnum[keyof typeof ShipmentRequestDTOCourierEnum];
|
|
5434
5511
|
|
|
5512
|
+
/**
|
|
5513
|
+
* Legacy Portal Shipping Address
|
|
5514
|
+
*/
|
|
5515
|
+
export interface ShippingAddressDTO {
|
|
5516
|
+
/**
|
|
5517
|
+
* Ship Name
|
|
5518
|
+
*/
|
|
5519
|
+
'shipName'?: string | null;
|
|
5520
|
+
/**
|
|
5521
|
+
* Ship Company
|
|
5522
|
+
*/
|
|
5523
|
+
'shipCompany'?: string | null;
|
|
5524
|
+
/**
|
|
5525
|
+
* Ship Address Line 1
|
|
5526
|
+
*/
|
|
5527
|
+
'shipAddress1'?: string | null;
|
|
5528
|
+
/**
|
|
5529
|
+
* Ship Address Line 2
|
|
5530
|
+
*/
|
|
5531
|
+
'shipAddress2'?: string | null;
|
|
5532
|
+
/**
|
|
5533
|
+
* Ship City
|
|
5534
|
+
*/
|
|
5535
|
+
'shipCity'?: string | null;
|
|
5536
|
+
/**
|
|
5537
|
+
* Ship Region
|
|
5538
|
+
*/
|
|
5539
|
+
'shipRegion'?: string | null;
|
|
5540
|
+
/**
|
|
5541
|
+
* Ship Post Code
|
|
5542
|
+
*/
|
|
5543
|
+
'shipPostCode'?: string | null;
|
|
5544
|
+
/**
|
|
5545
|
+
* Ship ISO
|
|
5546
|
+
*/
|
|
5547
|
+
'shipIso'?: string | null;
|
|
5548
|
+
}
|
|
5435
5549
|
export interface ShippingConsignmentModel {
|
|
5436
5550
|
'service'?: ShippingServiceModel;
|
|
5437
5551
|
/**
|
|
@@ -19102,6 +19216,39 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
19102
19216
|
options: localVarRequestOptions,
|
|
19103
19217
|
};
|
|
19104
19218
|
},
|
|
19219
|
+
/**
|
|
19220
|
+
* Create an order via the legacy portal
|
|
19221
|
+
* @summary Create an order via the legacy portal
|
|
19222
|
+
* @param {OrderDTO} [orderDTO] Legacy Portal Order
|
|
19223
|
+
* @param {*} [options] Override http request option.
|
|
19224
|
+
* @throws {RequiredError}
|
|
19225
|
+
*/
|
|
19226
|
+
postCreatePortalOrderLegacy: async (orderDTO?: OrderDTO, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
19227
|
+
const localVarPath = `/orders/portal/legacy`;
|
|
19228
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
19229
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
19230
|
+
let baseOptions;
|
|
19231
|
+
if (configuration) {
|
|
19232
|
+
baseOptions = configuration.baseOptions;
|
|
19233
|
+
}
|
|
19234
|
+
|
|
19235
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
19236
|
+
const localVarHeaderParameter = {} as any;
|
|
19237
|
+
const localVarQueryParameter = {} as any;
|
|
19238
|
+
|
|
19239
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
19240
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
19241
|
+
|
|
19242
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
19243
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
19244
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
19245
|
+
localVarRequestOptions.data = serializeDataIfNeeded(orderDTO, localVarRequestOptions, configuration)
|
|
19246
|
+
|
|
19247
|
+
return {
|
|
19248
|
+
url: toPathString(localVarUrlObj),
|
|
19249
|
+
options: localVarRequestOptions,
|
|
19250
|
+
};
|
|
19251
|
+
},
|
|
19105
19252
|
/**
|
|
19106
19253
|
* Create Shipment (Admin)
|
|
19107
19254
|
* @summary Create Shipment (Admin)
|
|
@@ -19941,6 +20088,19 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
19941
20088
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.postCreateConsignment']?.[localVarOperationServerIndex]?.url;
|
|
19942
20089
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
19943
20090
|
},
|
|
20091
|
+
/**
|
|
20092
|
+
* Create an order via the legacy portal
|
|
20093
|
+
* @summary Create an order via the legacy portal
|
|
20094
|
+
* @param {OrderDTO} [orderDTO] Legacy Portal Order
|
|
20095
|
+
* @param {*} [options] Override http request option.
|
|
20096
|
+
* @throws {RequiredError}
|
|
20097
|
+
*/
|
|
20098
|
+
async postCreatePortalOrderLegacy(orderDTO?: OrderDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderResponseDTO>> {
|
|
20099
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postCreatePortalOrderLegacy(orderDTO, options);
|
|
20100
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
20101
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.postCreatePortalOrderLegacy']?.[localVarOperationServerIndex]?.url;
|
|
20102
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20103
|
+
},
|
|
19944
20104
|
/**
|
|
19945
20105
|
* Create Shipment (Admin)
|
|
19946
20106
|
* @summary Create Shipment (Admin)
|
|
@@ -20336,6 +20496,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
20336
20496
|
postCreateConsignment(id: number, shipmentId: number, shippingRequestDTO?: ShippingRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentDTO> {
|
|
20337
20497
|
return localVarFp.postCreateConsignment(id, shipmentId, shippingRequestDTO, options).then((request) => request(axios, basePath));
|
|
20338
20498
|
},
|
|
20499
|
+
/**
|
|
20500
|
+
* Create an order via the legacy portal
|
|
20501
|
+
* @summary Create an order via the legacy portal
|
|
20502
|
+
* @param {OrderDTO} [orderDTO] Legacy Portal Order
|
|
20503
|
+
* @param {*} [options] Override http request option.
|
|
20504
|
+
* @throws {RequiredError}
|
|
20505
|
+
*/
|
|
20506
|
+
postCreatePortalOrderLegacy(orderDTO?: OrderDTO, options?: RawAxiosRequestConfig): AxiosPromise<OrderResponseDTO> {
|
|
20507
|
+
return localVarFp.postCreatePortalOrderLegacy(orderDTO, options).then((request) => request(axios, basePath));
|
|
20508
|
+
},
|
|
20339
20509
|
/**
|
|
20340
20510
|
* Create Shipment (Admin)
|
|
20341
20511
|
* @summary Create Shipment (Admin)
|
|
@@ -20699,6 +20869,17 @@ export class OrdersApi extends BaseAPI {
|
|
|
20699
20869
|
return OrdersApiFp(this.configuration).postCreateConsignment(id, shipmentId, shippingRequestDTO, options).then((request) => request(this.axios, this.basePath));
|
|
20700
20870
|
}
|
|
20701
20871
|
|
|
20872
|
+
/**
|
|
20873
|
+
* Create an order via the legacy portal
|
|
20874
|
+
* @summary Create an order via the legacy portal
|
|
20875
|
+
* @param {OrderDTO} [orderDTO] Legacy Portal Order
|
|
20876
|
+
* @param {*} [options] Override http request option.
|
|
20877
|
+
* @throws {RequiredError}
|
|
20878
|
+
*/
|
|
20879
|
+
public postCreatePortalOrderLegacy(orderDTO?: OrderDTO, options?: RawAxiosRequestConfig) {
|
|
20880
|
+
return OrdersApiFp(this.configuration).postCreatePortalOrderLegacy(orderDTO, options).then((request) => request(this.axios, this.basePath));
|
|
20881
|
+
}
|
|
20882
|
+
|
|
20702
20883
|
/**
|
|
20703
20884
|
* Create Shipment (Admin)
|
|
20704
20885
|
* @summary Create Shipment (Admin)
|
package/dist/api.d.ts
CHANGED
|
@@ -683,7 +683,16 @@ export interface AdminOrderRequestDTO {
|
|
|
683
683
|
* Send Order Email
|
|
684
684
|
*/
|
|
685
685
|
'sendOrderEmail'?: boolean | null;
|
|
686
|
+
/**
|
|
687
|
+
* Payment Method
|
|
688
|
+
*/
|
|
689
|
+
'paymentMethod'?: AdminOrderRequestDTOPaymentMethodEnum | null;
|
|
686
690
|
}
|
|
691
|
+
export declare const AdminOrderRequestDTOPaymentMethodEnum: {
|
|
692
|
+
readonly Card: "card";
|
|
693
|
+
readonly Bacs: "bacs";
|
|
694
|
+
};
|
|
695
|
+
export type AdminOrderRequestDTOPaymentMethodEnum = typeof AdminOrderRequestDTOPaymentMethodEnum[keyof typeof AdminOrderRequestDTOPaymentMethodEnum];
|
|
687
696
|
/**
|
|
688
697
|
* Admin User
|
|
689
698
|
*/
|
|
@@ -3411,6 +3420,17 @@ export interface OfflineInstancesEntity {
|
|
|
3411
3420
|
*/
|
|
3412
3421
|
'alerted'?: number;
|
|
3413
3422
|
}
|
|
3423
|
+
/**
|
|
3424
|
+
* Legacy Portal Order
|
|
3425
|
+
*/
|
|
3426
|
+
export interface OrderDTO {
|
|
3427
|
+
/**
|
|
3428
|
+
* Basket
|
|
3429
|
+
*/
|
|
3430
|
+
'basket'?: Array<ItemDTO>;
|
|
3431
|
+
'shippingAddress'?: ShippingAddressDTO;
|
|
3432
|
+
'orderDetails'?: OrderDetailsDTO;
|
|
3433
|
+
}
|
|
3414
3434
|
/**
|
|
3415
3435
|
* Order Details
|
|
3416
3436
|
*/
|
|
@@ -3881,6 +3901,23 @@ export declare const OrderRequestModelSchoolTypeEnum: {
|
|
|
3881
3901
|
readonly Secondary: "secondary";
|
|
3882
3902
|
};
|
|
3883
3903
|
export type OrderRequestModelSchoolTypeEnum = typeof OrderRequestModelSchoolTypeEnum[keyof typeof OrderRequestModelSchoolTypeEnum];
|
|
3904
|
+
/**
|
|
3905
|
+
* Legacy Portal Response
|
|
3906
|
+
*/
|
|
3907
|
+
export interface OrderResponseDTO {
|
|
3908
|
+
/**
|
|
3909
|
+
* URL
|
|
3910
|
+
*/
|
|
3911
|
+
'url'?: string | null;
|
|
3912
|
+
/**
|
|
3913
|
+
* Order ID
|
|
3914
|
+
*/
|
|
3915
|
+
'orderID'?: string | null;
|
|
3916
|
+
/**
|
|
3917
|
+
* Unique ID
|
|
3918
|
+
*/
|
|
3919
|
+
'uniqueID'?: string | null;
|
|
3920
|
+
}
|
|
3884
3921
|
/**
|
|
3885
3922
|
* Sales Orders
|
|
3886
3923
|
*/
|
|
@@ -4987,6 +5024,43 @@ export interface S3BucketEntity {
|
|
|
4987
5024
|
*/
|
|
4988
5025
|
'secretAccessKey'?: string;
|
|
4989
5026
|
}
|
|
5027
|
+
/**
|
|
5028
|
+
* Legacy Portal SBC
|
|
5029
|
+
*/
|
|
5030
|
+
export interface SbcDTO {
|
|
5031
|
+
/**
|
|
5032
|
+
* No Config
|
|
5033
|
+
*/
|
|
5034
|
+
'noConfig'?: boolean | null;
|
|
5035
|
+
/**
|
|
5036
|
+
* DHCP
|
|
5037
|
+
*/
|
|
5038
|
+
'dhcp'?: boolean | null;
|
|
5039
|
+
/**
|
|
5040
|
+
* 3CX URL
|
|
5041
|
+
*/
|
|
5042
|
+
'url'?: boolean | null;
|
|
5043
|
+
/**
|
|
5044
|
+
* 3CX SBC Auth Key
|
|
5045
|
+
*/
|
|
5046
|
+
'authKey'?: boolean | null;
|
|
5047
|
+
/**
|
|
5048
|
+
* LAN IP Address
|
|
5049
|
+
*/
|
|
5050
|
+
'ipAddress'?: boolean | null;
|
|
5051
|
+
/**
|
|
5052
|
+
* LAN Subnet Mask
|
|
5053
|
+
*/
|
|
5054
|
+
'subnetMask'?: boolean | null;
|
|
5055
|
+
/**
|
|
5056
|
+
* LAN Default Gateway
|
|
5057
|
+
*/
|
|
5058
|
+
'defaultGateway'?: boolean | null;
|
|
5059
|
+
/**
|
|
5060
|
+
* DNS
|
|
5061
|
+
*/
|
|
5062
|
+
'dns'?: boolean | null;
|
|
5063
|
+
}
|
|
4990
5064
|
/**
|
|
4991
5065
|
* Item MAC & Serial Details
|
|
4992
5066
|
*/
|
|
@@ -5367,6 +5441,43 @@ export declare const ShipmentRequestDTOCourierEnum: {
|
|
|
5367
5441
|
readonly Pops: "POPS";
|
|
5368
5442
|
};
|
|
5369
5443
|
export type ShipmentRequestDTOCourierEnum = typeof ShipmentRequestDTOCourierEnum[keyof typeof ShipmentRequestDTOCourierEnum];
|
|
5444
|
+
/**
|
|
5445
|
+
* Legacy Portal Shipping Address
|
|
5446
|
+
*/
|
|
5447
|
+
export interface ShippingAddressDTO {
|
|
5448
|
+
/**
|
|
5449
|
+
* Ship Name
|
|
5450
|
+
*/
|
|
5451
|
+
'shipName'?: string | null;
|
|
5452
|
+
/**
|
|
5453
|
+
* Ship Company
|
|
5454
|
+
*/
|
|
5455
|
+
'shipCompany'?: string | null;
|
|
5456
|
+
/**
|
|
5457
|
+
* Ship Address Line 1
|
|
5458
|
+
*/
|
|
5459
|
+
'shipAddress1'?: string | null;
|
|
5460
|
+
/**
|
|
5461
|
+
* Ship Address Line 2
|
|
5462
|
+
*/
|
|
5463
|
+
'shipAddress2'?: string | null;
|
|
5464
|
+
/**
|
|
5465
|
+
* Ship City
|
|
5466
|
+
*/
|
|
5467
|
+
'shipCity'?: string | null;
|
|
5468
|
+
/**
|
|
5469
|
+
* Ship Region
|
|
5470
|
+
*/
|
|
5471
|
+
'shipRegion'?: string | null;
|
|
5472
|
+
/**
|
|
5473
|
+
* Ship Post Code
|
|
5474
|
+
*/
|
|
5475
|
+
'shipPostCode'?: string | null;
|
|
5476
|
+
/**
|
|
5477
|
+
* Ship ISO
|
|
5478
|
+
*/
|
|
5479
|
+
'shipIso'?: string | null;
|
|
5480
|
+
}
|
|
5370
5481
|
export interface ShippingConsignmentModel {
|
|
5371
5482
|
'service'?: ShippingServiceModel;
|
|
5372
5483
|
/**
|
|
@@ -13221,6 +13332,14 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
13221
13332
|
* @throws {RequiredError}
|
|
13222
13333
|
*/
|
|
13223
13334
|
postCreateConsignment: (id: number, shipmentId: number, shippingRequestDTO?: ShippingRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13335
|
+
/**
|
|
13336
|
+
* Create an order via the legacy portal
|
|
13337
|
+
* @summary Create an order via the legacy portal
|
|
13338
|
+
* @param {OrderDTO} [orderDTO] Legacy Portal Order
|
|
13339
|
+
* @param {*} [options] Override http request option.
|
|
13340
|
+
* @throws {RequiredError}
|
|
13341
|
+
*/
|
|
13342
|
+
postCreatePortalOrderLegacy: (orderDTO?: OrderDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13224
13343
|
/**
|
|
13225
13344
|
* Create Shipment (Admin)
|
|
13226
13345
|
* @summary Create Shipment (Admin)
|
|
@@ -13507,6 +13626,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
13507
13626
|
* @throws {RequiredError}
|
|
13508
13627
|
*/
|
|
13509
13628
|
postCreateConsignment(id: number, shipmentId: number, shippingRequestDTO?: ShippingRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentDTO>>;
|
|
13629
|
+
/**
|
|
13630
|
+
* Create an order via the legacy portal
|
|
13631
|
+
* @summary Create an order via the legacy portal
|
|
13632
|
+
* @param {OrderDTO} [orderDTO] Legacy Portal Order
|
|
13633
|
+
* @param {*} [options] Override http request option.
|
|
13634
|
+
* @throws {RequiredError}
|
|
13635
|
+
*/
|
|
13636
|
+
postCreatePortalOrderLegacy(orderDTO?: OrderDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderResponseDTO>>;
|
|
13510
13637
|
/**
|
|
13511
13638
|
* Create Shipment (Admin)
|
|
13512
13639
|
* @summary Create Shipment (Admin)
|
|
@@ -13793,6 +13920,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
13793
13920
|
* @throws {RequiredError}
|
|
13794
13921
|
*/
|
|
13795
13922
|
postCreateConsignment(id: number, shipmentId: number, shippingRequestDTO?: ShippingRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentDTO>;
|
|
13923
|
+
/**
|
|
13924
|
+
* Create an order via the legacy portal
|
|
13925
|
+
* @summary Create an order via the legacy portal
|
|
13926
|
+
* @param {OrderDTO} [orderDTO] Legacy Portal Order
|
|
13927
|
+
* @param {*} [options] Override http request option.
|
|
13928
|
+
* @throws {RequiredError}
|
|
13929
|
+
*/
|
|
13930
|
+
postCreatePortalOrderLegacy(orderDTO?: OrderDTO, options?: RawAxiosRequestConfig): AxiosPromise<OrderResponseDTO>;
|
|
13796
13931
|
/**
|
|
13797
13932
|
* Create Shipment (Admin)
|
|
13798
13933
|
* @summary Create Shipment (Admin)
|
|
@@ -14079,6 +14214,14 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
14079
14214
|
* @throws {RequiredError}
|
|
14080
14215
|
*/
|
|
14081
14216
|
postCreateConsignment(id: number, shipmentId: number, shippingRequestDTO?: ShippingRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShipmentDTO, any, {}>>;
|
|
14217
|
+
/**
|
|
14218
|
+
* Create an order via the legacy portal
|
|
14219
|
+
* @summary Create an order via the legacy portal
|
|
14220
|
+
* @param {OrderDTO} [orderDTO] Legacy Portal Order
|
|
14221
|
+
* @param {*} [options] Override http request option.
|
|
14222
|
+
* @throws {RequiredError}
|
|
14223
|
+
*/
|
|
14224
|
+
postCreatePortalOrderLegacy(orderDTO?: OrderDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderResponseDTO, any, {}>>;
|
|
14082
14225
|
/**
|
|
14083
14226
|
* Create Shipment (Admin)
|
|
14084
14227
|
* @summary Create Shipment (Admin)
|
package/dist/api.js
CHANGED
|
@@ -84,16 +84,20 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
|
|
|
84
84
|
return to.concat(ar || Array.prototype.slice.call(from));
|
|
85
85
|
};
|
|
86
86
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
87
|
-
exports.
|
|
88
|
-
exports.
|
|
89
|
-
exports.
|
|
90
|
-
exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = void 0;
|
|
87
|
+
exports.Class3CXApiAxiosParamCreator = exports.GetGetCrmActivitiesTypeEnum = exports.CRMApi = exports.CRMApiFactory = exports.CRMApiFp = exports.CRMApiAxiosParamCreator = exports.PatchSetPrizePromoStateEnum = exports.PatchSetPortalAccessStateEnum = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.UpgradeRequestModelSchoolTypeEnum = exports.UpgradeRequestModelLicenceTypeEnum = exports.TcxWizardModelInstallationStatusEnum = exports.TcxWizardModelInstallTypeEnum = exports.TcxSetupEntityRegionEnum = exports.TcxSetupEntityInstallTypeEnum = exports.TcxMultiTenantModelPackageEnum = exports.StockOrderModelPaidEnum = exports.StockOrderModelDeliveryMethodEnum = exports.SmsResponseModelEventTypeEnum = exports.SmsPhoneNumberModelStatusEnum = exports.SmsAccountRequestDTOTypeEnum = exports.SmsAccountRequestDTOProviderEnum = exports.SipTrunkChangeResponseModelTypeEnum = exports.ShippingServiceModelCourierEnum = exports.ShippingServiceDTOCourierEnum = exports.ShippingRequestDTOPrinterEnum = exports.ShippingRequestDTOCourierEnum = exports.ShipmentRequestDTOCourierEnum = exports.ShipmentDTOCourierEnum = exports.ServiceStatusDTOStatusEnum = exports.ServiceHealthDTOGlobalStatusEnum = exports.ProspectDTOStatusEnum = exports.PatchUpdateTcxHostingPriceListRequestPriceListEnum = exports.PatchUpdatePriceListRequestPriceListEnum = exports.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.ItemDiscountEntityTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.EventDTOStatusEnum = exports.DivertResponseModelStatusEnum = exports.AuditLogEntityTypeEnum = exports.AuditLogEntityActionEnum = exports.AdminUserModelRoleEnum = exports.AdminOrderRequestDTOPaymentMethodEnum = void 0;
|
|
88
|
+
exports.PostPrintShippingLabelPrinterEnum = exports.GetGetOrdersFilterEnum = exports.GetGetOrdersStatusEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.PostAuthoriseScopeEnum = exports.PostAccessTokenTokenExchangeTypeEnum = exports.PostAccessTokenScopeEnum = exports.PostAccessTokenGrantTypeEnum = exports.OAuth20Api = exports.OAuth20ApiFactory = exports.OAuth20ApiFp = exports.OAuth20ApiAxiosParamCreator = exports.NumberPortingApi = exports.NumberPortingApiFactory = exports.NumberPortingApiFp = exports.NumberPortingApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = exports.GetGetTenantsStatusEnum = exports.Class3CXMultiTenantApi = exports.Class3CXMultiTenantApiFactory = exports.Class3CXMultiTenantApiFp = exports.Class3CXMultiTenantApiAxiosParamCreator = exports.GetGetPriceSchoolTypeEnum = exports.GetGetPriceLicenceTypeEnum = exports.Class3CXIntegrationsApi = exports.Class3CXIntegrationsApiFactory = exports.Class3CXIntegrationsApiFp = exports.Class3CXIntegrationsApiAxiosParamCreator = exports.PostResizeInstanceSizeEnum = exports.PostFailoverInstanceTypeEnum = exports.GetGetInstallationsInstallTypeEnum = exports.GetGetInstallationsHostingEnum = exports.GetGetInstallationsStatusEnum = exports.Class3CXInstallationsApi = exports.Class3CXInstallationsApiFactory = exports.Class3CXInstallationsApiFp = exports.Class3CXInstallationsApiAxiosParamCreator = exports.Class3CXInstallationWizardApi = exports.Class3CXInstallationWizardApiFactory = exports.Class3CXInstallationWizardApiFp = exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = exports.Class3CXApiFactory = exports.Class3CXApiFp = void 0;
|
|
89
|
+
exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.ServicesApi = exports.ServicesApiFactory = exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = exports.SMSApiAxiosParamCreator = exports.SIPTrunksApi = exports.SIPTrunksApiFactory = exports.SIPTrunksApiFp = exports.SIPTrunksApiAxiosParamCreator = exports.ProvisioningApi = exports.ProvisioningApiFactory = exports.ProvisioningApiFp = exports.ProvisioningApiAxiosParamCreator = exports.ProspectsApi = exports.ProspectsApiFactory = exports.ProspectsApiFp = exports.ProspectsApiAxiosParamCreator = exports.GetGetLegacyStockListFormatEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.PostSendPriceListCategoryEnum = exports.PostSendPriceListFormatEnum = exports.PostSendPriceListTypeEnum = exports.GetGetPriceListCategoryEnum = exports.GetGetPriceListFormatEnum = exports.GetGetPriceListTypeEnum = exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = void 0;
|
|
90
|
+
exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = void 0;
|
|
91
91
|
var axios_1 = require("axios");
|
|
92
92
|
// Some imports not used depending on template conditions
|
|
93
93
|
// @ts-ignore
|
|
94
94
|
var common_1 = require("./common");
|
|
95
95
|
// @ts-ignore
|
|
96
96
|
var base_1 = require("./base");
|
|
97
|
+
exports.AdminOrderRequestDTOPaymentMethodEnum = {
|
|
98
|
+
Card: 'card',
|
|
99
|
+
Bacs: 'bacs'
|
|
100
|
+
};
|
|
97
101
|
exports.AdminUserModelRoleEnum = {
|
|
98
102
|
NUMBER_0: 0,
|
|
99
103
|
NUMBER_1: 1,
|
|
@@ -12996,6 +13000,43 @@ var OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
12996
13000
|
});
|
|
12997
13001
|
});
|
|
12998
13002
|
},
|
|
13003
|
+
/**
|
|
13004
|
+
* Create an order via the legacy portal
|
|
13005
|
+
* @summary Create an order via the legacy portal
|
|
13006
|
+
* @param {OrderDTO} [orderDTO] Legacy Portal Order
|
|
13007
|
+
* @param {*} [options] Override http request option.
|
|
13008
|
+
* @throws {RequiredError}
|
|
13009
|
+
*/
|
|
13010
|
+
postCreatePortalOrderLegacy: function (orderDTO_1) {
|
|
13011
|
+
var args_1 = [];
|
|
13012
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
13013
|
+
args_1[_i - 1] = arguments[_i];
|
|
13014
|
+
}
|
|
13015
|
+
return __awaiter(_this, __spreadArray([orderDTO_1], args_1, true), void 0, function (orderDTO, options) {
|
|
13016
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
13017
|
+
if (options === void 0) { options = {}; }
|
|
13018
|
+
return __generator(this, function (_a) {
|
|
13019
|
+
localVarPath = "/orders/portal/legacy";
|
|
13020
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
13021
|
+
if (configuration) {
|
|
13022
|
+
baseOptions = configuration.baseOptions;
|
|
13023
|
+
}
|
|
13024
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
13025
|
+
localVarHeaderParameter = {};
|
|
13026
|
+
localVarQueryParameter = {};
|
|
13027
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
13028
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
13029
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
13030
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13031
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
13032
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(orderDTO, localVarRequestOptions, configuration);
|
|
13033
|
+
return [2 /*return*/, {
|
|
13034
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
13035
|
+
options: localVarRequestOptions,
|
|
13036
|
+
}];
|
|
13037
|
+
});
|
|
13038
|
+
});
|
|
13039
|
+
},
|
|
12999
13040
|
/**
|
|
13000
13041
|
* Create Shipment (Admin)
|
|
13001
13042
|
* @summary Create Shipment (Admin)
|
|
@@ -14037,6 +14078,29 @@ var OrdersApiFp = function (configuration) {
|
|
|
14037
14078
|
});
|
|
14038
14079
|
});
|
|
14039
14080
|
},
|
|
14081
|
+
/**
|
|
14082
|
+
* Create an order via the legacy portal
|
|
14083
|
+
* @summary Create an order via the legacy portal
|
|
14084
|
+
* @param {OrderDTO} [orderDTO] Legacy Portal Order
|
|
14085
|
+
* @param {*} [options] Override http request option.
|
|
14086
|
+
* @throws {RequiredError}
|
|
14087
|
+
*/
|
|
14088
|
+
postCreatePortalOrderLegacy: function (orderDTO, options) {
|
|
14089
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
14090
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
14091
|
+
var _a, _b, _c;
|
|
14092
|
+
return __generator(this, function (_d) {
|
|
14093
|
+
switch (_d.label) {
|
|
14094
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postCreatePortalOrderLegacy(orderDTO, options)];
|
|
14095
|
+
case 1:
|
|
14096
|
+
localVarAxiosArgs = _d.sent();
|
|
14097
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
14098
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.postCreatePortalOrderLegacy']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
14099
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
14100
|
+
}
|
|
14101
|
+
});
|
|
14102
|
+
});
|
|
14103
|
+
},
|
|
14040
14104
|
/**
|
|
14041
14105
|
* Create Shipment (Admin)
|
|
14042
14106
|
* @summary Create Shipment (Admin)
|
|
@@ -14582,6 +14646,16 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
14582
14646
|
postCreateConsignment: function (id, shipmentId, shippingRequestDTO, options) {
|
|
14583
14647
|
return localVarFp.postCreateConsignment(id, shipmentId, shippingRequestDTO, options).then(function (request) { return request(axios, basePath); });
|
|
14584
14648
|
},
|
|
14649
|
+
/**
|
|
14650
|
+
* Create an order via the legacy portal
|
|
14651
|
+
* @summary Create an order via the legacy portal
|
|
14652
|
+
* @param {OrderDTO} [orderDTO] Legacy Portal Order
|
|
14653
|
+
* @param {*} [options] Override http request option.
|
|
14654
|
+
* @throws {RequiredError}
|
|
14655
|
+
*/
|
|
14656
|
+
postCreatePortalOrderLegacy: function (orderDTO, options) {
|
|
14657
|
+
return localVarFp.postCreatePortalOrderLegacy(orderDTO, options).then(function (request) { return request(axios, basePath); });
|
|
14658
|
+
},
|
|
14585
14659
|
/**
|
|
14586
14660
|
* Create Shipment (Admin)
|
|
14587
14661
|
* @summary Create Shipment (Admin)
|
|
@@ -14949,6 +15023,17 @@ var OrdersApi = /** @class */ (function (_super) {
|
|
|
14949
15023
|
var _this = this;
|
|
14950
15024
|
return (0, exports.OrdersApiFp)(this.configuration).postCreateConsignment(id, shipmentId, shippingRequestDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
14951
15025
|
};
|
|
15026
|
+
/**
|
|
15027
|
+
* Create an order via the legacy portal
|
|
15028
|
+
* @summary Create an order via the legacy portal
|
|
15029
|
+
* @param {OrderDTO} [orderDTO] Legacy Portal Order
|
|
15030
|
+
* @param {*} [options] Override http request option.
|
|
15031
|
+
* @throws {RequiredError}
|
|
15032
|
+
*/
|
|
15033
|
+
OrdersApi.prototype.postCreatePortalOrderLegacy = function (orderDTO, options) {
|
|
15034
|
+
var _this = this;
|
|
15035
|
+
return (0, exports.OrdersApiFp)(this.configuration).postCreatePortalOrderLegacy(orderDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
15036
|
+
};
|
|
14952
15037
|
/**
|
|
14953
15038
|
* Create Shipment (Admin)
|
|
14954
15039
|
* @summary Create Shipment (Admin)
|
|
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**includeNfrPromos** | **boolean** | Include NFR Promos | [optional] [default to false]
|
|
21
21
|
**carriageCharge** | **number** | Carriage Charge | [optional] [default to undefined]
|
|
22
22
|
**sendOrderEmail** | **boolean** | Send Order Email | [optional] [default to undefined]
|
|
23
|
+
**paymentMethod** | **string** | Payment Method | [optional] [default to undefined]
|
|
23
24
|
|
|
24
25
|
## Example
|
|
25
26
|
|
|
@@ -41,6 +42,7 @@ const instance: AdminOrderRequestDTO = {
|
|
|
41
42
|
includeNfrPromos,
|
|
42
43
|
carriageCharge,
|
|
43
44
|
sendOrderEmail,
|
|
45
|
+
paymentMethod,
|
|
44
46
|
};
|
|
45
47
|
```
|
|
46
48
|
|
package/docs/OrderDTO.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# OrderDTO
|
|
2
|
+
|
|
3
|
+
Legacy Portal Order
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**basket** | [**Array<ItemDTO>**](ItemDTO.md) | Basket | [optional] [default to undefined]
|
|
10
|
+
**shippingAddress** | [**ShippingAddressDTO**](ShippingAddressDTO.md) | | [optional] [default to undefined]
|
|
11
|
+
**orderDetails** | [**OrderDetailsDTO**](OrderDetailsDTO.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { OrderDTO } from 'yellowgrid-api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: OrderDTO = {
|
|
19
|
+
basket,
|
|
20
|
+
shippingAddress,
|
|
21
|
+
orderDetails,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# OrderResponseDTO
|
|
2
|
+
|
|
3
|
+
Legacy Portal Response
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**url** | **string** | URL | [optional] [default to undefined]
|
|
10
|
+
**orderID** | **string** | Order ID | [optional] [default to undefined]
|
|
11
|
+
**uniqueID** | **string** | Unique ID | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { OrderResponseDTO } from 'yellowgrid-api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: OrderResponseDTO = {
|
|
19
|
+
url,
|
|
20
|
+
orderID,
|
|
21
|
+
uniqueID,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[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/OrdersApi.md
CHANGED
|
@@ -19,6 +19,7 @@ All URIs are relative to *https://localhost*
|
|
|
19
19
|
|[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
|
|
20
20
|
|[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
|
|
21
21
|
|[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
|
|
22
|
+
|[**postCreatePortalOrderLegacy**](#postcreateportalorderlegacy) | **POST** /orders/portal/legacy | Create an order via the legacy portal|
|
|
22
23
|
|[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
|
|
23
24
|
|[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
|
|
24
25
|
|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
|
|
@@ -896,6 +897,61 @@ No authorization required
|
|
|
896
897
|
|
|
897
898
|
[[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)
|
|
898
899
|
|
|
900
|
+
# **postCreatePortalOrderLegacy**
|
|
901
|
+
> OrderResponseDTO postCreatePortalOrderLegacy()
|
|
902
|
+
|
|
903
|
+
Create an order via the legacy portal
|
|
904
|
+
|
|
905
|
+
### Example
|
|
906
|
+
|
|
907
|
+
```typescript
|
|
908
|
+
import {
|
|
909
|
+
OrdersApi,
|
|
910
|
+
Configuration,
|
|
911
|
+
OrderDTO
|
|
912
|
+
} from 'yellowgrid-api-ts';
|
|
913
|
+
|
|
914
|
+
const configuration = new Configuration();
|
|
915
|
+
const apiInstance = new OrdersApi(configuration);
|
|
916
|
+
|
|
917
|
+
let orderDTO: OrderDTO; //Legacy Portal Order (optional)
|
|
918
|
+
|
|
919
|
+
const { status, data } = await apiInstance.postCreatePortalOrderLegacy(
|
|
920
|
+
orderDTO
|
|
921
|
+
);
|
|
922
|
+
```
|
|
923
|
+
|
|
924
|
+
### Parameters
|
|
925
|
+
|
|
926
|
+
|Name | Type | Description | Notes|
|
|
927
|
+
|------------- | ------------- | ------------- | -------------|
|
|
928
|
+
| **orderDTO** | **OrderDTO**| Legacy Portal Order | |
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
### Return type
|
|
932
|
+
|
|
933
|
+
**OrderResponseDTO**
|
|
934
|
+
|
|
935
|
+
### Authorization
|
|
936
|
+
|
|
937
|
+
No authorization required
|
|
938
|
+
|
|
939
|
+
### HTTP request headers
|
|
940
|
+
|
|
941
|
+
- **Content-Type**: application/json
|
|
942
|
+
- **Accept**: application/json
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
### HTTP response details
|
|
946
|
+
| Status code | Description | Response headers |
|
|
947
|
+
|-------------|-------------|------------------|
|
|
948
|
+
|**200** | Legacy Portal Order Response | - |
|
|
949
|
+
|**400** | Bad Request | - |
|
|
950
|
+
|**401** | Unauthorised | - |
|
|
951
|
+
|**403** | Access Denied | - |
|
|
952
|
+
|
|
953
|
+
[[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)
|
|
954
|
+
|
|
899
955
|
# **postCreateShipment**
|
|
900
956
|
> ShipmentDTO postCreateShipment()
|
|
901
957
|
|
package/docs/SbcDTO.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# SbcDTO
|
|
2
|
+
|
|
3
|
+
Legacy Portal SBC
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**noConfig** | **boolean** | No Config | [optional] [default to undefined]
|
|
10
|
+
**dhcp** | **boolean** | DHCP | [optional] [default to undefined]
|
|
11
|
+
**url** | **boolean** | 3CX URL | [optional] [default to undefined]
|
|
12
|
+
**authKey** | **boolean** | 3CX SBC Auth Key | [optional] [default to undefined]
|
|
13
|
+
**ipAddress** | **boolean** | LAN IP Address | [optional] [default to undefined]
|
|
14
|
+
**subnetMask** | **boolean** | LAN Subnet Mask | [optional] [default to undefined]
|
|
15
|
+
**defaultGateway** | **boolean** | LAN Default Gateway | [optional] [default to undefined]
|
|
16
|
+
**dns** | **boolean** | DNS | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { SbcDTO } from 'yellowgrid-api-ts';
|
|
22
|
+
|
|
23
|
+
const instance: SbcDTO = {
|
|
24
|
+
noConfig,
|
|
25
|
+
dhcp,
|
|
26
|
+
url,
|
|
27
|
+
authKey,
|
|
28
|
+
ipAddress,
|
|
29
|
+
subnetMask,
|
|
30
|
+
defaultGateway,
|
|
31
|
+
dns,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# ShippingAddressDTO
|
|
2
|
+
|
|
3
|
+
Legacy Portal Shipping Address
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**shipName** | **string** | Ship Name | [optional] [default to undefined]
|
|
10
|
+
**shipCompany** | **string** | Ship Company | [optional] [default to undefined]
|
|
11
|
+
**shipAddress1** | **string** | Ship Address Line 1 | [optional] [default to undefined]
|
|
12
|
+
**shipAddress2** | **string** | Ship Address Line 2 | [optional] [default to undefined]
|
|
13
|
+
**shipCity** | **string** | Ship City | [optional] [default to undefined]
|
|
14
|
+
**shipRegion** | **string** | Ship Region | [optional] [default to undefined]
|
|
15
|
+
**shipPostCode** | **string** | Ship Post Code | [optional] [default to undefined]
|
|
16
|
+
**shipIso** | **string** | Ship ISO | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { ShippingAddressDTO } from 'yellowgrid-api-ts';
|
|
22
|
+
|
|
23
|
+
const instance: ShippingAddressDTO = {
|
|
24
|
+
shipName,
|
|
25
|
+
shipCompany,
|
|
26
|
+
shipAddress1,
|
|
27
|
+
shipAddress2,
|
|
28
|
+
shipCity,
|
|
29
|
+
shipRegion,
|
|
30
|
+
shipPostCode,
|
|
31
|
+
shipIso,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|