yellowgrid-api-ts 3.2.61-dev.0 → 3.2.61

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.
Files changed (69) hide show
  1. package/.openapi-generator/FILES +229 -249
  2. package/README.md +1 -36
  3. package/api.ts +212 -2463
  4. package/base.ts +2 -2
  5. package/common.ts +1 -1
  6. package/config.json +3 -3
  7. package/configuration.ts +1 -1
  8. package/dist/api.d.ts +104 -1769
  9. package/dist/api.js +94 -1480
  10. package/dist/base.d.ts +1 -1
  11. package/dist/base.js +2 -2
  12. package/dist/common.d.ts +1 -1
  13. package/dist/common.js +1 -1
  14. package/dist/configuration.d.ts +1 -1
  15. package/dist/configuration.js +1 -1
  16. package/dist/index.d.ts +1 -1
  17. package/dist/index.js +1 -1
  18. package/docs/AccountsApi.md +1 -1
  19. package/docs/CRMApi.md +1 -1
  20. package/docs/Class3CXApi.md +1 -1
  21. package/docs/Class3CXInstallationWizardApi.md +1 -1
  22. package/docs/Class3CXInstallationsApi.md +1 -1
  23. package/docs/Class3CXIntegrationsApi.md +1 -1
  24. package/docs/Class3CXMultiTenantApi.md +1 -1
  25. package/docs/MyPBXToolsApi.md +1 -1
  26. package/docs/OAuth20Api.md +1 -1
  27. package/docs/OrdersApi.md +23 -861
  28. package/docs/PricingApi.md +1 -1
  29. package/docs/ProductsApi.md +1 -1
  30. package/docs/ProvisioningApi.md +1 -1
  31. package/docs/SIPTrunksApi.md +1 -1
  32. package/docs/SMSApi.md +1 -1
  33. package/docs/ServicesApi.md +1 -1
  34. package/docs/ShippingApi.md +1 -1
  35. package/docs/StockManagementApi.md +1 -1
  36. package/docs/SystemApi.md +1 -1
  37. package/docs/TicketsApi.md +1 -1
  38. package/docs/WebhooksApi.md +1 -1
  39. package/getEnums.php +31 -31
  40. package/index.ts +1 -1
  41. package/package.json +1 -1
  42. package/dist/models/CourierEnum.d.ts +0 -18
  43. package/dist/models/CourierEnum.js +0 -20
  44. package/dist/models/PrinterEnum.d.ts +0 -18
  45. package/dist/models/PrinterEnum.js +0 -20
  46. package/docs/BatchDTO.md +0 -59
  47. package/docs/CreditNoteDTO.md +0 -21
  48. package/docs/CreditNoteEntity.md +0 -29
  49. package/docs/CreditNoteItemDTO.md +0 -25
  50. package/docs/CreditNoteItemEntity.md +0 -29
  51. package/docs/CreditNoteModel.md +0 -29
  52. package/docs/OrderDetailsDTO.md +0 -63
  53. package/docs/OrderItemDTO.md +0 -53
  54. package/docs/OrderedItemModel.md +0 -47
  55. package/docs/PostAddOrderNoteRequest.md +0 -20
  56. package/docs/PostSplitOrderRequest.md +0 -20
  57. package/docs/PrinterEntity.md +0 -29
  58. package/docs/PutAllocateItemsRequest.md +0 -20
  59. package/docs/PutAllocateItemsRequestItemsInner.md +0 -22
  60. package/docs/ShipmentDTO.md +0 -31
  61. package/docs/ShipmentItemDTO.md +0 -23
  62. package/docs/ShipmentItemModel.md +0 -29
  63. package/docs/ShipmentModel.md +0 -43
  64. package/docs/ShipmentRequestDTO.md +0 -31
  65. package/docs/ShippingRequestDTO.md +0 -24
  66. package/docs/SupplierModel.md +0 -37
  67. package/hs_err_pid58424.log +0 -247
  68. package/models/CourierEnum.ts +0 -19
  69. package/models/PrinterEnum.ts +0 -19
package/dist/api.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Yellowgrid
3
- * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
3
+ * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
4
4
  *
5
5
  * The version of the OpenAPI document: 0
6
6
  *
@@ -1016,13 +1016,13 @@ export interface AuditLogEntity {
1016
1016
  * @type {string}
1017
1017
  * @memberof AuditLogEntity
1018
1018
  */
1019
- 'action'?: AuditLogEntityActionEnum;
1019
+ 'action'?: string;
1020
1020
  /**
1021
1021
  * type
1022
1022
  * @type {string}
1023
1023
  * @memberof AuditLogEntity
1024
1024
  */
1025
- 'type'?: AuditLogEntityTypeEnum;
1025
+ 'type'?: string;
1026
1026
  /**
1027
1027
  * identifier
1028
1028
  * @type {string}
@@ -1060,89 +1060,6 @@ export interface AuditLogEntity {
1060
1060
  */
1061
1061
  'description'?: string;
1062
1062
  }
1063
- export declare const AuditLogEntityActionEnum: {
1064
- readonly Create: "CREATE";
1065
- readonly Read: "READ";
1066
- readonly Update: "UPDATE";
1067
- readonly Delete: "DELETE";
1068
- };
1069
- export type AuditLogEntityActionEnum = typeof AuditLogEntityActionEnum[keyof typeof AuditLogEntityActionEnum];
1070
- export declare const AuditLogEntityTypeEnum: {
1071
- readonly AuditLog: "audit_log";
1072
- readonly PopsOrders: "pops_orders";
1073
- readonly PopsAccountContacts: "pops_account_contacts";
1074
- readonly ApiLog: "api_log";
1075
- readonly PopsBatches: "pops_batches";
1076
- readonly PopsCourierPrices: "pops_courier_prices";
1077
- readonly PopsCreditAccounts: "pops_credit_accounts";
1078
- readonly PopsCreditNotes: "pops_credit_notes";
1079
- readonly PopsCreditNotesItems: "pops_credit_notes_items";
1080
- readonly EdtechproClients: "edtechpro_clients";
1081
- readonly EdtechproSchools: "edtechpro_schools";
1082
- readonly FreshdeskTickets: "freshdesk_tickets";
1083
- readonly PopsFtpAccounts: "pops_ftp_accounts";
1084
- readonly ServiceEvents: "service_events";
1085
- readonly ServiceEventUpdates: "service_event_updates";
1086
- readonly ServiceEventSubscriptions: "service_event_subscriptions";
1087
- readonly PopsInstanceFailoverIps: "pops_instance_failover_ips";
1088
- readonly PopsOvhDeleteSchedule: "pops_ovh_delete_schedule";
1089
- readonly PopsOvhInstances: "pops_ovh_instances";
1090
- readonly PopsInstanceFailover: "pops_instance_failover";
1091
- readonly PopsInstanceMonitoring: "pops_instance_monitoring";
1092
- readonly PopsInstanceMonitoringLog: "pops_instance_monitoring_log";
1093
- readonly PopsInstanceScheduledTasks: "pops_instance_scheduled_tasks";
1094
- readonly PopsInstance3cxDetails: "pops_instance_3cx_details";
1095
- readonly PopsInstanceUserCredentials: "pops_instance_user_credentials";
1096
- readonly IpBlacklist: "ip_blacklist";
1097
- readonly PopsItemDiscounts: "pops_item_discounts";
1098
- readonly PopsItems: "pops_items";
1099
- readonly PopsLinkedOrders: "pops_linked_orders";
1100
- readonly PopsOfflineInstances: "pops_offline_instances";
1101
- readonly PopsOrderedItems: "pops_ordered_items";
1102
- readonly PopsPrizes: "pops_prizes";
1103
- readonly PopsPrinters: "pops_printers";
1104
- readonly PopsPromoCodes: "pops_promo_codes";
1105
- readonly PopsPromoItems: "pops_promo_items";
1106
- readonly PopsProvisioning: "pops_provisioning";
1107
- readonly S3Buckets: "s3_buckets";
1108
- readonly PopsShipmentAddress: "pops_shipment_address";
1109
- readonly PopsShipments: "pops_shipments";
1110
- readonly PopsShipmentItems: "pops_shipment_items";
1111
- readonly PopsSipTrunkChangeQueue: "pops_sip_trunk_change_queue";
1112
- readonly PopsSipTrunks: "pops_sip_trunks";
1113
- readonly PopsSms: "pops_sms";
1114
- readonly PopsSmsNumbers: "pops_sms_numbers";
1115
- readonly PopsSmsWhitelist: "pops_sms_whitelist";
1116
- readonly PopsDistCourier: "pops_dist_courier";
1117
- readonly PopsDistDeductions: "pops_dist_deductions";
1118
- readonly PopsDistOrder: "pops_dist_order";
1119
- readonly PopsDistItems: "pops_dist_items";
1120
- readonly PopsDistPrices: "pops_dist_prices";
1121
- readonly PopsDistManufacturer: "pops_dist_manufacturer";
1122
- readonly PopsStockTransactions: "pops_stock_transactions";
1123
- readonly PopsSuppliers: "pops_suppliers";
1124
- readonly PopsSupplierItems: "pops_supplier_items";
1125
- readonly Pops3cxBackup: "pops_3cx_backup";
1126
- readonly Pops3cxBilling: "pops_3cx_billing";
1127
- readonly PopsDeadLicences: "pops_dead_licences";
1128
- readonly Pops3cxExts: "pops_3cx_exts";
1129
- readonly PopsHostingPricing: "pops_hosting_pricing";
1130
- readonly Pops3cxKeys: "pops_3cx_keys";
1131
- readonly Pops3cxMacs: "pops_3cx_macs";
1132
- readonly Pops3cxNumbers: "pops_3cx_numbers";
1133
- readonly Pops3cxOfficeHours: "pops_3cx_office_hours";
1134
- readonly Pops3cxPhones: "pops_3cx_phones";
1135
- readonly Pops3cxSbc: "pops_3cx_sbc";
1136
- readonly Pops3cxSetup: "pops_3cx_setup";
1137
- readonly Pops3cxSipTrunks: "pops_3cx_sip_trunks";
1138
- readonly Pops3cxUsers: "pops_3cx_users";
1139
- readonly PopsUsers: "pops_users";
1140
- readonly Webhook: "webhook";
1141
- readonly PopsXeroLog: "pops_xero_log";
1142
- readonly Oauth2Clients: "oauth2_clients";
1143
- readonly Oauth2Tokens: "oauth2_tokens";
1144
- };
1145
- export type AuditLogEntityTypeEnum = typeof AuditLogEntityTypeEnum[keyof typeof AuditLogEntityTypeEnum];
1146
1063
  /**
1147
1064
  * OAuth Auth Code Response
1148
1065
  * @export
@@ -1206,133 +1123,6 @@ export interface BasicProductDTO {
1206
1123
  */
