ultracart_rest_api_v2_typescript 3.10.223 → 3.10.225

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/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@3.10.223
1
+ ## ultracart_rest_api_v2_typescript@3.10.225
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install ultracart_rest_api_v2_typescript@3.10.223 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.225 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.10.225 | 02/18/2025 | small bug fixes for incorrect return types on several methods |
58
+ | 3.10.224 | 02/06/2025 | added storefront_host_name to channel partner order object |
57
59
  | 3.10.223 | 01/09/2025 | fix for broken 4.0.39 due to incorrect query sig on getCustomers |
58
60
  | 3.10.222 | 01/09/2025 | added emails parameter to customer queries, refundOrder added to Channel partner |
59
61
  | 3.10.221 | 12/13/2024 | added user and group ids to conversation agent auth object |
package/api.ts CHANGED
@@ -6092,6 +6092,12 @@ export interface ChannelPartnerOrder {
6092
6092
  * @memberof ChannelPartnerOrder
6093
6093
  */
6094
6094
  store_if_payment_declines?: boolean;
6095
+ /**
6096
+ * StoreFront host name associated with the order
6097
+ * @type {string}
6098
+ * @memberof ChannelPartnerOrder
6099
+ */
6100
+ storefront_host_name?: string;
6095
6101
  /**
6096
6102
  * The optional shipping county used to determine exact taxes
6097
6103
  * @type {string}
@@ -14684,7 +14690,7 @@ export interface CustomerAttachment {
14684
14690
  */
14685
14691
  file_name?: string;
14686
14692
  /**
14687
- * Mime typoe
14693
+ * Mime type
14688
14694
  * @type {string}
14689
14695
  * @memberof CustomerAttachment
14690
14696
  */
@@ -28586,6 +28592,12 @@ export interface ItemPaymentProcessing {
28586
28592
  * @memberof ItemPaymentProcessing
28587
28593
  */
28588
28594
  block_prepaid?: boolean;
28595
+ /**
28596
+ * True if this item should block any refund attempts
28597
+ * @type {boolean}
28598
+ * @memberof ItemPaymentProcessing
28599
+ */
28600
+ block_refunds?: boolean;
28589
28601
  /**
28590
28602
  * Credit card transaction type
28591
28603
  * @type {string}
@@ -29211,6 +29223,12 @@ export interface ItemReview {
29211
29223
  * @memberof ItemReview
29212
29224
  */
29213
29225
  helpful_yes_votes?: number;
29226
+ /**
29227
+ * Merchant Reply (set to an empty string to remove)
29228
+ * @type {string}
29229
+ * @memberof ItemReview
29230
+ */
29231
+ merchant_reply?: string;
29214
29232
  /**
29215
29233
  *
29216
29234
  * @type {string}
@@ -31801,6 +31819,12 @@ export interface Order {
31801
31819
  * @memberof Order
31802
31820
  */
31803
31821
  current_stage?: Order.CurrentStageEnum;
31822
+ /**
31823
+ * History of the changes to the current_stage field
31824
+ * @type {Array<OrderCurrentStageHistory>}
31825
+ * @memberof Order
31826
+ */
31827
+ current_stage_histories?: Array<OrderCurrentStageHistory>;
31804
31828
  /**
31805
31829
  *
31806
31830
  * @type {Customer}
@@ -32644,6 +32668,77 @@ export interface OrderCoupon {
32644
32668
  hdie_from_customer?: boolean;
32645
32669
  }
32646
32670
 
32671
+ /**
32672
+ *
32673
+ * @export
32674
+ * @interface OrderCurrentStageHistory
32675
+ */
32676
+ export interface OrderCurrentStageHistory {
32677
+ /**
32678
+ * New stage that the order is in.
32679
+ * @type {string}
32680
+ * @memberof OrderCurrentStageHistory
32681
+ */
32682
+ after_stage?: OrderCurrentStageHistory.AfterStageEnum;
32683
+ /**
32684
+ * Previous stage that the order was in.
32685
+ * @type {string}
32686
+ * @memberof OrderCurrentStageHistory
32687
+ */
32688
+ before_stage?: OrderCurrentStageHistory.BeforeStageEnum;
32689
+ /**
32690
+ * Date/time that the stage transitioned
32691
+ * @type {string}
32692
+ * @memberof OrderCurrentStageHistory
32693
+ */
32694
+ transition_dts?: string;
32695
+ }
32696
+
32697
+ /**
32698
+ * @export
32699
+ * @namespace OrderCurrentStageHistory
32700
+ */
32701
+ export namespace OrderCurrentStageHistory {
32702
+ /**
32703
+ * @export
32704
+ * @enum {string}
32705
+ */
32706
+ export enum AfterStageEnum {
32707
+ AccountsReceivable = <any> 'Accounts Receivable',
32708
+ PendingClearance = <any> 'Pending Clearance',
32709
+ FraudReview = <any> 'Fraud Review',
32710
+ Rejected = <any> 'Rejected',
32711
+ ShippingDepartment = <any> 'Shipping Department',
32712
+ CompletedOrder = <any> 'Completed Order',
32713
+ QuoteRequest = <any> 'Quote Request',
32714
+ QuoteSent = <any> 'Quote Sent',
32715
+ LeastCostRouting = <any> 'Least Cost Routing',
32716
+ Unknown = <any> 'Unknown',
32717
+ PreOrdered = <any> 'Pre-ordered',
32718
+ AdvancedOrderRouting = <any> 'Advanced Order Routing',
32719
+ Hold = <any> 'Hold'
32720
+ }
32721
+ /**
32722
+ * @export
32723
+ * @enum {string}
32724
+ */
32725
+ export enum BeforeStageEnum {
32726
+ AccountsReceivable = <any> 'Accounts Receivable',
32727
+ PendingClearance = <any> 'Pending Clearance',
32728
+ FraudReview = <any> 'Fraud Review',
32729
+ Rejected = <any> 'Rejected',
32730
+ ShippingDepartment = <any> 'Shipping Department',
32731
+ CompletedOrder = <any> 'Completed Order',
32732
+ QuoteRequest = <any> 'Quote Request',
32733
+ QuoteSent = <any> 'Quote Sent',
32734
+ LeastCostRouting = <any> 'Least Cost Routing',
32735
+ Unknown = <any> 'Unknown',
32736
+ PreOrdered = <any> 'Pre-ordered',
32737
+ AdvancedOrderRouting = <any> 'Advanced Order Routing',
32738
+ Hold = <any> 'Hold'
32739
+ }
32740
+ }
32741
+
32647
32742
  /**
32648
32743
  *
32649
32744
  * @export
@@ -33395,6 +33490,12 @@ export interface OrderItem {
33395
33490
  * @memberof OrderItem
33396
33491
  */
33397
33492
  activation_codes?: Array<string>;
33493
+ /**
33494
+ *
33495
+ * @type {Currency}
33496
+ * @memberof OrderItem
33497
+ */
33498
+ actual_cogs?: Currency;
33398
33499
  /**
33399
33500
  *
33400
33501
  * @type {Currency}
@@ -35750,12 +35851,36 @@ export interface OrderSummary {
35750
35851
  * @memberof OrderSummary
35751
35852
  */
35752
35853
  actual_fulfillment?: Currency;
35854
+ /**
35855
+ *
35856
+ * @type {Currency}
35857
+ * @memberof OrderSummary
35858
+ */
35859
+ actual_other_cost?: Currency;
35753
35860
  /**
35754
35861
  *
35755
35862
  * @type {Currency}
35756
35863
  * @memberof OrderSummary
35757
35864
  */
35758
35865
  actual_payment_processing?: Currency;
35866
+ /**
35867
+ *
35868
+ * @type {Currency}
35869
+ * @memberof OrderSummary
35870
+ */
35871
+ actual_profit?: Currency;
35872
+ /**
35873
+ * Actual profit has been analyzed
35874
+ * @type {boolean}
35875
+ * @memberof OrderSummary
35876
+ */
35877
+ actual_profit_analyzed?: boolean;
35878
+ /**
35879
+ * Actual profit needs review
35880
+ * @type {boolean}
35881
+ * @memberof OrderSummary
35882
+ */
35883
+ actual_profit_review?: boolean;
35759
35884
  /**
35760
35885
  *
35761
35886
  * @type {Currency}
@@ -43931,109 +44056,97 @@ export interface WebhookLogSummary {
43931
44056
  /**
43932
44057
  *
43933
44058
  * @export
43934
- * @interface WebhookResponse
44059
+ * @interface WebhookReflow
43935
44060
  */
43936
- export interface WebhookResponse {
44061
+ export interface WebhookReflow {
43937
44062
  /**
43938
44063
  *
43939
- * @type {ModelError}
43940
- * @memberof WebhookResponse
44064
+ * @type {string}
44065
+ * @memberof WebhookReflow
43941
44066
  */
43942
- error?: ModelError;
44067
+ event_name?: string;
43943
44068
  /**
43944
44069
  *
43945
- * @type {ResponseMetadata}
43946
- * @memberof WebhookResponse
43947
- */
43948
- metadata?: ResponseMetadata;
43949
- /**
43950
- * Indicates if API call was successful
43951
44070
  * @type {boolean}
43952
- * @memberof WebhookResponse
43953
- */
43954
- success?: boolean;
43955
- /**
43956
- *
43957
- * @type {Warning}
43958
- * @memberof WebhookResponse
43959
- */
43960
- warning?: Warning;
43961
- /**
43962
- *
43963
- * @type {Webhook}
43964
- * @memberof WebhookResponse
44071
+ * @memberof WebhookReflow
43965
44072
  */
43966
- webhook?: Webhook;
44073
+ queued?: boolean;
43967
44074
  }
43968
44075
 
43969
44076
  /**
43970
44077
  *
43971
44078
  * @export
43972
- * @interface WebhookSampleRequest
44079
+ * @interface WebhookReflowResponse
43973
44080
  */
43974
- export interface WebhookSampleRequest {
44081
+ export interface WebhookReflowResponse {
43975
44082
  /**
43976
- * Request
43977
- * @type {string}
43978
- * @memberof WebhookSampleRequest
44083
+ *
44084
+ * @type {ModelError}
44085
+ * @memberof WebhookReflowResponse
43979
44086
  */
43980
- request?: string;
44087
+ error?: ModelError;
43981
44088
  /**
43982
- * Request headers
43983
- * @type {Array<HTTPHeader>}
43984
- * @memberof WebhookSampleRequest
44089
+ *
44090
+ * @type {ResponseMetadata}
44091
+ * @memberof WebhookReflowResponse
43985
44092
  */
43986
- request_headers?: Array<HTTPHeader>;
44093
+ metadata?: ResponseMetadata;
43987
44094
  /**
43988
- * Request id
43989
- * @type {string}
43990
- * @memberof WebhookSampleRequest
44095
+ *
44096
+ * @type {WebhookReflow}
44097
+ * @memberof WebhookReflowResponse
43991
44098
  */
43992
- request_id?: string;
44099
+ reflow?: WebhookReflow;
43993
44100
  /**
43994
- * URI to send request to
43995
- * @type {string}
43996
- * @memberof WebhookSampleRequest
44101
+ * Indicates if API call was successful
44102
+ * @type {boolean}
44103
+ * @memberof WebhookReflowResponse
43997
44104
  */
43998
- uri?: string;
44105
+ success?: boolean;
44106
+ /**
44107
+ *
44108
+ * @type {Warning}
44109
+ * @memberof WebhookReflowResponse
44110
+ */
44111
+ warning?: Warning;
43999
44112
  }
44000
44113
 
44001
44114
  /**
44002
44115
  *
44003
44116
  * @export
44004
- * @interface WebhookSampleRequestResponse
44117
+ * @interface WebhookResponse
44005
44118
  */
44006
- export interface WebhookSampleRequestResponse {
44119
+ export interface WebhookResponse {
44007
44120
  /**
44008
44121
  *
44009
44122
  * @type {ModelError}
44010
- * @memberof WebhookSampleRequestResponse
44123
+ * @memberof WebhookResponse
44011
44124
  */
44012
44125
  error?: ModelError;
44013
44126
  /**
44014
44127
  *
44015
44128
  * @type {ResponseMetadata}
44016
- * @memberof WebhookSampleRequestResponse
44129
+ * @memberof WebhookResponse
44017
44130
  */
44018
44131
  metadata?: ResponseMetadata;
44019
44132
  /**
44020
44133
  * Indicates if API call was successful
44021
44134
  * @type {boolean}
44022
- * @memberof WebhookSampleRequestResponse
44135
+ * @memberof WebhookResponse
44023
44136
  */
44024
44137
  success?: boolean;
44025
44138
  /**
44026
44139
  *
44027
44140
  * @type {Warning}
44028
- * @memberof WebhookSampleRequestResponse
44141
+ * @memberof WebhookResponse
44029
44142
  */
44030
44143
  warning?: Warning;
44031
44144
  /**
44032
44145
  *
44033
- * @type {WebhookSampleRequest}
44034
- * @memberof WebhookSampleRequestResponse
44146
+ * @type {Webhook}
44147
+ * @memberof WebhookResponse
44035
44148
  */
44036
- webhook_sample_request?: WebhookSampleRequest;
44149
+ webhook?: Webhook;
44037
44150
  }
44038
44151
 
44039
44152
  /**
@@ -67048,7 +67161,7 @@ export const FulfillmentApiFetchParamCreator = function (configuration?: Configu
67048
67161
  };
67049
67162
  },
67050
67163
  /**
67051
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
67164
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
67052
67165
  * @summary Retrieve orders queued up for this distribution center.
67053
67166
  * @param {string} distribution_center_code Distribution center code
67054
67167
  * @param {*} [options] Override http request option.
@@ -67306,7 +67419,7 @@ export const FulfillmentApiFp = function(configuration?: Configuration) {
67306
67419
  * @param {*} [options] Override http request option.
67307
67420
  * @throws {RequiredError}
67308
67421
  */
67309
- generatePackingSlip(distribution_center_code: string, order_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrdersResponse> {
67422
+ generatePackingSlip(distribution_center_code: string, order_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderPackingSlipResponse> {
67310
67423
  const localVarFetchArgs = FulfillmentApiFetchParamCreator(configuration).generatePackingSlip(distribution_center_code, order_id, options);
67311
67424
  return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
67312
67425
  return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
@@ -67321,7 +67434,7 @@ export const FulfillmentApiFp = function(configuration?: Configuration) {
67321
67434
  };
67322
67435
  },
67323
67436
  /**
67324
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
67437
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
67325
67438
  * @summary Retrieve orders queued up for this distribution center.
67326
67439
  * @param {string} distribution_center_code Distribution center code
67327
67440
  * @param {*} [options] Override http request option.
@@ -67437,7 +67550,7 @@ export const FulfillmentApiFactory = function (configuration?: Configuration, fe
67437
67550
  return FulfillmentApiFp(configuration).generatePackingSlip(distribution_center_code, order_id, options)(fetch, basePath);
67438
67551
  },
67439
67552
  /**
67440
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
67553
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
67441
67554
  * @summary Retrieve orders queued up for this distribution center.
67442
67555
  * @param {string} distribution_center_code Distribution center code
67443
67556
  * @param {*} [options] Override http request option.
@@ -67506,10 +67619,10 @@ export interface FulfillmentApiInterface {
67506
67619
  * @throws {RequiredError}
67507
67620
  * @memberof FulfillmentApiInterface
67508
67621
  */
67509
- generatePackingSlip(distribution_center_code: string, order_id: string, options?: any): Promise<OrdersResponse>;
67622
+ generatePackingSlip(distribution_center_code: string, order_id: string, options?: any): Promise<OrderPackingSlipResponse>;
67510
67623
 
67511
67624
  /**
67512
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
67625
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
67513
67626
  * @summary Retrieve orders queued up for this distribution center.
67514
67627
  * @param {string} distribution_center_code Distribution center code
67515
67628
  * @param {*} [options] Override http request option.
@@ -67585,7 +67698,7 @@ export class FulfillmentApi extends BaseAPI implements FulfillmentApiInterface {
67585
67698
  }
67586
67699
 
67587
67700
  /**
67588
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
67701
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
67589
67702
  * @summary Retrieve orders queued up for this distribution center.
67590
67703
  * @param {string} distribution_center_code Distribution center code
67591
67704
  * @param {*} [options] Override http request option.
@@ -72068,7 +72181,7 @@ export const OauthApiFetchParamCreator = function (configuration?: Configuration
72068
72181
  * @param {string} client_id The OAuth application client_id.
72069
72182
  * @param {string} grant_type Type of grant
72070
72183
  * @param {string} [code] Authorization code received back from the browser redirect
72071
- * @param {string} [redirect_uri] The URI that you redirect the browser to to start the authorization process
72184
+ * @param {string} [redirect_uri] The URI that you redirect the browser to start the authorization process
72072
72185
  * @param {string} [refresh_token] The refresh token received during the original grant_type&#x3D;authorization_code that can be used to return a new access token
72073
72186
  * @param {*} [options] Override http request option.
72074
72187
  * @throws {RequiredError}
@@ -72244,7 +72357,7 @@ export const OauthApiFp = function(configuration?: Configuration) {
72244
72357
  * @param {string} client_id The OAuth application client_id.
72245
72358
  * @param {string} grant_type Type of grant
72246
72359
  * @param {string} [code] Authorization code received back from the browser redirect
72247
- * @param {string} [redirect_uri] The URI that you redirect the browser to to start the authorization process
72360
+ * @param {string} [redirect_uri] The URI that you redirect the browser to start the authorization process
72248
72361
  * @param {string} [refresh_token] The refresh token received during the original grant_type&#x3D;authorization_code that can be used to return a new access token
72249
72362
  * @param {*} [options] Override http request option.
72250
72363
  * @throws {RequiredError}
@@ -72300,7 +72413,7 @@ export const OauthApiFactory = function (configuration?: Configuration, fetch?:
72300
72413
  * @param {string} client_id The OAuth application client_id.
72301
72414
  * @param {string} grant_type Type of grant
72302
72415
  * @param {string} [code] Authorization code received back from the browser redirect
72303
- * @param {string} [redirect_uri] The URI that you redirect the browser to to start the authorization process
72416
+ * @param {string} [redirect_uri] The URI that you redirect the browser to start the authorization process
72304
72417
  * @param {string} [refresh_token] The refresh token received during the original grant_type&#x3D;authorization_code that can be used to return a new access token
72305
72418
  * @param {*} [options] Override http request option.
72306
72419
  * @throws {RequiredError}
@@ -72334,7 +72447,7 @@ export interface OauthApiInterface {
72334
72447
  * @param {string} client_id The OAuth application client_id.
72335
72448
  * @param {string} grant_type Type of grant
72336
72449
  * @param {string} [code] Authorization code received back from the browser redirect
72337
- * @param {string} [redirect_uri] The URI that you redirect the browser to to start the authorization process
72450
+ * @param {string} [redirect_uri] The URI that you redirect the browser to start the authorization process
72338
72451
  * @param {string} [refresh_token] The refresh token received during the original grant_type&#x3D;authorization_code that can be used to return a new access token
72339
72452
  * @param {*} [options] Override http request option.
72340
72453
  * @throws {RequiredError}
@@ -72368,7 +72481,7 @@ export class OauthApi extends BaseAPI implements OauthApiInterface {
72368
72481
  * @param {string} client_id The OAuth application client_id.
72369
72482
  * @param {string} grant_type Type of grant
72370
72483
  * @param {string} [code] Authorization code received back from the browser redirect
72371
- * @param {string} [redirect_uri] The URI that you redirect the browser to to start the authorization process
72484
+ * @param {string} [redirect_uri] The URI that you redirect the browser to start the authorization process
72372
72485
  * @param {string} [refresh_token] The refresh token received during the original grant_type&#x3D;authorization_code that can be used to return a new access token
72373
72486
  * @param {*} [options] Override http request option.
72374
72487
  * @throws {RequiredError}
@@ -103429,7 +103542,7 @@ export const WebhookApiFp = function(configuration?: Configuration) {
103429
103542
  * @param {*} [options] Override http request option.
103430
103543
  * @throws {RequiredError}
103431
103544
  */
103432
- resendEvent(webhookOid: number, eventName: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WebhookSampleRequestResponse> {
103545
+ resendEvent(webhookOid: number, eventName: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WebhookReflowResponse> {
103433
103546
  const localVarFetchArgs = WebhookApiFetchParamCreator(configuration).resendEvent(webhookOid, eventName, options);
103434
103547
  return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
103435
103548
  return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
@@ -103652,7 +103765,7 @@ export interface WebhookApiInterface {
103652
103765
  * @throws {RequiredError}
103653
103766
  * @memberof WebhookApiInterface
103654
103767
  */
103655
- resendEvent(webhookOid: number, eventName: string, options?: any): Promise<WebhookSampleRequestResponse>;
103768
+ resendEvent(webhookOid: number, eventName: string, options?: any): Promise<WebhookReflowResponse>;
103656
103769
 
103657
103770
  /**
103658
103771
  * Update a webhook on the account
package/dist/api.d.ts CHANGED
@@ -5957,6 +5957,12 @@ export interface ChannelPartnerOrder {
5957
5957
  * @memberof ChannelPartnerOrder
5958
5958
  */
5959
5959
  store_if_payment_declines?: boolean;
5960
+ /**
5961
+ * StoreFront host name associated with the order
5962
+ * @type {string}
5963
+ * @memberof ChannelPartnerOrder
5964
+ */
5965
+ storefront_host_name?: string;
5960
5966
  /**
5961
5967
  * The optional shipping county used to determine exact taxes
5962
5968
  * @type {string}
@@ -14333,7 +14339,7 @@ export interface CustomerAttachment {
14333
14339
  */
14334
14340
  file_name?: string;
14335
14341
  /**
14336
- * Mime typoe
14342
+ * Mime type
14337
14343
  * @type {string}
14338
14344
  * @memberof CustomerAttachment
14339
14345
  */
@@ -27982,6 +27988,12 @@ export interface ItemPaymentProcessing {
27982
27988
  * @memberof ItemPaymentProcessing
27983
27989
  */
27984
27990
  block_prepaid?: boolean;
27991
+ /**
27992
+ * True if this item should block any refund attempts
27993
+ * @type {boolean}
27994
+ * @memberof ItemPaymentProcessing
27995
+ */
27996
+ block_refunds?: boolean;
27985
27997
  /**
27986
27998
  * Credit card transaction type
27987
27999
  * @type {string}
@@ -28590,6 +28602,12 @@ export interface ItemReview {
28590
28602
  * @memberof ItemReview
28591
28603
  */
28592
28604
  helpful_yes_votes?: number;
28605
+ /**
28606
+ * Merchant Reply (set to an empty string to remove)
28607
+ * @type {string}
28608
+ * @memberof ItemReview
28609
+ */
28610
+ merchant_reply?: string;
28593
28611
  /**
28594
28612
  *
28595
28613
  * @type {string}
@@ -31126,6 +31144,12 @@ export interface Order {
31126
31144
  * @memberof Order
31127
31145
  */
31128
31146
  current_stage?: Order.CurrentStageEnum;
31147
+ /**
31148
+ * History of the changes to the current_stage field
31149
+ * @type {Array<OrderCurrentStageHistory>}
31150
+ * @memberof Order
31151
+ */
31152
+ current_stage_histories?: Array<OrderCurrentStageHistory>;
31129
31153
  /**
31130
31154
  *
31131
31155
  * @type {Customer}
@@ -31956,6 +31980,75 @@ export interface OrderCoupon {
31956
31980
  */
31957
31981
  hdie_from_customer?: boolean;
31958
31982
  }
31983
+ /**
31984
+ *
31985
+ * @export
31986
+ * @interface OrderCurrentStageHistory
31987
+ */
31988
+ export interface OrderCurrentStageHistory {
31989
+ /**
31990
+ * New stage that the order is in.
31991
+ * @type {string}
31992
+ * @memberof OrderCurrentStageHistory
31993
+ */
31994
+ after_stage?: OrderCurrentStageHistory.AfterStageEnum;
31995
+ /**
31996
+ * Previous stage that the order was in.
31997
+ * @type {string}
31998
+ * @memberof OrderCurrentStageHistory
31999
+ */
32000
+ before_stage?: OrderCurrentStageHistory.BeforeStageEnum;
32001
+ /**
32002
+ * Date/time that the stage transitioned
32003
+ * @type {string}
32004
+ * @memberof OrderCurrentStageHistory
32005
+ */
32006
+ transition_dts?: string;
32007
+ }
32008
+ /**
32009
+ * @export
32010
+ * @namespace OrderCurrentStageHistory
32011
+ */
32012
+ export declare namespace OrderCurrentStageHistory {
32013
+ /**
32014
+ * @export
32015
+ * @enum {string}
32016
+ */
32017
+ enum AfterStageEnum {
32018
+ AccountsReceivable,
32019
+ PendingClearance,
32020
+ FraudReview,
32021
+ Rejected,
32022
+ ShippingDepartment,
32023
+ CompletedOrder,
32024
+ QuoteRequest,
32025
+ QuoteSent,
32026
+ LeastCostRouting,
32027
+ Unknown,
32028
+ PreOrdered,
32029
+ AdvancedOrderRouting,
32030
+ Hold
32031
+ }
32032
+ /**
32033
+ * @export
32034
+ * @enum {string}
32035
+ */
32036
+ enum BeforeStageEnum {
32037
+ AccountsReceivable,
32038
+ PendingClearance,
32039
+ FraudReview,
32040
+ Rejected,
32041
+ ShippingDepartment,
32042
+ CompletedOrder,
32043
+ QuoteRequest,
32044
+ QuoteSent,
32045
+ LeastCostRouting,
32046
+ Unknown,
32047
+ PreOrdered,
32048
+ AdvancedOrderRouting,
32049
+ Hold
32050
+ }
32051
+ }
31959
32052
  /**
31960
32053
  *
31961
32054
  * @export
@@ -32692,6 +32785,12 @@ export interface OrderItem {
32692
32785
  * @memberof OrderItem
32693
32786
  */
32694
32787
  activation_codes?: Array<string>;
32788
+ /**
32789
+ *
32790
+ * @type {Currency}
32791
+ * @memberof OrderItem
32792
+ */
32793
+ actual_cogs?: Currency;
32695
32794
  /**
32696
32795
  *
32697
32796
  * @type {Currency}
@@ -35003,12 +35102,36 @@ export interface OrderSummary {
35003
35102
  * @memberof OrderSummary
35004
35103
  */
35005
35104
  actual_fulfillment?: Currency;
35105
+ /**
35106
+ *
35107
+ * @type {Currency}
35108
+ * @memberof OrderSummary
35109
+ */
35110
+ actual_other_cost?: Currency;
35006
35111
  /**
35007
35112
  *
35008
35113
  * @type {Currency}
35009
35114
  * @memberof OrderSummary
35010
35115
  */
35011
35116
  actual_payment_processing?: Currency;
35117
+ /**
35118
+ *
35119
+ * @type {Currency}
35120
+ * @memberof OrderSummary
35121
+ */
35122
+ actual_profit?: Currency;
35123
+ /**
35124
+ * Actual profit has been analyzed
35125
+ * @type {boolean}
35126
+ * @memberof OrderSummary
35127
+ */
35128
+ actual_profit_analyzed?: boolean;
35129
+ /**
35130
+ * Actual profit needs review
35131
+ * @type {boolean}
35132
+ * @memberof OrderSummary
35133
+ */
35134
+ actual_profit_review?: boolean;
35012
35135
  /**
35013
35136
  *
35014
35137
  * @type {Currency}
@@ -43006,107 +43129,95 @@ export interface WebhookLogSummary {
43006
43129
  /**
43007
43130
  *
43008
43131
  * @export
43009
- * @interface WebhookResponse
43132
+ * @interface WebhookReflow
43010
43133
  */
43011
- export interface WebhookResponse {
43134
+ export interface WebhookReflow {
43012
43135
  /**
43013
43136
  *
43014
- * @type {ModelError}
43015
- * @memberof WebhookResponse
43137
+ * @type {string}
43138
+ * @memberof WebhookReflow
43016
43139
  */
43017
- error?: ModelError;
43140
+ event_name?: string;
43018
43141
  /**
43019
43142
  *
43020
- * @type {ResponseMetadata}
43021
- * @memberof WebhookResponse
43022
- */
43023
- metadata?: ResponseMetadata;
43024
- /**
43025
- * Indicates if API call was successful
43026
43143
  * @type {boolean}
43027
- * @memberof WebhookResponse
43144
+ * @memberof WebhookReflow
43028
43145
  */
43029
- success?: boolean;
43030
- /**
43031
- *
43032
- * @type {Warning}
43033
- * @memberof WebhookResponse
43034
- */
43035
- warning?: Warning;
43036
- /**
43037
- *
43038
- * @type {Webhook}
43039
- * @memberof WebhookResponse
43040
- */
43041
- webhook?: Webhook;
43146
+ queued?: boolean;
43042
43147
  }
43043
43148
  /**
43044
43149
  *
43045
43150
  * @export
43046
- * @interface WebhookSampleRequest
43151
+ * @interface WebhookReflowResponse
43047
43152
  */
43048
- export interface WebhookSampleRequest {
43153
+ export interface WebhookReflowResponse {
43049
43154
  /**
43050
- * Request
43051
- * @type {string}
43052
- * @memberof WebhookSampleRequest
43155
+ *
43156
+ * @type {ModelError}
43157
+ * @memberof WebhookReflowResponse
43053
43158
  */
43054
- request?: string;
43159
+ error?: ModelError;
43055
43160
  /**
43056
- * Request headers
43057
- * @type {Array<HTTPHeader>}
43058
- * @memberof WebhookSampleRequest
43161
+ *
43162
+ * @type {ResponseMetadata}
43163
+ * @memberof WebhookReflowResponse
43059
43164
  */
43060
- request_headers?: Array<HTTPHeader>;
43165
+ metadata?: ResponseMetadata;
43061
43166
  /**
43062
- * Request id
43063
- * @type {string}
43064
- * @memberof WebhookSampleRequest
43167
+ *
43168
+ * @type {WebhookReflow}
43169
+ * @memberof WebhookReflowResponse
43065
43170
  */
43066
- request_id?: string;
43171
+ reflow?: WebhookReflow;
43067
43172
  /**
43068
- * URI to send request to
43069
- * @type {string}
43070
- * @memberof WebhookSampleRequest
43173
+ * Indicates if API call was successful
43174
+ * @type {boolean}
43175
+ * @memberof WebhookReflowResponse
43071
43176
  */
43072
- uri?: string;
43177
+ success?: boolean;
43178
+ /**
43179
+ *
43180
+ * @type {Warning}
43181
+ * @memberof WebhookReflowResponse
43182
+ */
43183
+ warning?: Warning;
43073
43184
  }
43074
43185
  /**
43075
43186
  *
43076
43187
  * @export
43077
- * @interface WebhookSampleRequestResponse
43188
+ * @interface WebhookResponse
43078
43189
  */
43079
- export interface WebhookSampleRequestResponse {
43190
+ export interface WebhookResponse {
43080
43191
  /**
43081
43192
  *
43082
43193
  * @type {ModelError}
43083
- * @memberof WebhookSampleRequestResponse
43194
+ * @memberof WebhookResponse
43084
43195
  */
43085
43196
  error?: ModelError;
43086
43197
  /**
43087
43198
  *
43088
43199
  * @type {ResponseMetadata}
43089
- * @memberof WebhookSampleRequestResponse
43200
+ * @memberof WebhookResponse
43090
43201
  */
43091
43202
  metadata?: ResponseMetadata;
43092
43203
  /**
43093
43204
  * Indicates if API call was successful
43094
43205
  * @type {boolean}
43095
- * @memberof WebhookSampleRequestResponse
43206
+ * @memberof WebhookResponse
43096
43207
  */
43097
43208
  success?: boolean;
43098
43209
  /**
43099
43210
  *
43100
43211
  * @type {Warning}
43101
- * @memberof WebhookSampleRequestResponse
43212
+ * @memberof WebhookResponse
43102
43213
  */
43103
43214
  warning?: Warning;
43104
43215
  /**
43105
43216
  *
43106
- * @type {WebhookSampleRequest}
43107
- * @memberof WebhookSampleRequestResponse
43217
+ * @type {Webhook}
43218
+ * @memberof WebhookResponse
43108
43219
  */
43109
- webhook_sample_request?: WebhookSampleRequest;
43220
+ webhook?: Webhook;
43110
43221
  }
43111
43222
  /**
43112
43223
  *
@@ -53111,7 +53222,7 @@ export declare const FulfillmentApiFetchParamCreator: (configuration?: Configura
53111
53222
  */
53112
53223
  generatePackingSlip(distribution_center_code: string, order_id: string, options?: any): FetchArgs;
53113
53224
  /**
53114
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
53225
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
53115
53226
  * @summary Retrieve orders queued up for this distribution center.
53116
53227
  * @param {string} distribution_center_code Distribution center code
53117
53228
  * @param {*} [options] Override http request option.
@@ -53166,9 +53277,9 @@ export declare const FulfillmentApiFp: (configuration?: Configuration) => {
53166
53277
  * @param {*} [options] Override http request option.
53167
53278
  * @throws {RequiredError}
53168
53279
  */
53169
- generatePackingSlip(distribution_center_code: string, order_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrdersResponse>;
53280
+ generatePackingSlip(distribution_center_code: string, order_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderPackingSlipResponse>;
53170
53281
  /**
53171
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
53282
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
53172
53283
  * @summary Retrieve orders queued up for this distribution center.
53173
53284
  * @param {string} distribution_center_code Distribution center code
53174
53285
  * @param {*} [options] Override http request option.
@@ -53223,9 +53334,9 @@ export declare const FulfillmentApiFactory: (configuration?: Configuration, fetc
53223
53334
  * @param {*} [options] Override http request option.
53224
53335
  * @throws {RequiredError}
53225
53336
  */
53226
- generatePackingSlip(distribution_center_code: string, order_id: string, options?: any): Promise<OrdersResponse>;
53337
+ generatePackingSlip(distribution_center_code: string, order_id: string, options?: any): Promise<OrderPackingSlipResponse>;
53227
53338
  /**
53228
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
53339
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
53229
53340
  * @summary Retrieve orders queued up for this distribution center.
53230
53341
  * @param {string} distribution_center_code Distribution center code
53231
53342
  * @param {*} [options] Override http request option.
@@ -53283,9 +53394,9 @@ export interface FulfillmentApiInterface {
53283
53394
  * @throws {RequiredError}
53284
53395
  * @memberof FulfillmentApiInterface
53285
53396
  */
53286
- generatePackingSlip(distribution_center_code: string, order_id: string, options?: any): Promise<OrdersResponse>;
53397
+ generatePackingSlip(distribution_center_code: string, order_id: string, options?: any): Promise<OrderPackingSlipResponse>;
53287
53398
  /**
53288
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
53399
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
53289
53400
  * @summary Retrieve orders queued up for this distribution center.
53290
53401
  * @param {string} distribution_center_code Distribution center code
53291
53402
  * @param {*} [options] Override http request option.
@@ -53348,9 +53459,9 @@ export declare class FulfillmentApi extends BaseAPI implements FulfillmentApiInt
53348
53459
  * @throws {RequiredError}
53349
53460
  * @memberof FulfillmentApi
53350
53461
  */
53351
- generatePackingSlip(distribution_center_code: string, order_id: string, options?: any): Promise<OrdersResponse>;
53462
+ generatePackingSlip(distribution_center_code: string, order_id: string, options?: any): Promise<OrderPackingSlipResponse>;
53352
53463
  /**
53353
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
53464
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
53354
53465
  * @summary Retrieve orders queued up for this distribution center.
53355
53466
  * @param {string} distribution_center_code Distribution center code
53356
53467
  * @param {*} [options] Override http request option.
@@ -55259,7 +55370,7 @@ export declare const OauthApiFetchParamCreator: (configuration?: Configuration)
55259
55370
  * @param {string} client_id The OAuth application client_id.
55260
55371
  * @param {string} grant_type Type of grant
55261
55372
  * @param {string} [code] Authorization code received back from the browser redirect
55262
- * @param {string} [redirect_uri] The URI that you redirect the browser to to start the authorization process
55373
+ * @param {string} [redirect_uri] The URI that you redirect the browser to start the authorization process
55263
55374
  * @param {string} [refresh_token] The refresh token received during the original grant_type&#x3D;authorization_code that can be used to return a new access token
55264
55375
  * @param {*} [options] Override http request option.
55265
55376
  * @throws {RequiredError}
@@ -55286,7 +55397,7 @@ export declare const OauthApiFp: (configuration?: Configuration) => {
55286
55397
  * @param {string} client_id The OAuth application client_id.
55287
55398
  * @param {string} grant_type Type of grant
55288
55399
  * @param {string} [code] Authorization code received back from the browser redirect
55289
- * @param {string} [redirect_uri] The URI that you redirect the browser to to start the authorization process
55400
+ * @param {string} [redirect_uri] The URI that you redirect the browser to start the authorization process
55290
55401
  * @param {string} [refresh_token] The refresh token received during the original grant_type&#x3D;authorization_code that can be used to return a new access token
55291
55402
  * @param {*} [options] Override http request option.
55292
55403
  * @throws {RequiredError}
@@ -55313,7 +55424,7 @@ export declare const OauthApiFactory: (configuration?: Configuration, fetch?: Fe
55313
55424
  * @param {string} client_id The OAuth application client_id.
55314
55425
  * @param {string} grant_type Type of grant
55315
55426
  * @param {string} [code] Authorization code received back from the browser redirect
55316
- * @param {string} [redirect_uri] The URI that you redirect the browser to to start the authorization process
55427
+ * @param {string} [redirect_uri] The URI that you redirect the browser to start the authorization process
55317
55428
  * @param {string} [refresh_token] The refresh token received during the original grant_type&#x3D;authorization_code that can be used to return a new access token
55318
55429
  * @param {*} [options] Override http request option.
55319
55430
  * @throws {RequiredError}
@@ -55341,7 +55452,7 @@ export interface OauthApiInterface {
55341
55452
  * @param {string} client_id The OAuth application client_id.
55342
55453
  * @param {string} grant_type Type of grant
55343
55454
  * @param {string} [code] Authorization code received back from the browser redirect
55344
- * @param {string} [redirect_uri] The URI that you redirect the browser to to start the authorization process
55455
+ * @param {string} [redirect_uri] The URI that you redirect the browser to start the authorization process
55345
55456
  * @param {string} [refresh_token] The refresh token received during the original grant_type&#x3D;authorization_code that can be used to return a new access token
55346
55457
  * @param {*} [options] Override http request option.
55347
55458
  * @throws {RequiredError}
@@ -55372,7 +55483,7 @@ export declare class OauthApi extends BaseAPI implements OauthApiInterface {
55372
55483
  * @param {string} client_id The OAuth application client_id.
55373
55484
  * @param {string} grant_type Type of grant
55374
55485
  * @param {string} [code] Authorization code received back from the browser redirect
55375
- * @param {string} [redirect_uri] The URI that you redirect the browser to to start the authorization process
55486
+ * @param {string} [redirect_uri] The URI that you redirect the browser to start the authorization process
55376
55487
  * @param {string} [refresh_token] The refresh token received during the original grant_type&#x3D;authorization_code that can be used to return a new access token
55377
55488
  * @param {*} [options] Override http request option.
55378
55489
  * @throws {RequiredError}
@@ -67451,7 +67562,7 @@ export declare const WebhookApiFp: (configuration?: Configuration) => {
67451
67562
  * @param {*} [options] Override http request option.
67452
67563
  * @throws {RequiredError}
67453
67564
  */
67454
- resendEvent(webhookOid: number, eventName: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WebhookSampleRequestResponse>;
67565
+ resendEvent(webhookOid: number, eventName: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WebhookReflowResponse>;
67455
67566
  /**
67456
67567
  * Update a webhook on the account
67457
67568
  * @summary Update a webhook
@@ -67532,7 +67643,7 @@ export declare const WebhookApiFactory: (configuration?: Configuration, fetch?:
67532
67643
  * @param {*} [options] Override http request option.
67533
67644
  * @throws {RequiredError}
67534
67645
  */
67535
- resendEvent(webhookOid: number, eventName: string, options?: any): Promise<WebhookSampleRequestResponse>;
67646
+ resendEvent(webhookOid: number, eventName: string, options?: any): Promise<WebhookReflowResponse>;
67536
67647
  /**
67537
67648
  * Update a webhook on the account
67538
67649
  * @summary Update a webhook
@@ -67621,7 +67732,7 @@ export interface WebhookApiInterface {
67621
67732
  * @throws {RequiredError}
67622
67733
  * @memberof WebhookApiInterface
67623
67734
  */
67624
- resendEvent(webhookOid: number, eventName: string, options?: any): Promise<WebhookSampleRequestResponse>;
67735
+ resendEvent(webhookOid: number, eventName: string, options?: any): Promise<WebhookReflowResponse>;
67625
67736
  /**
67626
67737
  * Update a webhook on the account
67627
67738
  * @summary Update a webhook
@@ -67712,7 +67823,7 @@ export declare class WebhookApi extends BaseAPI implements WebhookApiInterface {
67712
67823
  * @throws {RequiredError}
67713
67824
  * @memberof WebhookApi
67714
67825
  */
67715
- resendEvent(webhookOid: number, eventName: string, options?: any): Promise<WebhookSampleRequestResponse>;
67826
+ resendEvent(webhookOid: number, eventName: string, options?: any): Promise<WebhookReflowResponse>;
67716
67827
  /**
67717
67828
  * Update a webhook on the account
67718
67829
  * @summary Update a webhook
package/dist/api.js CHANGED
@@ -29,9 +29,9 @@ var __extends = (this && this.__extends) || (function () {
29
29
  })();
30
30
  Object.defineProperty(exports, "__esModule", { value: true });
31
31
  exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemReview = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.Coupon = exports.ConversationWebsocketMessage = exports.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationSummary = exports.ConversationSentiment = exports.ConversationPbxVoicemailMessageSummary = exports.ConversationPbxVoicemailMessage = exports.ConversationPbxVoicemailMailbox = exports.ConversationPbxTimeBasedMapping = exports.ConversationPbxPhoneNumber = exports.ConversationPbxMenuMapping = exports.ConversationPbxMenu = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationEventRRWeb = exports.ConversationEngagementEquationFunction = exports.ConversationEngagement = exports.ConversationAgentProfile = exports.Conversation = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
32
- exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.WorkflowTasksRequest = exports.WorkflowTask = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.ReportWebsocketEvent = exports.ReportPageVisualizationMetric = exports.ReportPageVisualization = exports.ReportFilter = exports.ReportExecuteQueriesRequest = exports.ReportDataSourceSchema = exports.ReportDataSetSchema = exports.ReportDataSetQuery = exports.ReportDataSet = exports.Report = exports.PointOfSaleReader = exports.OrderQueryBatch = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderEdiDocument = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = void 0;
33
- exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.DatawarehouseApi = exports.DatawarehouseApiFactory = exports.DatawarehouseApiFp = exports.DatawarehouseApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = void 0;
34
- exports.WorkflowApi = exports.WorkflowApiFactory = exports.WorkflowApiFp = exports.WorkflowApiFetchParamCreator = exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = void 0;
32
+ exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.WorkflowTasksRequest = exports.WorkflowTask = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.ReportWebsocketEvent = exports.ReportPageVisualizationMetric = exports.ReportPageVisualization = exports.ReportFilter = exports.ReportExecuteQueriesRequest = exports.ReportDataSourceSchema = exports.ReportDataSetSchema = exports.ReportDataSetQuery = exports.ReportDataSet = exports.Report = exports.PointOfSaleReader = exports.OrderQueryBatch = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderEdiDocument = exports.OrderCurrentStageHistory = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = void 0;
33
+ exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.DatawarehouseApi = exports.DatawarehouseApiFactory = exports.DatawarehouseApiFp = exports.DatawarehouseApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = void 0;
34
+ exports.WorkflowApi = exports.WorkflowApiFactory = exports.WorkflowApiFp = exports.WorkflowApiFetchParamCreator = exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = void 0;
35
35
  var url = require("url");
36
36
  var portableFetch = require("portable-fetch");
37
37
  var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
@@ -1231,6 +1231,53 @@ var OrderAutoOrder;
1231
1231
  StatusEnum[StatusEnum["Disabled"] = 'disabled'] = "Disabled";
1232
1232
  })(StatusEnum = OrderAutoOrder.StatusEnum || (OrderAutoOrder.StatusEnum = {}));
1233
1233
  })(OrderAutoOrder = exports.OrderAutoOrder || (exports.OrderAutoOrder = {}));
1234
+ /**
1235
+ * @export
1236
+ * @namespace OrderCurrentStageHistory
1237
+ */
1238
+ var OrderCurrentStageHistory;
1239
+ (function (OrderCurrentStageHistory) {
1240
+ /**
1241
+ * @export
1242
+ * @enum {string}
1243
+ */
1244
+ var AfterStageEnum;
1245
+ (function (AfterStageEnum) {
1246
+ AfterStageEnum[AfterStageEnum["AccountsReceivable"] = 'Accounts Receivable'] = "AccountsReceivable";
1247
+ AfterStageEnum[AfterStageEnum["PendingClearance"] = 'Pending Clearance'] = "PendingClearance";
1248
+ AfterStageEnum[AfterStageEnum["FraudReview"] = 'Fraud Review'] = "FraudReview";
1249
+ AfterStageEnum[AfterStageEnum["Rejected"] = 'Rejected'] = "Rejected";
1250
+ AfterStageEnum[AfterStageEnum["ShippingDepartment"] = 'Shipping Department'] = "ShippingDepartment";
1251
+ AfterStageEnum[AfterStageEnum["CompletedOrder"] = 'Completed Order'] = "CompletedOrder";
1252
+ AfterStageEnum[AfterStageEnum["QuoteRequest"] = 'Quote Request'] = "QuoteRequest";
1253
+ AfterStageEnum[AfterStageEnum["QuoteSent"] = 'Quote Sent'] = "QuoteSent";
1254
+ AfterStageEnum[AfterStageEnum["LeastCostRouting"] = 'Least Cost Routing'] = "LeastCostRouting";
1255
+ AfterStageEnum[AfterStageEnum["Unknown"] = 'Unknown'] = "Unknown";
1256
+ AfterStageEnum[AfterStageEnum["PreOrdered"] = 'Pre-ordered'] = "PreOrdered";
1257
+ AfterStageEnum[AfterStageEnum["AdvancedOrderRouting"] = 'Advanced Order Routing'] = "AdvancedOrderRouting";
1258
+ AfterStageEnum[AfterStageEnum["Hold"] = 'Hold'] = "Hold";
1259
+ })(AfterStageEnum = OrderCurrentStageHistory.AfterStageEnum || (OrderCurrentStageHistory.AfterStageEnum = {}));
1260
+ /**
1261
+ * @export
1262
+ * @enum {string}
1263
+ */
1264
+ var BeforeStageEnum;
1265
+ (function (BeforeStageEnum) {
1266
+ BeforeStageEnum[BeforeStageEnum["AccountsReceivable"] = 'Accounts Receivable'] = "AccountsReceivable";
1267
+ BeforeStageEnum[BeforeStageEnum["PendingClearance"] = 'Pending Clearance'] = "PendingClearance";
1268
+ BeforeStageEnum[BeforeStageEnum["FraudReview"] = 'Fraud Review'] = "FraudReview";
1269
+ BeforeStageEnum[BeforeStageEnum["Rejected"] = 'Rejected'] = "Rejected";
1270
+ BeforeStageEnum[BeforeStageEnum["ShippingDepartment"] = 'Shipping Department'] = "ShippingDepartment";
1271
+ BeforeStageEnum[BeforeStageEnum["CompletedOrder"] = 'Completed Order'] = "CompletedOrder";
1272
+ BeforeStageEnum[BeforeStageEnum["QuoteRequest"] = 'Quote Request'] = "QuoteRequest";
1273
+ BeforeStageEnum[BeforeStageEnum["QuoteSent"] = 'Quote Sent'] = "QuoteSent";
1274
+ BeforeStageEnum[BeforeStageEnum["LeastCostRouting"] = 'Least Cost Routing'] = "LeastCostRouting";
1275
+ BeforeStageEnum[BeforeStageEnum["Unknown"] = 'Unknown'] = "Unknown";
1276
+ BeforeStageEnum[BeforeStageEnum["PreOrdered"] = 'Pre-ordered'] = "PreOrdered";
1277
+ BeforeStageEnum[BeforeStageEnum["AdvancedOrderRouting"] = 'Advanced Order Routing'] = "AdvancedOrderRouting";
1278
+ BeforeStageEnum[BeforeStageEnum["Hold"] = 'Hold'] = "Hold";
1279
+ })(BeforeStageEnum = OrderCurrentStageHistory.BeforeStageEnum || (OrderCurrentStageHistory.BeforeStageEnum = {}));
1280
+ })(OrderCurrentStageHistory = exports.OrderCurrentStageHistory || (exports.OrderCurrentStageHistory = {}));
1234
1281
  /**
1235
1282
  * @export
1236
1283
  * @namespace OrderEdiDocument
@@ -20376,7 +20423,7 @@ var FulfillmentApiFetchParamCreator = function (configuration) {
20376
20423
  };
20377
20424
  },
20378
20425
  /**
20379
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
20426
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
20380
20427
  * @summary Retrieve orders queued up for this distribution center.
20381
20428
  * @param {string} distribution_center_code Distribution center code
20382
20429
  * @param {*} [options] Override http request option.
@@ -20625,7 +20672,7 @@ var FulfillmentApiFp = function (configuration) {
20625
20672
  };
20626
20673
  },
20627
20674
  /**
20628
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
20675
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
20629
20676
  * @summary Retrieve orders queued up for this distribution center.
20630
20677
  * @param {string} distribution_center_code Distribution center code
20631
20678
  * @param {*} [options] Override http request option.
@@ -20745,7 +20792,7 @@ var FulfillmentApiFactory = function (configuration, fetch, basePath) {
20745
20792
  return (0, exports.FulfillmentApiFp)(configuration).generatePackingSlip(distribution_center_code, order_id, options)(fetch, basePath);
20746
20793
  },
20747
20794
  /**
20748
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
20795
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
20749
20796
  * @summary Retrieve orders queued up for this distribution center.
20750
20797
  * @param {string} distribution_center_code Distribution center code
20751
20798
  * @param {*} [options] Override http request option.
@@ -20824,7 +20871,7 @@ var FulfillmentApi = /** @class */ (function (_super) {
20824
20871
  return (0, exports.FulfillmentApiFp)(this.configuration).generatePackingSlip(distribution_center_code, order_id, options)(this.fetch, this.basePath);
20825
20872
  };
20826
20873
  /**
20827
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
20874
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
20828
20875
  * @summary Retrieve orders queued up for this distribution center.
20829
20876
  * @param {string} distribution_center_code Distribution center code
20830
20877
  * @param {*} [options] Override http request option.
@@ -24613,7 +24660,7 @@ var OauthApiFetchParamCreator = function (configuration) {
24613
24660
  * @param {string} client_id The OAuth application client_id.
24614
24661
  * @param {string} grant_type Type of grant
24615
24662
  * @param {string} [code] Authorization code received back from the browser redirect
24616
- * @param {string} [redirect_uri] The URI that you redirect the browser to to start the authorization process
24663
+ * @param {string} [redirect_uri] The URI that you redirect the browser to start the authorization process
24617
24664
  * @param {string} [refresh_token] The refresh token received during the original grant_type&#x3D;authorization_code that can be used to return a new access token
24618
24665
  * @param {*} [options] Override http request option.
24619
24666
  * @throws {RequiredError}
@@ -24766,7 +24813,7 @@ var OauthApiFp = function (configuration) {
24766
24813
  * @param {string} client_id The OAuth application client_id.
24767
24814
  * @param {string} grant_type Type of grant
24768
24815
  * @param {string} [code] Authorization code received back from the browser redirect
24769
- * @param {string} [redirect_uri] The URI that you redirect the browser to to start the authorization process
24816
+ * @param {string} [redirect_uri] The URI that you redirect the browser to start the authorization process
24770
24817
  * @param {string} [refresh_token] The refresh token received during the original grant_type&#x3D;authorization_code that can be used to return a new access token
24771
24818
  * @param {*} [options] Override http request option.
24772
24819
  * @throws {RequiredError}
@@ -24824,7 +24871,7 @@ var OauthApiFactory = function (configuration, fetch, basePath) {
24824
24871
  * @param {string} client_id The OAuth application client_id.
24825
24872
  * @param {string} grant_type Type of grant
24826
24873
  * @param {string} [code] Authorization code received back from the browser redirect
24827
- * @param {string} [redirect_uri] The URI that you redirect the browser to to start the authorization process
24874
+ * @param {string} [redirect_uri] The URI that you redirect the browser to start the authorization process
24828
24875
  * @param {string} [refresh_token] The refresh token received during the original grant_type&#x3D;authorization_code that can be used to return a new access token
24829
24876
  * @param {*} [options] Override http request option.
24830
24877
  * @throws {RequiredError}
@@ -24863,7 +24910,7 @@ var OauthApi = /** @class */ (function (_super) {
24863
24910
  * @param {string} client_id The OAuth application client_id.
24864
24911
  * @param {string} grant_type Type of grant
24865
24912
  * @param {string} [code] Authorization code received back from the browser redirect
24866
- * @param {string} [redirect_uri] The URI that you redirect the browser to to start the authorization process
24913
+ * @param {string} [redirect_uri] The URI that you redirect the browser to start the authorization process
24867
24914
  * @param {string} [refresh_token] The refresh token received during the original grant_type&#x3D;authorization_code that can be used to return a new access token
24868
24915
  * @param {*} [options] Override http request option.
24869
24916
  * @throws {RequiredError}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.223",
3
+ "version": "3.10.225",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [