yellowgrid-api-ts 3.2.101-dev.0 → 3.2.103-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 +28 -1
- package/README.md +60 -1
- package/api.ts +3441 -182
- package/dist/api.d.ts +2218 -157
- package/dist/api.js +3028 -235
- package/docs/AccountPageDetailsDTO.md +35 -0
- package/docs/AccountsApi.md +352 -4
- package/docs/AdminNumberPortDTO.md +4 -0
- package/docs/BatchDTO.md +59 -0
- package/docs/CreditNoteDTO.md +21 -0
- package/docs/CreditNoteEntity.md +29 -0
- package/docs/CreditNoteItemDTO.md +25 -0
- package/docs/CreditNoteItemEntity.md +29 -0
- package/docs/CreditNoteItemModel.md +29 -0
- package/docs/CreditNoteModel.md +31 -0
- package/docs/NumberPortingApi.md +60 -5
- package/docs/OAuth20Api.md +3 -3
- package/docs/OrderDetailsDTO.md +65 -0
- package/docs/OrderItemDTO.md +55 -0
- package/docs/OrderedItemModel.md +47 -0
- package/docs/OrdersApi.md +1325 -74
- package/docs/PatchUpdateAccountCnameRequest.md +20 -0
- package/docs/PostAddAdminNoteRequest.md +20 -0
- package/docs/PostAddOrderNoteRequest.md +20 -0
- package/docs/PostSplitOrderRequest.md +20 -0
- package/docs/PrinterEntity.md +29 -0
- package/docs/ProductsApi.md +58 -0
- package/docs/PutAllocateItemsRequest.md +20 -0
- package/docs/PutAllocateItemsRequestItemsInner.md +22 -0
- package/docs/SMSApi.md +56 -0
- package/docs/ShipmentDTO.md +41 -0
- package/docs/ShipmentItemDTO.md +23 -0
- package/docs/ShipmentItemEntity.md +1 -1
- package/docs/ShipmentItemModel.md +29 -0
- package/docs/ShipmentModel.md +43 -0
- package/docs/ShipmentRequestDTO.md +31 -0
- package/docs/ShippingRequestDTO.md +28 -0
- package/docs/SmsAccountDTO.md +31 -0
- package/docs/SmsAccountRequestDTO.md +29 -0
- package/docs/SupplierItemModel.md +35 -0
- package/docs/SupplierModel.md +37 -0
- package/docs/TcxSbcDTO.md +2 -0
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -237,6 +237,37 @@ export interface AccountDetailedSummaryDTO {
|
|
|
237
237
|
*/
|
|
238
238
|
'balance'?: number | null;
|
|
239
239
|
}
|
|
240
|
+
/**
|
|
241
|
+
* Account Page Details
|
|
242
|
+
*/
|
|
243
|
+
export interface AccountPageDetailsDTO {
|
|
244
|
+
/**
|
|
245
|
+
* Xero ID
|
|
246
|
+
*/
|
|
247
|
+
'xeroId'?: string;
|
|
248
|
+
/**
|
|
249
|
+
* Company
|
|
250
|
+
*/
|
|
251
|
+
'companyName'?: string;
|
|
252
|
+
'billingAddress'?: AddressModel;
|
|
253
|
+
'defaultShippingAddress'?: AddressModel;
|
|
254
|
+
/**
|
|
255
|
+
* Addresses
|
|
256
|
+
*/
|
|
257
|
+
'previousShippingAddreses'?: Array<AddressModel>;
|
|
258
|
+
/**
|
|
259
|
+
* Portal Access
|
|
260
|
+
*/
|
|
261
|
+
'portalAccess'?: boolean;
|
|
262
|
+
/**
|
|
263
|
+
* CNAME
|
|
264
|
+
*/
|
|
265
|
+
'cname'?: string;
|
|
266
|
+
/**
|
|
267
|
+
* Prizes Enabled
|
|
268
|
+
*/
|
|
269
|
+
'prizesEnabled'?: boolean;
|
|
270
|
+
}
|
|
240
271
|
/**
|
|
241
272
|
* New Account Request
|
|
242
273
|
*/
|
|
@@ -510,6 +541,14 @@ export interface AdminNumberPortDTO {
|
|
|
510
541
|
* Notes
|
|
511
542
|
*/
|
|
512
543
|
'notes'?: Array<NumberPortNoteDTO>;
|
|
544
|
+
/**
|
|
545
|
+
* Attachments
|
|
546
|
+
*/
|
|
547
|
+
'cloas'?: Array<AttachmentModel>;
|
|
548
|
+
/**
|
|
549
|
+
* Created At
|
|
550
|
+
*/
|
|
551
|
+
'createdAt'?: string;
|
|
513
552
|
}
|
|
514
553
|
/**
|
|
515
554
|
* Admin Order Request
|
|
@@ -756,11 +795,11 @@ export interface AuditLogEntity {
|
|
|
756
795
|
/**
|
|
757
796
|
* action
|
|
758
797
|
*/
|
|
759
|
-
'action'?:
|
|
798
|
+
'action'?: AuditLogEntityActionEnum;
|
|
760
799
|
/**
|
|
761
800
|
* type
|
|
762
801
|
*/
|
|
763
|
-
'type'?:
|
|
802
|
+
'type'?: AuditLogEntityTypeEnum;
|
|
764
803
|
/**
|
|
765
804
|
* identifier
|
|
766
805
|
*/
|
|
@@ -786,6 +825,92 @@ export interface AuditLogEntity {
|
|
|
786
825
|
*/
|
|
787
826
|
'description'?: string;
|
|
788
827
|
}
|
|
828
|
+
export declare const AuditLogEntityActionEnum: {
|
|
829
|
+
readonly Create: "CREATE";
|
|
830
|
+
readonly Read: "READ";
|
|
831
|
+
readonly Update: "UPDATE";
|
|
832
|
+
readonly Delete: "DELETE";
|
|
833
|
+
};
|
|
834
|
+
export type AuditLogEntityActionEnum = typeof AuditLogEntityActionEnum[keyof typeof AuditLogEntityActionEnum];
|
|
835
|
+
export declare const AuditLogEntityTypeEnum: {
|
|
836
|
+
readonly AuditLog: "audit_log";
|
|
837
|
+
readonly PopsOrders: "pops_orders";
|
|
838
|
+
readonly PopsAccountContacts: "pops_account_contacts";
|
|
839
|
+
readonly ApiLog: "api_log";
|
|
840
|
+
readonly PopsBatches: "pops_batches";
|
|
841
|
+
readonly PopsCourierPrices: "pops_courier_prices";
|
|
842
|
+
readonly PopsCreditAccounts: "pops_credit_accounts";
|
|
843
|
+
readonly PopsCreditNotes: "pops_credit_notes";
|
|
844
|
+
readonly PopsCreditNotesItems: "pops_credit_notes_items";
|
|
845
|
+
readonly EdtechproClients: "edtechpro_clients";
|
|
846
|
+
readonly EdtechproSchools: "edtechpro_schools";
|
|
847
|
+
readonly FreshdeskTickets: "freshdesk_tickets";
|
|
848
|
+
readonly PopsFtpAccounts: "pops_ftp_accounts";
|
|
849
|
+
readonly ServiceEvents: "service_events";
|
|
850
|
+
readonly ServiceEventUpdates: "service_event_updates";
|
|
851
|
+
readonly ServiceEventSubscriptions: "service_event_subscriptions";
|
|
852
|
+
readonly PopsInstanceFailoverIps: "pops_instance_failover_ips";
|
|
853
|
+
readonly PopsOvhDeleteSchedule: "pops_ovh_delete_schedule";
|
|
854
|
+
readonly PopsOvhInstances: "pops_ovh_instances";
|
|
855
|
+
readonly PopsInstanceFailover: "pops_instance_failover";
|
|
856
|
+
readonly PopsInstanceMonitoring: "pops_instance_monitoring";
|
|
857
|
+
readonly PopsInstanceMonitoringLog: "pops_instance_monitoring_log";
|
|
858
|
+
readonly PopsInstanceScheduledTasks: "pops_instance_scheduled_tasks";
|
|
859
|
+
readonly PopsInstance3cxDetails: "pops_instance_3cx_details";
|
|
860
|
+
readonly PopsInstanceUserCredentials: "pops_instance_user_credentials";
|
|
861
|
+
readonly IpBlacklist: "ip_blacklist";
|
|
862
|
+
readonly PopsItemDiscounts: "pops_item_discounts";
|
|
863
|
+
readonly PopsItems: "pops_items";
|
|
864
|
+
readonly PopsLinkedOrders: "pops_linked_orders";
|
|
865
|
+
readonly NumberPorts: "number_ports";
|
|
866
|
+
readonly NumberPortRanges: "number_port_ranges";
|
|
867
|
+
readonly NumberPortNotes: "number_port_notes";
|
|
868
|
+
readonly PopsOfflineInstances: "pops_offline_instances";
|
|
869
|
+
readonly PopsOrderedItems: "pops_ordered_items";
|
|
870
|
+
readonly PopsPrizes: "pops_prizes";
|
|
871
|
+
readonly PopsPrinters: "pops_printers";
|
|
872
|
+
readonly PopsPromoCodes: "pops_promo_codes";
|
|
873
|
+
readonly PopsPromoItems: "pops_promo_items";
|
|
874
|
+
readonly PopsProvisioning: "pops_provisioning";
|
|
875
|
+
readonly S3Buckets: "s3_buckets";
|
|
876
|
+
readonly PopsShipmentAddress: "pops_shipment_address";
|
|
877
|
+
readonly PopsShipments: "pops_shipments";
|
|
878
|
+
readonly PopsShipmentItems: "pops_shipment_items";
|
|
879
|
+
readonly PopsSipTrunkChangeQueue: "pops_sip_trunk_change_queue";
|
|
880
|
+
readonly PopsSipTrunks: "pops_sip_trunks";
|
|
881
|
+
readonly PopsSms: "pops_sms";
|
|
882
|
+
readonly PopsSmsNumbers: "pops_sms_numbers";
|
|
883
|
+
readonly PopsSmsWhitelist: "pops_sms_whitelist";
|
|
884
|
+
readonly PopsDistCourier: "pops_dist_courier";
|
|
885
|
+
readonly PopsDistDeductions: "pops_dist_deductions";
|
|
886
|
+
readonly PopsDistOrder: "pops_dist_order";
|
|
887
|
+
readonly PopsDistItems: "pops_dist_items";
|
|
888
|
+
readonly PopsDistPrices: "pops_dist_prices";
|
|
889
|
+
readonly PopsDistManufacturer: "pops_dist_manufacturer";
|
|
890
|
+
readonly PopsStockTransactions: "pops_stock_transactions";
|
|
891
|
+
readonly PopsSuppliers: "pops_suppliers";
|
|
892
|
+
readonly PopsSupplierItems: "pops_supplier_items";
|
|
893
|
+
readonly Pops3cxBackup: "pops_3cx_backup";
|
|
894
|
+
readonly Pops3cxBilling: "pops_3cx_billing";
|
|
895
|
+
readonly PopsDeadLicences: "pops_dead_licences";
|
|
896
|
+
readonly Pops3cxExts: "pops_3cx_exts";
|
|
897
|
+
readonly PopsHostingPricing: "pops_hosting_pricing";
|
|
898
|
+
readonly Pops3cxKeys: "pops_3cx_keys";
|
|
899
|
+
readonly Pops3cxMacs: "pops_3cx_macs";
|
|
900
|
+
readonly Pops3cxNumbers: "pops_3cx_numbers";
|
|
901
|
+
readonly Pops3cxOfficeHours: "pops_3cx_office_hours";
|
|
902
|
+
readonly Pops3cxPhones: "pops_3cx_phones";
|
|
903
|
+
readonly Pops3cxSbc: "pops_3cx_sbc";
|
|
904
|
+
readonly Pops3cxSetup: "pops_3cx_setup";
|
|
905
|
+
readonly Pops3cxSipTrunks: "pops_3cx_sip_trunks";
|
|
906
|
+
readonly Pops3cxUsers: "pops_3cx_users";
|
|
907
|
+
readonly PopsUsers: "pops_users";
|
|
908
|
+
readonly Webhook: "webhook";
|
|
909
|
+
readonly PopsXeroLog: "pops_xero_log";
|
|
910
|
+
readonly Oauth2Clients: "oauth2_clients";
|
|
911
|
+
readonly Oauth2Tokens: "oauth2_tokens";
|
|
912
|
+
};
|
|
913
|
+
export type AuditLogEntityTypeEnum = typeof AuditLogEntityTypeEnum[keyof typeof AuditLogEntityTypeEnum];
|
|
789
914
|
/**
|
|
790
915
|
* OAuth Auth Code Response
|
|
791
916
|
*/
|
|
@@ -829,6 +954,88 @@ export interface BasicProductDTO {
|
|
|
829
954
|
*/
|
|
830
955
|
'title'?: string;
|
|
831
956
|
}
|
|
957
|
+
/**
|
|
958
|
+
* Batch DTO
|
|
959
|
+
*/
|
|
960
|
+
export interface BatchDTO {
|
|
961
|
+
/**
|
|
962
|
+
* id
|
|
963
|
+
*/
|
|
964
|
+
'id'?: number;
|
|
965
|
+
/**
|
|
966
|
+
* orderId
|
|
967
|
+
*/
|
|
968
|
+
'orderId'?: number;
|
|
969
|
+
/**
|
|
970
|
+
* supplierId
|
|
971
|
+
*/
|
|
972
|
+
'supplierId'?: number;
|
|
973
|
+
/**
|
|
974
|
+
* poNumber
|
|
975
|
+
*/
|
|
976
|
+
'poNumber'?: string;
|
|
977
|
+
/**
|
|
978
|
+
* carriage
|
|
979
|
+
*/
|
|
980
|
+
'carriage'?: number;
|
|
981
|
+
/**
|
|
982
|
+
* courier
|
|
983
|
+
*/
|
|
984
|
+
'courier'?: string;
|
|
985
|
+
/**
|
|
986
|
+
* courierService
|
|
987
|
+
*/
|
|
988
|
+
'courierService'?: string;
|
|
989
|
+
/**
|
|
990
|
+
* courierReference
|
|
991
|
+
*/
|
|
992
|
+
'courierReference'?: string;
|
|
993
|
+
/**
|
|
994
|
+
* courierUnique
|
|
995
|
+
*/
|
|
996
|
+
'courierUnique'?: string;
|
|
997
|
+
/**
|
|
998
|
+
* notes
|
|
999
|
+
*/
|
|
1000
|
+
'notes'?: string;
|
|
1001
|
+
/**
|
|
1002
|
+
* ordered
|
|
1003
|
+
*/
|
|
1004
|
+
'ordered'?: number;
|
|
1005
|
+
/**
|
|
1006
|
+
* carriagePaid
|
|
1007
|
+
*/
|
|
1008
|
+
'carriagePaid'?: number;
|
|
1009
|
+
/**
|
|
1010
|
+
* carriageRefunded
|
|
1011
|
+
*/
|
|
1012
|
+
'carriageRefunded'?: number;
|
|
1013
|
+
/**
|
|
1014
|
+
* carriageRefundedDue
|
|
1015
|
+
*/
|
|
1016
|
+
'carriageRefundedDue'?: number;
|
|
1017
|
+
/**
|
|
1018
|
+
* netdespatchLabel
|
|
1019
|
+
*/
|
|
1020
|
+
'netdespatchLabel'?: string;
|
|
1021
|
+
/**
|
|
1022
|
+
* courierBoxes
|
|
1023
|
+
*/
|
|
1024
|
+
'courierBoxes'?: number;
|
|
1025
|
+
/**
|
|
1026
|
+
* mac
|
|
1027
|
+
*/
|
|
1028
|
+
'mac'?: string;
|
|
1029
|
+
/**
|
|
1030
|
+
* Shipments
|
|
1031
|
+
*/
|
|
1032
|
+
'shipments'?: Array<ShipmentDTO>;
|
|
1033
|
+
/**
|
|
1034
|
+
* Items
|
|
1035
|
+
*/
|
|
1036
|
+
'items'?: Array<OrderedItemModel>;
|
|
1037
|
+
'supplier'?: SupplierModel;
|
|
1038
|
+
}
|
|
832
1039
|
/**
|
|
833
1040
|
* BatchesEntity
|
|
834
1041
|
*/
|
|
@@ -1202,6 +1409,136 @@ export interface CreditAccountEntity {
|
|
|
1202
1409
|
*/
|
|
1203
1410
|
'prizePromo'?: boolean;
|
|
1204
1411
|
}
|
|
1412
|
+
/**
|
|
1413
|
+
* Credit Note
|
|
1414
|
+
*/
|
|
1415
|
+
export interface CreditNoteDTO {
|
|
1416
|
+
/**
|
|
1417
|
+
* Items
|
|
1418
|
+
*/
|
|
1419
|
+
'items'?: Array<CreditNoteItemDTO>;
|
|
1420
|
+
}
|
|
1421
|
+
/**
|
|
1422
|
+
* CreditNotesEntity
|
|
1423
|
+
*/
|
|
1424
|
+
export interface CreditNoteEntity {
|
|
1425
|
+
/**
|
|
1426
|
+
* id
|
|
1427
|
+
*/
|
|
1428
|
+
'id'?: number;
|
|
1429
|
+
/**
|
|
1430
|
+
* orderId
|
|
1431
|
+
*/
|
|
1432
|
+
'orderId'?: number;
|
|
1433
|
+
/**
|
|
1434
|
+
* transactionId
|
|
1435
|
+
*/
|
|
1436
|
+
'transactionId'?: string;
|
|
1437
|
+
/**
|
|
1438
|
+
* amount
|
|
1439
|
+
*/
|
|
1440
|
+
'amount'?: number;
|
|
1441
|
+
/**
|
|
1442
|
+
* timestamp
|
|
1443
|
+
*/
|
|
1444
|
+
'timestamp'?: string;
|
|
1445
|
+
}
|
|
1446
|
+
/**
|
|
1447
|
+
* Credit Note Item
|
|
1448
|
+
*/
|
|
1449
|
+
export interface CreditNoteItemDTO {
|
|
1450
|
+
/**
|
|
1451
|
+
* Item ID
|
|
1452
|
+
*/
|
|
1453
|
+
'itemId'?: number;
|
|
1454
|
+
/**
|
|
1455
|
+
* Quantity
|
|
1456
|
+
*/
|
|
1457
|
+
'quantity'?: number | null;
|
|
1458
|
+
/**
|
|
1459
|
+
* Amount
|
|
1460
|
+
*/
|
|
1461
|
+
'amount'?: number | null;
|
|
1462
|
+
}
|
|
1463
|
+
/**
|
|
1464
|
+
* CreditNotesItemsEntity
|
|
1465
|
+
*/
|
|
1466
|
+
export interface CreditNoteItemEntity {
|
|
1467
|
+
/**
|
|
1468
|
+
* id
|
|
1469
|
+
*/
|
|
1470
|
+
'id'?: number;
|
|
1471
|
+
/**
|
|
1472
|
+
* creditNoteId
|
|
1473
|
+
*/
|
|
1474
|
+
'creditNoteId'?: number;
|
|
1475
|
+
/**
|
|
1476
|
+
* orderId
|
|
1477
|
+
*/
|
|
1478
|
+
'orderId'?: number;
|
|
1479
|
+
/**
|
|
1480
|
+
* itemId
|
|
1481
|
+
*/
|
|
1482
|
+
'itemId'?: number;
|
|
1483
|
+
/**
|
|
1484
|
+
* amount
|
|
1485
|
+
*/
|
|
1486
|
+
'amount'?: number;
|
|
1487
|
+
}
|
|
1488
|
+
/**
|
|
1489
|
+
* Credit Note Item
|
|
1490
|
+
*/
|
|
1491
|
+
export interface CreditNoteItemModel {
|
|
1492
|
+
/**
|
|
1493
|
+
* id
|
|
1494
|
+
*/
|
|
1495
|
+
'id'?: number;
|
|
1496
|
+
/**
|
|
1497
|
+
* creditNoteId
|
|
1498
|
+
*/
|
|
1499
|
+
'creditNoteId'?: number;
|
|
1500
|
+
/**
|
|
1501
|
+
* orderId
|
|
1502
|
+
*/
|
|
1503
|
+
'orderId'?: number;
|
|
1504
|
+
/**
|
|
1505
|
+
* itemId
|
|
1506
|
+
*/
|
|
1507
|
+
'itemId'?: number;
|
|
1508
|
+
/**
|
|
1509
|
+
* amount
|
|
1510
|
+
*/
|
|
1511
|
+
'amount'?: number;
|
|
1512
|
+
}
|
|
1513
|
+
/**
|
|
1514
|
+
* Credit Note Model
|
|
1515
|
+
*/
|
|
1516
|
+
export interface CreditNoteModel {
|
|
1517
|
+
/**
|
|
1518
|
+
* id
|
|
1519
|
+
*/
|
|
1520
|
+
'id'?: number;
|
|
1521
|
+
/**
|
|
1522
|
+
* orderId
|
|
1523
|
+
*/
|
|
1524
|
+
'orderId'?: number;
|
|
1525
|
+
/**
|
|
1526
|
+
* transactionId
|
|
1527
|
+
*/
|
|
1528
|
+
'transactionId'?: string;
|
|
1529
|
+
/**
|
|
1530
|
+
* amount
|
|
1531
|
+
*/
|
|
1532
|
+
'amount'?: number;
|
|
1533
|
+
/**
|
|
1534
|
+
* timestamp
|
|
1535
|
+
*/
|
|
1536
|
+
'timestamp'?: string;
|
|
1537
|
+
/**
|
|
1538
|
+
* Credit Note Items
|
|
1539
|
+
*/
|
|
1540
|
+
'items'?: Array<CreditNoteItemModel>;
|
|
1541
|
+
}
|
|
1205
1542
|
/**
|
|
1206
1543
|
* CRM Contact
|
|
1207
1544
|
*/
|
|
@@ -2338,7 +2675,7 @@ export interface ItemDTO {
|
|
|
2338
2675
|
/**
|
|
2339
2676
|
* SBCs
|
|
2340
2677
|
*/
|
|
2341
|
-
'sbcs'?: Array<TcxSbcDTO
|
|
2678
|
+
'sbcs'?: Array<TcxSbcDTO>;
|
|
2342
2679
|
/**
|
|
2343
2680
|
* Readonly
|
|
2344
2681
|
*/
|
|
@@ -2781,51 +3118,136 @@ export interface OfflineInstancesEntity {
|
|
|
2781
3118
|
'alerted'?: number;
|
|
2782
3119
|
}
|
|
2783
3120
|
/**
|
|
2784
|
-
*
|
|
3121
|
+
* Order Details
|
|
2785
3122
|
*/
|
|
2786
|
-
export interface
|
|
3123
|
+
export interface OrderDetailsDTO {
|
|
2787
3124
|
/**
|
|
2788
|
-
*
|
|
3125
|
+
* ID
|
|
2789
3126
|
*/
|
|
2790
3127
|
'id'?: number;
|
|
2791
3128
|
/**
|
|
2792
|
-
*
|
|
2793
|
-
*/
|
|
2794
|
-
'reference'?: string;
|
|
2795
|
-
/**
|
|
2796
|
-
* sourceId
|
|
3129
|
+
* Reference
|
|
2797
3130
|
*/
|
|
2798
|
-
'
|
|
3131
|
+
'reference'?: string | null;
|
|
2799
3132
|
/**
|
|
2800
|
-
*
|
|
3133
|
+
* Invoice Number
|
|
2801
3134
|
*/
|
|
2802
3135
|
'invoiceNumber'?: string;
|
|
2803
3136
|
/**
|
|
2804
|
-
*
|
|
3137
|
+
* Invoice ID
|
|
2805
3138
|
*/
|
|
2806
3139
|
'invoiceId'?: string | null;
|
|
2807
3140
|
/**
|
|
2808
|
-
*
|
|
2809
|
-
*/
|
|
2810
|
-
'customerId'?: number;
|
|
2811
|
-
/**
|
|
2812
|
-
* orderDate
|
|
3141
|
+
* Date Time
|
|
2813
3142
|
*/
|
|
2814
3143
|
'orderDate'?: string;
|
|
2815
3144
|
/**
|
|
2816
|
-
*
|
|
3145
|
+
* Paid
|
|
2817
3146
|
*/
|
|
2818
|
-
'
|
|
3147
|
+
'paid'?: boolean;
|
|
2819
3148
|
/**
|
|
2820
|
-
*
|
|
3149
|
+
* Complete
|
|
2821
3150
|
*/
|
|
2822
|
-
'
|
|
3151
|
+
'complete'?: boolean;
|
|
2823
3152
|
/**
|
|
2824
|
-
*
|
|
3153
|
+
* Quote
|
|
2825
3154
|
*/
|
|
2826
|
-
'
|
|
3155
|
+
'quote'?: boolean;
|
|
3156
|
+
'customer'?: AccountSummaryDTO;
|
|
3157
|
+
'shippingAddress'?: AddressModel | null;
|
|
2827
3158
|
/**
|
|
2828
|
-
*
|
|
3159
|
+
* Items
|
|
3160
|
+
*/
|
|
3161
|
+
'items'?: Array<ItemDTO>;
|
|
3162
|
+
/**
|
|
3163
|
+
* Carriage Charge
|
|
3164
|
+
*/
|
|
3165
|
+
'carriageCharge'?: number;
|
|
3166
|
+
/**
|
|
3167
|
+
* Fulfillable
|
|
3168
|
+
*/
|
|
3169
|
+
'fulfillable'?: boolean | null;
|
|
3170
|
+
/**
|
|
3171
|
+
* Provisioning URL
|
|
3172
|
+
*/
|
|
3173
|
+
'provisioningUrl'?: string | null;
|
|
3174
|
+
'shippingService'?: ShippingServiceDTO | null;
|
|
3175
|
+
/**
|
|
3176
|
+
* Readonly
|
|
3177
|
+
*/
|
|
3178
|
+
'readonly'?: boolean;
|
|
3179
|
+
/**
|
|
3180
|
+
* Detailed Items
|
|
3181
|
+
*/
|
|
3182
|
+
'detailedItems'?: Array<OrderItemDTO>;
|
|
3183
|
+
/**
|
|
3184
|
+
* Batches
|
|
3185
|
+
*/
|
|
3186
|
+
'batches'?: Array<BatchDTO>;
|
|
3187
|
+
/**
|
|
3188
|
+
* Audit Log
|
|
3189
|
+
*/
|
|
3190
|
+
'logEntries'?: Array<AuditLogEntity>;
|
|
3191
|
+
/**
|
|
3192
|
+
* Card Payment Link
|
|
3193
|
+
*/
|
|
3194
|
+
'paymentLink'?: string | null;
|
|
3195
|
+
/**
|
|
3196
|
+
* Credits
|
|
3197
|
+
*/
|
|
3198
|
+
'credits'?: Array<CreditNoteModel>;
|
|
3199
|
+
/**
|
|
3200
|
+
* Customer Email
|
|
3201
|
+
*/
|
|
3202
|
+
'customerEmail'?: string;
|
|
3203
|
+
'totals'?: OrderTotalModel;
|
|
3204
|
+
}
|
|
3205
|
+
/**
|
|
3206
|
+
* OrdersEntity
|
|
3207
|
+
*/
|
|
3208
|
+
export interface OrderEntity {
|
|
3209
|
+
/**
|
|
3210
|
+
* id
|
|
3211
|
+
*/
|
|
3212
|
+
'id'?: number;
|
|
3213
|
+
/**
|
|
3214
|
+
* externalId
|
|
3215
|
+
*/
|
|
3216
|
+
'reference'?: string;
|
|
3217
|
+
/**
|
|
3218
|
+
* sourceId
|
|
3219
|
+
*/
|
|
3220
|
+
'sourceId'?: number;
|
|
3221
|
+
/**
|
|
3222
|
+
* sageInv
|
|
3223
|
+
*/
|
|
3224
|
+
'invoiceNumber'?: string;
|
|
3225
|
+
/**
|
|
3226
|
+
* invoiceId
|
|
3227
|
+
*/
|
|
3228
|
+
'invoiceId'?: string | null;
|
|
3229
|
+
/**
|
|
3230
|
+
* creditAccountId
|
|
3231
|
+
*/
|
|
3232
|
+
'customerId'?: number;
|
|
3233
|
+
/**
|
|
3234
|
+
* orderDate
|
|
3235
|
+
*/
|
|
3236
|
+
'orderDate'?: string;
|
|
3237
|
+
/**
|
|
3238
|
+
* orderPostedDate
|
|
3239
|
+
*/
|
|
3240
|
+
'orderPostedDate'?: string;
|
|
3241
|
+
/**
|
|
3242
|
+
* buyerEmail
|
|
3243
|
+
*/
|
|
3244
|
+
'buyerEmail'?: string;
|
|
3245
|
+
/**
|
|
3246
|
+
* buyerPhone
|
|
3247
|
+
*/
|
|
3248
|
+
'buyerPhone'?: string;
|
|
3249
|
+
/**
|
|
3250
|
+
* buyerName
|
|
2829
3251
|
*/
|
|
2830
3252
|
'buyerName'?: string;
|
|
2831
3253
|
/**
|
|
@@ -3017,6 +3439,83 @@ export interface OrderEntity {
|
|
|
3017
3439
|
*/
|
|
3018
3440
|
'fulfillable'?: boolean | null;
|
|
3019
3441
|
}
|
|
3442
|
+
/**
|
|
3443
|
+
* Order Item Details
|
|
3444
|
+
*/
|
|
3445
|
+
export interface OrderItemDTO {
|
|
3446
|
+
/**
|
|
3447
|
+
* SKU
|
|
3448
|
+
*/
|
|
3449
|
+
'sku'?: string;
|
|
3450
|
+
/**
|
|
3451
|
+
* Quantity
|
|
3452
|
+
*/
|
|
3453
|
+
'quantity'?: number;
|
|
3454
|
+
/**
|
|
3455
|
+
* ID
|
|
3456
|
+
*/
|
|
3457
|
+
'id'?: number | null;
|
|
3458
|
+
/**
|
|
3459
|
+
* Order ID
|
|
3460
|
+
*/
|
|
3461
|
+
'orderId'?: number | null;
|
|
3462
|
+
/**
|
|
3463
|
+
* Title
|
|
3464
|
+
*/
|
|
3465
|
+
'title'?: string;
|
|
3466
|
+
/**
|
|
3467
|
+
* Price
|
|
3468
|
+
*/
|
|
3469
|
+
'price'?: number;
|
|
3470
|
+
/**
|
|
3471
|
+
* 3CX Licence Key
|
|
3472
|
+
*/
|
|
3473
|
+
'licenceKey'?: string | null;
|
|
3474
|
+
/**
|
|
3475
|
+
* Date Time
|
|
3476
|
+
*/
|
|
3477
|
+
'licenceExpiry'?: string | null;
|
|
3478
|
+
/**
|
|
3479
|
+
* Date Time
|
|
3480
|
+
*/
|
|
3481
|
+
'processDate'?: string | null;
|
|
3482
|
+
/**
|
|
3483
|
+
* 3CX Hosting
|
|
3484
|
+
*/
|
|
3485
|
+
'hosting'?: boolean | null;
|
|
3486
|
+
/**
|
|
3487
|
+
* Promo Item
|
|
3488
|
+
*/
|
|
3489
|
+
'promoItem'?: boolean;
|
|
3490
|
+
/**
|
|
3491
|
+
* Refunded
|
|
3492
|
+
*/
|
|
3493
|
+
'refunded'?: number | null;
|
|
3494
|
+
/**
|
|
3495
|
+
* SBCs
|
|
3496
|
+
*/
|
|
3497
|
+
'sbcs'?: Array<TcxSbcDTO>;
|
|
3498
|
+
/**
|
|
3499
|
+
* Readonly
|
|
3500
|
+
*/
|
|
3501
|
+
'readonly'?: boolean;
|
|
3502
|
+
/**
|
|
3503
|
+
* 3CX Sales Code
|
|
3504
|
+
*/
|
|
3505
|
+
'tcxSalesCode'?: string | null;
|
|
3506
|
+
/**
|
|
3507
|
+
* Suppliers
|
|
3508
|
+
*/
|
|
3509
|
+
'suppliers'?: Array<SupplierModel>;
|
|
3510
|
+
/**
|
|
3511
|
+
* Supplier Items
|
|
3512
|
+
*/
|
|
3513
|
+
'supplierItems'?: Array<SupplierItemModel>;
|
|
3514
|
+
/**
|
|
3515
|
+
* Allocated
|
|
3516
|
+
*/
|
|
3517
|
+
'allocated'?: number | null;
|
|
3518
|
+
}
|
|
3020
3519
|
/**
|
|
3021
3520
|
* EdTechPro Order Request
|
|
3022
3521
|
*/
|
|
@@ -3297,7 +3796,68 @@ export interface OrderedItemEntity {
|
|
|
3297
3796
|
*/
|
|
3298
3797
|
'returnedStock'?: number;
|
|
3299
3798
|
}
|
|
3300
|
-
|
|
3799
|
+
/**
|
|
3800
|
+
* Ordered Item Model
|
|
3801
|
+
*/
|
|
3802
|
+
export interface OrderedItemModel {
|
|
3803
|
+
/**
|
|
3804
|
+
* id
|
|
3805
|
+
*/
|
|
3806
|
+
'id'?: number;
|
|
3807
|
+
/**
|
|
3808
|
+
* itemId
|
|
3809
|
+
*/
|
|
3810
|
+
'itemId'?: number;
|
|
3811
|
+
/**
|
|
3812
|
+
* orderedQuantity
|
|
3813
|
+
*/
|
|
3814
|
+
'orderedQuantity'?: number;
|
|
3815
|
+
/**
|
|
3816
|
+
* itemStatus
|
|
3817
|
+
*/
|
|
3818
|
+
'itemStatus'?: number;
|
|
3819
|
+
/**
|
|
3820
|
+
* supplierId
|
|
3821
|
+
*/
|
|
3822
|
+
'supplierId'?: number;
|
|
3823
|
+
/**
|
|
3824
|
+
* supplierItemId
|
|
3825
|
+
*/
|
|
3826
|
+
'supplierItemId'?: number;
|
|
3827
|
+
/**
|
|
3828
|
+
* supplierPrice
|
|
3829
|
+
*/
|
|
3830
|
+
'supplierPrice'?: number;
|
|
3831
|
+
/**
|
|
3832
|
+
* statusDate
|
|
3833
|
+
*/
|
|
3834
|
+
'statusDate'?: string;
|
|
3835
|
+
/**
|
|
3836
|
+
* statusAuthor
|
|
3837
|
+
*/
|
|
3838
|
+
'statusAuthor'?: number;
|
|
3839
|
+
/**
|
|
3840
|
+
* supplierPaid
|
|
3841
|
+
*/
|
|
3842
|
+
'supplierPaid'?: number;
|
|
3843
|
+
/**
|
|
3844
|
+
* supplierCreditDue
|
|
3845
|
+
*/
|
|
3846
|
+
'supplierCreditDue'?: number;
|
|
3847
|
+
/**
|
|
3848
|
+
* supplierCreditReceived
|
|
3849
|
+
*/
|
|
3850
|
+
'supplierCreditReceived'?: number;
|
|
3851
|
+
/**
|
|
3852
|
+
* supplierSku
|
|
3853
|
+
*/
|
|
3854
|
+
'supplierSku'?: string;
|
|
3855
|
+
/**
|
|
3856
|
+
* returnedStock
|
|
3857
|
+
*/
|
|
3858
|
+
'returnedStock'?: number;
|
|
3859
|
+
}
|
|
3860
|
+
export interface PatchUpdateAccountCnameRequest {
|
|
3301
3861
|
/**
|
|
3302
3862
|
* CNAME
|
|
3303
3863
|
*/
|
|
@@ -3443,6 +4003,18 @@ export interface PortalLoginModel {
|
|
|
3443
4003
|
*/
|
|
3444
4004
|
'redirect_uri'?: string;
|
|
3445
4005
|
}
|
|
4006
|
+
export interface PostAddAdminNoteRequest {
|
|
4007
|
+
/**
|
|
4008
|
+
* Note
|
|
4009
|
+
*/
|
|
4010
|
+
'note'?: string;
|
|
4011
|
+
}
|
|
4012
|
+
export interface PostAddOrderNoteRequest {
|
|
4013
|
+
/**
|
|
4014
|
+
* Order Note
|
|
4015
|
+
*/
|
|
4016
|
+
'note'?: string;
|
|
4017
|
+
}
|
|
3446
4018
|
export interface PostAddWebhook200Response {
|
|
3447
4019
|
'url'?: string;
|
|
3448
4020
|
}
|
|
@@ -3484,6 +4056,12 @@ export interface PostGetProductRequest {
|
|
|
3484
4056
|
*/
|
|
3485
4057
|
'hosting'?: boolean | null;
|
|
3486
4058
|
}
|
|
4059
|
+
export interface PostSplitOrderRequest {
|
|
4060
|
+
/**
|
|
4061
|
+
* Item Ids
|
|
4062
|
+
*/
|
|
4063
|
+
'itemIds'?: Array<number>;
|
|
4064
|
+
}
|
|
3487
4065
|
/**
|
|
3488
4066
|
* Price & Stock List
|
|
3489
4067
|
*/
|
|
@@ -3509,6 +4087,31 @@ export interface PriceListItemModel {
|
|
|
3509
4087
|
*/
|
|
3510
4088
|
'stock'?: number | null;
|
|
3511
4089
|
}
|
|
4090
|
+
/**
|
|
4091
|
+
* PrintersEntity
|
|
4092
|
+
*/
|
|
4093
|
+
export interface PrinterEntity {
|
|
4094
|
+
/**
|
|
4095
|
+
* id
|
|
4096
|
+
*/
|
|
4097
|
+
'id'?: number;
|
|
4098
|
+
/**
|
|
4099
|
+
* brand
|
|
4100
|
+
*/
|
|
4101
|
+
'brand'?: string;
|
|
4102
|
+
/**
|
|
4103
|
+
* model
|
|
4104
|
+
*/
|
|
4105
|
+
'model'?: string;
|
|
4106
|
+
/**
|
|
4107
|
+
* sn
|
|
4108
|
+
*/
|
|
4109
|
+
'sn'?: string;
|
|
4110
|
+
/**
|
|
4111
|
+
* location
|
|
4112
|
+
*/
|
|
4113
|
+
'location'?: string;
|
|
4114
|
+
}
|
|
3512
4115
|
/**
|
|
3513
4116
|
* PrizesEntity
|
|
3514
4117
|
*/
|
|
@@ -3767,6 +4370,22 @@ export interface ProvisioningRequestEntity {
|
|
|
3767
4370
|
*/
|
|
3768
4371
|
'auth'?: string;
|
|
3769
4372
|
}
|
|
4373
|
+
export interface PutAllocateItemsRequest {
|
|
4374
|
+
/**
|
|
4375
|
+
* Items
|
|
4376
|
+
*/
|
|
4377
|
+
'items'?: Array<PutAllocateItemsRequestItemsInner>;
|
|
4378
|
+
}
|
|
4379
|
+
export interface PutAllocateItemsRequestItemsInner {
|
|
4380
|
+
/**
|
|
4381
|
+
* Item ID
|
|
4382
|
+
*/
|
|
4383
|
+
'itemId'?: number;
|
|
4384
|
+
/**
|
|
4385
|
+
* Quantity To Allocate
|
|
4386
|
+
*/
|
|
4387
|
+
'quantity'?: number;
|
|
4388
|
+
}
|
|
3770
4389
|
/**
|
|
3771
4390
|
* Azure Recordings Backup
|
|
3772
4391
|
*/
|
|
@@ -3978,21 +4597,73 @@ export interface ShipmentAddressEntity {
|
|
|
3978
4597
|
'shipPhoneNumber'?: string;
|
|
3979
4598
|
}
|
|
3980
4599
|
/**
|
|
3981
|
-
*
|
|
4600
|
+
* Shipment
|
|
3982
4601
|
*/
|
|
3983
|
-
export interface
|
|
4602
|
+
export interface ShipmentDTO {
|
|
3984
4603
|
/**
|
|
3985
|
-
*
|
|
4604
|
+
* ID
|
|
3986
4605
|
*/
|
|
3987
|
-
'id'?: number;
|
|
4606
|
+
'id'?: number | null;
|
|
3988
4607
|
/**
|
|
3989
|
-
*
|
|
4608
|
+
* Batch ID
|
|
3990
4609
|
*/
|
|
3991
|
-
'batchId'?: number;
|
|
4610
|
+
'batchId'?: number | null;
|
|
3992
4611
|
/**
|
|
3993
|
-
*
|
|
4612
|
+
* Courier
|
|
3994
4613
|
*/
|
|
3995
|
-
'courier'?:
|
|
4614
|
+
'courier'?: ShipmentDTOCourierEnum | null;
|
|
4615
|
+
/**
|
|
4616
|
+
* Courier Reference
|
|
4617
|
+
*/
|
|
4618
|
+
'reference'?: string | null;
|
|
4619
|
+
/**
|
|
4620
|
+
* Courier Tracking
|
|
4621
|
+
*/
|
|
4622
|
+
'tracking'?: string | null;
|
|
4623
|
+
/**
|
|
4624
|
+
* Courier Tracking URL
|
|
4625
|
+
*/
|
|
4626
|
+
'trackingUrl'?: string | null;
|
|
4627
|
+
/**
|
|
4628
|
+
* Date Time
|
|
4629
|
+
*/
|
|
4630
|
+
'requestedDate'?: string;
|
|
4631
|
+
/**
|
|
4632
|
+
* Scanned Items
|
|
4633
|
+
*/
|
|
4634
|
+
'scannedItems'?: Array<ScannedItemModel>;
|
|
4635
|
+
/**
|
|
4636
|
+
* Items
|
|
4637
|
+
*/
|
|
4638
|
+
'items'?: Array<ShipmentItemModel>;
|
|
4639
|
+
'address'?: AddressModel;
|
|
4640
|
+
/**
|
|
4641
|
+
* Boxes Shipped
|
|
4642
|
+
*/
|
|
4643
|
+
'boxes'?: number | null;
|
|
4644
|
+
}
|
|
4645
|
+
export declare const ShipmentDTOCourierEnum: {
|
|
4646
|
+
readonly Dpd: "DPD";
|
|
4647
|
+
readonly ChorltonPallet: "Chorlton Pallet";
|
|
4648
|
+
readonly Pops: "POPS";
|
|
4649
|
+
};
|
|
4650
|
+
export type ShipmentDTOCourierEnum = typeof ShipmentDTOCourierEnum[keyof typeof ShipmentDTOCourierEnum];
|
|
4651
|
+
/**
|
|
4652
|
+
* ShipmentsEntity
|
|
4653
|
+
*/
|
|
4654
|
+
export interface ShipmentEntity {
|
|
4655
|
+
/**
|
|
4656
|
+
* id
|
|
4657
|
+
*/
|
|
4658
|
+
'id'?: number;
|
|
4659
|
+
/**
|
|
4660
|
+
* batchId
|
|
4661
|
+
*/
|
|
4662
|
+
'batchId'?: number;
|
|
4663
|
+
/**
|
|
4664
|
+
* courier
|
|
4665
|
+
*/
|
|
4666
|
+
'courier'?: string;
|
|
3996
4667
|
/**
|
|
3997
4668
|
* courierService
|
|
3998
4669
|
*/
|
|
@@ -4030,6 +4701,19 @@ export interface ShipmentEntity {
|
|
|
4030
4701
|
*/
|
|
4031
4702
|
'provId'?: number;
|
|
4032
4703
|
}
|
|
4704
|
+
/**
|
|
4705
|
+
* Shipment Item
|
|
4706
|
+
*/
|
|
4707
|
+
export interface ShipmentItemDTO {
|
|
4708
|
+
/**
|
|
4709
|
+
* Item ID
|
|
4710
|
+
*/
|
|
4711
|
+
'itemId'?: number;
|
|
4712
|
+
/**
|
|
4713
|
+
* Quantity
|
|
4714
|
+
*/
|
|
4715
|
+
'quantity'?: number;
|
|
4716
|
+
}
|
|
4033
4717
|
/**
|
|
4034
4718
|
* ShipmentItemsEntity
|
|
4035
4719
|
*/
|
|
@@ -4053,8 +4737,118 @@ export interface ShipmentItemEntity {
|
|
|
4053
4737
|
/**
|
|
4054
4738
|
* item
|
|
4055
4739
|
*/
|
|
4056
|
-
'itemId'?:
|
|
4740
|
+
'itemId'?: number;
|
|
4741
|
+
}
|
|
4742
|
+
/**
|
|
4743
|
+
* Shipment Item
|
|
4744
|
+
*/
|
|
4745
|
+
export interface ShipmentItemModel {
|
|
4746
|
+
/**
|
|
4747
|
+
* id
|
|
4748
|
+
*/
|
|
4749
|
+
'id'?: number;
|
|
4750
|
+
/**
|
|
4751
|
+
* shipmentId
|
|
4752
|
+
*/
|
|
4753
|
+
'shipmentId'?: number;
|
|
4754
|
+
/**
|
|
4755
|
+
* batchId
|
|
4756
|
+
*/
|
|
4757
|
+
'batchId'?: number;
|
|
4758
|
+
/**
|
|
4759
|
+
* quantity
|
|
4760
|
+
*/
|
|
4761
|
+
'quantity'?: number;
|
|
4762
|
+
/**
|
|
4763
|
+
* item
|
|
4764
|
+
*/
|
|
4765
|
+
'itemId'?: number;
|
|
4766
|
+
}
|
|
4767
|
+
/**
|
|
4768
|
+
* Shipment
|
|
4769
|
+
*/
|
|
4770
|
+
export interface ShipmentModel {
|
|
4771
|
+
/**
|
|
4772
|
+
* id
|
|
4773
|
+
*/
|
|
4774
|
+
'id'?: number;
|
|
4775
|
+
/**
|
|
4776
|
+
* batchId
|
|
4777
|
+
*/
|
|
4778
|
+
'batchId'?: number;
|
|
4779
|
+
/**
|
|
4780
|
+
* courier
|
|
4781
|
+
*/
|
|
4782
|
+
'courier'?: string;
|
|
4783
|
+
/**
|
|
4784
|
+
* courierService
|
|
4785
|
+
*/
|
|
4786
|
+
'courierService'?: string;
|
|
4787
|
+
/**
|
|
4788
|
+
* courierServiceDesc
|
|
4789
|
+
*/
|
|
4790
|
+
'courierServiceDesc'?: string;
|
|
4791
|
+
/**
|
|
4792
|
+
* courierReference
|
|
4793
|
+
*/
|
|
4794
|
+
'courierReference'?: string;
|
|
4795
|
+
/**
|
|
4796
|
+
* courierTracking
|
|
4797
|
+
*/
|
|
4798
|
+
'courierTracking'?: string;
|
|
4799
|
+
/**
|
|
4800
|
+
* courierBoxes
|
|
4801
|
+
*/
|
|
4802
|
+
'courierBoxes'?: number;
|
|
4803
|
+
/**
|
|
4804
|
+
* mac
|
|
4805
|
+
*/
|
|
4806
|
+
'scannedData'?: string;
|
|
4807
|
+
/**
|
|
4808
|
+
* date
|
|
4809
|
+
*/
|
|
4810
|
+
'dateShipped'?: string;
|
|
4811
|
+
/**
|
|
4812
|
+
* requestDate
|
|
4813
|
+
*/
|
|
4814
|
+
'requestDate'?: string;
|
|
4815
|
+
/**
|
|
4816
|
+
* provId
|
|
4817
|
+
*/
|
|
4818
|
+
'provId'?: number;
|
|
4819
|
+
}
|
|
4820
|
+
/**
|
|
4821
|
+
* Shipment Request
|
|
4822
|
+
*/
|
|
4823
|
+
export interface ShipmentRequestDTO {
|
|
4824
|
+
/**
|
|
4825
|
+
* Courier
|
|
4826
|
+
*/
|
|
4827
|
+
'courier'?: ShipmentRequestDTOCourierEnum;
|
|
4828
|
+
'address'?: AddressModel | null;
|
|
4829
|
+
/**
|
|
4830
|
+
* Scanned Lines
|
|
4831
|
+
*/
|
|
4832
|
+
'scannedLines'?: Array<string>;
|
|
4833
|
+
/**
|
|
4834
|
+
* Service
|
|
4835
|
+
*/
|
|
4836
|
+
'service'?: string;
|
|
4837
|
+
/**
|
|
4838
|
+
* Date Time
|
|
4839
|
+
*/
|
|
4840
|
+
'shipDate'?: string | null;
|
|
4841
|
+
/**
|
|
4842
|
+
* Items
|
|
4843
|
+
*/
|
|
4844
|
+
'items'?: Array<ShipmentItemDTO>;
|
|
4057
4845
|
}
|
|
4846
|
+
export declare const ShipmentRequestDTOCourierEnum: {
|
|
4847
|
+
readonly Dpd: "DPD";
|
|
4848
|
+
readonly ChorltonPallet: "Chorlton Pallet";
|
|
4849
|
+
readonly Pops: "POPS";
|
|
4850
|
+
};
|
|
4851
|
+
export type ShipmentRequestDTOCourierEnum = typeof ShipmentRequestDTOCourierEnum[keyof typeof ShipmentRequestDTOCourierEnum];
|
|
4058
4852
|
export interface ShippingConsignmentModel {
|
|
4059
4853
|
'service'?: ShippingServiceModel;
|
|
4060
4854
|
/**
|
|
@@ -4087,6 +4881,37 @@ export interface ShippingInformationDTO {
|
|
|
4087
4881
|
*/
|
|
4088
4882
|
'iso'?: string;
|
|
4089
4883
|
}
|
|
4884
|
+
export interface ShippingRequestDTO {
|
|
4885
|
+
/**
|
|
4886
|
+
* Courier
|
|
4887
|
+
*/
|
|
4888
|
+
'courier'?: ShippingRequestDTOCourierEnum;
|
|
4889
|
+
/**
|
|
4890
|
+
* Courier Service
|
|
4891
|
+
*/
|
|
4892
|
+
'service'?: string;
|
|
4893
|
+
/**
|
|
4894
|
+
* Boxes
|
|
4895
|
+
*/
|
|
4896
|
+
'boxes'?: number;
|
|
4897
|
+
/**
|
|
4898
|
+
* Printer
|
|
4899
|
+
*/
|
|
4900
|
+
'printer'?: ShippingRequestDTOPrinterEnum | null;
|
|
4901
|
+
'shipment'?: ShipmentRequestDTO | null;
|
|
4902
|
+
}
|
|
4903
|
+
export declare const ShippingRequestDTOCourierEnum: {
|
|
4904
|
+
readonly Dpd: "DPD";
|
|
4905
|
+
readonly ChorltonPallet: "Chorlton Pallet";
|
|
4906
|
+
readonly Pops: "POPS";
|
|
4907
|
+
};
|
|
4908
|
+
export type ShippingRequestDTOCourierEnum = typeof ShippingRequestDTOCourierEnum[keyof typeof ShippingRequestDTOCourierEnum];
|
|
4909
|
+
export declare const ShippingRequestDTOPrinterEnum: {
|
|
4910
|
+
readonly NUMBER_1: 1;
|
|
4911
|
+
readonly NUMBER_2: 2;
|
|
4912
|
+
readonly NUMBER_3: 3;
|
|
4913
|
+
};
|
|
4914
|
+
export type ShippingRequestDTOPrinterEnum = typeof ShippingRequestDTOPrinterEnum[keyof typeof ShippingRequestDTOPrinterEnum];
|
|
4090
4915
|
/**
|
|
4091
4916
|
* Shipping Service
|
|
4092
4917
|
*/
|
|
@@ -4277,6 +5102,35 @@ export interface SipTrunksResponseModel {
|
|
|
4277
5102
|
*/
|
|
4278
5103
|
'totalResults'?: number;
|
|
4279
5104
|
}
|
|
5105
|
+
/**
|
|
5106
|
+
* SMS Account
|
|
5107
|
+
*/
|
|
5108
|
+
export interface SmsAccountDTO {
|
|
5109
|
+
/**
|
|
5110
|
+
* Send URL
|
|
5111
|
+
*/
|
|
5112
|
+
'sendUrl'?: string;
|
|
5113
|
+
/**
|
|
5114
|
+
* Webhook URL
|
|
5115
|
+
*/
|
|
5116
|
+
'webhookUrl'?: string;
|
|
5117
|
+
/**
|
|
5118
|
+
* API Key
|
|
5119
|
+
*/
|
|
5120
|
+
'apiKey'?: string;
|
|
5121
|
+
/**
|
|
5122
|
+
* Numbers
|
|
5123
|
+
*/
|
|
5124
|
+
'numbers'?: Array<SmsNumbersEntity>;
|
|
5125
|
+
/**
|
|
5126
|
+
* Name
|
|
5127
|
+
*/
|
|
5128
|
+
'name'?: string;
|
|
5129
|
+
/**
|
|
5130
|
+
* Sender Whitelist
|
|
5131
|
+
*/
|
|
5132
|
+
'whitelist'?: Array<SmsWhitelistEntity>;
|
|
5133
|
+
}
|
|
4280
5134
|
/**
|
|
4281
5135
|
* SmsEntity
|
|
4282
5136
|
*/
|
|
@@ -4310,6 +5164,43 @@ export interface SmsAccountEntity {
|
|
|
4310
5164
|
*/
|
|
4311
5165
|
'name'?: string;
|
|
4312
5166
|
}
|
|
5167
|
+
/**
|
|
5168
|
+
* SMS Account Request
|
|
5169
|
+
*/
|
|
5170
|
+
export interface SmsAccountRequestDTO {
|
|
5171
|
+
/**
|
|
5172
|
+
* SMS Provider
|
|
5173
|
+
*/
|
|
5174
|
+
'provider'?: SmsAccountRequestDTOProviderEnum;
|
|
5175
|
+
/**
|
|
5176
|
+
* Customer Name
|
|
5177
|
+
*/
|
|
5178
|
+
'name'?: string;
|
|
5179
|
+
/**
|
|
5180
|
+
* SMS Webhook
|
|
5181
|
+
*/
|
|
5182
|
+
'webhookUrl'?: string;
|
|
5183
|
+
/**
|
|
5184
|
+
* Number Country
|
|
5185
|
+
*/
|
|
5186
|
+
'iso'?: string;
|
|
5187
|
+
/**
|
|
5188
|
+
* Number Type
|
|
5189
|
+
*/
|
|
5190
|
+
'type'?: SmsAccountRequestDTOTypeEnum;
|
|
5191
|
+
}
|
|
5192
|
+
export declare const SmsAccountRequestDTOProviderEnum: {
|
|
5193
|
+
readonly NUMBER_1: 1;
|
|
5194
|
+
};
|
|
5195
|
+
export type SmsAccountRequestDTOProviderEnum = typeof SmsAccountRequestDTOProviderEnum[keyof typeof SmsAccountRequestDTOProviderEnum];
|
|
5196
|
+
export declare const SmsAccountRequestDTOTypeEnum: {
|
|
5197
|
+
readonly Local: "local";
|
|
5198
|
+
readonly TollFree: "toll_free";
|
|
5199
|
+
readonly Mobile: "mobile";
|
|
5200
|
+
readonly National: "national";
|
|
5201
|
+
readonly SharedCost: "shared_cost";
|
|
5202
|
+
};
|
|
5203
|
+
export type SmsAccountRequestDTOTypeEnum = typeof SmsAccountRequestDTOTypeEnum[keyof typeof SmsAccountRequestDTOTypeEnum];
|
|
4313
5204
|
/**
|
|
4314
5205
|
* SMS Data Model
|
|
4315
5206
|
*/
|
|
@@ -5131,72 +6022,150 @@ export interface SupplierItemEntity {
|
|
|
5131
6022
|
'supplierSku'?: string;
|
|
5132
6023
|
}
|
|
5133
6024
|
/**
|
|
5134
|
-
*
|
|
6025
|
+
* Supplier Item
|
|
5135
6026
|
*/
|
|
5136
|
-
export interface
|
|
6027
|
+
export interface SupplierItemModel {
|
|
5137
6028
|
/**
|
|
5138
|
-
*
|
|
6029
|
+
* id
|
|
5139
6030
|
*/
|
|
5140
6031
|
'id'?: number;
|
|
5141
6032
|
/**
|
|
5142
|
-
*
|
|
5143
|
-
*/
|
|
5144
|
-
'status'?: string;
|
|
5145
|
-
/**
|
|
5146
|
-
* Ticket status ID
|
|
5147
|
-
*/
|
|
5148
|
-
'statusId'?: number;
|
|
5149
|
-
/**
|
|
5150
|
-
* Ticket subject
|
|
5151
|
-
*/
|
|
5152
|
-
'subject'?: string;
|
|
5153
|
-
/**
|
|
5154
|
-
* Support email address
|
|
6033
|
+
* supplierId
|
|
5155
6034
|
*/
|
|
5156
|
-
'
|
|
6035
|
+
'supplierId'?: number;
|
|
5157
6036
|
/**
|
|
5158
|
-
*
|
|
6037
|
+
* sku
|
|
5159
6038
|
*/
|
|
5160
|
-
'
|
|
6039
|
+
'sku'?: string;
|
|
5161
6040
|
/**
|
|
5162
|
-
*
|
|
6041
|
+
* title
|
|
5163
6042
|
*/
|
|
5164
|
-
'
|
|
6043
|
+
'title'?: string;
|
|
5165
6044
|
/**
|
|
5166
|
-
*
|
|
6045
|
+
* itemOptions
|
|
5167
6046
|
*/
|
|
5168
|
-
'
|
|
6047
|
+
'itemOptions'?: string;
|
|
5169
6048
|
/**
|
|
5170
|
-
*
|
|
6049
|
+
* itemPrice
|
|
5171
6050
|
*/
|
|
5172
|
-
'
|
|
6051
|
+
'itemPrice'?: number;
|
|
5173
6052
|
/**
|
|
5174
|
-
*
|
|
6053
|
+
* itemType
|
|
5175
6054
|
*/
|
|
5176
|
-
'
|
|
6055
|
+
'itemType'?: number;
|
|
5177
6056
|
/**
|
|
5178
|
-
*
|
|
6057
|
+
* supplierSku
|
|
5179
6058
|
*/
|
|
5180
|
-
'
|
|
6059
|
+
'supplierSku'?: string;
|
|
5181
6060
|
}
|
|
5182
6061
|
/**
|
|
5183
|
-
*
|
|
6062
|
+
* Supplier
|
|
5184
6063
|
*/
|
|
5185
|
-
export interface
|
|
6064
|
+
export interface SupplierModel {
|
|
5186
6065
|
/**
|
|
5187
6066
|
* id
|
|
5188
6067
|
*/
|
|
5189
6068
|
'id'?: number;
|
|
5190
6069
|
/**
|
|
5191
|
-
*
|
|
6070
|
+
* name
|
|
5192
6071
|
*/
|
|
5193
|
-
'
|
|
6072
|
+
'name'?: string;
|
|
5194
6073
|
/**
|
|
5195
|
-
*
|
|
6074
|
+
* nameShort
|
|
5196
6075
|
*/
|
|
5197
|
-
'
|
|
6076
|
+
'shortName'?: string;
|
|
5198
6077
|
/**
|
|
5199
|
-
*
|
|
6078
|
+
* email
|
|
6079
|
+
*/
|
|
6080
|
+
'email'?: string;
|
|
6081
|
+
/**
|
|
6082
|
+
* phone
|
|
6083
|
+
*/
|
|
6084
|
+
'phone'?: string;
|
|
6085
|
+
/**
|
|
6086
|
+
* defaultCourier
|
|
6087
|
+
*/
|
|
6088
|
+
'defaultCourier'?: string;
|
|
6089
|
+
/**
|
|
6090
|
+
* defaultCarriage
|
|
6091
|
+
*/
|
|
6092
|
+
'defaultCarriage'?: number;
|
|
6093
|
+
/**
|
|
6094
|
+
* account
|
|
6095
|
+
*/
|
|
6096
|
+
'accountNumber'?: string;
|
|
6097
|
+
/**
|
|
6098
|
+
* internalAccount
|
|
6099
|
+
*/
|
|
6100
|
+
'xeroAccountNumber'?: string;
|
|
6101
|
+
}
|
|
6102
|
+
/**
|
|
6103
|
+
* Telephony Support Ticket
|
|
6104
|
+
*/
|
|
6105
|
+
export interface SupportTicketModel {
|
|
6106
|
+
/**
|
|
6107
|
+
* Ticket ID
|
|
6108
|
+
*/
|
|
6109
|
+
'id'?: number;
|
|
6110
|
+
/**
|
|
6111
|
+
* Ticket status
|
|
6112
|
+
*/
|
|
6113
|
+
'status'?: string;
|
|
6114
|
+
/**
|
|
6115
|
+
* Ticket status ID
|
|
6116
|
+
*/
|
|
6117
|
+
'statusId'?: number;
|
|
6118
|
+
/**
|
|
6119
|
+
* Ticket subject
|
|
6120
|
+
*/
|
|
6121
|
+
'subject'?: string;
|
|
6122
|
+
/**
|
|
6123
|
+
* Support email address
|
|
6124
|
+
*/
|
|
6125
|
+
'supportEmail'?: string | null;
|
|
6126
|
+
/**
|
|
6127
|
+
* Recipient emails
|
|
6128
|
+
*/
|
|
6129
|
+
'toEmails'?: Array<string>;
|
|
6130
|
+
/**
|
|
6131
|
+
* Ticket description (HTML)
|
|
6132
|
+
*/
|
|
6133
|
+
'description'?: string;
|
|
6134
|
+
/**
|
|
6135
|
+
* Ticket description (plain text)
|
|
6136
|
+
*/
|
|
6137
|
+
'descriptionText'?: string;
|
|
6138
|
+
/**
|
|
6139
|
+
* Creation timestamp
|
|
6140
|
+
*/
|
|
6141
|
+
'createdAt'?: string;
|
|
6142
|
+
/**
|
|
6143
|
+
* Attachments
|
|
6144
|
+
*/
|
|
6145
|
+
'attachments'?: Array<AttachmentModel>;
|
|
6146
|
+
/**
|
|
6147
|
+
* Conversations
|
|
6148
|
+
*/
|
|
6149
|
+
'conversations'?: Array<ConversationModel>;
|
|
6150
|
+
}
|
|
6151
|
+
/**
|
|
6152
|
+
* 3CX Wizard Restore From Backup
|
|
6153
|
+
*/
|
|
6154
|
+
export interface TcxBackupEntity {
|
|
6155
|
+
/**
|
|
6156
|
+
* id
|
|
6157
|
+
*/
|
|
6158
|
+
'id'?: number;
|
|
6159
|
+
/**
|
|
6160
|
+
* Backup Filename
|
|
6161
|
+
*/
|
|
6162
|
+
'path'?: string;
|
|
6163
|
+
/**
|
|
6164
|
+
* password
|
|
6165
|
+
*/
|
|
6166
|
+
'password'?: string;
|
|
6167
|
+
/**
|
|
6168
|
+
* adminUsername
|
|
5200
6169
|
*/
|
|
5201
6170
|
'adminUsername'?: string;
|
|
5202
6171
|
/**
|
|
@@ -6053,6 +7022,10 @@ export interface TcxRemoteStorageModel {
|
|
|
6053
7022
|
* SBC Data
|
|
6054
7023
|
*/
|
|
6055
7024
|
export interface TcxSbcDTO {
|
|
7025
|
+
/**
|
|
7026
|
+
* ID
|
|
7027
|
+
*/
|
|
7028
|
+
'id'?: number | null;
|
|
6056
7029
|
/**
|
|
6057
7030
|
* LAN IP Address
|
|
6058
7031
|
*/
|
|
@@ -6829,6 +7802,13 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
6829
7802
|
* @throws {RequiredError}
|
|
6830
7803
|
*/
|
|
6831
7804
|
getGetAccountDetailedSummary: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7805
|
+
/**
|
|
7806
|
+
* Get Account Page Details
|
|
7807
|
+
* @param {string} id Xero ID
|
|
7808
|
+
* @param {*} [options] Override http request option.
|
|
7809
|
+
* @throws {RequiredError}
|
|
7810
|
+
*/
|
|
7811
|
+
getGetAccountPageInfo: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6832
7812
|
/**
|
|
6833
7813
|
* Get Accounts
|
|
6834
7814
|
* @summary Get Accounts
|
|
@@ -6862,13 +7842,37 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
6862
7842
|
* @throws {RequiredError}
|
|
6863
7843
|
*/
|
|
6864
7844
|
getVerifyEmailAddress: (token: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7845
|
+
/**
|
|
7846
|
+
* Set Account Portal Access
|
|
7847
|
+
* @param {string} id Xero ID
|
|
7848
|
+
* @param {PatchSetPortalAccessStateEnum} state Portal Access State
|
|
7849
|
+
* @param {*} [options] Override http request option.
|
|
7850
|
+
* @throws {RequiredError}
|
|
7851
|
+
*/
|
|
7852
|
+
patchSetPortalAccess: (id: string, state: PatchSetPortalAccessStateEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7853
|
+
/**
|
|
7854
|
+
* Set Account Prize Promo
|
|
7855
|
+
* @param {string} id Xero ID
|
|
7856
|
+
* @param {PatchSetPrizePromoStateEnum} state Prize Promo State
|
|
7857
|
+
* @param {*} [options] Override http request option.
|
|
7858
|
+
* @throws {RequiredError}
|
|
7859
|
+
*/
|
|
7860
|
+
patchSetPrizePromo: (id: string, state: PatchSetPrizePromoStateEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6865
7861
|
/**
|
|
6866
7862
|
* Set 3CX Wizard CNAME
|
|
6867
|
-
* @param {
|
|
7863
|
+
* @param {PatchUpdateAccountCnameRequest} [patchUpdateAccountCnameRequest] CNAME Request
|
|
7864
|
+
* @param {*} [options] Override http request option.
|
|
7865
|
+
* @throws {RequiredError}
|
|
7866
|
+
*/
|
|
7867
|
+
patchSetTcxWizardCname: (patchUpdateAccountCnameRequest?: PatchUpdateAccountCnameRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7868
|
+
/**
|
|
7869
|
+
* Set Account Prize Promo
|
|
7870
|
+
* @param {string} id Xero ID
|
|
7871
|
+
* @param {PatchUpdateAccountCnameRequest} [patchUpdateAccountCnameRequest] CNAME Request
|
|
6868
7872
|
* @param {*} [options] Override http request option.
|
|
6869
7873
|
* @throws {RequiredError}
|
|
6870
7874
|
*/
|
|
6871
|
-
|
|
7875
|
+
patchUpdateAccountCname: (id: string, patchUpdateAccountCnameRequest?: PatchUpdateAccountCnameRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6872
7876
|
/**
|
|
6873
7877
|
* Update Account Password
|
|
6874
7878
|
* @summary Update Account Password
|
|
@@ -6944,6 +7948,22 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
6944
7948
|
* @throws {RequiredError}
|
|
6945
7949
|
*/
|
|
6946
7950
|
putUpdateAccountContact: (email: string, accountContactRequestModel?: AccountContactRequestModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7951
|
+
/**
|
|
7952
|
+
* Update Account Billing Address
|
|
7953
|
+
* @param {string} id Xero ID
|
|
7954
|
+
* @param {AddressModel} [addressModel] Updated Billing Address
|
|
7955
|
+
* @param {*} [options] Override http request option.
|
|
7956
|
+
* @throws {RequiredError}
|
|
7957
|
+
*/
|
|
7958
|
+
putUpdateBillingAddress: (id: string, addressModel?: AddressModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7959
|
+
/**
|
|
7960
|
+
* Update Account Shipping Address
|
|
7961
|
+
* @param {string} id Xero ID
|
|
7962
|
+
* @param {AddressModel} [addressModel] Updated Shipping Address
|
|
7963
|
+
* @param {*} [options] Override http request option.
|
|
7964
|
+
* @throws {RequiredError}
|
|
7965
|
+
*/
|
|
7966
|
+
putUpdateShippingAddress: (id: string, addressModel?: AddressModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6947
7967
|
};
|
|
6948
7968
|
/**
|
|
6949
7969
|
* AccountsApi - functional programming interface
|
|
@@ -6988,6 +8008,13 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
6988
8008
|
* @throws {RequiredError}
|
|
6989
8009
|
*/
|
|
6990
8010
|
getGetAccountDetailedSummary(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountDetailedSummaryDTO>>;
|
|
8011
|
+
/**
|
|
8012
|
+
* Get Account Page Details
|
|
8013
|
+
* @param {string} id Xero ID
|
|
8014
|
+
* @param {*} [options] Override http request option.
|
|
8015
|
+
* @throws {RequiredError}
|
|
8016
|
+
*/
|
|
8017
|
+
getGetAccountPageInfo(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountPageDetailsDTO>>;
|
|
6991
8018
|
/**
|
|
6992
8019
|
* Get Accounts
|
|
6993
8020
|
* @summary Get Accounts
|
|
@@ -7021,13 +8048,37 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
7021
8048
|
* @throws {RequiredError}
|
|
7022
8049
|
*/
|
|
7023
8050
|
getVerifyEmailAddress(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8051
|
+
/**
|
|
8052
|
+
* Set Account Portal Access
|
|
8053
|
+
* @param {string} id Xero ID
|
|
8054
|
+
* @param {PatchSetPortalAccessStateEnum} state Portal Access State
|
|
8055
|
+
* @param {*} [options] Override http request option.
|
|
8056
|
+
* @throws {RequiredError}
|
|
8057
|
+
*/
|
|
8058
|
+
patchSetPortalAccess(id: string, state: PatchSetPortalAccessStateEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8059
|
+
/**
|
|
8060
|
+
* Set Account Prize Promo
|
|
8061
|
+
* @param {string} id Xero ID
|
|
8062
|
+
* @param {PatchSetPrizePromoStateEnum} state Prize Promo State
|
|
8063
|
+
* @param {*} [options] Override http request option.
|
|
8064
|
+
* @throws {RequiredError}
|
|
8065
|
+
*/
|
|
8066
|
+
patchSetPrizePromo(id: string, state: PatchSetPrizePromoStateEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7024
8067
|
/**
|
|
7025
8068
|
* Set 3CX Wizard CNAME
|
|
7026
|
-
* @param {
|
|
8069
|
+
* @param {PatchUpdateAccountCnameRequest} [patchUpdateAccountCnameRequest] CNAME Request
|
|
8070
|
+
* @param {*} [options] Override http request option.
|
|
8071
|
+
* @throws {RequiredError}
|
|
8072
|
+
*/
|
|
8073
|
+
patchSetTcxWizardCname(patchUpdateAccountCnameRequest?: PatchUpdateAccountCnameRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8074
|
+
/**
|
|
8075
|
+
* Set Account Prize Promo
|
|
8076
|
+
* @param {string} id Xero ID
|
|
8077
|
+
* @param {PatchUpdateAccountCnameRequest} [patchUpdateAccountCnameRequest] CNAME Request
|
|
7027
8078
|
* @param {*} [options] Override http request option.
|
|
7028
8079
|
* @throws {RequiredError}
|
|
7029
8080
|
*/
|
|
7030
|
-
|
|
8081
|
+
patchUpdateAccountCname(id: string, patchUpdateAccountCnameRequest?: PatchUpdateAccountCnameRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7031
8082
|
/**
|
|
7032
8083
|
* Update Account Password
|
|
7033
8084
|
* @summary Update Account Password
|
|
@@ -7103,6 +8154,22 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
7103
8154
|
* @throws {RequiredError}
|
|
7104
8155
|
*/
|
|
7105
8156
|
putUpdateAccountContact(email: string, accountContactRequestModel?: AccountContactRequestModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8157
|
+
/**
|
|
8158
|
+
* Update Account Billing Address
|
|
8159
|
+
* @param {string} id Xero ID
|
|
8160
|
+
* @param {AddressModel} [addressModel] Updated Billing Address
|
|
8161
|
+
* @param {*} [options] Override http request option.
|
|
8162
|
+
* @throws {RequiredError}
|
|
8163
|
+
*/
|
|
8164
|
+
putUpdateBillingAddress(id: string, addressModel?: AddressModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8165
|
+
/**
|
|
8166
|
+
* Update Account Shipping Address
|
|
8167
|
+
* @param {string} id Xero ID
|
|
8168
|
+
* @param {AddressModel} [addressModel] Updated Shipping Address
|
|
8169
|
+
* @param {*} [options] Override http request option.
|
|
8170
|
+
* @throws {RequiredError}
|
|
8171
|
+
*/
|
|
8172
|
+
putUpdateShippingAddress(id: string, addressModel?: AddressModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7106
8173
|
};
|
|
7107
8174
|
/**
|
|
7108
8175
|
* AccountsApi - factory interface
|
|
@@ -7147,6 +8214,13 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
7147
8214
|
* @throws {RequiredError}
|
|
7148
8215
|
*/
|
|
7149
8216
|
getGetAccountDetailedSummary(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AccountDetailedSummaryDTO>;
|
|
8217
|
+
/**
|
|
8218
|
+
* Get Account Page Details
|
|
8219
|
+
* @param {string} id Xero ID
|
|
8220
|
+
* @param {*} [options] Override http request option.
|
|
8221
|
+
* @throws {RequiredError}
|
|
8222
|
+
*/
|
|
8223
|
+
getGetAccountPageInfo(id: string, options?: RawAxiosRequestConfig): AxiosPromise<AccountPageDetailsDTO>;
|
|
7150
8224
|
/**
|
|
7151
8225
|
* Get Accounts
|
|
7152
8226
|
* @summary Get Accounts
|
|
@@ -7180,13 +8254,37 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
7180
8254
|
* @throws {RequiredError}
|
|
7181
8255
|
*/
|
|
7182
8256
|
getVerifyEmailAddress(token: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8257
|
+
/**
|
|
8258
|
+
* Set Account Portal Access
|
|
8259
|
+
* @param {string} id Xero ID
|
|
8260
|
+
* @param {PatchSetPortalAccessStateEnum} state Portal Access State
|
|
8261
|
+
* @param {*} [options] Override http request option.
|
|
8262
|
+
* @throws {RequiredError}
|
|
8263
|
+
*/
|
|
8264
|
+
patchSetPortalAccess(id: string, state: PatchSetPortalAccessStateEnum, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8265
|
+
/**
|
|
8266
|
+
* Set Account Prize Promo
|
|
8267
|
+
* @param {string} id Xero ID
|
|
8268
|
+
* @param {PatchSetPrizePromoStateEnum} state Prize Promo State
|
|
8269
|
+
* @param {*} [options] Override http request option.
|
|
8270
|
+
* @throws {RequiredError}
|
|
8271
|
+
*/
|
|
8272
|
+
patchSetPrizePromo(id: string, state: PatchSetPrizePromoStateEnum, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7183
8273
|
/**
|
|
7184
8274
|
* Set 3CX Wizard CNAME
|
|
7185
|
-
* @param {
|
|
8275
|
+
* @param {PatchUpdateAccountCnameRequest} [patchUpdateAccountCnameRequest] CNAME Request
|
|
8276
|
+
* @param {*} [options] Override http request option.
|
|
8277
|
+
* @throws {RequiredError}
|
|
8278
|
+
*/
|
|
8279
|
+
patchSetTcxWizardCname(patchUpdateAccountCnameRequest?: PatchUpdateAccountCnameRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8280
|
+
/**
|
|
8281
|
+
* Set Account Prize Promo
|
|
8282
|
+
* @param {string} id Xero ID
|
|
8283
|
+
* @param {PatchUpdateAccountCnameRequest} [patchUpdateAccountCnameRequest] CNAME Request
|
|
7186
8284
|
* @param {*} [options] Override http request option.
|
|
7187
8285
|
* @throws {RequiredError}
|
|
7188
8286
|
*/
|
|
7189
|
-
|
|
8287
|
+
patchUpdateAccountCname(id: string, patchUpdateAccountCnameRequest?: PatchUpdateAccountCnameRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7190
8288
|
/**
|
|
7191
8289
|
* Update Account Password
|
|
7192
8290
|
* @summary Update Account Password
|
|
@@ -7262,6 +8360,22 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
7262
8360
|
* @throws {RequiredError}
|
|
7263
8361
|
*/
|
|
7264
8362
|
putUpdateAccountContact(email: string, accountContactRequestModel?: AccountContactRequestModel, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8363
|
+
/**
|
|
8364
|
+
* Update Account Billing Address
|
|
8365
|
+
* @param {string} id Xero ID
|
|
8366
|
+
* @param {AddressModel} [addressModel] Updated Billing Address
|
|
8367
|
+
* @param {*} [options] Override http request option.
|
|
8368
|
+
* @throws {RequiredError}
|
|
8369
|
+
*/
|
|
8370
|
+
putUpdateBillingAddress(id: string, addressModel?: AddressModel, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8371
|
+
/**
|
|
8372
|
+
* Update Account Shipping Address
|
|
8373
|
+
* @param {string} id Xero ID
|
|
8374
|
+
* @param {AddressModel} [addressModel] Updated Shipping Address
|
|
8375
|
+
* @param {*} [options] Override http request option.
|
|
8376
|
+
* @throws {RequiredError}
|
|
8377
|
+
*/
|
|
8378
|
+
putUpdateShippingAddress(id: string, addressModel?: AddressModel, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7265
8379
|
};
|
|
7266
8380
|
/**
|
|
7267
8381
|
* AccountsApi - object-oriented interface
|
|
@@ -7306,6 +8420,13 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
7306
8420
|
* @throws {RequiredError}
|
|
7307
8421
|
*/
|
|
7308
8422
|
getGetAccountDetailedSummary(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountDetailedSummaryDTO, any, {}>>;
|
|
8423
|
+
/**
|
|
8424
|
+
* Get Account Page Details
|
|
8425
|
+
* @param {string} id Xero ID
|
|
8426
|
+
* @param {*} [options] Override http request option.
|
|
8427
|
+
* @throws {RequiredError}
|
|
8428
|
+
*/
|
|
8429
|
+
getGetAccountPageInfo(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountPageDetailsDTO, any, {}>>;
|
|
7309
8430
|
/**
|
|
7310
8431
|
* Get Accounts
|
|
7311
8432
|
* @summary Get Accounts
|
|
@@ -7339,13 +8460,37 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
7339
8460
|
* @throws {RequiredError}
|
|
7340
8461
|
*/
|
|
7341
8462
|
getVerifyEmailAddress(token: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
8463
|
+
/**
|
|
8464
|
+
* Set Account Portal Access
|
|
8465
|
+
* @param {string} id Xero ID
|
|
8466
|
+
* @param {PatchSetPortalAccessStateEnum} state Portal Access State
|
|
8467
|
+
* @param {*} [options] Override http request option.
|
|
8468
|
+
* @throws {RequiredError}
|
|
8469
|
+
*/
|
|
8470
|
+
patchSetPortalAccess(id: string, state: PatchSetPortalAccessStateEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
8471
|
+
/**
|
|
8472
|
+
* Set Account Prize Promo
|
|
8473
|
+
* @param {string} id Xero ID
|
|
8474
|
+
* @param {PatchSetPrizePromoStateEnum} state Prize Promo State
|
|
8475
|
+
* @param {*} [options] Override http request option.
|
|
8476
|
+
* @throws {RequiredError}
|
|
8477
|
+
*/
|
|
8478
|
+
patchSetPrizePromo(id: string, state: PatchSetPrizePromoStateEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7342
8479
|
/**
|
|
7343
8480
|
* Set 3CX Wizard CNAME
|
|
7344
|
-
* @param {
|
|
8481
|
+
* @param {PatchUpdateAccountCnameRequest} [patchUpdateAccountCnameRequest] CNAME Request
|
|
8482
|
+
* @param {*} [options] Override http request option.
|
|
8483
|
+
* @throws {RequiredError}
|
|
8484
|
+
*/
|
|
8485
|
+
patchSetTcxWizardCname(patchUpdateAccountCnameRequest?: PatchUpdateAccountCnameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
8486
|
+
/**
|
|
8487
|
+
* Set Account Prize Promo
|
|
8488
|
+
* @param {string} id Xero ID
|
|
8489
|
+
* @param {PatchUpdateAccountCnameRequest} [patchUpdateAccountCnameRequest] CNAME Request
|
|
7345
8490
|
* @param {*} [options] Override http request option.
|
|
7346
8491
|
* @throws {RequiredError}
|
|
7347
8492
|
*/
|
|
7348
|
-
|
|
8493
|
+
patchUpdateAccountCname(id: string, patchUpdateAccountCnameRequest?: PatchUpdateAccountCnameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7349
8494
|
/**
|
|
7350
8495
|
* Update Account Password
|
|
7351
8496
|
* @summary Update Account Password
|
|
@@ -7421,7 +8566,33 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
7421
8566
|
* @throws {RequiredError}
|
|
7422
8567
|
*/
|
|
7423
8568
|
putUpdateAccountContact(email: string, accountContactRequestModel?: AccountContactRequestModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
8569
|
+
/**
|
|
8570
|
+
* Update Account Billing Address
|
|
8571
|
+
* @param {string} id Xero ID
|
|
8572
|
+
* @param {AddressModel} [addressModel] Updated Billing Address
|
|
8573
|
+
* @param {*} [options] Override http request option.
|
|
8574
|
+
* @throws {RequiredError}
|
|
8575
|
+
*/
|
|
8576
|
+
putUpdateBillingAddress(id: string, addressModel?: AddressModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
8577
|
+
/**
|
|
8578
|
+
* Update Account Shipping Address
|
|
8579
|
+
* @param {string} id Xero ID
|
|
8580
|
+
* @param {AddressModel} [addressModel] Updated Shipping Address
|
|
8581
|
+
* @param {*} [options] Override http request option.
|
|
8582
|
+
* @throws {RequiredError}
|
|
8583
|
+
*/
|
|
8584
|
+
putUpdateShippingAddress(id: string, addressModel?: AddressModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7424
8585
|
}
|
|
8586
|
+
export declare const PatchSetPortalAccessStateEnum: {
|
|
8587
|
+
readonly Enable: "enable";
|
|
8588
|
+
readonly Disable: "disable";
|
|
8589
|
+
};
|
|
8590
|
+
export type PatchSetPortalAccessStateEnum = typeof PatchSetPortalAccessStateEnum[keyof typeof PatchSetPortalAccessStateEnum];
|
|
8591
|
+
export declare const PatchSetPrizePromoStateEnum: {
|
|
8592
|
+
readonly Enable: "enable";
|
|
8593
|
+
readonly Disable: "disable";
|
|
8594
|
+
};
|
|
8595
|
+
export type PatchSetPrizePromoStateEnum = typeof PatchSetPrizePromoStateEnum[keyof typeof PatchSetPrizePromoStateEnum];
|
|
7425
8596
|
/**
|
|
7426
8597
|
* CRMApi - axios parameter creator
|
|
7427
8598
|
*/
|
|
@@ -9820,6 +10991,13 @@ export declare const NumberPortingApiAxiosParamCreator: (configuration?: Configu
|
|
|
9820
10991
|
* @throws {RequiredError}
|
|
9821
10992
|
*/
|
|
9822
10993
|
getUpdateNumberPort: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10994
|
+
/**
|
|
10995
|
+
*
|
|
10996
|
+
* @param {number} id Number Port ID
|
|
10997
|
+
* @param {*} [options] Override http request option.
|
|
10998
|
+
* @throws {RequiredError}
|
|
10999
|
+
*/
|
|
11000
|
+
patchCancelAdminNumberPort: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9823
11001
|
/**
|
|
9824
11002
|
*
|
|
9825
11003
|
* @param {number} id Number Port ID
|
|
@@ -9830,11 +11008,11 @@ export declare const NumberPortingApiAxiosParamCreator: (configuration?: Configu
|
|
|
9830
11008
|
/**
|
|
9831
11009
|
*
|
|
9832
11010
|
* @param {number} id Number Port ID
|
|
9833
|
-
* @param {
|
|
11011
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
9834
11012
|
* @param {*} [options] Override http request option.
|
|
9835
11013
|
* @throws {RequiredError}
|
|
9836
11014
|
*/
|
|
9837
|
-
postAddAdminNote: (id: number,
|
|
11015
|
+
postAddAdminNote: (id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9838
11016
|
/**
|
|
9839
11017
|
*
|
|
9840
11018
|
* @param {string | null} [companyName] Company Name
|
|
@@ -9943,6 +11121,13 @@ export declare const NumberPortingApiFp: (configuration?: Configuration) => {
|
|
|
9943
11121
|
* @throws {RequiredError}
|
|
9944
11122
|
*/
|
|
9945
11123
|
getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NumberPortDTO>>;
|
|
11124
|
+
/**
|
|
11125
|
+
*
|
|
11126
|
+
* @param {number} id Number Port ID
|
|
11127
|
+
* @param {*} [options] Override http request option.
|
|
11128
|
+
* @throws {RequiredError}
|
|
11129
|
+
*/
|
|
11130
|
+
patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>>;
|
|
9946
11131
|
/**
|
|
9947
11132
|
*
|
|
9948
11133
|
* @param {number} id Number Port ID
|
|
@@ -9953,11 +11138,11 @@ export declare const NumberPortingApiFp: (configuration?: Configuration) => {
|
|
|
9953
11138
|
/**
|
|
9954
11139
|
*
|
|
9955
11140
|
* @param {number} id Number Port ID
|
|
9956
|
-
* @param {
|
|
11141
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
9957
11142
|
* @param {*} [options] Override http request option.
|
|
9958
11143
|
* @throws {RequiredError}
|
|
9959
11144
|
*/
|
|
9960
|
-
postAddAdminNote(id: number,
|
|
11145
|
+
postAddAdminNote(id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>>;
|
|
9961
11146
|
/**
|
|
9962
11147
|
*
|
|
9963
11148
|
* @param {string | null} [companyName] Company Name
|
|
@@ -10066,6 +11251,13 @@ export declare const NumberPortingApiFactory: (configuration?: Configuration, ba
|
|
|
10066
11251
|
* @throws {RequiredError}
|
|
10067
11252
|
*/
|
|
10068
11253
|
getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<NumberPortDTO>;
|
|
11254
|
+
/**
|
|
11255
|
+
*
|
|
11256
|
+
* @param {number} id Number Port ID
|
|
11257
|
+
* @param {*} [options] Override http request option.
|
|
11258
|
+
* @throws {RequiredError}
|
|
11259
|
+
*/
|
|
11260
|
+
patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO>;
|
|
10069
11261
|
/**
|
|
10070
11262
|
*
|
|
10071
11263
|
* @param {number} id Number Port ID
|
|
@@ -10076,11 +11268,11 @@ export declare const NumberPortingApiFactory: (configuration?: Configuration, ba
|
|
|
10076
11268
|
/**
|
|
10077
11269
|
*
|
|
10078
11270
|
* @param {number} id Number Port ID
|
|
10079
|
-
* @param {
|
|
11271
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
10080
11272
|
* @param {*} [options] Override http request option.
|
|
10081
11273
|
* @throws {RequiredError}
|
|
10082
11274
|
*/
|
|
10083
|
-
postAddAdminNote(id: number,
|
|
11275
|
+
postAddAdminNote(id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO>;
|
|
10084
11276
|
/**
|
|
10085
11277
|
*
|
|
10086
11278
|
* @param {string | null} [companyName] Company Name
|
|
@@ -10189,6 +11381,13 @@ export declare class NumberPortingApi extends BaseAPI {
|
|
|
10189
11381
|
* @throws {RequiredError}
|
|
10190
11382
|
*/
|
|
10191
11383
|
getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NumberPortDTO, any, {}>>;
|
|
11384
|
+
/**
|
|
11385
|
+
*
|
|
11386
|
+
* @param {number} id Number Port ID
|
|
11387
|
+
* @param {*} [options] Override http request option.
|
|
11388
|
+
* @throws {RequiredError}
|
|
11389
|
+
*/
|
|
11390
|
+
patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminNumberPortDTO, any, {}>>;
|
|
10192
11391
|
/**
|
|
10193
11392
|
*
|
|
10194
11393
|
* @param {number} id Number Port ID
|
|
@@ -10199,11 +11398,11 @@ export declare class NumberPortingApi extends BaseAPI {
|
|
|
10199
11398
|
/**
|
|
10200
11399
|
*
|
|
10201
11400
|
* @param {number} id Number Port ID
|
|
10202
|
-
* @param {
|
|
11401
|
+
* @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
|
|
10203
11402
|
* @param {*} [options] Override http request option.
|
|
10204
11403
|
* @throws {RequiredError}
|
|
10205
11404
|
*/
|
|
10206
|
-
postAddAdminNote(id: number,
|
|
11405
|
+
postAddAdminNote(id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminNumberPortDTO, any, {}>>;
|
|
10207
11406
|
/**
|
|
10208
11407
|
*
|
|
10209
11408
|
* @param {string | null} [companyName] Company Name
|
|
@@ -10563,6 +11762,8 @@ export declare const PostAccessTokenScopeEnum: {
|
|
|
10563
11762
|
readonly ProductsRead: "products.read";
|
|
10564
11763
|
readonly ProvisioningRead: "provisioning.read";
|
|
10565
11764
|
readonly ProvisioningWrite: "provisioning.write";
|
|
11765
|
+
readonly SmsRead: "sms.read";
|
|
11766
|
+
readonly SmsWrite: "sms.write";
|
|
10566
11767
|
readonly TrunksRead: "trunks.read";
|
|
10567
11768
|
readonly TrunksWrite: "trunks.write";
|
|
10568
11769
|
readonly TcxIntegrationsRead: "tcx_integrations.read";
|
|
@@ -10597,6 +11798,8 @@ export declare const PostAuthoriseScopeEnum: {
|
|
|
10597
11798
|
readonly ProductsRead: "products.read";
|
|
10598
11799
|
readonly ProvisioningRead: "provisioning.read";
|
|
10599
11800
|
readonly ProvisioningWrite: "provisioning.write";
|
|
11801
|
+
readonly SmsRead: "sms.read";
|
|
11802
|
+
readonly SmsWrite: "sms.write";
|
|
10600
11803
|
readonly TrunksRead: "trunks.read";
|
|
10601
11804
|
readonly TrunksWrite: "trunks.write";
|
|
10602
11805
|
readonly TcxIntegrationsRead: "tcx_integrations.read";
|
|
@@ -10614,6 +11817,14 @@ export type PostAuthoriseScopeEnum = typeof PostAuthoriseScopeEnum[keyof typeof
|
|
|
10614
11817
|
* OrdersApi - axios parameter creator
|
|
10615
11818
|
*/
|
|
10616
11819
|
export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11820
|
+
/**
|
|
11821
|
+
* Delete Batch (Admin)
|
|
11822
|
+
* @param {number} id Order ID
|
|
11823
|
+
* @param {number} batchId Batch ID
|
|
11824
|
+
* @param {*} [options] Override http request option.
|
|
11825
|
+
* @throws {RequiredError}
|
|
11826
|
+
*/
|
|
11827
|
+
deleteDeleteBatch: (id: number, batchId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10617
11828
|
/**
|
|
10618
11829
|
* Delete Orders (Beta)
|
|
10619
11830
|
* @summary Delete Orders (Beta)
|
|
@@ -10622,6 +11833,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
10622
11833
|
* @throws {RequiredError}
|
|
10623
11834
|
*/
|
|
10624
11835
|
deleteUpdateOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11836
|
+
/**
|
|
11837
|
+
* Delete Shipment (Admin)
|
|
11838
|
+
* @summary Delete Shipment (Admin)
|
|
11839
|
+
* @param {number} id Order ID
|
|
11840
|
+
* @param {number} batchId Batch ID
|
|
11841
|
+
* @param {number} shipmentId Shipment ID
|
|
11842
|
+
* @param {*} [options] Override http request option.
|
|
11843
|
+
* @throws {RequiredError}
|
|
11844
|
+
*/
|
|
11845
|
+
deleteUpdateShipment: (id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10625
11846
|
/**
|
|
10626
11847
|
* Get Editable Order (Admin)
|
|
10627
11848
|
* @summary Get Editable Order (Admin)
|
|
@@ -10630,6 +11851,24 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
10630
11851
|
* @throws {RequiredError}
|
|
10631
11852
|
*/
|
|
10632
11853
|
getGetAdminEditableOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11854
|
+
/**
|
|
11855
|
+
* Get Order Details (Admin)
|
|
11856
|
+
* @summary Get Order Details (Admin)
|
|
11857
|
+
* @param {number} id Order ID
|
|
11858
|
+
* @param {*} [options] Override http request option.
|
|
11859
|
+
* @throws {RequiredError}
|
|
11860
|
+
*/
|
|
11861
|
+
getGetAdminOrderDetails: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11862
|
+
/**
|
|
11863
|
+
* Get Commercial Invoice PDF
|
|
11864
|
+
* @summary Get Commercial Invoice PDF
|
|
11865
|
+
* @param {number} id Order ID
|
|
11866
|
+
* @param {number} batchId Batch ID
|
|
11867
|
+
* @param {number} shipmentId Shipment ID
|
|
11868
|
+
* @param {*} [options] Override http request option.
|
|
11869
|
+
* @throws {RequiredError}
|
|
11870
|
+
*/
|
|
11871
|
+
getGetCommercialInvoice: (id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10633
11872
|
/**
|
|
10634
11873
|
* Get Editable Order (Beta)
|
|
10635
11874
|
* @summary Get Editable Order (Beta)
|
|
@@ -10638,6 +11877,31 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
10638
11877
|
* @throws {RequiredError}
|
|
10639
11878
|
*/
|
|
10640
11879
|
getGetEditableOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11880
|
+
/**
|
|
11881
|
+
* Get Item Serial Info (Admin)
|
|
11882
|
+
* @summary Get Item Serial Info (Admin)
|
|
11883
|
+
* @param {number} id Order ID
|
|
11884
|
+
* @param {number} itemId Shipment Item ID
|
|
11885
|
+
* @param {*} [options] Override http request option.
|
|
11886
|
+
* @throws {RequiredError}
|
|
11887
|
+
*/
|
|
11888
|
+
getGetItemSerialInfo: (id: number, itemId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11889
|
+
/**
|
|
11890
|
+
* Download Order PDF
|
|
11891
|
+
* @summary Download Order PDF
|
|
11892
|
+
* @param {number} id Order ID
|
|
11893
|
+
* @param {*} [options] Override http request option.
|
|
11894
|
+
* @throws {RequiredError}
|
|
11895
|
+
*/
|
|
11896
|
+
getGetOrderPdf: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11897
|
+
/**
|
|
11898
|
+
* Get Order Summary (Admin)
|
|
11899
|
+
* @summary Get Order Summary (Admin)
|
|
11900
|
+
* @param {number} id Order ID
|
|
11901
|
+
* @param {*} [options] Override http request option.
|
|
11902
|
+
* @throws {RequiredError}
|
|
11903
|
+
*/
|
|
11904
|
+
getGetOrderSummary: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10641
11905
|
/**
|
|
10642
11906
|
* Get Orders (Beta)
|
|
10643
11907
|
* @summary Get Orders (Beta)
|
|
@@ -10653,14 +11917,51 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
10653
11917
|
*/
|
|
10654
11918
|
getGetOrders: (pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10655
11919
|
/**
|
|
10656
|
-
*
|
|
10657
|
-
* @summary
|
|
10658
|
-
* @param {
|
|
10659
|
-
* @param {
|
|
11920
|
+
* Mark Order As Complete (Admin)
|
|
11921
|
+
* @summary Mark Order As Complete (Admin)
|
|
11922
|
+
* @param {number} id Order ID
|
|
11923
|
+
* @param {*} [options] Override http request option.
|
|
11924
|
+
* @throws {RequiredError}
|
|
11925
|
+
*/
|
|
11926
|
+
patchCompleteOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11927
|
+
/**
|
|
11928
|
+
* Add Order Note
|
|
11929
|
+
* @summary Add Order Note
|
|
11930
|
+
* @param {number} id Order ID
|
|
11931
|
+
* @param {PostAddOrderNoteRequest} [postAddOrderNoteRequest]
|
|
11932
|
+
* @param {*} [options] Override http request option.
|
|
11933
|
+
* @throws {RequiredError}
|
|
11934
|
+
*/
|
|
11935
|
+
postAddOrderNote: (id: number, postAddOrderNoteRequest?: PostAddOrderNoteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11936
|
+
/**
|
|
11937
|
+
* Create An Order (Admin)
|
|
11938
|
+
* @summary Create An Order (Admin)
|
|
11939
|
+
* @param {boolean} [readonly] Readonly Order
|
|
11940
|
+
* @param {AdminOrderRequestDTO} [adminOrderRequestDTO] Admin Order Request
|
|
10660
11941
|
* @param {*} [options] Override http request option.
|
|
10661
11942
|
* @throws {RequiredError}
|
|
10662
11943
|
*/
|
|
10663
11944
|
postCreateAdminOrder: (readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11945
|
+
/**
|
|
11946
|
+
* Create Shipping Consignment
|
|
11947
|
+
* @summary Create Shipping Consignment
|
|
11948
|
+
* @param {number} id Order ID
|
|
11949
|
+
* @param {number} shipmentId Shipment ID
|
|
11950
|
+
* @param {ShippingRequestDTO} [shippingRequestDTO] Shipping Request
|
|
11951
|
+
* @param {*} [options] Override http request option.
|
|
11952
|
+
* @throws {RequiredError}
|
|
11953
|
+
*/
|
|
11954
|
+
postCreateConsignment: (id: number, shipmentId: number, shippingRequestDTO?: ShippingRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11955
|
+
/**
|
|
11956
|
+
* Create Shipment (Admin)
|
|
11957
|
+
* @summary Create Shipment (Admin)
|
|
11958
|
+
* @param {number} id Order ID
|
|
11959
|
+
* @param {number} batchId Batch ID
|
|
11960
|
+
* @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
|
|
11961
|
+
* @param {*} [options] Override http request option.
|
|
11962
|
+
* @throws {RequiredError}
|
|
11963
|
+
*/
|
|
11964
|
+
postCreateShipment: (id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10664
11965
|
/**
|
|
10665
11966
|
* Create An Order (Beta)
|
|
10666
11967
|
* @summary Create An Order (Beta)
|
|
@@ -10670,6 +11971,73 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
10670
11971
|
* @throws {RequiredError}
|
|
10671
11972
|
*/
|
|
10672
11973
|
postGetOrders: (readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11974
|
+
/**
|
|
11975
|
+
* Issue Credit (Admin)
|
|
11976
|
+
* @summary Issue Credit (Admin)
|
|
11977
|
+
* @param {number} id Order ID
|
|
11978
|
+
* @param {CreditNoteDTO} [creditNoteDTO] Credit Request
|
|
11979
|
+
* @param {*} [options] Override http request option.
|
|
11980
|
+
* @throws {RequiredError}
|
|
11981
|
+
*/
|
|
11982
|
+
postIssueCredit: (id: number, creditNoteDTO?: CreditNoteDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11983
|
+
/**
|
|
11984
|
+
* Print Shipment Label
|
|
11985
|
+
* @summary Print Shipment Label
|
|
11986
|
+
* @param {number} id Order ID
|
|
11987
|
+
* @param {number} shipmentId Shipment ID
|
|
11988
|
+
* @param {PostPrintShippingLabelPrinterEnum} printer Printer
|
|
11989
|
+
* @param {*} [options] Override http request option.
|
|
11990
|
+
* @throws {RequiredError}
|
|
11991
|
+
*/
|
|
11992
|
+
postPrintShippingLabel: (id: number, shipmentId: number, printer: PostPrintShippingLabelPrinterEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11993
|
+
/**
|
|
11994
|
+
* Send Order Email
|
|
11995
|
+
* @summary Send Order Email
|
|
11996
|
+
* @param {number} id Order ID
|
|
11997
|
+
* @param {string} email Email Address
|
|
11998
|
+
* @param {*} [options] Override http request option.
|
|
11999
|
+
* @throws {RequiredError}
|
|
12000
|
+
*/
|
|
12001
|
+
postSendOrderEmail: (id: number, email: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12002
|
+
/**
|
|
12003
|
+
* Send Shipment Email (Admin)
|
|
12004
|
+
* @summary Send Shipment Email (Admin)
|
|
12005
|
+
* @param {number} id Order ID
|
|
12006
|
+
* @param {number} batchId Batch ID
|
|
12007
|
+
* @param {number} shipmentId Shipment ID
|
|
12008
|
+
* @param {string} email Email Address
|
|
12009
|
+
* @param {*} [options] Override http request option.
|
|
12010
|
+
* @throws {RequiredError}
|
|
12011
|
+
*/
|
|
12012
|
+
postSendShipmentEmail: (id: number, batchId: number, shipmentId: number, email: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12013
|
+
/**
|
|
12014
|
+
* Send Supplier Email
|
|
12015
|
+
* @summary Send Supplier Email
|
|
12016
|
+
* @param {number} id Order ID
|
|
12017
|
+
* @param {number} batchId Batch ID
|
|
12018
|
+
* @param {*} [options] Override http request option.
|
|
12019
|
+
* @throws {RequiredError}
|
|
12020
|
+
*/
|
|
12021
|
+
postSendSupplierEmail: (id: number, batchId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12022
|
+
/**
|
|
12023
|
+
* Split Order
|
|
12024
|
+
* @summary Split Order
|
|
12025
|
+
* @param {number} id Order ID
|
|
12026
|
+
* @param {PostSplitOrderRequest} [postSplitOrderRequest]
|
|
12027
|
+
* @param {*} [options] Override http request option.
|
|
12028
|
+
* @throws {RequiredError}
|
|
12029
|
+
*/
|
|
12030
|
+
postSplitOrder: (id: number, postSplitOrderRequest?: PostSplitOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12031
|
+
/**
|
|
12032
|
+
* Allocate Items To Supplier
|
|
12033
|
+
* @summary Allocate Items To Supplier
|
|
12034
|
+
* @param {number} id Order ID
|
|
12035
|
+
* @param {number} supplierId Supplier ID
|
|
12036
|
+
* @param {PutAllocateItemsRequest} [putAllocateItemsRequest]
|
|
12037
|
+
* @param {*} [options] Override http request option.
|
|
12038
|
+
* @throws {RequiredError}
|
|
12039
|
+
*/
|
|
12040
|
+
putAllocateItems: (id: number, supplierId: number, putAllocateItemsRequest?: PutAllocateItemsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10673
12041
|
/**
|
|
10674
12042
|
* Update An Order (Admin)
|
|
10675
12043
|
* @summary Update An Order (Admin)
|
|
@@ -10680,6 +12048,17 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
10680
12048
|
* @throws {RequiredError}
|
|
10681
12049
|
*/
|
|
10682
12050
|
putUpdateAdminOrder: (id: number, readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12051
|
+
/**
|
|
12052
|
+
* Update Batch Item (Admin)
|
|
12053
|
+
* @summary Update Batch Item (Admin)
|
|
12054
|
+
* @param {number} id Order ID
|
|
12055
|
+
* @param {number} batchId Batch ID
|
|
12056
|
+
* @param {number} itemId Ordered Item ID
|
|
12057
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
12058
|
+
* @param {*} [options] Override http request option.
|
|
12059
|
+
* @throws {RequiredError}
|
|
12060
|
+
*/
|
|
12061
|
+
putUpdateBatchItem: (id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10683
12062
|
/**
|
|
10684
12063
|
* Update An Order (Beta)
|
|
10685
12064
|
* @summary Update An Order (Beta)
|
|
@@ -10689,36 +12068,394 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
10689
12068
|
* @param {*} [options] Override http request option.
|
|
10690
12069
|
* @throws {RequiredError}
|
|
10691
12070
|
*/
|
|
10692
|
-
putUpdateOrder: (id: number, readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10693
|
-
|
|
10694
|
-
|
|
10695
|
-
|
|
10696
|
-
|
|
10697
|
-
|
|
12071
|
+
putUpdateOrder: (id: number, readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12072
|
+
/**
|
|
12073
|
+
* Change Payment Status (Admin)
|
|
12074
|
+
* @summary Change Payment Status (Admin)
|
|
12075
|
+
* @param {number} id Order ID
|
|
12076
|
+
* @param {boolean} paid Paid
|
|
12077
|
+
* @param {*} [options] Override http request option.
|
|
12078
|
+
* @throws {RequiredError}
|
|
12079
|
+
*/
|
|
12080
|
+
putUpdatePaymentStatus: (id: number, paid: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12081
|
+
/**
|
|
12082
|
+
* Update Shipment (Admin)
|
|
12083
|
+
* @summary Update Shipment (Admin)
|
|
12084
|
+
* @param {number} id Order ID
|
|
12085
|
+
* @param {number} batchId Batch ID
|
|
12086
|
+
* @param {number} shipmentId Shipment ID
|
|
12087
|
+
* @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
|
|
12088
|
+
* @param {*} [options] Override http request option.
|
|
12089
|
+
* @throws {RequiredError}
|
|
12090
|
+
*/
|
|
12091
|
+
putUpdateShipment: (id: number, batchId: number, shipmentId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12092
|
+
};
|
|
12093
|
+
/**
|
|
12094
|
+
* OrdersApi - functional programming interface
|
|
12095
|
+
*/
|
|
12096
|
+
export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
12097
|
+
/**
|
|
12098
|
+
* Delete Batch (Admin)
|
|
12099
|
+
* @param {number} id Order ID
|
|
12100
|
+
* @param {number} batchId Batch ID
|
|
12101
|
+
* @param {*} [options] Override http request option.
|
|
12102
|
+
* @throws {RequiredError}
|
|
12103
|
+
*/
|
|
12104
|
+
deleteDeleteBatch(id: number, batchId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
12105
|
+
/**
|
|
12106
|
+
* Delete Orders (Beta)
|
|
12107
|
+
* @summary Delete Orders (Beta)
|
|
12108
|
+
* @param {number} id Order ID
|
|
12109
|
+
* @param {*} [options] Override http request option.
|
|
12110
|
+
* @throws {RequiredError}
|
|
12111
|
+
*/
|
|
12112
|
+
deleteUpdateOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
12113
|
+
/**
|
|
12114
|
+
* Delete Shipment (Admin)
|
|
12115
|
+
* @summary Delete Shipment (Admin)
|
|
12116
|
+
* @param {number} id Order ID
|
|
12117
|
+
* @param {number} batchId Batch ID
|
|
12118
|
+
* @param {number} shipmentId Shipment ID
|
|
12119
|
+
* @param {*} [options] Override http request option.
|
|
12120
|
+
* @throws {RequiredError}
|
|
12121
|
+
*/
|
|
12122
|
+
deleteUpdateShipment(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
12123
|
+
/**
|
|
12124
|
+
* Get Editable Order (Admin)
|
|
12125
|
+
* @summary Get Editable Order (Admin)
|
|
12126
|
+
* @param {number} id Order ID
|
|
12127
|
+
* @param {*} [options] Override http request option.
|
|
12128
|
+
* @throws {RequiredError}
|
|
12129
|
+
*/
|
|
12130
|
+
getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminOrderRequestDTO>>;
|
|
12131
|
+
/**
|
|
12132
|
+
* Get Order Details (Admin)
|
|
12133
|
+
* @summary Get Order Details (Admin)
|
|
12134
|
+
* @param {number} id Order ID
|
|
12135
|
+
* @param {*} [options] Override http request option.
|
|
12136
|
+
* @throws {RequiredError}
|
|
12137
|
+
*/
|
|
12138
|
+
getGetAdminOrderDetails(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>>;
|
|
12139
|
+
/**
|
|
12140
|
+
* Get Commercial Invoice PDF
|
|
12141
|
+
* @summary Get Commercial Invoice PDF
|
|
12142
|
+
* @param {number} id Order ID
|
|
12143
|
+
* @param {number} batchId Batch ID
|
|
12144
|
+
* @param {number} shipmentId Shipment ID
|
|
12145
|
+
* @param {*} [options] Override http request option.
|
|
12146
|
+
* @throws {RequiredError}
|
|
12147
|
+
*/
|
|
12148
|
+
getGetCommercialInvoice(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
12149
|
+
/**
|
|
12150
|
+
* Get Editable Order (Beta)
|
|
12151
|
+
* @summary Get Editable Order (Beta)
|
|
12152
|
+
* @param {number} id Order ID
|
|
12153
|
+
* @param {*} [options] Override http request option.
|
|
12154
|
+
* @throws {RequiredError}
|
|
12155
|
+
*/
|
|
12156
|
+
getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetailedOrderRequestDTO>>;
|
|
12157
|
+
/**
|
|
12158
|
+
* Get Item Serial Info (Admin)
|
|
12159
|
+
* @summary Get Item Serial Info (Admin)
|
|
12160
|
+
* @param {number} id Order ID
|
|
12161
|
+
* @param {number} itemId Shipment Item ID
|
|
12162
|
+
* @param {*} [options] Override http request option.
|
|
12163
|
+
* @throws {RequiredError}
|
|
12164
|
+
*/
|
|
12165
|
+
getGetItemSerialInfo(id: number, itemId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSerialInfoModel>>;
|
|
12166
|
+
/**
|
|
12167
|
+
* Download Order PDF
|
|
12168
|
+
* @summary Download Order PDF
|
|
12169
|
+
* @param {number} id Order ID
|
|
12170
|
+
* @param {*} [options] Override http request option.
|
|
12171
|
+
* @throws {RequiredError}
|
|
12172
|
+
*/
|
|
12173
|
+
getGetOrderPdf(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
12174
|
+
/**
|
|
12175
|
+
* Get Order Summary (Admin)
|
|
12176
|
+
* @summary Get Order Summary (Admin)
|
|
12177
|
+
* @param {number} id Order ID
|
|
12178
|
+
* @param {*} [options] Override http request option.
|
|
12179
|
+
* @throws {RequiredError}
|
|
12180
|
+
*/
|
|
12181
|
+
getGetOrderSummary(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderSummaryDTO>>;
|
|
12182
|
+
/**
|
|
12183
|
+
* Get Orders (Beta)
|
|
12184
|
+
* @summary Get Orders (Beta)
|
|
12185
|
+
* @param {number} [pageSize] Number Of Results
|
|
12186
|
+
* @param {number} [page] Page Number
|
|
12187
|
+
* @param {string} [search] Search
|
|
12188
|
+
* @param {boolean | null} [fulfillable] Fulfillable
|
|
12189
|
+
* @param {GetGetOrdersStatusEnum} [status] Status
|
|
12190
|
+
* @param {GetGetOrdersFilterEnum} [filter] Filter
|
|
12191
|
+
* @param {number | null} [customerId] Customer ID
|
|
12192
|
+
* @param {*} [options] Override http request option.
|
|
12193
|
+
* @throws {RequiredError}
|
|
12194
|
+
*/
|
|
12195
|
+
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>>;
|
|
12196
|
+
/**
|
|
12197
|
+
* Mark Order As Complete (Admin)
|
|
12198
|
+
* @summary Mark Order As Complete (Admin)
|
|
12199
|
+
* @param {number} id Order ID
|
|
12200
|
+
* @param {*} [options] Override http request option.
|
|
12201
|
+
* @throws {RequiredError}
|
|
12202
|
+
*/
|
|
12203
|
+
patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>>;
|
|
12204
|
+
/**
|
|
12205
|
+
* Add Order Note
|
|
12206
|
+
* @summary Add Order Note
|
|
12207
|
+
* @param {number} id Order ID
|
|
12208
|
+
* @param {PostAddOrderNoteRequest} [postAddOrderNoteRequest]
|
|
12209
|
+
* @param {*} [options] Override http request option.
|
|
12210
|
+
* @throws {RequiredError}
|
|
12211
|
+
*/
|
|
12212
|
+
postAddOrderNote(id: number, postAddOrderNoteRequest?: PostAddOrderNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuditLogEntity>>;
|
|
12213
|
+
/**
|
|
12214
|
+
* Create An Order (Admin)
|
|
12215
|
+
* @summary Create An Order (Admin)
|
|
12216
|
+
* @param {boolean} [readonly] Readonly Order
|
|
12217
|
+
* @param {AdminOrderRequestDTO} [adminOrderRequestDTO] Admin Order Request
|
|
12218
|
+
* @param {*} [options] Override http request option.
|
|
12219
|
+
* @throws {RequiredError}
|
|
12220
|
+
*/
|
|
12221
|
+
postCreateAdminOrder(readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OrderSummaryDTO>>>;
|
|
12222
|
+
/**
|
|
12223
|
+
* Create Shipping Consignment
|
|
12224
|
+
* @summary Create Shipping Consignment
|
|
12225
|
+
* @param {number} id Order ID
|
|
12226
|
+
* @param {number} shipmentId Shipment ID
|
|
12227
|
+
* @param {ShippingRequestDTO} [shippingRequestDTO] Shipping Request
|
|
12228
|
+
* @param {*} [options] Override http request option.
|
|
12229
|
+
* @throws {RequiredError}
|
|
12230
|
+
*/
|
|
12231
|
+
postCreateConsignment(id: number, shipmentId: number, shippingRequestDTO?: ShippingRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentDTO>>;
|
|
12232
|
+
/**
|
|
12233
|
+
* Create Shipment (Admin)
|
|
12234
|
+
* @summary Create Shipment (Admin)
|
|
12235
|
+
* @param {number} id Order ID
|
|
12236
|
+
* @param {number} batchId Batch ID
|
|
12237
|
+
* @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
|
|
12238
|
+
* @param {*} [options] Override http request option.
|
|
12239
|
+
* @throws {RequiredError}
|
|
12240
|
+
*/
|
|
12241
|
+
postCreateShipment(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentDTO>>;
|
|
12242
|
+
/**
|
|
12243
|
+
* Create An Order (Beta)
|
|
12244
|
+
* @summary Create An Order (Beta)
|
|
12245
|
+
* @param {boolean} [readonly] Readonly Order
|
|
12246
|
+
* @param {CustomerOrderRequestDTO} [customerOrderRequestDTO] Order Request
|
|
12247
|
+
* @param {*} [options] Override http request option.
|
|
12248
|
+
* @throws {RequiredError}
|
|
12249
|
+
*/
|
|
12250
|
+
postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OrderSummaryDTO>>>;
|
|
12251
|
+
/**
|
|
12252
|
+
* Issue Credit (Admin)
|
|
12253
|
+
* @summary Issue Credit (Admin)
|
|
12254
|
+
* @param {number} id Order ID
|
|
12255
|
+
* @param {CreditNoteDTO} [creditNoteDTO] Credit Request
|
|
12256
|
+
* @param {*} [options] Override http request option.
|
|
12257
|
+
* @throws {RequiredError}
|
|
12258
|
+
*/
|
|
12259
|
+
postIssueCredit(id: number, creditNoteDTO?: CreditNoteDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreditNoteModel>>;
|
|
12260
|
+
/**
|
|
12261
|
+
* Print Shipment Label
|
|
12262
|
+
* @summary Print Shipment Label
|
|
12263
|
+
* @param {number} id Order ID
|
|
12264
|
+
* @param {number} shipmentId Shipment ID
|
|
12265
|
+
* @param {PostPrintShippingLabelPrinterEnum} printer Printer
|
|
12266
|
+
* @param {*} [options] Override http request option.
|
|
12267
|
+
* @throws {RequiredError}
|
|
12268
|
+
*/
|
|
12269
|
+
postPrintShippingLabel(id: number, shipmentId: number, printer: PostPrintShippingLabelPrinterEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
12270
|
+
/**
|
|
12271
|
+
* Send Order Email
|
|
12272
|
+
* @summary Send Order Email
|
|
12273
|
+
* @param {number} id Order ID
|
|
12274
|
+
* @param {string} email Email Address
|
|
12275
|
+
* @param {*} [options] Override http request option.
|
|
12276
|
+
* @throws {RequiredError}
|
|
12277
|
+
*/
|
|
12278
|
+
postSendOrderEmail(id: number, email: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
12279
|
+
/**
|
|
12280
|
+
* Send Shipment Email (Admin)
|
|
12281
|
+
* @summary Send Shipment Email (Admin)
|
|
12282
|
+
* @param {number} id Order ID
|
|
12283
|
+
* @param {number} batchId Batch ID
|
|
12284
|
+
* @param {number} shipmentId Shipment ID
|
|
12285
|
+
* @param {string} email Email Address
|
|
12286
|
+
* @param {*} [options] Override http request option.
|
|
12287
|
+
* @throws {RequiredError}
|
|
12288
|
+
*/
|
|
12289
|
+
postSendShipmentEmail(id: number, batchId: number, shipmentId: number, email: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
12290
|
+
/**
|
|
12291
|
+
* Send Supplier Email
|
|
12292
|
+
* @summary Send Supplier Email
|
|
12293
|
+
* @param {number} id Order ID
|
|
12294
|
+
* @param {number} batchId Batch ID
|
|
12295
|
+
* @param {*} [options] Override http request option.
|
|
12296
|
+
* @throws {RequiredError}
|
|
12297
|
+
*/
|
|
12298
|
+
postSendSupplierEmail(id: number, batchId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
12299
|
+
/**
|
|
12300
|
+
* Split Order
|
|
12301
|
+
* @summary Split Order
|
|
12302
|
+
* @param {number} id Order ID
|
|
12303
|
+
* @param {PostSplitOrderRequest} [postSplitOrderRequest]
|
|
12304
|
+
* @param {*} [options] Override http request option.
|
|
12305
|
+
* @throws {RequiredError}
|
|
12306
|
+
*/
|
|
12307
|
+
postSplitOrder(id: number, postSplitOrderRequest?: PostSplitOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OrderSummaryDTO>>>;
|
|
12308
|
+
/**
|
|
12309
|
+
* Allocate Items To Supplier
|
|
12310
|
+
* @summary Allocate Items To Supplier
|
|
12311
|
+
* @param {number} id Order ID
|
|
12312
|
+
* @param {number} supplierId Supplier ID
|
|
12313
|
+
* @param {PutAllocateItemsRequest} [putAllocateItemsRequest]
|
|
12314
|
+
* @param {*} [options] Override http request option.
|
|
12315
|
+
* @throws {RequiredError}
|
|
12316
|
+
*/
|
|
12317
|
+
putAllocateItems(id: number, supplierId: number, putAllocateItemsRequest?: PutAllocateItemsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BatchDTO>>>;
|
|
12318
|
+
/**
|
|
12319
|
+
* Update An Order (Admin)
|
|
12320
|
+
* @summary Update An Order (Admin)
|
|
12321
|
+
* @param {number} id Order ID
|
|
12322
|
+
* @param {boolean} [readonly] Readonly Order
|
|
12323
|
+
* @param {AdminOrderRequestDTO} [adminOrderRequestDTO] Order Request
|
|
12324
|
+
* @param {*} [options] Override http request option.
|
|
12325
|
+
* @throws {RequiredError}
|
|
12326
|
+
*/
|
|
12327
|
+
putUpdateAdminOrder(id: number, readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OrderSummaryDTO>>>;
|
|
12328
|
+
/**
|
|
12329
|
+
* Update Batch Item (Admin)
|
|
12330
|
+
* @summary Update Batch Item (Admin)
|
|
12331
|
+
* @param {number} id Order ID
|
|
12332
|
+
* @param {number} batchId Batch ID
|
|
12333
|
+
* @param {number} itemId Ordered Item ID
|
|
12334
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
12335
|
+
* @param {*} [options] Override http request option.
|
|
12336
|
+
* @throws {RequiredError}
|
|
12337
|
+
*/
|
|
12338
|
+
putUpdateBatchItem(id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderedItemModel>>;
|
|
12339
|
+
/**
|
|
12340
|
+
* Update An Order (Beta)
|
|
12341
|
+
* @summary Update An Order (Beta)
|
|
12342
|
+
* @param {number} id Order ID
|
|
12343
|
+
* @param {boolean} [readonly] Readonly Order
|
|
12344
|
+
* @param {CustomerOrderRequestDTO} [customerOrderRequestDTO] Order Request
|
|
12345
|
+
* @param {*} [options] Override http request option.
|
|
12346
|
+
* @throws {RequiredError}
|
|
12347
|
+
*/
|
|
12348
|
+
putUpdateOrder(id: number, readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OrderSummaryDTO>>>;
|
|
12349
|
+
/**
|
|
12350
|
+
* Change Payment Status (Admin)
|
|
12351
|
+
* @summary Change Payment Status (Admin)
|
|
12352
|
+
* @param {number} id Order ID
|
|
12353
|
+
* @param {boolean} paid Paid
|
|
12354
|
+
* @param {*} [options] Override http request option.
|
|
12355
|
+
* @throws {RequiredError}
|
|
12356
|
+
*/
|
|
12357
|
+
putUpdatePaymentStatus(id: number, paid: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>>;
|
|
12358
|
+
/**
|
|
12359
|
+
* Update Shipment (Admin)
|
|
12360
|
+
* @summary Update Shipment (Admin)
|
|
12361
|
+
* @param {number} id Order ID
|
|
12362
|
+
* @param {number} batchId Batch ID
|
|
12363
|
+
* @param {number} shipmentId Shipment ID
|
|
12364
|
+
* @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
|
|
12365
|
+
* @param {*} [options] Override http request option.
|
|
12366
|
+
* @throws {RequiredError}
|
|
12367
|
+
*/
|
|
12368
|
+
putUpdateShipment(id: number, batchId: number, shipmentId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentDTO>>;
|
|
12369
|
+
};
|
|
12370
|
+
/**
|
|
12371
|
+
* OrdersApi - factory interface
|
|
12372
|
+
*/
|
|
12373
|
+
export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
12374
|
+
/**
|
|
12375
|
+
* Delete Batch (Admin)
|
|
12376
|
+
* @param {number} id Order ID
|
|
12377
|
+
* @param {number} batchId Batch ID
|
|
12378
|
+
* @param {*} [options] Override http request option.
|
|
12379
|
+
* @throws {RequiredError}
|
|
12380
|
+
*/
|
|
12381
|
+
deleteDeleteBatch(id: number, batchId: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
12382
|
+
/**
|
|
12383
|
+
* Delete Orders (Beta)
|
|
12384
|
+
* @summary Delete Orders (Beta)
|
|
12385
|
+
* @param {number} id Order ID
|
|
12386
|
+
* @param {*} [options] Override http request option.
|
|
12387
|
+
* @throws {RequiredError}
|
|
12388
|
+
*/
|
|
12389
|
+
deleteUpdateOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
12390
|
+
/**
|
|
12391
|
+
* Delete Shipment (Admin)
|
|
12392
|
+
* @summary Delete Shipment (Admin)
|
|
12393
|
+
* @param {number} id Order ID
|
|
12394
|
+
* @param {number} batchId Batch ID
|
|
12395
|
+
* @param {number} shipmentId Shipment ID
|
|
12396
|
+
* @param {*} [options] Override http request option.
|
|
12397
|
+
* @throws {RequiredError}
|
|
12398
|
+
*/
|
|
12399
|
+
deleteUpdateShipment(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
12400
|
+
/**
|
|
12401
|
+
* Get Editable Order (Admin)
|
|
12402
|
+
* @summary Get Editable Order (Admin)
|
|
12403
|
+
* @param {number} id Order ID
|
|
12404
|
+
* @param {*} [options] Override http request option.
|
|
12405
|
+
* @throws {RequiredError}
|
|
12406
|
+
*/
|
|
12407
|
+
getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminOrderRequestDTO>;
|
|
12408
|
+
/**
|
|
12409
|
+
* Get Order Details (Admin)
|
|
12410
|
+
* @summary Get Order Details (Admin)
|
|
12411
|
+
* @param {number} id Order ID
|
|
12412
|
+
* @param {*} [options] Override http request option.
|
|
12413
|
+
* @throws {RequiredError}
|
|
12414
|
+
*/
|
|
12415
|
+
getGetAdminOrderDetails(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO>;
|
|
12416
|
+
/**
|
|
12417
|
+
* Get Commercial Invoice PDF
|
|
12418
|
+
* @summary Get Commercial Invoice PDF
|
|
12419
|
+
* @param {number} id Order ID
|
|
12420
|
+
* @param {number} batchId Batch ID
|
|
12421
|
+
* @param {number} shipmentId Shipment ID
|
|
12422
|
+
* @param {*} [options] Override http request option.
|
|
12423
|
+
* @throws {RequiredError}
|
|
12424
|
+
*/
|
|
12425
|
+
getGetCommercialInvoice(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
12426
|
+
/**
|
|
12427
|
+
* Get Editable Order (Beta)
|
|
12428
|
+
* @summary Get Editable Order (Beta)
|
|
12429
|
+
* @param {number} id Order ID
|
|
12430
|
+
* @param {*} [options] Override http request option.
|
|
12431
|
+
* @throws {RequiredError}
|
|
12432
|
+
*/
|
|
12433
|
+
getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DetailedOrderRequestDTO>;
|
|
10698
12434
|
/**
|
|
10699
|
-
*
|
|
10700
|
-
* @summary
|
|
12435
|
+
* Get Item Serial Info (Admin)
|
|
12436
|
+
* @summary Get Item Serial Info (Admin)
|
|
10701
12437
|
* @param {number} id Order ID
|
|
12438
|
+
* @param {number} itemId Shipment Item ID
|
|
10702
12439
|
* @param {*} [options] Override http request option.
|
|
10703
12440
|
* @throws {RequiredError}
|
|
10704
12441
|
*/
|
|
10705
|
-
|
|
12442
|
+
getGetItemSerialInfo(id: number, itemId: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSerialInfoModel>;
|
|
10706
12443
|
/**
|
|
10707
|
-
*
|
|
10708
|
-
* @summary
|
|
12444
|
+
* Download Order PDF
|
|
12445
|
+
* @summary Download Order PDF
|
|
10709
12446
|
* @param {number} id Order ID
|
|
10710
12447
|
* @param {*} [options] Override http request option.
|
|
10711
12448
|
* @throws {RequiredError}
|
|
10712
12449
|
*/
|
|
10713
|
-
|
|
12450
|
+
getGetOrderPdf(id: number, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
10714
12451
|
/**
|
|
10715
|
-
* Get
|
|
10716
|
-
* @summary Get
|
|
12452
|
+
* Get Order Summary (Admin)
|
|
12453
|
+
* @summary Get Order Summary (Admin)
|
|
10717
12454
|
* @param {number} id Order ID
|
|
10718
12455
|
* @param {*} [options] Override http request option.
|
|
10719
12456
|
* @throws {RequiredError}
|
|
10720
12457
|
*/
|
|
10721
|
-
|
|
12458
|
+
getGetOrderSummary(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummaryDTO>;
|
|
10722
12459
|
/**
|
|
10723
12460
|
* Get Orders (Beta)
|
|
10724
12461
|
* @summary Get Orders (Beta)
|
|
@@ -10732,7 +12469,24 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
10732
12469
|
* @param {*} [options] Override http request option.
|
|
10733
12470
|
* @throws {RequiredError}
|
|
10734
12471
|
*/
|
|
10735
|
-
getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig):
|
|
12472
|
+
getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummariesModel>;
|
|
12473
|
+
/**
|
|
12474
|
+
* Mark Order As Complete (Admin)
|
|
12475
|
+
* @summary Mark Order As Complete (Admin)
|
|
12476
|
+
* @param {number} id Order ID
|
|
12477
|
+
* @param {*} [options] Override http request option.
|
|
12478
|
+
* @throws {RequiredError}
|
|
12479
|
+
*/
|
|
12480
|
+
patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO>;
|
|
12481
|
+
/**
|
|
12482
|
+
* Add Order Note
|
|
12483
|
+
* @summary Add Order Note
|
|
12484
|
+
* @param {number} id Order ID
|
|
12485
|
+
* @param {PostAddOrderNoteRequest} [postAddOrderNoteRequest]
|
|
12486
|
+
* @param {*} [options] Override http request option.
|
|
12487
|
+
* @throws {RequiredError}
|
|
12488
|
+
*/
|
|
12489
|
+
postAddOrderNote(id: number, postAddOrderNoteRequest?: PostAddOrderNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuditLogEntity>;
|
|
10736
12490
|
/**
|
|
10737
12491
|
* Create An Order (Admin)
|
|
10738
12492
|
* @summary Create An Order (Admin)
|
|
@@ -10741,97 +12495,103 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
10741
12495
|
* @param {*} [options] Override http request option.
|
|
10742
12496
|
* @throws {RequiredError}
|
|
10743
12497
|
*/
|
|
10744
|
-
postCreateAdminOrder(readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig):
|
|
12498
|
+
postCreateAdminOrder(readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>>;
|
|
10745
12499
|
/**
|
|
10746
|
-
* Create
|
|
10747
|
-
* @summary Create
|
|
10748
|
-
* @param {
|
|
10749
|
-
* @param {
|
|
12500
|
+
* Create Shipping Consignment
|
|
12501
|
+
* @summary Create Shipping Consignment
|
|
12502
|
+
* @param {number} id Order ID
|
|
12503
|
+
* @param {number} shipmentId Shipment ID
|
|
12504
|
+
* @param {ShippingRequestDTO} [shippingRequestDTO] Shipping Request
|
|
10750
12505
|
* @param {*} [options] Override http request option.
|
|
10751
12506
|
* @throws {RequiredError}
|
|
10752
12507
|
*/
|
|
10753
|
-
|
|
12508
|
+
postCreateConsignment(id: number, shipmentId: number, shippingRequestDTO?: ShippingRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentDTO>;
|
|
10754
12509
|
/**
|
|
10755
|
-
*
|
|
10756
|
-
* @summary
|
|
12510
|
+
* Create Shipment (Admin)
|
|
12511
|
+
* @summary Create Shipment (Admin)
|
|
10757
12512
|
* @param {number} id Order ID
|
|
10758
|
-
* @param {
|
|
10759
|
-
* @param {
|
|
12513
|
+
* @param {number} batchId Batch ID
|
|
12514
|
+
* @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
|
|
10760
12515
|
* @param {*} [options] Override http request option.
|
|
10761
12516
|
* @throws {RequiredError}
|
|
10762
12517
|
*/
|
|
10763
|
-
|
|
12518
|
+
postCreateShipment(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentDTO>;
|
|
10764
12519
|
/**
|
|
10765
|
-
*
|
|
10766
|
-
* @summary
|
|
10767
|
-
* @param {number} id Order ID
|
|
12520
|
+
* Create An Order (Beta)
|
|
12521
|
+
* @summary Create An Order (Beta)
|
|
10768
12522
|
* @param {boolean} [readonly] Readonly Order
|
|
10769
12523
|
* @param {CustomerOrderRequestDTO} [customerOrderRequestDTO] Order Request
|
|
10770
12524
|
* @param {*} [options] Override http request option.
|
|
10771
12525
|
* @throws {RequiredError}
|
|
10772
12526
|
*/
|
|
10773
|
-
|
|
10774
|
-
};
|
|
10775
|
-
/**
|
|
10776
|
-
* OrdersApi - factory interface
|
|
10777
|
-
*/
|
|
10778
|
-
export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
12527
|
+
postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>>;
|
|
10779
12528
|
/**
|
|
10780
|
-
*
|
|
10781
|
-
* @summary
|
|
12529
|
+
* Issue Credit (Admin)
|
|
12530
|
+
* @summary Issue Credit (Admin)
|
|
10782
12531
|
* @param {number} id Order ID
|
|
12532
|
+
* @param {CreditNoteDTO} [creditNoteDTO] Credit Request
|
|
10783
12533
|
* @param {*} [options] Override http request option.
|
|
10784
12534
|
* @throws {RequiredError}
|
|
10785
12535
|
*/
|
|
10786
|
-
|
|
12536
|
+
postIssueCredit(id: number, creditNoteDTO?: CreditNoteDTO, options?: RawAxiosRequestConfig): AxiosPromise<CreditNoteModel>;
|
|
10787
12537
|
/**
|
|
10788
|
-
*
|
|
10789
|
-
* @summary
|
|
12538
|
+
* Print Shipment Label
|
|
12539
|
+
* @summary Print Shipment Label
|
|
10790
12540
|
* @param {number} id Order ID
|
|
12541
|
+
* @param {number} shipmentId Shipment ID
|
|
12542
|
+
* @param {PostPrintShippingLabelPrinterEnum} printer Printer
|
|
10791
12543
|
* @param {*} [options] Override http request option.
|
|
10792
12544
|
* @throws {RequiredError}
|
|
10793
12545
|
*/
|
|
10794
|
-
|
|
12546
|
+
postPrintShippingLabel(id: number, shipmentId: number, printer: PostPrintShippingLabelPrinterEnum, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
10795
12547
|
/**
|
|
10796
|
-
*
|
|
10797
|
-
* @summary
|
|
12548
|
+
* Send Order Email
|
|
12549
|
+
* @summary Send Order Email
|
|
10798
12550
|
* @param {number} id Order ID
|
|
12551
|
+
* @param {string} email Email Address
|
|
10799
12552
|
* @param {*} [options] Override http request option.
|
|
10800
12553
|
* @throws {RequiredError}
|
|
10801
12554
|
*/
|
|
10802
|
-
|
|
12555
|
+
postSendOrderEmail(id: number, email: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10803
12556
|
/**
|
|
10804
|
-
*
|
|
10805
|
-
* @summary
|
|
10806
|
-
* @param {number}
|
|
10807
|
-
* @param {number}
|
|
10808
|
-
* @param {
|
|
10809
|
-
* @param {
|
|
10810
|
-
* @param {GetGetOrdersStatusEnum} [status] Status
|
|
10811
|
-
* @param {GetGetOrdersFilterEnum} [filter] Filter
|
|
10812
|
-
* @param {number | null} [customerId] Customer ID
|
|
12557
|
+
* Send Shipment Email (Admin)
|
|
12558
|
+
* @summary Send Shipment Email (Admin)
|
|
12559
|
+
* @param {number} id Order ID
|
|
12560
|
+
* @param {number} batchId Batch ID
|
|
12561
|
+
* @param {number} shipmentId Shipment ID
|
|
12562
|
+
* @param {string} email Email Address
|
|
10813
12563
|
* @param {*} [options] Override http request option.
|
|
10814
12564
|
* @throws {RequiredError}
|
|
10815
12565
|
*/
|
|
10816
|
-
|
|
12566
|
+
postSendShipmentEmail(id: number, batchId: number, shipmentId: number, email: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10817
12567
|
/**
|
|
10818
|
-
*
|
|
10819
|
-
* @summary
|
|
10820
|
-
* @param {
|
|
10821
|
-
* @param {
|
|
12568
|
+
* Send Supplier Email
|
|
12569
|
+
* @summary Send Supplier Email
|
|
12570
|
+
* @param {number} id Order ID
|
|
12571
|
+
* @param {number} batchId Batch ID
|
|
10822
12572
|
* @param {*} [options] Override http request option.
|
|
10823
12573
|
* @throws {RequiredError}
|
|
10824
12574
|
*/
|
|
10825
|
-
|
|
12575
|
+
postSendSupplierEmail(id: number, batchId: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10826
12576
|
/**
|
|
10827
|
-
*
|
|
10828
|
-
* @summary
|
|
10829
|
-
* @param {
|
|
10830
|
-
* @param {
|
|
12577
|
+
* Split Order
|
|
12578
|
+
* @summary Split Order
|
|
12579
|
+
* @param {number} id Order ID
|
|
12580
|
+
* @param {PostSplitOrderRequest} [postSplitOrderRequest]
|
|
10831
12581
|
* @param {*} [options] Override http request option.
|
|
10832
12582
|
* @throws {RequiredError}
|
|
10833
12583
|
*/
|
|
10834
|
-
|
|
12584
|
+
postSplitOrder(id: number, postSplitOrderRequest?: PostSplitOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>>;
|
|
12585
|
+
/**
|
|
12586
|
+
* Allocate Items To Supplier
|
|
12587
|
+
* @summary Allocate Items To Supplier
|
|
12588
|
+
* @param {number} id Order ID
|
|
12589
|
+
* @param {number} supplierId Supplier ID
|
|
12590
|
+
* @param {PutAllocateItemsRequest} [putAllocateItemsRequest]
|
|
12591
|
+
* @param {*} [options] Override http request option.
|
|
12592
|
+
* @throws {RequiredError}
|
|
12593
|
+
*/
|
|
12594
|
+
putAllocateItems(id: number, supplierId: number, putAllocateItemsRequest?: PutAllocateItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<BatchDTO>>;
|
|
10835
12595
|
/**
|
|
10836
12596
|
* Update An Order (Admin)
|
|
10837
12597
|
* @summary Update An Order (Admin)
|
|
@@ -10842,6 +12602,17 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
10842
12602
|
* @throws {RequiredError}
|
|
10843
12603
|
*/
|
|
10844
12604
|
putUpdateAdminOrder(id: number, readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>>;
|
|
12605
|
+
/**
|
|
12606
|
+
* Update Batch Item (Admin)
|
|
12607
|
+
* @summary Update Batch Item (Admin)
|
|
12608
|
+
* @param {number} id Order ID
|
|
12609
|
+
* @param {number} batchId Batch ID
|
|
12610
|
+
* @param {number} itemId Ordered Item ID
|
|
12611
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
12612
|
+
* @param {*} [options] Override http request option.
|
|
12613
|
+
* @throws {RequiredError}
|
|
12614
|
+
*/
|
|
12615
|
+
putUpdateBatchItem(id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig): AxiosPromise<OrderedItemModel>;
|
|
10845
12616
|
/**
|
|
10846
12617
|
* Update An Order (Beta)
|
|
10847
12618
|
* @summary Update An Order (Beta)
|
|
@@ -10852,11 +12623,39 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
10852
12623
|
* @throws {RequiredError}
|
|
10853
12624
|
*/
|
|
10854
12625
|
putUpdateOrder(id: number, readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>>;
|
|
12626
|
+
/**
|
|
12627
|
+
* Change Payment Status (Admin)
|
|
12628
|
+
* @summary Change Payment Status (Admin)
|
|
12629
|
+
* @param {number} id Order ID
|
|
12630
|
+
* @param {boolean} paid Paid
|
|
12631
|
+
* @param {*} [options] Override http request option.
|
|
12632
|
+
* @throws {RequiredError}
|
|
12633
|
+
*/
|
|
12634
|
+
putUpdatePaymentStatus(id: number, paid: boolean, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO>;
|
|
12635
|
+
/**
|
|
12636
|
+
* Update Shipment (Admin)
|
|
12637
|
+
* @summary Update Shipment (Admin)
|
|
12638
|
+
* @param {number} id Order ID
|
|
12639
|
+
* @param {number} batchId Batch ID
|
|
12640
|
+
* @param {number} shipmentId Shipment ID
|
|
12641
|
+
* @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
|
|
12642
|
+
* @param {*} [options] Override http request option.
|
|
12643
|
+
* @throws {RequiredError}
|
|
12644
|
+
*/
|
|
12645
|
+
putUpdateShipment(id: number, batchId: number, shipmentId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentDTO>;
|
|
10855
12646
|
};
|
|
10856
12647
|
/**
|
|
10857
12648
|
* OrdersApi - object-oriented interface
|
|
10858
12649
|
*/
|
|
10859
12650
|
export declare class OrdersApi extends BaseAPI {
|
|
12651
|
+
/**
|
|
12652
|
+
* Delete Batch (Admin)
|
|
12653
|
+
* @param {number} id Order ID
|
|
12654
|
+
* @param {number} batchId Batch ID
|
|
12655
|
+
* @param {*} [options] Override http request option.
|
|
12656
|
+
* @throws {RequiredError}
|
|
12657
|
+
*/
|
|
12658
|
+
deleteDeleteBatch(id: number, batchId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
10860
12659
|
/**
|
|
10861
12660
|
* Delete Orders (Beta)
|
|
10862
12661
|
* @summary Delete Orders (Beta)
|
|
@@ -10865,6 +12664,16 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10865
12664
|
* @throws {RequiredError}
|
|
10866
12665
|
*/
|
|
10867
12666
|
deleteUpdateOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
12667
|
+
/**
|
|
12668
|
+
* Delete Shipment (Admin)
|
|
12669
|
+
* @summary Delete Shipment (Admin)
|
|
12670
|
+
* @param {number} id Order ID
|
|
12671
|
+
* @param {number} batchId Batch ID
|
|
12672
|
+
* @param {number} shipmentId Shipment ID
|
|
12673
|
+
* @param {*} [options] Override http request option.
|
|
12674
|
+
* @throws {RequiredError}
|
|
12675
|
+
*/
|
|
12676
|
+
deleteUpdateShipment(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
10868
12677
|
/**
|
|
10869
12678
|
* Get Editable Order (Admin)
|
|
10870
12679
|
* @summary Get Editable Order (Admin)
|
|
@@ -10873,6 +12682,24 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10873
12682
|
* @throws {RequiredError}
|
|
10874
12683
|
*/
|
|
10875
12684
|
getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminOrderRequestDTO, any, {}>>;
|
|
12685
|
+
/**
|
|
12686
|
+
* Get Order Details (Admin)
|
|
12687
|
+
* @summary Get Order Details (Admin)
|
|
12688
|
+
* @param {number} id Order ID
|
|
12689
|
+
* @param {*} [options] Override http request option.
|
|
12690
|
+
* @throws {RequiredError}
|
|
12691
|
+
*/
|
|
12692
|
+
getGetAdminOrderDetails(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderDetailsDTO, any, {}>>;
|
|
12693
|
+
/**
|
|
12694
|
+
* Get Commercial Invoice PDF
|
|
12695
|
+
* @summary Get Commercial Invoice PDF
|
|
12696
|
+
* @param {number} id Order ID
|
|
12697
|
+
* @param {number} batchId Batch ID
|
|
12698
|
+
* @param {number} shipmentId Shipment ID
|
|
12699
|
+
* @param {*} [options] Override http request option.
|
|
12700
|
+
* @throws {RequiredError}
|
|
12701
|
+
*/
|
|
12702
|
+
getGetCommercialInvoice(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
10876
12703
|
/**
|
|
10877
12704
|
* Get Editable Order (Beta)
|
|
10878
12705
|
* @summary Get Editable Order (Beta)
|
|
@@ -10881,6 +12708,31 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10881
12708
|
* @throws {RequiredError}
|
|
10882
12709
|
*/
|
|
10883
12710
|
getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DetailedOrderRequestDTO, any, {}>>;
|
|
12711
|
+
/**
|
|
12712
|
+
* Get Item Serial Info (Admin)
|
|
12713
|
+
* @summary Get Item Serial Info (Admin)
|
|
12714
|
+
* @param {number} id Order ID
|
|
12715
|
+
* @param {number} itemId Shipment Item ID
|
|
12716
|
+
* @param {*} [options] Override http request option.
|
|
12717
|
+
* @throws {RequiredError}
|
|
12718
|
+
*/
|
|
12719
|
+
getGetItemSerialInfo(id: number, itemId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSerialInfoModel, any, {}>>;
|
|
12720
|
+
/**
|
|
12721
|
+
* Download Order PDF
|
|
12722
|
+
* @summary Download Order PDF
|
|
12723
|
+
* @param {number} id Order ID
|
|
12724
|
+
* @param {*} [options] Override http request option.
|
|
12725
|
+
* @throws {RequiredError}
|
|
12726
|
+
*/
|
|
12727
|
+
getGetOrderPdf(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
12728
|
+
/**
|
|
12729
|
+
* Get Order Summary (Admin)
|
|
12730
|
+
* @summary Get Order Summary (Admin)
|
|
12731
|
+
* @param {number} id Order ID
|
|
12732
|
+
* @param {*} [options] Override http request option.
|
|
12733
|
+
* @throws {RequiredError}
|
|
12734
|
+
*/
|
|
12735
|
+
getGetOrderSummary(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO, any, {}>>;
|
|
10884
12736
|
/**
|
|
10885
12737
|
* Get Orders (Beta)
|
|
10886
12738
|
* @summary Get Orders (Beta)
|
|
@@ -10895,6 +12747,23 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10895
12747
|
* @throws {RequiredError}
|
|
10896
12748
|
*/
|
|
10897
12749
|
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, {}>>;
|
|
12750
|
+
/**
|
|
12751
|
+
* Mark Order As Complete (Admin)
|
|
12752
|
+
* @summary Mark Order As Complete (Admin)
|
|
12753
|
+
* @param {number} id Order ID
|
|
12754
|
+
* @param {*} [options] Override http request option.
|
|
12755
|
+
* @throws {RequiredError}
|
|
12756
|
+
*/
|
|
12757
|
+
patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderDetailsDTO, any, {}>>;
|
|
12758
|
+
/**
|
|
12759
|
+
* Add Order Note
|
|
12760
|
+
* @summary Add Order Note
|
|
12761
|
+
* @param {number} id Order ID
|
|
12762
|
+
* @param {PostAddOrderNoteRequest} [postAddOrderNoteRequest]
|
|
12763
|
+
* @param {*} [options] Override http request option.
|
|
12764
|
+
* @throws {RequiredError}
|
|
12765
|
+
*/
|
|
12766
|
+
postAddOrderNote(id: number, postAddOrderNoteRequest?: PostAddOrderNoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuditLogEntity, any, {}>>;
|
|
10898
12767
|
/**
|
|
10899
12768
|
* Create An Order (Admin)
|
|
10900
12769
|
* @summary Create An Order (Admin)
|
|
@@ -10904,6 +12773,26 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10904
12773
|
* @throws {RequiredError}
|
|
10905
12774
|
*/
|
|
10906
12775
|
postCreateAdminOrder(readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO[], any, {}>>;
|
|
12776
|
+
/**
|
|
12777
|
+
* Create Shipping Consignment
|
|
12778
|
+
* @summary Create Shipping Consignment
|
|
12779
|
+
* @param {number} id Order ID
|
|
12780
|
+
* @param {number} shipmentId Shipment ID
|
|
12781
|
+
* @param {ShippingRequestDTO} [shippingRequestDTO] Shipping Request
|
|
12782
|
+
* @param {*} [options] Override http request option.
|
|
12783
|
+
* @throws {RequiredError}
|
|
12784
|
+
*/
|
|
12785
|
+
postCreateConsignment(id: number, shipmentId: number, shippingRequestDTO?: ShippingRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShipmentDTO, any, {}>>;
|
|
12786
|
+
/**
|
|
12787
|
+
* Create Shipment (Admin)
|
|
12788
|
+
* @summary Create Shipment (Admin)
|
|
12789
|
+
* @param {number} id Order ID
|
|
12790
|
+
* @param {number} batchId Batch ID
|
|
12791
|
+
* @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
|
|
12792
|
+
* @param {*} [options] Override http request option.
|
|
12793
|
+
* @throws {RequiredError}
|
|
12794
|
+
*/
|
|
12795
|
+
postCreateShipment(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShipmentDTO, any, {}>>;
|
|
10907
12796
|
/**
|
|
10908
12797
|
* Create An Order (Beta)
|
|
10909
12798
|
* @summary Create An Order (Beta)
|
|
@@ -10913,6 +12802,73 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10913
12802
|
* @throws {RequiredError}
|
|
10914
12803
|
*/
|
|
10915
12804
|
postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO[], any, {}>>;
|
|
12805
|
+
/**
|
|
12806
|
+
* Issue Credit (Admin)
|
|
12807
|
+
* @summary Issue Credit (Admin)
|
|
12808
|
+
* @param {number} id Order ID
|
|
12809
|
+
* @param {CreditNoteDTO} [creditNoteDTO] Credit Request
|
|
12810
|
+
* @param {*} [options] Override http request option.
|
|
12811
|
+
* @throws {RequiredError}
|
|
12812
|
+
*/
|
|
12813
|
+
postIssueCredit(id: number, creditNoteDTO?: CreditNoteDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreditNoteModel, any, {}>>;
|
|
12814
|
+
/**
|
|
12815
|
+
* Print Shipment Label
|
|
12816
|
+
* @summary Print Shipment Label
|
|
12817
|
+
* @param {number} id Order ID
|
|
12818
|
+
* @param {number} shipmentId Shipment ID
|
|
12819
|
+
* @param {PostPrintShippingLabelPrinterEnum} printer Printer
|
|
12820
|
+
* @param {*} [options] Override http request option.
|
|
12821
|
+
* @throws {RequiredError}
|
|
12822
|
+
*/
|
|
12823
|
+
postPrintShippingLabel(id: number, shipmentId: number, printer: PostPrintShippingLabelPrinterEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
12824
|
+
/**
|
|
12825
|
+
* Send Order Email
|
|
12826
|
+
* @summary Send Order Email
|
|
12827
|
+
* @param {number} id Order ID
|
|
12828
|
+
* @param {string} email Email Address
|
|
12829
|
+
* @param {*} [options] Override http request option.
|
|
12830
|
+
* @throws {RequiredError}
|
|
12831
|
+
*/
|
|
12832
|
+
postSendOrderEmail(id: number, email: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
12833
|
+
/**
|
|
12834
|
+
* Send Shipment Email (Admin)
|
|
12835
|
+
* @summary Send Shipment Email (Admin)
|
|
12836
|
+
* @param {number} id Order ID
|
|
12837
|
+
* @param {number} batchId Batch ID
|
|
12838
|
+
* @param {number} shipmentId Shipment ID
|
|
12839
|
+
* @param {string} email Email Address
|
|
12840
|
+
* @param {*} [options] Override http request option.
|
|
12841
|
+
* @throws {RequiredError}
|
|
12842
|
+
*/
|
|
12843
|
+
postSendShipmentEmail(id: number, batchId: number, shipmentId: number, email: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
12844
|
+
/**
|
|
12845
|
+
* Send Supplier Email
|
|
12846
|
+
* @summary Send Supplier Email
|
|
12847
|
+
* @param {number} id Order ID
|
|
12848
|
+
* @param {number} batchId Batch ID
|
|
12849
|
+
* @param {*} [options] Override http request option.
|
|
12850
|
+
* @throws {RequiredError}
|
|
12851
|
+
*/
|
|
12852
|
+
postSendSupplierEmail(id: number, batchId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
12853
|
+
/**
|
|
12854
|
+
* Split Order
|
|
12855
|
+
* @summary Split Order
|
|
12856
|
+
* @param {number} id Order ID
|
|
12857
|
+
* @param {PostSplitOrderRequest} [postSplitOrderRequest]
|
|
12858
|
+
* @param {*} [options] Override http request option.
|
|
12859
|
+
* @throws {RequiredError}
|
|
12860
|
+
*/
|
|
12861
|
+
postSplitOrder(id: number, postSplitOrderRequest?: PostSplitOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO[], any, {}>>;
|
|
12862
|
+
/**
|
|
12863
|
+
* Allocate Items To Supplier
|
|
12864
|
+
* @summary Allocate Items To Supplier
|
|
12865
|
+
* @param {number} id Order ID
|
|
12866
|
+
* @param {number} supplierId Supplier ID
|
|
12867
|
+
* @param {PutAllocateItemsRequest} [putAllocateItemsRequest]
|
|
12868
|
+
* @param {*} [options] Override http request option.
|
|
12869
|
+
* @throws {RequiredError}
|
|
12870
|
+
*/
|
|
12871
|
+
putAllocateItems(id: number, supplierId: number, putAllocateItemsRequest?: PutAllocateItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchDTO[], any, {}>>;
|
|
10916
12872
|
/**
|
|
10917
12873
|
* Update An Order (Admin)
|
|
10918
12874
|
* @summary Update An Order (Admin)
|
|
@@ -10923,6 +12879,17 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10923
12879
|
* @throws {RequiredError}
|
|
10924
12880
|
*/
|
|
10925
12881
|
putUpdateAdminOrder(id: number, readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO[], any, {}>>;
|
|
12882
|
+
/**
|
|
12883
|
+
* Update Batch Item (Admin)
|
|
12884
|
+
* @summary Update Batch Item (Admin)
|
|
12885
|
+
* @param {number} id Order ID
|
|
12886
|
+
* @param {number} batchId Batch ID
|
|
12887
|
+
* @param {number} itemId Ordered Item ID
|
|
12888
|
+
* @param {OrderedItemModel} [orderedItemModel] Batch Item
|
|
12889
|
+
* @param {*} [options] Override http request option.
|
|
12890
|
+
* @throws {RequiredError}
|
|
12891
|
+
*/
|
|
12892
|
+
putUpdateBatchItem(id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderedItemModel, any, {}>>;
|
|
10926
12893
|
/**
|
|
10927
12894
|
* Update An Order (Beta)
|
|
10928
12895
|
* @summary Update An Order (Beta)
|
|
@@ -10933,6 +12900,26 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10933
12900
|
* @throws {RequiredError}
|
|
10934
12901
|
*/
|
|
10935
12902
|
putUpdateOrder(id: number, readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO[], any, {}>>;
|
|
12903
|
+
/**
|
|
12904
|
+
* Change Payment Status (Admin)
|
|
12905
|
+
* @summary Change Payment Status (Admin)
|
|
12906
|
+
* @param {number} id Order ID
|
|
12907
|
+
* @param {boolean} paid Paid
|
|
12908
|
+
* @param {*} [options] Override http request option.
|
|
12909
|
+
* @throws {RequiredError}
|
|
12910
|
+
*/
|
|
12911
|
+
putUpdatePaymentStatus(id: number, paid: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderDetailsDTO, any, {}>>;
|
|
12912
|
+
/**
|
|
12913
|
+
* Update Shipment (Admin)
|
|
12914
|
+
* @summary Update Shipment (Admin)
|
|
12915
|
+
* @param {number} id Order ID
|
|
12916
|
+
* @param {number} batchId Batch ID
|
|
12917
|
+
* @param {number} shipmentId Shipment ID
|
|
12918
|
+
* @param {ShipmentRequestDTO} [shipmentRequestDTO] Shipment Request
|
|
12919
|
+
* @param {*} [options] Override http request option.
|
|
12920
|
+
* @throws {RequiredError}
|
|
12921
|
+
*/
|
|
12922
|
+
putUpdateShipment(id: number, batchId: number, shipmentId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShipmentDTO, any, {}>>;
|
|
10936
12923
|
}
|
|
10937
12924
|
export declare const GetGetOrdersStatusEnum: {
|
|
10938
12925
|
readonly Paid: "PAID";
|
|
@@ -10948,6 +12935,12 @@ export declare const GetGetOrdersFilterEnum: {
|
|
|
10948
12935
|
readonly BackOrders: "BACK_ORDERS";
|
|
10949
12936
|
};
|
|
10950
12937
|
export type GetGetOrdersFilterEnum = typeof GetGetOrdersFilterEnum[keyof typeof GetGetOrdersFilterEnum];
|
|
12938
|
+
export declare const PostPrintShippingLabelPrinterEnum: {
|
|
12939
|
+
readonly NUMBER_1: 1;
|
|
12940
|
+
readonly NUMBER_2: 2;
|
|
12941
|
+
readonly NUMBER_3: 3;
|
|
12942
|
+
};
|
|
12943
|
+
export type PostPrintShippingLabelPrinterEnum = typeof PostPrintShippingLabelPrinterEnum[keyof typeof PostPrintShippingLabelPrinterEnum];
|
|
10951
12944
|
/**
|
|
10952
12945
|
* PricingApi - axios parameter creator
|
|
10953
12946
|
*/
|
|
@@ -11204,6 +13197,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11204
13197
|
* @throws {RequiredError}
|
|
11205
13198
|
*/
|
|
11206
13199
|
getSearchProducts: (pageSize?: number, page?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13200
|
+
/**
|
|
13201
|
+
* Add Item Quantity To Stock
|
|
13202
|
+
* @summary Add Item Quantity To Stock
|
|
13203
|
+
* @param {string} sku Product SKU
|
|
13204
|
+
* @param {number} quantity Quantity
|
|
13205
|
+
* @param {*} [options] Override http request option.
|
|
13206
|
+
* @throws {RequiredError}
|
|
13207
|
+
*/
|
|
13208
|
+
patchAddQuantityToStock: (sku: string, quantity: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11207
13209
|
/**
|
|
11208
13210
|
* Get Product
|
|
11209
13211
|
* @summary Get Product
|
|
@@ -11282,6 +13284,15 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
11282
13284
|
* @throws {RequiredError}
|
|
11283
13285
|
*/
|
|
11284
13286
|
getSearchProducts(pageSize?: number, page?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSearchResultsModel>>;
|
|
13287
|
+
/**
|
|
13288
|
+
* Add Item Quantity To Stock
|
|
13289
|
+
* @summary Add Item Quantity To Stock
|
|
13290
|
+
* @param {string} sku Product SKU
|
|
13291
|
+
* @param {number} quantity Quantity
|
|
13292
|
+
* @param {*} [options] Override http request option.
|
|
13293
|
+
* @throws {RequiredError}
|
|
13294
|
+
*/
|
|
13295
|
+
patchAddQuantityToStock(sku: string, quantity: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
11285
13296
|
/**
|
|
11286
13297
|
* Get Product
|
|
11287
13298
|
* @summary Get Product
|
|
@@ -11360,6 +13371,15 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
11360
13371
|
* @throws {RequiredError}
|
|
11361
13372
|
*/
|
|
11362
13373
|
getSearchProducts(pageSize?: number, page?: number, search?: string, options?: RawAxiosRequestConfig): AxiosPromise<ProductSearchResultsModel>;
|
|
13374
|
+
/**
|
|
13375
|
+
* Add Item Quantity To Stock
|
|
13376
|
+
* @summary Add Item Quantity To Stock
|
|
13377
|
+
* @param {string} sku Product SKU
|
|
13378
|
+
* @param {number} quantity Quantity
|
|
13379
|
+
* @param {*} [options] Override http request option.
|
|
13380
|
+
* @throws {RequiredError}
|
|
13381
|
+
*/
|
|
13382
|
+
patchAddQuantityToStock(sku: string, quantity: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11363
13383
|
/**
|
|
11364
13384
|
* Get Product
|
|
11365
13385
|
* @summary Get Product
|
|
@@ -11438,6 +13458,15 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
11438
13458
|
* @throws {RequiredError}
|
|
11439
13459
|
*/
|
|
11440
13460
|
getSearchProducts(pageSize?: number, page?: number, search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSearchResultsModel, any, {}>>;
|
|
13461
|
+
/**
|
|
13462
|
+
* Add Item Quantity To Stock
|
|
13463
|
+
* @summary Add Item Quantity To Stock
|
|
13464
|
+
* @param {string} sku Product SKU
|
|
13465
|
+
* @param {number} quantity Quantity
|
|
13466
|
+
* @param {*} [options] Override http request option.
|
|
13467
|
+
* @throws {RequiredError}
|
|
13468
|
+
*/
|
|
13469
|
+
patchAddQuantityToStock(sku: string, quantity: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
11441
13470
|
/**
|
|
11442
13471
|
* Get Product
|
|
11443
13472
|
* @summary Get Product
|
|
@@ -12527,6 +14556,14 @@ export declare class SIPTrunksApi extends BaseAPI {
|
|
|
12527
14556
|
* SMSApi - axios parameter creator
|
|
12528
14557
|
*/
|
|
12529
14558
|
export declare const SMSApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
14559
|
+
/**
|
|
14560
|
+
* Create SMS Account
|
|
14561
|
+
* @summary Create SMS Account
|
|
14562
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
14563
|
+
* @param {*} [options] Override http request option.
|
|
14564
|
+
* @throws {RequiredError}
|
|
14565
|
+
*/
|
|
14566
|
+
postCreateSmsAccount: (smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12530
14567
|
/**
|
|
12531
14568
|
* Send SMS
|
|
12532
14569
|
* @param {string} authorization Bearer Token
|
|
@@ -12540,6 +14577,14 @@ export declare const SMSApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
12540
14577
|
* SMSApi - functional programming interface
|
|
12541
14578
|
*/
|
|
12542
14579
|
export declare const SMSApiFp: (configuration?: Configuration) => {
|
|
14580
|
+
/**
|
|
14581
|
+
* Create SMS Account
|
|
14582
|
+
* @summary Create SMS Account
|
|
14583
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
14584
|
+
* @param {*} [options] Override http request option.
|
|
14585
|
+
* @throws {RequiredError}
|
|
14586
|
+
*/
|
|
14587
|
+
postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SmsAccountDTO>>;
|
|
12543
14588
|
/**
|
|
12544
14589
|
* Send SMS
|
|
12545
14590
|
* @param {string} authorization Bearer Token
|
|
@@ -12553,6 +14598,14 @@ export declare const SMSApiFp: (configuration?: Configuration) => {
|
|
|
12553
14598
|
* SMSApi - factory interface
|
|
12554
14599
|
*/
|
|
12555
14600
|
export declare const SMSApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
14601
|
+
/**
|
|
14602
|
+
* Create SMS Account
|
|
14603
|
+
* @summary Create SMS Account
|
|
14604
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
14605
|
+
* @param {*} [options] Override http request option.
|
|
14606
|
+
* @throws {RequiredError}
|
|
14607
|
+
*/
|
|
14608
|
+
postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<SmsAccountDTO>;
|
|
12556
14609
|
/**
|
|
12557
14610
|
* Send SMS
|
|
12558
14611
|
* @param {string} authorization Bearer Token
|
|
@@ -12566,6 +14619,14 @@ export declare const SMSApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
12566
14619
|
* SMSApi - object-oriented interface
|
|
12567
14620
|
*/
|
|
12568
14621
|
export declare class SMSApi extends BaseAPI {
|
|
14622
|
+
/**
|
|
14623
|
+
* Create SMS Account
|
|
14624
|
+
* @summary Create SMS Account
|
|
14625
|
+
* @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
|
|
14626
|
+
* @param {*} [options] Override http request option.
|
|
14627
|
+
* @throws {RequiredError}
|
|
14628
|
+
*/
|
|
14629
|
+
postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SmsAccountDTO, any, {}>>;
|
|
12569
14630
|
/**
|
|
12570
14631
|
* Send SMS
|
|
12571
14632
|
* @param {string} authorization Bearer Token
|