1207
1124
  'title'?: string;
1208
1125
  }
1209
- /**
1210
- * Batch DTO
1211
- * @export
1212
- * @interface BatchDTO
1213
- */
1214
- export interface BatchDTO {
1215
- /**
1216
- * id
1217
- * @type {number}
1218
- * @memberof BatchDTO
1219
- */
1220
- 'id'?: number;
1221
- /**
1222
- * orderId
1223
- * @type {number}
1224
- * @memberof BatchDTO
1225
- */
1226
- 'orderId'?: number;
1227
- /**
1228
- * supplierId
1229
- * @type {number}
1230
- * @memberof BatchDTO
1231
- */
1232
- 'supplierId'?: number;
1233
- /**
1234
- * poNumber
1235
- * @type {string}
1236
- * @memberof BatchDTO
1237
- */
1238
- 'poNumber'?: string;
1239
- /**
1240
- * carriage
1241
- * @type {number}
1242
- * @memberof BatchDTO
1243
- */
1244
- 'carriage'?: number;
1245
- /**
1246
- * courier
1247
- * @type {string}
1248
- * @memberof BatchDTO
1249
- */
1250
- 'courier'?: string;
1251
- /**
1252
- * courierService
1253
- * @type {string}
1254
- * @memberof BatchDTO
1255
- */
1256
- 'courierService'?: string;
1257
- /**
1258
- * courierReference
1259
- * @type {string}
1260
- * @memberof BatchDTO
1261
- */
1262
- 'courierReference'?: string;
1263
- /**
1264
- * courierUnique
1265
- * @type {string}
1266
- * @memberof BatchDTO
1267
- */
1268
- 'courierUnique'?: string;
1269
- /**
1270
- * notes
1271
- * @type {string}
1272
- * @memberof BatchDTO
1273
- */
1274
- 'notes'?: string;
1275
- /**
1276
- * ordered
1277
- * @type {number}
1278
- * @memberof BatchDTO
1279
- */
1280
- 'ordered'?: number;
1281
- /**
1282
- * carriagePaid
1283
- * @type {number}
1284
- * @memberof BatchDTO
1285
- */
1286
- 'carriagePaid'?: number;
1287
- /**
1288
- * carriageRefunded
1289
- * @type {number}
1290
- * @memberof BatchDTO
1291
- */
1292
- 'carriageRefunded'?: number;
1293
- /**
1294
- * carriageRefundedDue
1295
- * @type {number}
1296
- * @memberof BatchDTO
1297
- */
1298
- 'carriageRefundedDue'?: number;
1299
- /**
1300
- * netdespatchLabel
1301
- * @type {string}
1302
- * @memberof BatchDTO
1303
- */
1304
- 'netdespatchLabel'?: string;
1305
- /**
1306
- * courierBoxes
1307
- * @type {number}
1308
- * @memberof BatchDTO
1309
- */
1310
- 'courierBoxes'?: number;
1311
- /**
1312
- * mac
1313
- * @type {string}
1314
- * @memberof BatchDTO
1315
- */
1316
- 'mac'?: string;
1317
- /**
1318
- * Shipments
1319
- * @type {Array<ShipmentDTO>}
1320
- * @memberof BatchDTO
1321
- */
1322
- 'shipments'?: Array<ShipmentDTO>;
1323
- /**
1324
- * Items
1325
- * @type {Array<OrderedItemModel>}
1326
- * @memberof BatchDTO
1327
- */
1328
- 'items'?: Array<OrderedItemModel>;
1329
- /**
1330
- *
1331
- * @type {SupplierModel}
1332
- * @memberof BatchDTO
1333
- */
1334
- 'supplier'?: SupplierModel;
1335
- }
1336
1126
  /**
1337
1127
  * BatchesEntity
1338
1128
  * @export
@@ -1888,155 +1678,6 @@ export interface CreditAccountEntity {
1888
1678
  */
1889
1679
  'prizePromo'?: boolean;
1890
1680
  }
1891
- /**
1892
- * Credit Note
1893
- * @export
1894
- * @interface CreditNoteDTO
1895
- */
1896
- export interface CreditNoteDTO {
1897
- /**
1898
- * Items
1899
- * @type {Array<CreditNoteItemDTO>}
1900
- * @memberof CreditNoteDTO
1901
- */
1902
- 'items'?: Array<CreditNoteItemDTO>;
1903
- }
1904
- /**
1905
- * CreditNotesEntity
1906
- * @export
1907
- * @interface CreditNoteEntity
1908
- */
1909
- export interface CreditNoteEntity {
1910
- /**
1911
- * id
1912
- * @type {number}
1913
- * @memberof CreditNoteEntity
1914
- */
1915
- 'id'?: number;
1916
- /**
1917
- * orderId
1918
- * @type {number}
1919
- * @memberof CreditNoteEntity
1920
- */
1921
- 'orderId'?: number;
1922
- /**
1923
- * transactionId
1924
- * @type {string}
1925
- * @memberof CreditNoteEntity
1926
- */
1927
- 'transactionId'?: string;
1928
- /**
1929
- * amount
1930
- * @type {number}
1931
- * @memberof CreditNoteEntity
1932
- */
1933
- 'amount'?: number;
1934
- /**
1935
- * timestamp
1936
- * @type {string}
1937
- * @memberof CreditNoteEntity
1938
- */
1939
- 'timestamp'?: string;
1940
- }
1941
- /**
1942
- * Credit Note Item
1943
- * @export
1944
- * @interface CreditNoteItemDTO
1945
- */
1946
- export interface CreditNoteItemDTO {
1947
- /**
1948
- * Item ID
1949
- * @type {number}
1950
- * @memberof CreditNoteItemDTO
1951
- */
1952
- 'itemId'?: number;
1953
- /**
1954
- * Quantity
1955
- * @type {number}
1956
- * @memberof CreditNoteItemDTO
1957
- */
1958
- 'quantity'?: number | null;
1959
- /**
1960
- * Amount
1961
- * @type {number}
1962
- * @memberof CreditNoteItemDTO
1963
- */
1964
- 'amount'?: number | null;
1965
- }
1966
- /**
1967
- * CreditNotesItemsEntity
1968
- * @export
1969
- * @interface CreditNoteItemEntity
1970
- */
1971
- export interface CreditNoteItemEntity {
1972
- /**
1973
- * id
1974
- * @type {number}
1975
- * @memberof CreditNoteItemEntity
1976
- */
1977
- 'id'?: number;
1978
- /**
1979
- * creditNoteId
1980
- * @type {number}
1981
- * @memberof CreditNoteItemEntity
1982
- */
1983
- 'creditNoteId'?: number;
1984
- /**
1985
- * orderId
1986
- * @type {number}
1987
- * @memberof CreditNoteItemEntity
1988
- */
1989
- 'orderId'?: number;
1990
- /**
1991
- * itemId
1992
- * @type {number}
1993
- * @memberof CreditNoteItemEntity
1994
- */
1995
- 'itemId'?: number;
1996
- /**
1997
- * amount
1998
- * @type {number}
1999
- * @memberof CreditNoteItemEntity
2000
- */
2001
- 'amount'?: number;
2002
- }
2003
- /**
2004
- * Credit Note Model
2005
- * @export
2006
- * @interface CreditNoteModel
2007
- */
2008
- export interface CreditNoteModel {
2009
- /**
2010
- * id
2011
- * @type {number}
2012
- * @memberof CreditNoteModel
2013
- */
2014
- 'id'?: number;
2015
- /**
2016
- * orderId
2017
- * @type {number}
2018
- * @memberof CreditNoteModel
2019
- */
2020
- 'orderId'?: number;
2021
- /**
2022
- * transactionId
2023
- * @type {string}
2024
- * @memberof CreditNoteModel
2025
- */
2026
- 'transactionId'?: string;
2027
- /**
2028
- * amount
2029
- * @type {number}
2030
- * @memberof CreditNoteModel
2031
- */
2032
- 'amount'?: number;
2033
- /**
2034
- * timestamp
2035
- * @type {string}
2036
- * @memberof CreditNoteModel
2037
- */
2038
- 'timestamp'?: string;
2039
- }
2040
1681
  /**
2041
1682
  * CRM Contact
2042
1683
  * @export
@@ -3748,7 +3389,7 @@ export interface ItemDTO {
3748
3389
  * @type {Array<TcxSbcDTO>}
3749
3390
  * @memberof ItemDTO
3750
3391
  */
3751
- 'sbcs'?: Array<TcxSbcDTO>;
3392
+ 'sbcs'?: Array<TcxSbcDTO> | null;
3752
3393
  /**
3753
3394
  * Readonly
3754
3395
  * @type {boolean}
@@ -4130,202 +3771,63 @@ export interface OfflineInstancesEntity {
4130
3771
  'alerted'?: number;
4131
3772
  }
4132
3773
  /**
4133
- * Order Details
3774
+ * OrdersEntity
4134
3775
  * @export
4135
- * @interface OrderDetailsDTO
3776
+ * @interface OrderEntity
4136
3777
  */
4137
- export interface OrderDetailsDTO {
3778
+ export interface OrderEntity {
4138
3779
  /**
4139
- * ID
3780
+ * id
4140
3781
  * @type {number}
4141
- * @memberof OrderDetailsDTO
3782
+ * @memberof OrderEntity
4142
3783
  */
4143
3784
  'id'?: number;
4144
3785
  /**
4145
- * Reference
3786
+ * externalId
4146
3787
  * @type {string}
4147
- * @memberof OrderDetailsDTO
3788
+ * @memberof OrderEntity
4148
3789
  */
4149
- 'reference'?: string | null;
3790
+ 'reference'?: string;
4150
3791
  /**
4151
- * Invoice Number
3792
+ * sourceId
3793
+ * @type {number}
3794
+ * @memberof OrderEntity
3795
+ */
3796
+ 'sourceId'?: number;
3797
+ /**
3798
+ * sageInv
4152
3799
  * @type {string}
4153
- * @memberof OrderDetailsDTO
3800
+ * @memberof OrderEntity
4154
3801
  */
4155
3802
  'invoiceNumber'?: string;
4156
3803
  /**
4157
- * Invoice ID
3804
+ * invoiceId
4158
3805
  * @type {string}
4159
- * @memberof OrderDetailsDTO
3806
+ * @memberof OrderEntity
4160
3807
  */
4161
3808
  'invoiceId'?: string | null;
4162
3809
  /**
4163
- * Date Time
3810
+ * creditAccountId
3811
+ * @type {number}
3812
+ * @memberof OrderEntity
3813
+ */
3814
+ 'customerId'?: number;
3815
+ /**
3816
+ * orderDate
4164
3817
  * @type {string}
4165
- * @memberof OrderDetailsDTO
3818
+ * @memberof OrderEntity
4166
3819
  */
4167
3820
  'orderDate'?: string;
4168
3821
  /**
4169
- * Paid
4170
- * @type {boolean}
4171
- * @memberof OrderDetailsDTO
3822
+ * orderPostedDate
3823
+ * @type {string}
3824
+ * @memberof OrderEntity
4172
3825
  */
4173
- 'paid'?: boolean;
3826
+ 'orderPostedDate'?: string;
4174
3827
  /**
4175
- * Complete
4176
- * @type {boolean}
4177
- * @memberof OrderDetailsDTO
4178
- */
4179
- 'complete'?: boolean;
4180
- /**
4181
- * Quote
4182
- * @type {boolean}
4183
- * @memberof OrderDetailsDTO
4184
- */
4185
- 'quote'?: boolean;
4186
- /**
4187
- *
4188
- * @type {AccountSummaryDTO}
4189
- * @memberof OrderDetailsDTO
4190
- */
4191
- 'customer'?: AccountSummaryDTO;
4192
- /**
4193
- *
4194
- * @type {AddressModel}
4195
- * @memberof OrderDetailsDTO
4196
- */
4197
- 'shippingAddress'?: AddressModel;
4198
- /**
4199
- * Items
4200
- * @type {Array<ItemDTO>}
4201
- * @memberof OrderDetailsDTO
4202
- */
4203
- 'items'?: Array<ItemDTO>;
4204
- /**
4205
- * Carriage Charge
4206
- * @type {number}
4207
- * @memberof OrderDetailsDTO
4208
- */
4209
- 'carriageCharge'?: number;
4210
- /**
4211
- * Fulfillable
4212
- * @type {boolean}
4213
- * @memberof OrderDetailsDTO
4214
- */
4215
- 'fulfillable'?: boolean | null;
4216
- /**
4217
- * Provisioning URL
4218
- * @type {string}
4219
- * @memberof OrderDetailsDTO
4220
- */
4221
- 'provisioningUrl'?: string | null;
4222
- /**
4223
- *
4224
- * @type {ShippingServiceDTO}
4225
- * @memberof OrderDetailsDTO
4226
- */
4227
- 'shippingService'?: ShippingServiceDTO;
4228
- /**
4229
- * Readonly
4230
- * @type {boolean}
4231
- * @memberof OrderDetailsDTO
4232
- */
4233
- 'readonly'?: boolean;
4234
- /**
4235
- * Detailed Items
4236
- * @type {Array<OrderItemDTO>}
4237
- * @memberof OrderDetailsDTO
4238
- */
4239
- 'detailedItems'?: Array<OrderItemDTO>;
4240
- /**
4241
- * Batches
4242
- * @type {Array<BatchDTO>}
4243
- * @memberof OrderDetailsDTO
4244
- */
4245
- 'batches'?: Array<BatchDTO>;
4246
- /**
4247
- * Audit Log
4248
- * @type {Array<AuditLogEntity>}
4249
- * @memberof OrderDetailsDTO
4250
- */
4251
- 'logEntries'?: Array<AuditLogEntity>;
4252
- /**
4253
- * Card Payment Link
4254
- * @type {string}
4255
- * @memberof OrderDetailsDTO
4256
- */
4257
- 'paymentLink'?: string | null;
4258
- /**
4259
- * Credits
4260
- * @type {Array<CreditNoteModel>}
4261
- * @memberof OrderDetailsDTO
4262
- */
4263
- 'credits'?: Array<CreditNoteModel>;
4264
- /**
4265
- * Customer Email
4266
- * @type {string}
4267
- * @memberof OrderDetailsDTO
4268
- */
4269
- 'customerEmail'?: string;
4270
- }
4271
- /**
4272
- * OrdersEntity
4273
- * @export
4274
- * @interface OrderEntity
4275
- */
4276
- export interface OrderEntity {
4277
- /**
4278
- * id
4279
- * @type {number}
4280
- * @memberof OrderEntity
4281
- */
4282
- 'id'?: number;
4283
- /**
4284
- * externalId
4285
- * @type {string}
4286
- * @memberof OrderEntity
4287
- */
4288
- 'reference'?: string;
4289
- /**
4290
- * sourceId
4291
- * @type {number}
4292
- * @memberof OrderEntity
4293
- */
4294
- 'sourceId'?: number;
4295
- /**
4296
- * sageInv
4297
- * @type {string}
4298
- * @memberof OrderEntity
4299
- */
4300
- 'invoiceNumber'?: string;
4301
- /**
4302
- * invoiceId
4303
- * @type {string}
4304
- * @memberof OrderEntity
4305
- */
4306
- 'invoiceId'?: string | null;
4307
- /**
4308
- * creditAccountId
4309
- * @type {number}
4310
- * @memberof OrderEntity
4311
- */
4312
- 'customerId'?: number;
4313
- /**
4314
- * orderDate
4315
- * @type {string}
4316
- * @memberof OrderEntity
4317
- */
4318
- 'orderDate'?: string;
4319
- /**
4320
- * orderPostedDate
4321
- * @type {string}
4322
- * @memberof OrderEntity
4323
- */
4324
- 'orderPostedDate'?: string;
4325
- /**
4326
- * buyerEmail
4327
- * @type {string}
4328
- * @memberof OrderEntity
3828
+ * buyerEmail
3829
+ * @type {string}
3830
+ * @memberof OrderEntity
4329
3831
  */
4330
3832
  'buyerEmail'?: string;
4331
3833
  /**
@@ -4623,115 +4125,6 @@ export interface OrderEntity {
4623
4125
  */
4624
4126
  'fulfillable'?: boolean | null;
4625
4127
  }
4626
- /**
4627
- * Order Item Details
4628
- * @export
4629
- * @interface OrderItemDTO
4630
- */
4631
- export interface OrderItemDTO {
4632
- /**
4633
- * SKU
4634
- * @type {string}
4635
- * @memberof OrderItemDTO
4636
- */
4637
- 'sku'?: string;
4638
- /**
4639
- * Quantity
4640
- * @type {number}
4641
- * @memberof OrderItemDTO
4642
- */
4643
- 'quantity'?: number;
4644
- /**
4645
- * ID
4646
- * @type {number}
4647
- * @memberof OrderItemDTO
4648
- */
4649
- 'id'?: number | null;
4650
- /**
4651
- * Order ID
4652
- * @type {number}
4653
- * @memberof OrderItemDTO
4654
- */
4655
- 'orderId'?: number | null;
4656
- /**
4657
- * Title
4658
- * @type {string}
4659
- * @memberof OrderItemDTO
4660
- */
4661
- 'title'?: string;
4662
- /**
4663
- * Price
4664
- * @type {number}
4665
- * @memberof OrderItemDTO
4666
- */
4667
- 'price'?: number;
4668
- /**
4669
- * 3CX Licence Key
4670
- * @type {string}
4671
- * @memberof OrderItemDTO
4672
- */
4673
- 'licenceKey'?: string | null;
4674
- /**
4675
- * Date Time
4676
- * @type {string}
4677
- * @memberof OrderItemDTO
4678
- */
4679
- 'licenceExpiry'?: string;
4680
- /**
4681
- * Date Time
4682
- * @type {string}
4683
- * @memberof OrderItemDTO
4684
- */
4685
- 'processDate'?: string;
4686
- /**
4687
- * 3CX Hosting
4688
- * @type {boolean}
4689
- * @memberof OrderItemDTO
4690
- */
4691
- 'hosting'?: boolean | null;
4692
- /**
4693
- * Promo Item
4694
- * @type {boolean}
4695
- * @memberof OrderItemDTO
4696
- */
4697
- 'promoItem'?: boolean;
4698
- /**
4699
- * Refunded
4700
- * @type {number}
4701
- * @memberof OrderItemDTO
4702
- */
4703
- 'refunded'?: number | null;
4704
- /**
4705
- * SBCs
4706
- * @type {Array<TcxSbcDTO>}
4707
- * @memberof OrderItemDTO
4708
- */
4709
- 'sbcs'?: Array<TcxSbcDTO>;
4710
- /**
4711
- * Readonly
4712
- * @type {boolean}
4713
- * @memberof OrderItemDTO
4714
- */
4715
- 'readonly'?: boolean;
4716
- /**
4717
- * 3CX Sales Code
4718
- * @type {string}
4719
- * @memberof OrderItemDTO
4720
- */
4721
- 'tcxSalesCode'?: string | null;
4722
- /**
4723
- * Suppliers
4724
- * @type {Array<SupplierModel>}
4725
- * @memberof OrderItemDTO
4726
- */
4727
- 'suppliers'?: Array<SupplierModel>;
4728
- /**
4729
- * Allocated
4730
- * @type {number}
4731
- * @memberof OrderItemDTO
4732
- */
4733
- 'allocated'?: number | null;
4734
- }
4735
4128
  /**
4736
4129
  * EdTechPro Order Request
4737
4130
  * @export
@@ -5142,146 +4535,55 @@ export interface OrderedItemEntity {
5142
4535
  'returnedStock'?: number;
5143
4536
  }
5144
4537
  /**
5145
- * Ordered Item Model
4538
+ *
5146
4539
  * @export
5147
- * @interface OrderedItemModel
4540
+ * @interface PatchSetTcxWizardCnameRequest
5148
4541
  */
5149
- export interface OrderedItemModel {
4542
+ export interface PatchSetTcxWizardCnameRequest {
5150
4543
  /**
5151
- * id
5152
- * @type {number}
5153
- * @memberof OrderedItemModel
4544
+ * CNAME
4545
+ * @type {string}
4546
+ * @memberof PatchSetTcxWizardCnameRequest
5154
4547
  */
5155
- 'id'?: number;
4548
+ 'cname'?: string;
4549
+ }
4550
+ /**
4551
+ *
4552
+ * @export
4553
+ * @interface PatchUpdateAccountContactPasswordRequest
4554
+ */
4555
+ export interface PatchUpdateAccountContactPasswordRequest {
5156
4556
  /**
5157
- * itemId
5158
- * @type {number}
5159
- * @memberof OrderedItemModel
4557
+ * Password
4558
+ * @type {string}
4559
+ * @memberof PatchUpdateAccountContactPasswordRequest
5160
4560
  */
5161
- 'itemId'?: number;
4561
+ 'password'?: string;
4562
+ }
4563
+ /**
4564
+ * Customer Account
4565
+ * @export
4566
+ * @interface PortalAccountModel
4567
+ */
4568
+ export interface PortalAccountModel {
5162
4569
  /**
5163
- * orderedQuantity
4570
+ * ID
5164
4571
  * @type {number}
5165
- * @memberof OrderedItemModel
4572
+ * @memberof PortalAccountModel
5166
4573
  */
5167
- 'orderedQuantity'?: number;
4574
+ 'id'?: number;
5168
4575
  /**
5169
- * itemStatus
5170
- * @type {number}
5171
- * @memberof OrderedItemModel
4576
+ * Contact Name
4577
+ * @type {string}
4578
+ * @memberof PortalAccountModel
5172
4579
  */
5173
- 'itemStatus'?: number;
4580
+ 'name'?: string;
5174
4581
  /**
5175
- * supplierId
5176
- * @type {number}
5177
- * @memberof OrderedItemModel
4582
+ * Email
4583
+ * @type {string}
4584
+ * @memberof PortalAccountModel
5178
4585
  */
5179
- 'supplierId'?: number;
5180
- /**
5181
- * supplierItemId
5182
- * @type {number}
5183
- * @memberof OrderedItemModel
5184
- */
5185
- 'supplierItemId'?: number;
5186
- /**
5187
- * supplierPrice
5188
- * @type {number}
5189
- * @memberof OrderedItemModel
5190
- */
5191
- 'supplierPrice'?: number;
5192
- /**
5193
- * statusDate
5194
- * @type {string}
5195
- * @memberof OrderedItemModel
5196
- */
5197
- 'statusDate'?: string;
5198
- /**
5199
- * statusAuthor
5200
- * @type {number}
5201
- * @memberof OrderedItemModel
5202
- */
5203
- 'statusAuthor'?: number;
5204
- /**
5205
- * supplierPaid
5206
- * @type {number}
5207
- * @memberof OrderedItemModel
5208
- */
5209
- 'supplierPaid'?: number;
5210
- /**
5211
- * supplierCreditDue
5212
- * @type {number}
5213
- * @memberof OrderedItemModel
5214
- */
5215
- 'supplierCreditDue'?: number;
5216
- /**
5217
- * supplierCreditReceived
5218
- * @type {number}
5219
- * @memberof OrderedItemModel
5220
- */
5221
- 'supplierCreditReceived'?: number;
5222
- /**
5223
- * supplierSku
5224
- * @type {string}
5225
- * @memberof OrderedItemModel
5226
- */
5227
- 'supplierSku'?: string;
5228
- /**
5229
- * returnedStock
5230
- * @type {number}
5231
- * @memberof OrderedItemModel
5232
- */
5233
- 'returnedStock'?: number;
5234
- }
5235
- /**
5236
- *
5237
- * @export
5238
- * @interface PatchSetTcxWizardCnameRequest
5239
- */
5240
- export interface PatchSetTcxWizardCnameRequest {
5241
- /**
5242
- * CNAME
5243
- * @type {string}
5244
- * @memberof PatchSetTcxWizardCnameRequest
5245
- */
5246
- 'cname'?: string;
5247
- }
5248
- /**
5249
- *
5250
- * @export
5251
- * @interface PatchUpdateAccountContactPasswordRequest
5252
- */
5253
- export interface PatchUpdateAccountContactPasswordRequest {
5254
- /**
5255
- * Password
5256
- * @type {string}
5257
- * @memberof PatchUpdateAccountContactPasswordRequest
5258
- */
5259
- 'password'?: string;
5260
- }
5261
- /**
5262
- * Customer Account
5263
- * @export
5264
- * @interface PortalAccountModel
5265
- */
5266
- export interface PortalAccountModel {
5267
- /**
5268
- * ID
5269
- * @type {number}
5270
- * @memberof PortalAccountModel
5271
- */
5272
- 'id'?: number;
5273
- /**
5274
- * Contact Name
5275
- * @type {string}
5276
- * @memberof PortalAccountModel
5277
- */
5278
- 'name'?: string;
5279
- /**
5280
- * Email
5281
- * @type {string}
5282
- * @memberof PortalAccountModel
5283
- */
5284
- 'email'?: string;
4586
+ 'email'?: string;
5285
4587
  /**
5286
4588
  * Phone Number
5287
4589
  * @type {string}
@@ -5458,19 +4760,6 @@ export interface PortalLoginModel {
5458
4760
  */
5459
4761
  'redirect_uri'?: string;
5460
4762
  }
5461
- /**
5462
- *
5463
- * @export
5464
- * @interface PostAddOrderNoteRequest
5465
- */
5466
- export interface PostAddOrderNoteRequest {
5467
- /**
5468
- * Order Note
5469
- * @type {string}
5470
- * @memberof PostAddOrderNoteRequest
5471
- */
5472
- 'note'?: string;
5473
- }
5474
4763
  /**
5475
4764
  *
5476
4765
  * @export
@@ -5553,19 +4842,6 @@ export interface PostGetProductRequest {
5553
4842
  */
5554
4843
  'hosting'?: boolean | null;
5555
4844
  }
5556
- /**
5557
- *
5558
- * @export
5559
- * @interface PostSplitOrderRequest
5560
- */
5561
- export interface PostSplitOrderRequest {
5562
- /**
5563
- * Item Ids
5564
- * @type {Array<number>}
5565
- * @memberof PostSplitOrderRequest
5566
- */
5567
- 'itemIds'?: Array<number>;
5568
- }
5569
4845
  /**
5570
4846
  * Price & Stock List
5571
4847
  * @export
@@ -5603,43 +4879,6 @@ export interface PriceListItemModel {
5603
4879
  */
5604
4880
  'stock'?: number | null;
5605
4881
  }
5606
- /**
5607
- * PrintersEntity
5608
- * @export
5609
- * @interface PrinterEntity
5610
- */
5611
- export interface PrinterEntity {
5612
- /**
5613
- * id
5614
- * @type {number}
5615
- * @memberof PrinterEntity
5616
- */
5617
- 'id'?: number;
5618
- /**
5619
- * brand
5620
- * @type {string}
5621
- * @memberof PrinterEntity
5622
- */
5623
- 'brand'?: string;
5624
- /**
5625
- * model
5626
- * @type {string}
5627
- * @memberof PrinterEntity
5628
- */
5629
- 'model'?: string;
5630
- /**
5631
- * sn
5632
- * @type {string}
5633
- * @memberof PrinterEntity
5634
- */
5635
- 'sn'?: string;
5636
- /**
5637
- * location
5638
- * @type {string}
5639
- * @memberof PrinterEntity
5640
- */
5641
- 'location'?: string;
5642
- }
5643
4882
  /**
5644
4883
  * PrizesEntity
5645
4884
  * @export
@@ -6027,38 +5266,6 @@ export interface ProvisioningRequestEntity {
6027
5266
  */
6028
5267
  'auth'?: string;
6029
5268
  }
6030
- /**
6031
- *
6032
- * @export
6033
- * @interface PutAllocateItemsRequest
6034
- */
6035
- export interface PutAllocateItemsRequest {
6036
- /**
6037
- * Items
6038
- * @type {Array<PutAllocateItemsRequestItemsInner>}
6039
- * @memberof PutAllocateItemsRequest
6040
- */
6041
- 'items'?: Array<PutAllocateItemsRequestItemsInner>;
6042
- }
6043
- /**
6044
- *
6045
- * @export
6046
- * @interface PutAllocateItemsRequestItemsInner
6047
- */
6048
- export interface PutAllocateItemsRequestItemsInner {
6049
- /**
6050
- * Item ID
6051
- * @type {number}
6052
- * @memberof PutAllocateItemsRequestItemsInner
6053
- */
6054
- 'itemId'?: number;
6055
- /**
6056
- * Quantity To Allocate
6057
- * @type {number}
6058
- * @memberof PutAllocateItemsRequestItemsInner
6059
- */
6060
- 'quantity'?: number;
6061
- }
6062
5269
  /**
6063
5270
  * Azure Recordings Backup
6064
5271
  * @export
@@ -6381,55 +5588,6 @@ export interface ShipmentAddressEntity {
6381
5588
  */
6382
5589
  'shipPhoneNumber'?: string;
6383
5590
  }
6384
- /**
6385
- * Shipment
6386
- * @export
6387
- * @interface ShipmentDTO
6388
- */
6389
- export interface ShipmentDTO {
6390
- /**
6391
- * Courier
6392
- * @type {string}
6393
- * @memberof ShipmentDTO
6394
- */
6395
- 'courier'?: ShipmentDTOCourierEnum | null;
6396
- /**
6397
- * Courier Reference
6398
- * @type {string}
6399
- * @memberof ShipmentDTO
6400
- */
6401
- 'reference'?: string | null;
6402
- /**
6403
- * Date Time
6404
- * @type {string}
6405
- * @memberof ShipmentDTO
6406
- */
6407
- 'requestedDate'?: string;
6408
- /**
6409
- * Scanned Items
6410
- * @type {Array<ScannedItemModel>}
6411
- * @memberof ShipmentDTO
6412
- */
6413
- 'scannedItems'?: Array<ScannedItemModel>;
6414
- /**
6415
- * Items
6416
- * @type {Array<ShipmentItemModel>}
6417
- * @memberof ShipmentDTO
6418
- */
6419
- 'items'?: Array<ShipmentItemModel>;
6420
- /**
6421
- *
6422
- * @type {AddressModel}
6423
- * @memberof ShipmentDTO
6424
- */
6425
- 'address'?: AddressModel;
6426
- }
6427
- export declare const ShipmentDTOCourierEnum: {
6428
- readonly Dpd: "DPD";
6429
- readonly ChorltonPallet: "Chorlton Pallet";
6430
- readonly Pops: "POPS";
6431
- };
6432
- export type ShipmentDTOCourierEnum = typeof ShipmentDTOCourierEnum[keyof typeof ShipmentDTOCourierEnum];
6433
5591
  /**
6434
5592
  * ShipmentsEntity
6435
5593
  * @export
@@ -6509,25 +5667,6 @@ export interface ShipmentEntity {
6509
5667
  */
6510
5668
  'provId'?: number;
6511
5669
  }
6512
- /**
6513
- * Shipment Item
6514
- * @export
6515
- * @interface ShipmentItemDTO
6516
- */
6517
- export interface ShipmentItemDTO {
6518
- /**
6519
- * Item ID
6520
- * @type {number}
6521
- * @memberof ShipmentItemDTO
6522
- */
6523
- 'itemId'?: number;
6524
- /**
6525
- * Quantity
6526
- * @type {number}
6527
- * @memberof ShipmentItemDTO
6528
- */
6529
- 'quantity'?: number;
6530
- }
6531
5670
  /**
6532
5671
  * ShipmentItemsEntity
6533
5672
  * @export
@@ -6566,257 +5705,61 @@ export interface ShipmentItemEntity {
6566
5705
  'itemId'?: string;
6567
5706
  }
6568
5707
  /**
6569
- * Shipment Item
5708
+ *
6570
5709
  * @export
6571
- * @interface ShipmentItemModel
5710
+ * @interface ShippingConsignmentModel
6572
5711
  */
