yellowgrid-api-ts 3.2.247-dev.0 → 3.2.249-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/dist/api.d.ts CHANGED
@@ -250,6 +250,10 @@ export interface AccountDetailedSummaryDTO {
250
250
  * Balance (£)
251
251
  */
252
252
  'balance'?: number | null;
253
+ /**
254
+ * First Order
255
+ */
256
+ 'firstOrder': boolean;
253
257
  }
254
258
  /**
255
259
  * Account Finance DTO
@@ -753,6 +757,10 @@ export interface AdminRmaDTO {
753
757
  */
754
758
  'approved': boolean;
755
759
  'address': AddressDTO;
760
+ /**
761
+ * Advance Replacement Order ID
762
+ */
763
+ 'advanceReplacementOrderId': number;
756
764
  /**
757
765
  * Customer ID
758
766
  */
@@ -802,7 +810,6 @@ export declare const AdminRmaDTOReasonEnum: {
802
810
  readonly NUMBER_1: 1;
803
811
  readonly NUMBER_2: 2;
804
812
  readonly NUMBER_3: 3;
805
- readonly NUMBER_4: 4;
806
813
  };
807
814
  export type AdminRmaDTOReasonEnum = typeof AdminRmaDTOReasonEnum[keyof typeof AdminRmaDTOReasonEnum];