6573
- export interface ShipmentItemModel {
6574
- /**
6575
- * id
6576
- * @type {number}
6577
- * @memberof ShipmentItemModel
6578
- */
6579
- 'id'?: number;
5712
+ export interface ShippingConsignmentModel {
6580
5713
  /**
6581
- * shipmentId
6582
- * @type {number}
6583
- * @memberof ShipmentItemModel
5714
+ *
5715
+ * @type {ShippingServiceModel}
5716
+ * @memberof ShippingConsignmentModel
6584
5717
  */
6585
- 'shipmentId'?: number;
5718
+ 'service'?: ShippingServiceModel;
6586
5719
  /**
6587
- * batchId
6588
- * @type {number}
6589
- * @memberof ShipmentItemModel
5720
+ * ID/Number
5721
+ * @type {string}
5722
+ * @memberof ShippingConsignmentModel
6590
5723
  */
6591
- 'batchId'?: number;
5724
+ 'id'?: string;
6592
5725
  /**
6593
- * quantity
6594
- * @type {number}
6595
- * @memberof ShipmentItemModel
5726
+ * Tracking Number
5727
+ * @type {string}
5728
+ * @memberof ShippingConsignmentModel
6596
5729
  */
6597
- 'quantity'?: number;
5730
+ 'trackingNumber'?: string;
6598
5731
  /**
6599
- * item
6600
- * @type {string}
6601
- * @memberof ShipmentItemModel
5732
+ * Parcels
5733
+ * @type {Array<string>}
5734
+ * @memberof ShippingConsignmentModel
6602
5735
  */
6603
- 'itemId'?: string;
5736
+ 'parcelIds'?: Array<string>;
6604
5737
  }
6605
5738
  /**
6606
- * Shipment
5739
+ * Shipping Information
6607
5740
  * @export
6608
- * @interface ShipmentModel
5741
+ * @interface ShippingInformationDTO
6609
5742
  */
6610
- export interface ShipmentModel {
6611
- /**
6612
- * id
6613
- * @type {number}
6614
- * @memberof ShipmentModel
6615
- */
6616
- 'id'?: number;
5743
+ export interface ShippingInformationDTO {
6617
5744
  /**
6618
- * batchId
6619
- * @type {number}
6620
- * @memberof ShipmentModel
5745
+ * Items
5746
+ * @type {Array<BasicItemDTO>}
5747
+ * @memberof ShippingInformationDTO
6621
5748
  */
6622
- 'batchId'?: number;
5749
+ 'items'?: Array<BasicItemDTO>;
6623
5750
  /**
6624
- * courier
5751
+ * Destination Post Code
6625
5752
  * @type {string}
6626
- * @memberof ShipmentModel
5753
+ * @memberof ShippingInformationDTO
6627
5754
  */
6628
- 'courier'?: string;
5755
+ 'postalCode'?: string;
6629
5756
  /**
6630
- * courierService
5757
+ * Destination ISO
6631
5758
  * @type {string}
6632
- * @memberof ShipmentModel
6633
- */
6634
- 'courierService'?: string;
6635
- /**
6636
- * courierServiceDesc
6637
- * @type {string}
6638
- * @memberof ShipmentModel
6639
- */
6640
- 'courierServiceDesc'?: string;
6641
- /**
6642
- * courierReference
6643
- * @type {string}
6644
- * @memberof ShipmentModel
6645
- */
6646
- 'courierReference'?: string;
6647
- /**
6648
- * courierTracking
6649
- * @type {string}
6650
- * @memberof ShipmentModel
6651
- */
6652
- 'courierTracking'?: string;
6653
- /**
6654
- * courierBoxes
6655
- * @type {number}
6656
- * @memberof ShipmentModel
6657
- */
6658
- 'courierBoxes'?: number;
6659
- /**
6660
- * mac
6661
- * @type {string}
6662
- * @memberof ShipmentModel
6663
- */
6664
- 'scannedData'?: string;
6665
- /**
6666
- * date
6667
- * @type {string}
6668
- * @memberof ShipmentModel
6669
- */
6670
- 'dateShipped'?: string;
6671
- /**
6672
- * requestDate
6673
- * @type {string}
6674
- * @memberof ShipmentModel
6675
- */
6676
- 'requestDate'?: string;
6677
- /**
6678
- * provId
6679
- * @type {number}
6680
- * @memberof ShipmentModel
6681
- */
6682
- 'provId'?: number;
6683
- }
6684
- /**
6685
- * Shipment Request
6686
- * @export
6687
- * @interface ShipmentRequestDTO
6688
- */
6689
- export interface ShipmentRequestDTO {
6690
- /**
6691
- * Courier
6692
- * @type {string}
6693
- * @memberof ShipmentRequestDTO
6694
- */
6695
- 'courier'?: ShipmentRequestDTOCourierEnum;
6696
- /**
6697
- *
6698
- * @type {AddressModel}
6699
- * @memberof ShipmentRequestDTO
6700
- */
6701
- 'address'?: AddressModel | null;
6702
- /**
6703
- * Scanned Lines
6704
- * @type {Array<string>}
6705
- * @memberof ShipmentRequestDTO
6706
- */
6707
- 'scannedLines'?: Array<string>;
6708
- /**
6709
- * Service
6710
- * @type {string}
6711
- * @memberof ShipmentRequestDTO
6712
- */
6713
- 'service'?: string;
6714
- /**
6715
- * Date Time
6716
- * @type {string}
6717
- * @memberof ShipmentRequestDTO
6718
- */
6719
- 'shipDate'?: string;
6720
- /**
6721
- * Items
6722
- * @type {Array<ShipmentItemDTO>}
6723
- * @memberof ShipmentRequestDTO
6724
- */
6725
- 'items'?: Array<ShipmentItemDTO>;
6726
- }
6727
- export declare const ShipmentRequestDTOCourierEnum: {
6728
- readonly Dpd: "DPD";
6729
- readonly ChorltonPallet: "Chorlton Pallet";
6730
- readonly Pops: "POPS";
6731
- };
6732
- export type ShipmentRequestDTOCourierEnum = typeof ShipmentRequestDTOCourierEnum[keyof typeof ShipmentRequestDTOCourierEnum];
6733
- /**
6734
- *
6735
- * @export
6736
- * @interface ShippingConsignmentModel
6737
- */
6738
- export interface ShippingConsignmentModel {
6739
- /**
6740
- *
6741
- * @type {ShippingServiceModel}
6742
- * @memberof ShippingConsignmentModel
6743
- */
6744
- 'service'?: ShippingServiceModel;
6745
- /**
6746
- * ID/Number
6747
- * @type {string}
6748
- * @memberof ShippingConsignmentModel
6749
- */
6750
- 'id'?: string;
6751
- /**
6752
- * Tracking Number
6753
- * @type {string}
6754
- * @memberof ShippingConsignmentModel
6755
- */
6756
- 'trackingNumber'?: string;
6757
- /**
6758
- * Parcels
6759
- * @type {Array<string>}
6760
- * @memberof ShippingConsignmentModel
6761
- */
6762
- 'parcelIds'?: Array<string>;
6763
- }
6764
- /**
6765
- * Shipping Information
6766
- * @export
6767
- * @interface ShippingInformationDTO
6768
- */
6769
- export interface ShippingInformationDTO {
6770
- /**
6771
- * Items
6772
- * @type {Array<BasicItemDTO>}
6773
- * @memberof ShippingInformationDTO
6774
- */
6775
- 'items'?: Array<BasicItemDTO>;
6776
- /**
6777
- * Destination Post Code
6778
- * @type {string}
6779
- * @memberof ShippingInformationDTO
6780
- */
6781
- 'postalCode'?: string;
6782
- /**
6783
- * Destination ISO
6784
- * @type {string}
6785
- * @memberof ShippingInformationDTO
5759
+ * @memberof ShippingInformationDTO
6786
5760
  */
6787
5761
  'iso'?: string;
6788
5762
  }
6789
- /**
6790
- *
6791
- * @export
6792
- * @interface ShippingRequestDTO
6793
- */
6794
- export interface ShippingRequestDTO {
6795
- /**
6796
- * Courier
6797
- * @type {string}
6798
- * @memberof ShippingRequestDTO
6799
- */
6800
- 'courier'?: ShippingRequestDTOCourierEnum;
6801
- /**
6802
- * Courier Service
6803
- * @type {string}
6804
- * @memberof ShippingRequestDTO
6805
- */
6806
- 'service'?: string;
6807
- /**
6808
- * Boxes
6809
- * @type {number}
6810
- * @memberof ShippingRequestDTO
6811
- */
6812
- 'boxes'?: number;
6813
- }
6814
- export declare const ShippingRequestDTOCourierEnum: {
6815
- readonly Dpd: "DPD";
6816
- readonly ChorltonPallet: "Chorlton Pallet";
6817
- readonly Pops: "POPS";
6818
- };
6819
- export type ShippingRequestDTOCourierEnum = typeof ShippingRequestDTOCourierEnum[keyof typeof ShippingRequestDTOCourierEnum];
6820
5763
  /**
6821
5764
  * Shipping Service
6822
5765
  * @export
@@ -8424,67 +7367,6 @@ export interface SupplierItemEntity {
8424
7367
  */
8425
7368
  'supplierSku'?: string;
8426
7369
  }
8427
- /**
8428
- * Supplier
8429
- * @export
8430
- * @interface SupplierModel
8431
- */
8432
- export interface SupplierModel {
8433
- /**
8434
- * id
8435
- * @type {number}
8436
- * @memberof SupplierModel
8437
- */
8438
- 'id'?: number;
8439
- /**
8440
- * name
8441
- * @type {string}
8442
- * @memberof SupplierModel
8443
- */
8444
- 'name'?: string;
8445
- /**
8446
- * nameShort
8447
- * @type {string}
8448
- * @memberof SupplierModel
8449
- */
8450
- 'shortName'?: string;
8451
- /**
8452
- * email
8453
- * @type {string}
8454
- * @memberof SupplierModel
8455
- */
8456
- 'email'?: string;
8457
- /**
8458
- * phone
8459
- * @type {string}
8460
- * @memberof SupplierModel
8461
- */
8462
- 'phone'?: string;
8463
- /**
8464
- * defaultCourier
8465
- * @type {string}
8466
- * @memberof SupplierModel
8467
- */
8468
- 'defaultCourier'?: string;
8469
- /**
8470
- * defaultCarriage
8471
- * @type {number}
8472
- * @memberof SupplierModel
8473
- */
8474
- 'defaultCarriage'?: number;
8475
- /**
8476
- * account
8477
- * @type {string}
8478
- * @memberof SupplierModel
8479
- */
8480
- 'accountNumber'?: string;
8481
- /**
8482
- * internalAccount
8483
- * @type {string}
8484
- * @memberof SupplierModel
8485
- */
8486
- 'xeroAccountNumber'?: string;
8487
- }
8488
7370
  /**
8489
7371
  * 3CX Wizard Restore From Backup
8490
7372
  * @export
@@ -14471,25 +13353,6 @@ export type PostAuthoriseScopeEnum = typeof PostAuthoriseScopeEnum[keyof typeof
14471
13353
  * @export
14472
13354
  */
14473
13355
  export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
14474
- /**
14475
- * Delete Shipment (Admin)
14476
- * @summary Delete Shipment (Admin)
14477
- * @param {number} id Order ID
14478
- * @param {number} batchId Batch ID
14479
- * @param {number} shipmentId Shipment ID
14480
- * @param {*} [options] Override http request option.
14481
- * @throws {RequiredError}
14482
- */
14483
- deleteCreateShipment: (id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14484
- /**
14485
- * Delete Batch (Admin)
14486
- * @param {number} id Order ID
14487
- * @param {number} batchId Batch ID
14488
- * @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
14489
- * @param {*} [options] Override http request option.
14490
- * @throws {RequiredError}
14491
- */
14492
- deleteDeleteBatch: (id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14493
13356
  /**
14494
13357
  * Delete Orders (Beta)
14495
13358
  * @summary Delete Orders (Beta)
@@ -14506,14 +13369,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
14506
13369
  * @throws {RequiredError}
14507
13370
  */
14508
13371
  getGetAdminEditableOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14509
- /**
14510
- * Get Order Details (Admin)
14511
- * @summary Get Order Details (Admin)
14512
- * @param {number} id Order ID
14513
- * @param {*} [options] Override http request option.
14514
- * @throws {RequiredError}
14515
- */
14516
- getGetAdminOrderDetails: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14517
13372
  /**
14518
13373
  * Get Editable Order (Beta)
14519
13374
  * @summary Get Editable Order (Beta)
@@ -14522,14 +13377,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
14522
13377
  * @throws {RequiredError}
14523
13378
  */
14524
13379
  getGetEditableOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14525
- /**
14526
- * Download Order PDF
14527
- * @summary Download Order PDF
14528
- * @param {number} id Order ID
14529
- * @param {*} [options] Override http request option.
14530
- * @throws {RequiredError}
14531
- */
14532
- getGetOrderPdf: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14533
13380
  /**
14534
13381
  * Get Orders (Beta)
14535
13382
  * @summary Get Orders (Beta)
@@ -14544,15 +13391,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
14544
13391
  * @throws {RequiredError}
14545
13392
  */
14546
13393
  getGetOrders: (pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14547
- /**
14548
- * Add Order Note
14549
- * @summary Add Order Note
14550
- * @param {number} id Order ID
14551
- * @param {PostAddOrderNoteRequest} [postAddOrderNoteRequest]
14552
- * @param {*} [options] Override http request option.
14553
- * @throws {RequiredError}
14554
- */
14555
- postAddOrderNote: (id: number, postAddOrderNoteRequest?: PostAddOrderNoteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14556
13394
  /**
14557
13395
  * Create An Order (Admin)
14558
13396
  * @summary Create An Order (Admin)
@@ -14562,26 +13400,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
14562
13400
  * @throws {RequiredError}
14563
13401
  */
14564
13402
  postCreateAdminOrder: (readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14565
- /**
14566
- * Create Shipping Consignment
14567
- * @summary Create Shipping Consignment
14568
- * @param {number} id Order ID
14569
- * @param {number} shipmentId Shipment ID
14570
- * @param {ShippingRequestDTO} [shippingRequestDTO] Shipping Request
14571
- * @param {*} [options] Override http request option.
14572
- * @throws {RequiredError}
14573
- */
14574
- postCreateConsignment: (id: number, shipmentId: number, shippingRequestDTO?: ShippingRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14575
- /**
14576
- * Create Shipment (Admin)
14577
- * @summary Create Shipment (Admin)
14578
- * @param {number} id Order ID
14579
- * @param {number} batchId Batch ID
14580
- * @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
14581
- * @param {*} [options] Override http request option.
14582
- * @throws {RequiredError}
14583
- */
14584
- postCreateShipment: (id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14585
13403
  /**
14586
13404
  * Create An Order (Beta)
14587
13405
  * @summary Create An Order (Beta)
@@ -14591,73 +13409,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
14591
13409
  * @throws {RequiredError}
14592
13410
  */
14593
13411
  postGetOrders: (readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14594
- /**
14595
- * Issue Credit (Admin)
14596
- * @summary Issue Credit (Admin)
14597
- * @param {number} id Order ID
14598
- * @param {CreditNoteDTO} [creditNoteDTO] Credit Request
14599
- * @param {*} [options] Override http request option.
14600
- * @throws {RequiredError}
14601
- */
14602
- postIssueCredit: (id: number, creditNoteDTO?: CreditNoteDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14603
- /**
14604
- * Print Shipment Label
14605
- * @summary Print Shipment Label
14606
- * @param {number} id Order ID
14607
- * @param {number} shipmentId Shipment ID
14608
- * @param {PostPrintShippingLabelPrinterEnum} printer Printer
14609
- * @param {*} [options] Override http request option.
14610
- * @throws {RequiredError}
14611
- */
14612
- postPrintShippingLabel: (id: number, shipmentId: number, printer: PostPrintShippingLabelPrinterEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14613
- /**
14614
- * Send Order Email
14615
- * @summary Send Order Email
14616
- * @param {number} id Order ID
14617
- * @param {string} email Email Address
14618
- * @param {*} [options] Override http request option.
14619
- * @throws {RequiredError}
14620
- */
14621
- postSendOrderEmail: (id: number, email: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14622
- /**
14623
- * Send Supplier Email
14624
- * @summary Send Supplier Email
14625
- * @param {number} id Order ID
14626
- * @param {number} batchId Batch ID
14627
- * @param {*} [options] Override http request option.
14628
- * @throws {RequiredError}
14629
- */
14630
- postSendSupplierEmail: (id: number, batchId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14631
- /**
14632
- * Split Order
14633
- * @summary Split Order
14634
- * @param {number} id Order ID
14635
- * @param {PostSplitOrderRequest} [postSplitOrderRequest]
14636
- * @param {*} [options] Override http request option.
14637
- * @throws {RequiredError}
14638
- */
14639
- postSplitOrder: (id: number, postSplitOrderRequest?: PostSplitOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14640
- /**
14641
- * Allocate Items To Supplier
14642
- * @summary Allocate Items To Supplier
14643
- * @param {number} id Order ID
14644
- * @param {number} supplierId Supplier ID
14645
- * @param {PutAllocateItemsRequest} [putAllocateItemsRequest]
14646
- * @param {*} [options] Override http request option.
14647
- * @throws {RequiredError}
14648
- */
14649
- putAllocateItems: (id: number, supplierId: number, putAllocateItemsRequest?: PutAllocateItemsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14650
- /**
14651
- * Update Shipment (Admin)
14652
- * @summary Update Shipment (Admin)
14653
- * @param {number} id Order ID
14654
- * @param {number} batchId Batch ID
14655
- * @param {number} shipmentId Shipment ID
14656
- * @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
14657
- * @param {*} [options] Override http request option.
14658
- * @throws {RequiredError}
14659
- */
14660
- putCreateShipment: (id: number, batchId: number, shipmentId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14661
13412
  /**
14662
13413
  * Update An Order (Admin)
14663
13414
  * @summary Update An Order (Admin)
@@ -14684,25 +13435,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
14684
13435
  * @export
14685
13436
  */
14686
13437
  export declare const OrdersApiFp: (configuration?: Configuration) => {
14687
- /**
14688
- * Delete Shipment (Admin)
14689
- * @summary Delete Shipment (Admin)
14690
- * @param {number} id Order ID
14691
- * @param {number} batchId Batch ID
14692
- * @param {number} shipmentId Shipment ID
14693
- * @param {*} [options] Override http request option.
14694
- * @throws {RequiredError}
14695
- */
14696
- deleteCreateShipment(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
14697
- /**
14698
- * Delete Batch (Admin)
14699
- * @param {number} id Order ID
14700
- * @param {number} batchId Batch ID
14701
- * @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
14702
- * @param {*} [options] Override http request option.
14703
- * @throws {RequiredError}
14704
- */
14705
- deleteDeleteBatch(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
14706
13438
  /**
14707
13439
  * Delete Orders (Beta)
14708
13440
  * @summary Delete Orders (Beta)
@@ -14719,14 +13451,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
14719
13451
  * @throws {RequiredError}
14720
13452
  */
14721
13453
  getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminOrderRequestDTO>>;
14722
- /**
14723
- * Get Order Details (Admin)
14724
- * @summary Get Order Details (Admin)
14725
- * @param {number} id Order ID
14726
- * @param {*} [options] Override http request option.
14727
- * @throws {RequiredError}
14728
- */
14729
- getGetAdminOrderDetails(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>>;
14730
13454
  /**
14731
13455
  * Get Editable Order (Beta)
14732
13456
  * @summary Get Editable Order (Beta)
@@ -14735,14 +13459,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
14735
13459
  * @throws {RequiredError}
14736
13460
  */
14737
13461
  getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetailedOrderRequestDTO>>;
14738
- /**
14739
- * Download Order PDF
14740
- * @summary Download Order PDF
14741
- * @param {number} id Order ID
14742
- * @param {*} [options] Override http request option.
14743
- * @throws {RequiredError}
14744
- */
14745
- getGetOrderPdf(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
14746
13462
  /**
14747
13463
  * Get Orders (Beta)
14748
13464
  * @summary Get Orders (Beta)
@@ -14757,15 +13473,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
14757
13473
  * @throws {RequiredError}
14758
13474
  */
14759
13475
  getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderSummariesModel>>;
14760
- /**
14761
- * Add Order Note
14762
- * @summary Add Order Note
14763
- * @param {number} id Order ID
14764
- * @param {PostAddOrderNoteRequest} [postAddOrderNoteRequest]
14765
- * @param {*} [options] Override http request option.
14766
- * @throws {RequiredError}
14767
- */
14768
- postAddOrderNote(id: number, postAddOrderNoteRequest?: PostAddOrderNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
14769
13476
  /**
14770
13477
  * Create An Order (Admin)
14771
13478
  * @summary Create An Order (Admin)
@@ -14775,26 +13482,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
14775
13482
  * @throws {RequiredError}
14776
13483
  */
14777
13484
  postCreateAdminOrder(readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OrderSummaryDTO>>>;
14778
- /**
14779
- * Create Shipping Consignment
14780
- * @summary Create Shipping Consignment
14781
- * @param {number} id Order ID
14782
- * @param {number} shipmentId Shipment ID
14783
- * @param {ShippingRequestDTO} [shippingRequestDTO] Shipping Request
14784
- * @param {*} [options] Override http request option.
14785
- * @throws {RequiredError}
14786
- */
14787
- postCreateConsignment(id: number, shipmentId: number, shippingRequestDTO?: ShippingRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentModel>>;
14788
- /**
14789
- * Create Shipment (Admin)
14790
- * @summary Create Shipment (Admin)
14791
- * @param {number} id Order ID
14792
- * @param {number} batchId Batch ID
14793
- * @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
14794
- * @param {*} [options] Override http request option.
14795
- * @throws {RequiredError}
14796
- */
14797
- postCreateShipment(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentModel>>;
14798
13485
  /**
14799
13486
  * Create An Order (Beta)
14800
13487
  * @summary Create An Order (Beta)
@@ -14804,73 +13491,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
14804
13491
  * @throws {RequiredError}
14805
13492
  */
14806
13493
  postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OrderSummaryDTO>>>;
14807
- /**
14808
- * Issue Credit (Admin)
14809
- * @summary Issue Credit (Admin)
14810
- * @param {number} id Order ID
14811
- * @param {CreditNoteDTO} [creditNoteDTO] Credit Request
14812
- * @param {*} [options] Override http request option.
14813
- * @throws {RequiredError}
14814
- */
14815
- postIssueCredit(id: number, creditNoteDTO?: CreditNoteDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreditNoteModel>>;
14816
- /**
14817
- * Print Shipment Label
14818
- * @summary Print Shipment Label
14819
- * @param {number} id Order ID
14820
- * @param {number} shipmentId Shipment ID
14821
- * @param {PostPrintShippingLabelPrinterEnum} printer Printer
14822
- * @param {*} [options] Override http request option.
14823
- * @throws {RequiredError}
14824
- */
14825
- postPrintShippingLabel(id: number, shipmentId: number, printer: PostPrintShippingLabelPrinterEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
14826
- /**
14827
- * Send Order Email
14828
- * @summary Send Order Email
14829
- * @param {number} id Order ID
14830
- * @param {string} email Email Address
14831
- * @param {*} [options] Override http request option.
14832
- * @throws {RequiredError}
14833
- */
14834
- postSendOrderEmail(id: number, email: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
14835
- /**
14836
- * Send Supplier Email
14837
- * @summary Send Supplier Email
14838
- * @param {number} id Order ID
14839
- * @param {number} batchId Batch ID
14840
- * @param {*} [options] Override http request option.
14841
- * @throws {RequiredError}
14842
- */
14843
- postSendSupplierEmail(id: number, batchId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
14844
- /**
14845
- * Split Order
14846
- * @summary Split Order
14847
- * @param {number} id Order ID
14848
- * @param {PostSplitOrderRequest} [postSplitOrderRequest]
14849
- * @param {*} [options] Override http request option.
14850
- * @throws {RequiredError}
14851
- */
14852
- postSplitOrder(id: number, postSplitOrderRequest?: PostSplitOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OrderSummaryDTO>>>;
14853
- /**
14854
- * Allocate Items To Supplier
14855
- * @summary Allocate Items To Supplier
14856
- * @param {number} id Order ID
14857
- * @param {number} supplierId Supplier ID
14858
- * @param {PutAllocateItemsRequest} [putAllocateItemsRequest]
14859
- * @param {*} [options] Override http request option.
14860
- * @throws {RequiredError}
14861
- */
14862
- putAllocateItems(id: number, supplierId: number, putAllocateItemsRequest?: PutAllocateItemsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
14863
- /**
14864
- * Update Shipment (Admin)
14865
- * @summary Update Shipment (Admin)
14866
- * @param {number} id Order ID
14867
- * @param {number} batchId Batch ID
14868
- * @param {number} shipmentId Shipment ID
14869
- * @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
14870
- * @param {*} [options] Override http request option.
14871
- * @throws {RequiredError}
14872
- */
14873
- putCreateShipment(id: number, batchId: number, shipmentId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentModel>>;
14874
13494
  /**
14875
13495
  * Update An Order (Admin)
14876
13496
  * @summary Update An Order (Admin)
@@ -14897,25 +13517,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
14897
13517
  * @export
14898
13518
  */
14899
13519
  export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
14900
- /**
14901
- * Delete Shipment (Admin)
14902
- * @summary Delete Shipment (Admin)
14903
- * @param {number} id Order ID
14904
- * @param {number} batchId Batch ID
14905
- * @param {number} shipmentId Shipment ID
14906
- * @param {*} [options] Override http request option.
14907
- * @throws {RequiredError}
14908
- */
14909
- deleteCreateShipment(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
14910
- /**
14911
- * Delete Batch (Admin)
14912
- * @param {number} id Order ID
14913
- * @param {number} batchId Batch ID
14914
- * @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
14915
- * @param {*} [options] Override http request option.
14916
- * @throws {RequiredError}
14917
- */
14918
- deleteDeleteBatch(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<void>;
14919
13520
  /**
14920
13521
  * Delete Orders (Beta)
14921
13522
  * @summary Delete Orders (Beta)
@@ -14932,14 +13533,6 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
14932
13533
  * @throws {RequiredError}
14933
13534
  */
14934
13535
  getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminOrderRequestDTO>;
14935
- /**
14936
- * Get Order Details (Admin)
14937
- * @summary Get Order Details (Admin)
14938
- * @param {number} id Order ID
14939
- * @param {*} [options] Override http request option.
14940
- * @throws {RequiredError}
14941
- */
14942
- getGetAdminOrderDetails(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO>;
14943
13536
  /**
14944
13537
  * Get Editable Order (Beta)
14945
13538
  * @summary Get Editable Order (Beta)
@@ -14948,14 +13541,6 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
14948
13541
  * @throws {RequiredError}
14949
13542
  */
14950
13543
  getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DetailedOrderRequestDTO>;
14951
- /**
14952
- * Download Order PDF
14953
- * @summary Download Order PDF
14954
- * @param {number} id Order ID
14955
- * @param {*} [options] Override http request option.
14956
- * @throws {RequiredError}
14957
- */
14958
- getGetOrderPdf(id: number, options?: RawAxiosRequestConfig): AxiosPromise<File>;
14959
13544
  /**
14960
13545
  * Get Orders (Beta)
14961
13546
  * @summary Get Orders (Beta)
@@ -14970,15 +13555,6 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
14970
13555
  * @throws {RequiredError}
14971
13556
  */
14972
13557
  getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummariesModel>;
14973
- /**
14974
- * Add Order Note
14975
- * @summary Add Order Note
14976
- * @param {number} id Order ID
14977
- * @param {PostAddOrderNoteRequest} [postAddOrderNoteRequest]
14978
- * @param {*} [options] Override http request option.
14979
- * @throws {RequiredError}
14980
- */
14981
- postAddOrderNote(id: number, postAddOrderNoteRequest?: PostAddOrderNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
14982
13558
  /**
14983
13559
  * Create An Order (Admin)
14984
13560
  * @summary Create An Order (Admin)
@@ -14988,26 +13564,6 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
14988
13564
  * @throws {RequiredError}
14989
13565
  */
14990
13566
  postCreateAdminOrder(readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>>;
14991
- /**
14992
- * Create Shipping Consignment
14993
- * @summary Create Shipping Consignment
14994
- * @param {number} id Order ID
14995
- * @param {number} shipmentId Shipment ID
14996
- * @param {ShippingRequestDTO} [shippingRequestDTO] Shipping Request
14997
- * @param {*} [options] Override http request option.
14998
- * @throws {RequiredError}
14999
- */
15000
- postCreateConsignment(id: number, shipmentId: number, shippingRequestDTO?: ShippingRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentModel>;
15001
- /**
15002
- * Create Shipment (Admin)
15003
- * @summary Create Shipment (Admin)
15004
- * @param {number} id Order ID
15005
- * @param {number} batchId Batch ID
15006
- * @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
15007
- * @param {*} [options] Override http request option.
15008
- * @throws {RequiredError}
15009
- */
15010
- postCreateShipment(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentModel>;
15011
13567
  /**
15012
13568
  * Create An Order (Beta)
15013
13569
  * @summary Create An Order (Beta)
@@ -15017,73 +13573,6 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
15017
13573
  * @throws {RequiredError}
15018
13574
  */
15019
13575
  postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>>;
15020
- /**
15021
- * Issue Credit (Admin)
15022
- * @summary Issue Credit (Admin)
15023
- * @param {number} id Order ID
15024
- * @param {CreditNoteDTO} [creditNoteDTO] Credit Request
15025
- * @param {*} [options] Override http request option.
15026
- * @throws {RequiredError}
15027
- */
15028
- postIssueCredit(id: number, creditNoteDTO?: CreditNoteDTO, options?: RawAxiosRequestConfig): AxiosPromise<CreditNoteModel>;
15029
- /**
15030
- * Print Shipment Label
15031
- * @summary Print Shipment Label
15032
- * @param {number} id Order ID
15033
- * @param {number} shipmentId Shipment ID
15034
- * @param {PostPrintShippingLabelPrinterEnum} printer Printer
15035
- * @param {*} [options] Override http request option.
15036
- * @throws {RequiredError}
15037
- */
15038
- postPrintShippingLabel(id: number, shipmentId: number, printer: PostPrintShippingLabelPrinterEnum, options?: RawAxiosRequestConfig): AxiosPromise<File>;
15039
- /**
15040
- * Send Order Email
15041
- * @summary Send Order Email
15042
- * @param {number} id Order ID
15043
- * @param {string} email Email Address
15044
- * @param {*} [options] Override http request option.
15045
- * @throws {RequiredError}
15046
- */
15047
- postSendOrderEmail(id: number, email: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
15048
- /**
15049
- * Send Supplier Email
15050
- * @summary Send Supplier Email
15051
- * @param {number} id Order ID
15052
- * @param {number} batchId Batch ID
15053
- * @param {*} [options] Override http request option.
15054
- * @throws {RequiredError}
15055
- */
15056
- postSendSupplierEmail(id: number, batchId: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
15057
- /**
15058
- * Split Order
15059
- * @summary Split Order
15060
- * @param {number} id Order ID
15061
- * @param {PostSplitOrderRequest} [postSplitOrderRequest]
15062
- * @param {*} [options] Override http request option.
15063
- * @throws {RequiredError}
15064
- */
15065
- postSplitOrder(id: number, postSplitOrderRequest?: PostSplitOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>>;
15066
- /**
15067
- * Allocate Items To Supplier
15068
- * @summary Allocate Items To Supplier
15069
- * @param {number} id Order ID
15070
- * @param {number} supplierId Supplier ID
15071
- * @param {PutAllocateItemsRequest} [putAllocateItemsRequest]
15072
- * @param {*} [options] Override http request option.
15073
- * @throws {RequiredError}
15074
- */
15075
- putAllocateItems(id: number, supplierId: number, putAllocateItemsRequest?: PutAllocateItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
15076
- /**
15077
- * Update Shipment (Admin)
15078
- * @summary Update Shipment (Admin)
15079
- * @param {number} id Order ID
15080
- * @param {number} batchId Batch ID
15081
- * @param {number} shipmentId Shipment ID
15082
- * @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
15083
- * @param {*} [options] Override http request option.
15084
- * @throws {RequiredError}
15085
- */
15086
- putCreateShipment(id: number, batchId: number, shipmentId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentModel>;
15087
13576
  /**
15088
13577
  * Update An Order (Admin)
15089
13578
  * @summary Update An Order (Admin)
@@ -15112,27 +13601,6 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
15112
13601
  * @extends {BaseAPI}
15113
13602
  */
15114
13603
  export declare class OrdersApi extends BaseAPI {
15115
- /**
15116
- * Delete Shipment (Admin)
15117
- * @summary Delete Shipment (Admin)
15118
- * @param {number} id Order ID
15119
- * @param {number} batchId Batch ID
15120
- * @param {number} shipmentId Shipment ID
15121
- * @param {*} [options] Override http request option.
15122
- * @throws {RequiredError}
15123
- * @memberof OrdersApi
15124
- */
15125
- deleteCreateShipment(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
15126
- /**
15127
- * Delete Batch (Admin)
15128
- * @param {number} id Order ID
15129
- * @param {number} batchId Batch ID
15130
- * @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
15131
- * @param {*} [options] Override http request option.
15132
- * @throws {RequiredError}
15133
- * @memberof OrdersApi
15134
- */
15135
- deleteDeleteBatch(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
15136
13604
  /**
15137
13605
  * Delete Orders (Beta)
15138
13606
  * @summary Delete Orders (Beta)
@@ -15151,15 +13619,6 @@ export declare class OrdersApi extends BaseAPI {
15151
13619
  * @memberof OrdersApi
15152
13620
  */
15153
13621
  getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminOrderRequestDTO, any, {}>>;
15154
- /**
15155
- * Get Order Details (Admin)
15156
- * @summary Get Order Details (Admin)
15157
- * @param {number} id Order ID
15158
- * @param {*} [options] Override http request option.
15159
- * @throws {RequiredError}
15160
- * @memberof OrdersApi
15161
- */
15162
- getGetAdminOrderDetails(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderDetailsDTO, any, {}>>;
15163
13622
  /**
15164
13623
  * Get Editable Order (Beta)
15165
13624
  * @summary Get Editable Order (Beta)
@@ -15169,15 +13628,6 @@ export declare class OrdersApi extends BaseAPI {
15169
13628
  * @memberof OrdersApi
15170
13629
  */
15171
13630
  getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DetailedOrderRequestDTO, any, {}>>;
15172
- /**
15173
- * Download Order PDF
15174
- * @summary Download Order PDF
15175
- * @param {number} id Order ID
15176
- * @param {*} [options] Override http request option.
15177
- * @throws {RequiredError}
15178
- * @memberof OrdersApi
15179
- */
15180
- getGetOrderPdf(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
15181
13631
  /**
15182
13632
  * Get Orders (Beta)
15183
13633
  * @summary Get Orders (Beta)
@@ -15193,16 +13643,6 @@ export declare class OrdersApi extends BaseAPI {
15193
13643
  * @memberof OrdersApi
15194
13644
  */
15195
13645
  getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummariesModel, any, {}>>;
15196
- /**
15197
- * Add Order Note
15198
- * @summary Add Order Note
15199
- * @param {number} id Order ID
15200
- * @param {PostAddOrderNoteRequest} [postAddOrderNoteRequest]
15201
- * @param {*} [options] Override http request option.
15202
- * @throws {RequiredError}
15203
- * @memberof OrdersApi
15204
- */
15205
- postAddOrderNote(id: number, postAddOrderNoteRequest?: PostAddOrderNoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
15206
13646
  /**
15207
13647
  * Create An Order (Admin)
15208
13648
  * @summary Create An Order (Admin)
@@ -15213,28 +13653,6 @@ export declare class OrdersApi extends BaseAPI {
15213
13653
  * @memberof OrdersApi
15214
13654
  */
15215
13655
  postCreateAdminOrder(readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO[], any, {}>>;
15216
- /**
15217
- * Create Shipping Consignment
15218
- * @summary Create Shipping Consignment
15219
- * @param {number} id Order ID
15220
- * @param {number} shipmentId Shipment ID
15221
- * @param {ShippingRequestDTO} [shippingRequestDTO] Shipping Request
15222
- * @param {*} [options] Override http request option.
15223
- * @throws {RequiredError}
15224
- * @memberof OrdersApi
15225
- */
15226
- postCreateConsignment(id: number, shipmentId: number, shippingRequestDTO?: ShippingRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShipmentModel, any, {}>>;
15227
- /**
15228
- * Create Shipment (Admin)
15229
- * @summary Create Shipment (Admin)
15230
- * @param {number} id Order ID
15231
- * @param {number} batchId Batch ID
15232
- * @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
15233
- * @param {*} [options] Override http request option.
15234
- * @throws {RequiredError}
15235
- * @memberof OrdersApi
15236
- */
15237
- postCreateShipment(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShipmentModel, any, {}>>;
15238
13656
  /**
15239
13657
  * Create An Order (Beta)
15240
13658
  * @summary Create An Order (Beta)
@@ -15245,80 +13663,6 @@ export declare class OrdersApi extends BaseAPI {
15245
13663
  * @memberof OrdersApi
15246
13664
  */
15247
13665
  postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO[], any, {}>>;
15248
- /**
15249
- * Issue Credit (Admin)
15250
- * @summary Issue Credit (Admin)
15251
- * @param {number} id Order ID
15252
- * @param {CreditNoteDTO} [creditNoteDTO] Credit Request
15253
- * @param {*} [options] Override http request option.
15254
- * @throws {RequiredError}
15255
- * @memberof OrdersApi
15256
- */
15257
- postIssueCredit(id: number, creditNoteDTO?: CreditNoteDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreditNoteModel, any, {}>>;
15258
- /**
15259
- * Print Shipment Label
15260
- * @summary Print Shipment Label
15261
- * @param {number} id Order ID
15262
- * @param {number} shipmentId Shipment ID
15263
- * @param {PostPrintShippingLabelPrinterEnum} printer Printer
15264
- * @param {*} [options] Override http request option.
15265
- * @throws {RequiredError}
15266
- * @memberof OrdersApi
15267
- */
15268
- postPrintShippingLabel(id: number, shipmentId: number, printer: PostPrintShippingLabelPrinterEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
15269
- /**
15270
- * Send Order Email
15271
- * @summary Send Order Email
15272
- * @param {number} id Order ID
15273
- * @param {string} email Email Address
15274
- * @param {*} [options] Override http request option.
15275
- * @throws {RequiredError}
15276
- * @memberof OrdersApi
15277
- */
15278
- postSendOrderEmail(id: number, email: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
15279
- /**
15280
- * Send Supplier Email
15281
- * @summary Send Supplier Email
15282
- * @param {number} id Order ID
15283
- * @param {number} batchId Batch ID
15284
- * @param {*} [options] Override http request option.
15285
- * @throws {RequiredError}
15286
- * @memberof OrdersApi
15287
- */
15288
- postSendSupplierEmail(id: number, batchId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
15289
- /**
15290
- * Split Order
15291
- * @summary Split Order
15292
- * @param {number} id Order ID
15293
- * @param {PostSplitOrderRequest} [postSplitOrderRequest]
15294
- * @param {*} [options] Override http request option.
15295
- * @throws {RequiredError}
15296
- * @memberof OrdersApi
15297
- */
15298
- postSplitOrder(id: number, postSplitOrderRequest?: PostSplitOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO[], any, {}>>;
15299
- /**
15300
- * Allocate Items To Supplier
15301
- * @summary Allocate Items To Supplier
15302
- * @param {number} id Order ID
15303
- * @param {number} supplierId Supplier ID
15304
- * @param {PutAllocateItemsRequest} [putAllocateItemsRequest]
15305
- * @param {*} [options] Override http request option.
15306
- * @throws {RequiredError}
15307
- * @memberof OrdersApi
15308
- */
15309
- putAllocateItems(id: number, supplierId: number, putAllocateItemsRequest?: PutAllocateItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
15310
- /**
15311
- * Update Shipment (Admin)
15312
- * @summary Update Shipment (Admin)
15313
- * @param {number} id Order ID
15314
- * @param {number} batchId Batch ID
15315
- * @param {number} shipmentId Shipment ID
15316
- * @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
15317
- * @param {*} [options] Override http request option.
15318
- * @throws {RequiredError}
15319
- * @memberof OrdersApi
15320
- */
15321
- putCreateShipment(id: number, batchId: number, shipmentId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShipmentModel, any, {}>>;
15322
13666
  /**
15323
13667
  * Update An Order (Admin)
15324
13668
  * @summary Update An Order (Admin)
@@ -15362,15 +13706,6 @@ export declare const GetGetOrdersFilterEnum: {
15362
13706
  readonly BackOrders: "BACK_ORDERS";
15363
13707
  };
15364
13708
  export type GetGetOrdersFilterEnum = typeof GetGetOrdersFilterEnum[keyof typeof GetGetOrdersFilterEnum];
15365
- /**
15366
- * @export
15367
- */
15368
- export declare const PostPrintShippingLabelPrinterEnum: {
15369
- readonly NUMBER_1: 1;
15370
- readonly NUMBER_2: 2;
15371
- readonly NUMBER_3: 3;
15372
- };
15373
- export type PostPrintShippingLabelPrinterEnum = typeof PostPrintShippingLabelPrinterEnum[keyof typeof PostPrintShippingLabelPrinterEnum];
15374
13709
  /**
15375
13710
  * PricingApi - axios parameter creator
15376
13711
  * @export