808
815
  export declare const AdminRmaDTOResolutionEnum: {
@@ -5643,8 +5650,10 @@ export declare const PostGetServicePlansRequestPlanGroupEnum: {
5643
5650
  readonly Hosting: "Hosting";
5644
5651
  readonly Crm: "CRM";
5645
5652
  readonly StarterBundle: "Starter Bundle";
5646
- readonly Other: "Other";
5647
5653
  readonly RecurringCharges: "Recurring Charges";
5654
+ readonly Sms: "SMS";
5655
+ readonly Cfd: "CFD";
5656
+ readonly EdTechPro: "EdTechPro";
5648
5657
  };
5649
5658
  export type PostGetServicePlansRequestPlanGroupEnum = typeof PostGetServicePlansRequestPlanGroupEnum[keyof typeof PostGetServicePlansRequestPlanGroupEnum];
5650
5659
  export interface PostGetSipTrunksBillingRequest {
@@ -5997,7 +6006,7 @@ export interface PromoCodesEntity {
5997
6006
  /**
5998
6007
  * id
5999
6008
  */
6000
- 'id': number;
6009
+ 'id'?: number | null;
6001
6010
  /**
6002
6011
  * code
6003
6012
  */
@@ -6006,18 +6015,14 @@ export interface PromoCodesEntity {
6006
6015
  * description
6007
6016
  */
6008
6017
  'description': string;
6009
- /**
6010
- * banner
6011
- */
6012
- 'banner': string;
6013
6018
  /**
6014
6019
  * start
6015
6020
  */
6016
- 'start': string;
6021
+ 'startDate'?: string | null;
6017
6022
  /**
6018
6023
  * expiry
6019
6024
  */
6020
- 'expiry': string;
6025
+ 'endDate'?: string | null;
6021
6026
  /**
6022
6027
  * customerLimit
6023
6028
  */
@@ -6029,19 +6034,60 @@ export interface PromoCodesEntity {
6029
6034
  /**
6030
6035
  * orderRestrictions
6031
6036
  */
6032
- 'orderRestrictions': string;
6037
+ 'orderRestrictions': Array<string>;
6033
6038
  /**
6034
6039
  * includeDistribution
6035
6040
  */
6036
- 'includeDistribution': number;
6041
+ 'includeDistribution': boolean;
6037
6042
  /**
6038
6043
  * distributionOnly
6039
6044
  */
6040
- 'distributionOnly': number;
6045
+ 'distributionOnly': boolean;
6046
+ /**
6047
+ * nfr
6048
+ */
6049
+ 'nfr': boolean;
6041
6050
  /**
6042
6051
  * note
6043
6052
  */
6044
- 'note': string;
6053
+ 'note'?: string | null;
6054
+ }
6055
+ /**
6056
+ * Promo Item
6057
+ */
6058
+ export interface PromoItemModel {
6059
+ /**
6060
+ * id
6061
+ */
6062
+ 'id': number;
6063
+ /**
6064
+ * promoId
6065
+ */
6066
+ 'promoId': number;
6067
+ /**
6068
+ * price
6069
+ */
6070
+ 'price': number;
6071
+ /**
6072
+ * discount
6073
+ */
6074
+ 'discount': number;
6075
+ /**
6076
+ * sku
6077
+ */
6078
+ 'sku': string;
6079
+ /**
6080
+ * quantity
6081
+ */
6082
+ 'quantity': number;
6083
+ /**
6084
+ * bulkQuantity
6085
+ */
6086
+ 'bulkQuantity': number;
6087
+ /**
6088
+ * bulkAdd
6089
+ */
6090
+ 'bulkAdd': number;
6045
6091
  }
6046
6092
  /**
6047
6093
  * PromoItemsEntity
@@ -6080,6 +6126,113 @@ export interface PromoItemsEntity {
6080
6126
  */
6081
6127
  'bulkAdd': number;
6082
6128
  }
6129
+ /**
6130
+ * Promotion
6131
+ */
6132
+ export interface PromoModel {
6133
+ /**
6134
+ * id
6135
+ */
6136
+ 'id'?: number | null;
6137
+ /**
6138
+ * code
6139
+ */
6140
+ 'code': string;
6141
+ /**
6142
+ * description
6143
+ */
6144
+ 'description': string;
6145
+ /**
6146
+ * start
6147
+ */
6148
+ 'startDate'?: string | null;
6149
+ /**
6150
+ * expiry
6151
+ */
6152
+ 'endDate'?: string | null;
6153
+ /**
6154
+ * customerLimit
6155
+ */
6156
+ 'customerLimit': number;
6157
+ /**
6158
+ * globalLimit
6159
+ */
6160
+ 'globalLimit': number;
6161
+ /**
6162
+ * orderRestrictions
6163
+ */
6164
+ 'orderRestrictions': Array<string>;
6165
+ /**
6166
+ * includeDistribution
6167
+ */
6168
+ 'includeDistribution': boolean;
6169
+ /**
6170
+ * distributionOnly
6171
+ */
6172
+ 'distributionOnly': boolean;
6173
+ /**
6174
+ * nfr
6175
+ */
6176
+ 'nfr': boolean;
6177
+ /**
6178
+ * note
6179
+ */
6180
+ 'note'?: string | null;
6181
+ /**
6182
+ * Items
6183
+ */
6184
+ 'items'?: Array<PromoItemModel>;
6185
+ }
6186
+ /**
6187
+ * Promotions
6188
+ */
6189
+ export interface PromoSummariesModel {
6190
+ /**
6191
+ * Results
6192
+ */
6193
+ 'results': Array<PromoSummaryDTO>;
6194
+ /**
6195
+ * Page
6196
+ */
6197
+ 'page': number;
6198
+ /**
6199
+ * Per Page
6200
+ */
6201
+ 'perPage': number;
6202
+ /**
6203
+ * Total Results
6204
+ */
6205
+ 'totalResults': number;
6206
+ }
6207
+ /**
6208
+ * Promo Summary
6209
+ */
6210
+ export interface PromoSummaryDTO {
6211
+ /**
6212
+ * ID
6213
+ */
6214
+ 'id'?: number | null;
6215
+ /**
6216
+ * Description
6217
+ */
6218
+ 'description': string;
6219
+ /**
6220
+ * Promo Code
6221
+ */
6222
+ 'code': string;
6223
+ /**
6224
+ * Start Date
6225
+ */
6226
+ 'startDate'?: string | null;
6227
+ /**
6228
+ * End Date
6229
+ */
6230
+ 'endDate'?: string | null;
6231
+ /**
6232
+ * Orders
6233
+ */
6234
+ 'orders': number;
6235
+ }
6083
6236
  /**
6084
6237
  * Prospect
6085
6238
  */
@@ -6295,7 +6448,6 @@ export declare const ReasonRequestModelReasonEnum: {
6295
6448
  readonly NUMBER_1: 1;
6296
6449
  readonly NUMBER_2: 2;
6297
6450
  readonly NUMBER_3: 3;
6298
- readonly NUMBER_4: 4;
6299
6451
  };
6300
6452
  export type ReasonRequestModelReasonEnum = typeof ReasonRequestModelReasonEnum[keyof typeof ReasonRequestModelReasonEnum];
6301
6453
  /**
@@ -6557,6 +6709,10 @@ export interface RmaDTO {
6557
6709
  */
6558
6710
  'approved': boolean;
6559
6711
  'address': AddressDTO;
6712
+ /**
6713
+ * Advance Replacement Order ID
6714
+ */
6715
+ 'advanceReplacementOrderId': number;
6560
6716
  /**
6561
6717
  * RMA Items
6562
6718
  */
@@ -6566,7 +6722,6 @@ export declare const RmaDTOReasonEnum: {
6566
6722
  readonly NUMBER_1: 1;
6567
6723
  readonly NUMBER_2: 2;
6568
6724
  readonly NUMBER_3: 3;
6569
- readonly NUMBER_4: 4;
6570
6725
  };
6571
6726
  export type RmaDTOReasonEnum = typeof RmaDTOReasonEnum[keyof typeof RmaDTOReasonEnum];
6572
6727
  export declare const RmaDTOResolutionEnum: {
@@ -6663,10 +6818,15 @@ export interface RmaOrderDTO {
6663
6818
  * Warranty Expired
6664
6819
  */
6665
6820
  'warrantyExpired'?: boolean;
6821
+ /**
6822
+ * Allowed Credit
6823
+ */
6824
+ 'allowedCredit'?: boolean;
6666
6825
  /**
6667
6826
  * RMA Order Items
6668
6827
  */
6669
6828
  'items'?: Array<RmaOrderItemDTO>;
6829
+ 'address'?: AddressDTO;
6670
6830
  }
6671
6831
  /**
6672
6832
  * RMA Order Item
@@ -6775,12 +6935,15 @@ export interface RmaRequestDTO {
6775
6935
  */
6776
6936
  'items': Array<RmaItemRequestDTO>;
6777
6937
  'address': AddressDTO;
6938
+ /**
6939
+ * Advance Replacement Order ID
6940
+ */
6941
+ 'advanceReplacementOrderId': number;
6778
6942
  }
6779
6943
  export declare const RmaRequestDTOReasonEnum: {
6780
6944
  readonly NUMBER_1: 1;
6781
6945
  readonly NUMBER_2: 2;
6782
6946
  readonly NUMBER_3: 3;
6783
- readonly NUMBER_4: 4;
6784
6947
  };
6785
6948
  export type RmaRequestDTOReasonEnum = typeof RmaRequestDTOReasonEnum[keyof typeof RmaRequestDTOReasonEnum];
6786
6949
  export declare const RmaRequestDTORequestedResolutionEnum: {
@@ -10675,6 +10838,12 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
10675
10838
  * @throws {RequiredError}
10676
10839
  */
10677
10840
  getGetCustomerMap: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10841
+ /**
10842
+ * Get account delivery addresses
10843
+ * @param {*} [options] Override http request option.
10844
+ * @throws {RequiredError}
10845
+ */
10846
+ getGetDeliveryAddresses: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10678
10847
  /**
10679
10848
  * Get Account Finance
10680
10849
  * @param {string} id Account Xero ID
@@ -11057,6 +11226,12 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
11057
11226
  * @throws {RequiredError}
11058
11227
  */
11059
11228
  getGetCustomerMap(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CustomerCoordinatesDTO>>>;
11229
+ /**
11230
+ * Get account delivery addresses
11231
+ * @param {*} [options] Override http request option.
11232
+ * @throws {RequiredError}
11233
+ */
11234
+ getGetDeliveryAddresses(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AddressModel>>>;
11060
11235
  /**
11061
11236
  * Get Account Finance
11062
11237
  * @param {string} id Account Xero ID
@@ -11439,6 +11614,12 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
11439
11614
  * @throws {RequiredError}
11440
11615
  */
11441
11616
  getGetCustomerMap(options?: RawAxiosRequestConfig): AxiosPromise<Array<CustomerCoordinatesDTO>>;
11617
+ /**
11618
+ * Get account delivery addresses
11619
+ * @param {*} [options] Override http request option.
11620
+ * @throws {RequiredError}
11621
+ */
11622
+ getGetDeliveryAddresses(options?: RawAxiosRequestConfig): AxiosPromise<Array<AddressModel>>;
11442
11623
  /**
11443
11624
  * Get Account Finance
11444
11625
  * @param {string} id Account Xero ID
@@ -11821,6 +12002,12 @@ export declare class AccountsApi extends BaseAPI {
11821
12002
  * @throws {RequiredError}
11822
12003
  */
11823
12004
  getGetCustomerMap(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomerCoordinatesDTO[], any, {}>>;
12005
+ /**
12006
+ * Get account delivery addresses
12007
+ * @param {*} [options] Override http request option.
12008
+ * @throws {RequiredError}
12009
+ */
12010
+ getGetDeliveryAddresses(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddressModel[], any, {}>>;
11824
12011
  /**
11825
12012
  * Get Account Finance
11826
12013
  * @param {string} id Account Xero ID
@@ -12148,6 +12335,13 @@ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration
12148
12335
  * @throws {RequiredError}
12149
12336
  */
12150
12337
  deleteCloseAccount: (billCustomerId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12338
+ /**
12339
+ * Delete Call Tariff By ID
12340
+ * @param {number} id Call Tariff ID
12341
+ * @param {*} [options] Override http request option.
12342
+ * @throws {RequiredError}
12343
+ */
12344
+ deleteDeleteCallTariffId: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12151
12345
  /**
12152
12346
  * Delete Base Service
12153
12347
  * @param {number} baseServiceId Base Service Plan ID
@@ -12234,11 +12428,11 @@ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration
12234
12428
  getGetBaseServices: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12235
12429
  /**
12236
12430
  * Get Customer
12237
- * @param {number} [billCustomerId] Customer ID
12431
+ * @param {string} [billCustomerId] Customer ID
12238
12432
  * @param {*} [options] Override http request option.
12239
12433
  * @throws {RequiredError}
12240
12434
  */
12241
- getGetBillingCustomerDetails: (billCustomerId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12435
+ getGetBillingCustomerDetails: (billCustomerId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12242
12436
  /**
12243
12437
  * Get Bundle Calls With Cost
12244
12438
  * @param {*} [options] Override http request option.
@@ -12635,6 +12829,13 @@ export declare const BillingApiFp: (configuration?: Configuration) => {
12635
12829
  * @throws {RequiredError}
12636
12830
  */
12637
12831
  deleteCloseAccount(billCustomerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>>;
12832
+ /**
12833
+ * Delete Call Tariff By ID
12834
+ * @param {number} id Call Tariff ID
12835
+ * @param {*} [options] Override http request option.
12836
+ * @throws {RequiredError}
12837
+ */
12838
+ deleteDeleteCallTariffId(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
12638
12839
  /**
12639
12840
  * Delete Base Service
12640
12841
  * @param {number} baseServiceId Base Service Plan ID
@@ -12725,11 +12926,11 @@ export declare const BillingApiFp: (configuration?: Configuration) => {
12725
12926
  getGetBaseServices(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BaseService>>>;
12726
12927
  /**
12727
12928
  * Get Customer
12728
- * @param {number} [billCustomerId] Customer ID
12929
+ * @param {string} [billCustomerId] Customer ID
12729
12930
  * @param {*} [options] Override http request option.
12730
12931
  * @throws {RequiredError}
12731
12932
  */
12732
- getGetBillingCustomerDetails(billCustomerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
12933
+ getGetBillingCustomerDetails(billCustomerId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
12733
12934
  /**
12734
12935
  * Get Bundle Calls With Cost
12735
12936
  * @param {*} [options] Override http request option.
@@ -13126,6 +13327,13 @@ export declare const BillingApiFactory: (configuration?: Configuration, basePath
13126
13327
  * @throws {RequiredError}
13127
13328
  */
13128
13329
  deleteCloseAccount(billCustomerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<number>;
13330
+ /**
13331
+ * Delete Call Tariff By ID
13332
+ * @param {number} id Call Tariff ID
13333
+ * @param {*} [options] Override http request option.
13334
+ * @throws {RequiredError}
13335
+ */
13336
+ deleteDeleteCallTariffId(id: number, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
13129
13337
  /**
13130
13338
  * Delete Base Service
13131
13339
  * @param {number} baseServiceId Base Service Plan ID
@@ -13216,11 +13424,11 @@ export declare const BillingApiFactory: (configuration?: Configuration, basePath
13216
13424
  getGetBaseServices(options?: RawAxiosRequestConfig): AxiosPromise<Array<BaseService>>;
13217
13425
  /**
13218
13426
  * Get Customer
13219
- * @param {number} [billCustomerId] Customer ID
13427
+ * @param {string} [billCustomerId] Customer ID
13220
13428
  * @param {*} [options] Override http request option.
13221
13429
  * @throws {RequiredError}
13222
13430
  */
13223
- getGetBillingCustomerDetails(billCustomerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
13431
+ getGetBillingCustomerDetails(billCustomerId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
13224
13432
  /**
13225
13433
  * Get Bundle Calls With Cost
13226
13434
  * @param {*} [options] Override http request option.
@@ -13617,6 +13825,13 @@ export declare class BillingApi extends BaseAPI {
13617
13825
  * @throws {RequiredError}
13618
13826
  */
13619
13827
  deleteCloseAccount(billCustomerId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<number, any, {}>>;
13828
+ /**
13829
+ * Delete Call Tariff By ID
13830
+ * @param {number} id Call Tariff ID
13831
+ * @param {*} [options] Override http request option.
13832
+ * @throws {RequiredError}
13833
+ */
13834
+ deleteDeleteCallTariffId(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any, {}>>;
13620
13835
  /**
13621
13836
  * Delete Base Service
13622
13837
  * @param {number} baseServiceId Base Service Plan ID
@@ -13707,11 +13922,11 @@ export declare class BillingApi extends BaseAPI {
13707
13922
  getGetBaseServices(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseService[], any, {}>>;
13708
13923
  /**
13709
13924
  * Get Customer
13710
- * @param {number} [billCustomerId] Customer ID
13925
+ * @param {string} [billCustomerId] Customer ID
13711
13926
  * @param {*} [options] Override http request option.
13712
13927
  * @throws {RequiredError}
13713
13928
  */
13714
- getGetBillingCustomerDetails(billCustomerId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any, {}>>;
13929
+ getGetBillingCustomerDetails(billCustomerId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any, {}>>;
13715
13930
  /**
13716
13931
  * Get Bundle Calls With Cost
13717
13932
  * @param {*} [options] Override http request option.
@@ -14085,8 +14300,10 @@ export declare const GetGetConnectionsTypeEnum: {
14085
14300
  readonly Hosting: "Hosting";
14086
14301
  readonly Crm: "CRM";
14087
14302
  readonly StarterBundle: "Starter Bundle";
14088
- readonly Other: "Other";
14089
14303
  readonly RecurringCharges: "Recurring Charges";
14304
+ readonly Sms: "SMS";
14305
+ readonly Cfd: "CFD";
14306
+ readonly EdTechPro: "EdTechPro";
14090
14307
  };
14091
14308
  export type GetGetConnectionsTypeEnum = typeof GetGetConnectionsTypeEnum[keyof typeof GetGetConnectionsTypeEnum];
14092
14309
  export declare const GetGetServicesPlanDetailsTypeEnum: {
@@ -14100,8 +14317,10 @@ export declare const GetGetServicesPlanDetailsTypeEnum: {
14100
14317
  readonly Hosting: "Hosting";
14101
14318
  readonly Crm: "CRM";
14102
14319
  readonly StarterBundle: "Starter Bundle";
14103
- readonly Other: "Other";
14104
14320
  readonly RecurringCharges: "Recurring Charges";
14321
+ readonly Sms: "SMS";
14322
+ readonly Cfd: "CFD";
14323
+ readonly EdTechPro: "EdTechPro";
14105
14324
  };
14106
14325
  export type GetGetServicesPlanDetailsTypeEnum = typeof GetGetServicesPlanDetailsTypeEnum[keyof typeof GetGetServicesPlanDetailsTypeEnum];
14107
14326
  /**
@@ -17886,6 +18105,13 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
17886
18105
  * @throws {RequiredError}
17887
18106
  */
17888
18107
  getGetCommercialInvoice: (id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18108
+ /**
18109
+ * Get Order
18110
+ * @param {number} id Order ID
18111
+ * @param {*} [options] Override http request option.
18112
+ * @throws {RequiredError}
18113
+ */
18114
+ getGetCustomerOrderSummary: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
17889
18115
  /**
17890
18116
  * Get Editable Order (Beta)
17891
18117
  * @summary Get Editable Order (Beta)
@@ -18181,6 +18407,13 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
18181
18407
  * @throws {RequiredError}
18182
18408
  */
18183
18409
  getGetCommercialInvoice(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
18410
+ /**
18411
+ * Get Order
18412
+ * @param {number} id Order ID
18413
+ * @param {*} [options] Override http request option.
18414
+ * @throws {RequiredError}
18415
+ */
18416
+ getGetCustomerOrderSummary(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderSummaryDTO>>;
18184
18417
  /**
18185
18418
  * Get Editable Order (Beta)
18186
18419
  * @summary Get Editable Order (Beta)
@@ -18476,6 +18709,13 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
18476
18709
  * @throws {RequiredError}
18477
18710
  */
18478
18711
  getGetCommercialInvoice(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): AxiosPromise<File>;
18712
+ /**
18713
+ * Get Order
18714
+ * @param {number} id Order ID
18715
+ * @param {*} [options] Override http request option.
18716
+ * @throws {RequiredError}
18717
+ */
18718
+ getGetCustomerOrderSummary(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummaryDTO>;
18479
18719
  /**
18480
18720
  * Get Editable Order (Beta)
18481
18721
  * @summary Get Editable Order (Beta)
@@ -18771,6 +19011,13 @@ export declare class OrdersApi extends BaseAPI {
18771
19011
  * @throws {RequiredError}
18772
19012
  */
18773
19013
  getGetCommercialInvoice(id: number, batchId: number, shipmentId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
19014
+ /**
19015
+ * Get Order
19016
+ * @param {number} id Order ID
19017
+ * @param {*} [options] Override http request option.
19018
+ * @throws {RequiredError}
19019
+ */
19020
+ getGetCustomerOrderSummary(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO, any, {}>>;
18774
19021
  /**
18775
19022
  * Get Editable Order (Beta)
18776
19023
  * @summary Get Editable Order (Beta)
@@ -19591,6 +19838,154 @@ export declare const GetGetLegacyStockListFormatEnum: {
19591
19838
  readonly Csv: "CSV";
19592
19839
  };
19593
19840
  export type GetGetLegacyStockListFormatEnum = typeof GetGetLegacyStockListFormatEnum[keyof typeof GetGetLegacyStockListFormatEnum];
19841
+ /**
19842
+ * PromotionsApi - axios parameter creator
19843
+ */
19844
+ export declare const PromotionsApiAxiosParamCreator: (configuration?: Configuration) => {
19845
+ /**
19846
+ * Get a promotion
19847
+ * @param {number} id Promo ID
19848
+ * @param {*} [options] Override http request option.
19849
+ * @throws {RequiredError}
19850
+ */
19851
+ getGetPromo: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19852
+ /**
19853
+ * Get Promos
19854
+ * @param {number} [pageSize] Number Of Results
19855
+ * @param {number} [page] Page Number
19856
+ * @param {string} [search] Search
19857
+ * @param {boolean} [expired] Expired
19858
+ * @param {*} [options] Override http request option.
19859
+ * @throws {RequiredError}
19860
+ */
19861
+ getGetPromos: (pageSize?: number, page?: number, search?: string, expired?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19862
+ /**
19863
+ * Create a promotion
19864
+ * @param {PromoModel} [promoModel] Promotion
19865
+ * @param {*} [options] Override http request option.
19866
+ * @throws {RequiredError}
19867
+ */
19868
+ postGetPromos: (promoModel?: PromoModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19869
+ /**
19870
+ * Update a promotion
19871
+ * @param {number} id Promo ID
19872
+ * @param {PromoModel} [promoModel] Promotion
19873
+ * @param {*} [options] Override http request option.
19874
+ * @throws {RequiredError}
19875
+ */
19876
+ putGetPromo: (id: number, promoModel?: PromoModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19877
+ };
19878
+ /**
19879
+ * PromotionsApi - functional programming interface
19880
+ */
19881
+ export declare const PromotionsApiFp: (configuration?: Configuration) => {
19882
+ /**
19883
+ * Get a promotion
19884
+ * @param {number} id Promo ID
19885
+ * @param {*} [options] Override http request option.
19886
+ * @throws {RequiredError}
19887
+ */
19888
+ getGetPromo(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromoModel>>;
19889
+ /**
19890
+ * Get Promos
19891
+ * @param {number} [pageSize] Number Of Results
19892
+ * @param {number} [page] Page Number
19893
+ * @param {string} [search] Search
19894
+ * @param {boolean} [expired] Expired
19895
+ * @param {*} [options] Override http request option.
19896
+ * @throws {RequiredError}
19897
+ */
19898
+ getGetPromos(pageSize?: number, page?: number, search?: string, expired?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromoSummariesModel>>;
19899
+ /**
19900
+ * Create a promotion
19901
+ * @param {PromoModel} [promoModel] Promotion
19902
+ * @param {*} [options] Override http request option.
19903
+ * @throws {RequiredError}
19904
+ */
19905
+ postGetPromos(promoModel?: PromoModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromoModel>>;
19906
+ /**
19907
+ * Update a promotion
19908
+ * @param {number} id Promo ID
19909
+ * @param {PromoModel} [promoModel] Promotion
19910
+ * @param {*} [options] Override http request option.
19911
+ * @throws {RequiredError}
19912
+ */
19913
+ putGetPromo(id: number, promoModel?: PromoModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromoModel>>;
19914
+ };
19915
+ /**
19916
+ * PromotionsApi - factory interface
19917
+ */
19918
+ export declare const PromotionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
19919
+ /**
19920
+ * Get a promotion
19921
+ * @param {number} id Promo ID
19922
+ * @param {*} [options] Override http request option.
19923
+ * @throws {RequiredError}
19924
+ */
19925
+ getGetPromo(id: number, options?: RawAxiosRequestConfig): AxiosPromise<PromoModel>;
19926
+ /**
19927
+ * Get Promos
19928
+ * @param {number} [pageSize] Number Of Results
19929
+ * @param {number} [page] Page Number
19930
+ * @param {string} [search] Search
19931
+ * @param {boolean} [expired] Expired
19932
+ * @param {*} [options] Override http request option.
19933
+ * @throws {RequiredError}
19934
+ */
19935
+ getGetPromos(pageSize?: number, page?: number, search?: string, expired?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<PromoSummariesModel>;
19936
+ /**
19937
+ * Create a promotion
19938
+ * @param {PromoModel} [promoModel] Promotion
19939
+ * @param {*} [options] Override http request option.
19940
+ * @throws {RequiredError}
19941
+ */
19942
+ postGetPromos(promoModel?: PromoModel, options?: RawAxiosRequestConfig): AxiosPromise<PromoModel>;
19943
+ /**
19944
+ * Update a promotion
19945
+ * @param {number} id Promo ID
19946
+ * @param {PromoModel} [promoModel] Promotion
19947
+ * @param {*} [options] Override http request option.
19948
+ * @throws {RequiredError}
19949
+ */
19950
+ putGetPromo(id: number, promoModel?: PromoModel, options?: RawAxiosRequestConfig): AxiosPromise<PromoModel>;
19951
+ };
19952
+ /**
19953
+ * PromotionsApi - object-oriented interface
19954
+ */
19955
+ export declare class PromotionsApi extends BaseAPI {
19956
+ /**
19957
+ * Get a promotion
19958
+ * @param {number} id Promo ID
19959
+ * @param {*} [options] Override http request option.
19960
+ * @throws {RequiredError}
19961
+ */
19962
+ getGetPromo(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PromoModel, any, {}>>;
19963
+ /**
19964
+ * Get Promos
19965
+ * @param {number} [pageSize] Number Of Results
19966
+ * @param {number} [page] Page Number
19967
+ * @param {string} [search] Search
19968
+ * @param {boolean} [expired] Expired
19969
+ * @param {*} [options] Override http request option.
19970
+ * @throws {RequiredError}
19971
+ */
19972
+ getGetPromos(pageSize?: number, page?: number, search?: string, expired?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PromoSummariesModel, any, {}>>;
19973
+ /**
19974
+ * Create a promotion
19975
+ * @param {PromoModel} [promoModel] Promotion
19976
+ * @param {*} [options] Override http request option.
19977
+ * @throws {RequiredError}
19978
+ */
19979
+ postGetPromos(promoModel?: PromoModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PromoModel, any, {}>>;
19980
+ /**
19981
+ * Update a promotion
19982
+ * @param {number} id Promo ID
19983
+ * @param {PromoModel} [promoModel] Promotion
19984
+ * @param {*} [options] Override http request option.
19985
+ * @throws {RequiredError}
19986
+ */
19987
+ putGetPromo(id: number, promoModel?: PromoModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PromoModel, any, {}>>;
19988
+ }
19594
19989
  /**
19595
19990
  * ProspectsApi - axios parameter creator
19596
19991
  */
@@ -20148,6 +20543,14 @@ export declare const RMAApiAxiosParamCreator: (configuration?: Configuration) =>
20148
20543
  * @throws {RequiredError}
20149
20544
  */
20150
20545
  getGetRmaOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20546
+ /**
20547
+ * Get suitable advance replacment orders
20548
+ * @param {string} sku Item SKU
20549
+ * @param {number} orderId Order ID
20550
+ * @param {*} [options] Override http request option.
20551
+ * @throws {RequiredError}
20552
+ */
20553
+ getSearchAdvanceReplacementOrders: (sku: string, orderId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20151
20554
  /**
20152
20555
  * Search for Orders to create an RMA
20153
20556
  * @param {string} [search] Search
@@ -20381,6 +20784,14 @@ export declare const RMAApiFp: (configuration?: Configuration) => {
20381
20784
  * @throws {RequiredError}
20382
20785
  */
20383
20786
  getGetRmaOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RmaOrderDTO>>;
20787
+ /**
20788
+ * Get suitable advance replacment orders
20789
+ * @param {string} sku Item SKU
20790
+ * @param {number} orderId Order ID
20791
+ * @param {*} [options] Override http request option.
20792
+ * @throws {RequiredError}
20793
+ */
20794
+ getSearchAdvanceReplacementOrders(sku: string, orderId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RmaOrderSummaryDTO>>>;
20384
20795
  /**
20385
20796
  * Search for Orders to create an RMA
20386
20797
  * @param {string} [search] Search
@@ -20614,6 +21025,14 @@ export declare const RMAApiFactory: (configuration?: Configuration, basePath?: s
20614
21025
  * @throws {RequiredError}
20615
21026
  */
20616
21027
  getGetRmaOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<RmaOrderDTO>;
21028
+ /**
21029
+ * Get suitable advance replacment orders
21030
+ * @param {string} sku Item SKU
21031
+ * @param {number} orderId Order ID
21032
+ * @param {*} [options] Override http request option.
21033
+ * @throws {RequiredError}
21034
+ */
21035
+ getSearchAdvanceReplacementOrders(sku: string, orderId: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<RmaOrderSummaryDTO>>;
20617
21036
  /**
20618
21037
  * Search for Orders to create an RMA
20619
21038
  * @param {string} [search] Search
@@ -20847,6 +21266,14 @@ export declare class RMAApi extends BaseAPI {
20847
21266
  * @throws {RequiredError}
20848
21267
  */
20849
21268
  getGetRmaOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RmaOrderDTO, any, {}>>;
21269
+ /**
21270
+ * Get suitable advance replacment orders
21271
+ * @param {string} sku Item SKU
21272
+ * @param {number} orderId Order ID
21273
+ * @param {*} [options] Override http request option.
21274
+ * @throws {RequiredError}
21275
+ */
21276
+ getSearchAdvanceReplacementOrders(sku: string, orderId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RmaOrderSummaryDTO[], any, {}>>;
20850
21277
  /**
20851
21278
  * Search for Orders to create an RMA
20852
21279
  * @param {string} [search] Search