ultracart_rest_api_v2_typescript 3.10.40 → 3.10.43
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 +5 -2
- package/api.ts +107 -8
- package/dist/api.d.ts +100 -5
- package/dist/api.js +14 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@3.10.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@3.10.43
|
|
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.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@3.10.43 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 3.10.43 | 09/02/2022 | customer editor added loyal ledger descriptions |
|
|
58
|
+
| 3.10.42 | 08/30/2022 | storefront comm fields for sms configuration |
|
|
59
|
+
| 3.10.41 | 08/26/2022 | postcard address fields for comm sequence testing |
|
|
57
60
|
| 3.10.40 | 08/22/2022 | exposing individual reviews within item.review object |
|
|
58
61
|
| 3.10.39 | 08/19/2022 | order api - added cell phone fields for sms |
|
|
59
62
|
| 3.10.38 | 08/12/2022 | internal code to allow merchant login as customer |
|
package/api.ts
CHANGED
|
@@ -10442,6 +10442,12 @@ export interface CustomerEditorValues {
|
|
|
10442
10442
|
* @memberof CustomerEditorValues
|
|
10443
10443
|
*/
|
|
10444
10444
|
countries?: Array<Country>;
|
|
10445
|
+
/**
|
|
10446
|
+
* loyalty_ledger_descriptions
|
|
10447
|
+
* @type {Array<string>}
|
|
10448
|
+
* @memberof CustomerEditorValues
|
|
10449
|
+
*/
|
|
10450
|
+
loyalty_ledger_descriptions?: Array<string>;
|
|
10445
10451
|
/**
|
|
10446
10452
|
* loyalty_program_type
|
|
10447
10453
|
* @type {string}
|
|
@@ -12123,6 +12129,18 @@ export interface EmailCampaign {
|
|
|
12123
12129
|
* @memberof EmailCampaign
|
|
12124
12130
|
*/
|
|
12125
12131
|
screenshot_large_full_url?: string;
|
|
12132
|
+
/**
|
|
12133
|
+
* Twilio Account UUID. Null for none
|
|
12134
|
+
* @type {string}
|
|
12135
|
+
* @memberof EmailCampaign
|
|
12136
|
+
*/
|
|
12137
|
+
sms_esp_twilio_uuid?: string;
|
|
12138
|
+
/**
|
|
12139
|
+
* Twilio SMS Phone Number. Null for none
|
|
12140
|
+
* @type {string}
|
|
12141
|
+
* @memberof EmailCampaign
|
|
12142
|
+
*/
|
|
12143
|
+
sms_phone_number?: string;
|
|
12126
12144
|
/**
|
|
12127
12145
|
* Status of the campaign of draft, archived, and sent
|
|
12128
12146
|
* @type {string}
|
|
@@ -13157,6 +13175,18 @@ export interface EmailCommseqResponse {
|
|
|
13157
13175
|
* @interface EmailCommseqSequenceTestRequest
|
|
13158
13176
|
*/
|
|
13159
13177
|
export interface EmailCommseqSequenceTestRequest {
|
|
13178
|
+
/**
|
|
13179
|
+
*
|
|
13180
|
+
* @type {string}
|
|
13181
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
13182
|
+
*/
|
|
13183
|
+
address_1?: string;
|
|
13184
|
+
/**
|
|
13185
|
+
*
|
|
13186
|
+
* @type {string}
|
|
13187
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
13188
|
+
*/
|
|
13189
|
+
address_2?: string;
|
|
13160
13190
|
/**
|
|
13161
13191
|
*
|
|
13162
13192
|
* @type {string}
|
|
@@ -13169,12 +13199,24 @@ export interface EmailCommseqSequenceTestRequest {
|
|
|
13169
13199
|
* @memberof EmailCommseqSequenceTestRequest
|
|
13170
13200
|
*/
|
|
13171
13201
|
cart_item_ids?: Array<string>;
|
|
13202
|
+
/**
|
|
13203
|
+
*
|
|
13204
|
+
* @type {string}
|
|
13205
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
13206
|
+
*/
|
|
13207
|
+
city?: string;
|
|
13172
13208
|
/**
|
|
13173
13209
|
*
|
|
13174
13210
|
* @type {string}
|
|
13175
13211
|
* @memberof EmailCommseqSequenceTestRequest
|
|
13176
13212
|
*/
|
|
13177
13213
|
esp_commseq_uuid?: string;
|
|
13214
|
+
/**
|
|
13215
|
+
*
|
|
13216
|
+
* @type {boolean}
|
|
13217
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
13218
|
+
*/
|
|
13219
|
+
mail_card?: boolean;
|
|
13178
13220
|
/**
|
|
13179
13221
|
*
|
|
13180
13222
|
* @type {string}
|
|
@@ -13193,6 +13235,12 @@ export interface EmailCommseqSequenceTestRequest {
|
|
|
13193
13235
|
* @memberof EmailCommseqSequenceTestRequest
|
|
13194
13236
|
*/
|
|
13195
13237
|
please_review?: boolean;
|
|
13238
|
+
/**
|
|
13239
|
+
*
|
|
13240
|
+
* @type {string}
|
|
13241
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
13242
|
+
*/
|
|
13243
|
+
postal_code?: string;
|
|
13196
13244
|
/**
|
|
13197
13245
|
*
|
|
13198
13246
|
* @type {string}
|
|
@@ -13205,6 +13253,12 @@ export interface EmailCommseqSequenceTestRequest {
|
|
|
13205
13253
|
* @memberof EmailCommseqSequenceTestRequest
|
|
13206
13254
|
*/
|
|
13207
13255
|
send_to_logged_in_user?: boolean;
|
|
13256
|
+
/**
|
|
13257
|
+
*
|
|
13258
|
+
* @type {string}
|
|
13259
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
13260
|
+
*/
|
|
13261
|
+
state?: string;
|
|
13208
13262
|
}
|
|
13209
13263
|
|
|
13210
13264
|
/**
|
|
@@ -14316,6 +14370,18 @@ export interface EmailFlow {
|
|
|
14316
14370
|
* @memberof EmailFlow
|
|
14317
14371
|
*/
|
|
14318
14372
|
screenshot_large_full_url?: string;
|
|
14373
|
+
/**
|
|
14374
|
+
* Twilio Account UUID. Null for none
|
|
14375
|
+
* @type {string}
|
|
14376
|
+
* @memberof EmailFlow
|
|
14377
|
+
*/
|
|
14378
|
+
sms_esp_twilio_uuid?: string;
|
|
14379
|
+
/**
|
|
14380
|
+
* Twilio SMS Phone Number. Null for none
|
|
14381
|
+
* @type {string}
|
|
14382
|
+
* @memberof EmailFlow
|
|
14383
|
+
*/
|
|
14384
|
+
sms_phone_number?: string;
|
|
14319
14385
|
/**
|
|
14320
14386
|
* Status of the campaign of draft, archived, active, and inactive
|
|
14321
14387
|
* @type {string}
|
|
@@ -16452,6 +16518,18 @@ export interface EmailSettings {
|
|
|
16452
16518
|
* @memberof EmailSettings
|
|
16453
16519
|
*/
|
|
16454
16520
|
postcard_from_state?: string;
|
|
16521
|
+
/**
|
|
16522
|
+
*
|
|
16523
|
+
* @type {string}
|
|
16524
|
+
* @memberof EmailSettings
|
|
16525
|
+
*/
|
|
16526
|
+
sms_esp_twilio_uuid?: string;
|
|
16527
|
+
/**
|
|
16528
|
+
*
|
|
16529
|
+
* @type {string}
|
|
16530
|
+
* @memberof EmailSettings
|
|
16531
|
+
*/
|
|
16532
|
+
sms_phone_number?: string;
|
|
16455
16533
|
/**
|
|
16456
16534
|
*
|
|
16457
16535
|
* @type {string}
|
|
@@ -17824,6 +17902,12 @@ export interface ExperimentVariation {
|
|
|
17824
17902
|
* @memberof ExperimentVariation
|
|
17825
17903
|
*/
|
|
17826
17904
|
session_count?: number;
|
|
17905
|
+
/**
|
|
17906
|
+
* SMS Opt Ins for this variation
|
|
17907
|
+
* @type {number}
|
|
17908
|
+
* @memberof ExperimentVariation
|
|
17909
|
+
*/
|
|
17910
|
+
sms_opt_ins?: number;
|
|
17827
17911
|
/**
|
|
17828
17912
|
* Percentage of the traffic this variation is currently receiving
|
|
17829
17913
|
* @type {number}
|
|
@@ -17922,6 +18006,12 @@ export interface ExperimentVariationStat {
|
|
|
17922
18006
|
* @memberof ExperimentVariationStat
|
|
17923
18007
|
*/
|
|
17924
18008
|
session_count?: number;
|
|
18009
|
+
/**
|
|
18010
|
+
* Total SMS opt in count for this variation
|
|
18011
|
+
* @type {number}
|
|
18012
|
+
* @memberof ExperimentVariationStat
|
|
18013
|
+
*/
|
|
18014
|
+
sms_opt_in_count?: number;
|
|
17925
18015
|
/**
|
|
17926
18016
|
* Date/time that the statistic was created
|
|
17927
18017
|
* @type {string}
|
|
@@ -50499,11 +50589,12 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
50499
50589
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
50500
50590
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
50501
50591
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
50592
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
50502
50593
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
50503
50594
|
* @param {*} [options] Override http request option.
|
|
50504
50595
|
* @throws {RequiredError}
|
|
50505
50596
|
*/
|
|
50506
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, _expand?: string, options: any = {}): FetchArgs {
|
|
50597
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options: any = {}): FetchArgs {
|
|
50507
50598
|
// verify required parameter 'order' is not null or undefined
|
|
50508
50599
|
if (order === null || order === undefined) {
|
|
50509
50600
|
throw new RequiredError('order','Required parameter order was null or undefined when calling refundOrder.');
|
|
@@ -50562,6 +50653,10 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
50562
50653
|
localVarQueryParameter['reverse_affiliate_transactions'] = reverse_affiliate_transactions;
|
|
50563
50654
|
}
|
|
50564
50655
|
|
|
50656
|
+
if (issue_store_credit !== undefined) {
|
|
50657
|
+
localVarQueryParameter['issue_store_credit'] = issue_store_credit;
|
|
50658
|
+
}
|
|
50659
|
+
|
|
50565
50660
|
if (_expand !== undefined) {
|
|
50566
50661
|
localVarQueryParameter['_expand'] = _expand;
|
|
50567
50662
|
}
|
|
@@ -51285,12 +51380,13 @@ export const OrderApiFp = function(configuration?: Configuration) {
|
|
|
51285
51380
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
51286
51381
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
51287
51382
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
51383
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
51288
51384
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
51289
51385
|
* @param {*} [options] Override http request option.
|
|
51290
51386
|
* @throws {RequiredError}
|
|
51291
51387
|
*/
|
|
51292
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse> {
|
|
51293
|
-
const localVarFetchArgs = OrderApiFetchParamCreator(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, _expand, options);
|
|
51388
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse> {
|
|
51389
|
+
const localVarFetchArgs = OrderApiFetchParamCreator(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options);
|
|
51294
51390
|
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
51295
51391
|
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
51296
51392
|
|
|
@@ -51643,12 +51739,13 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
|
|
|
51643
51739
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
51644
51740
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
51645
51741
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
51742
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
51646
51743
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
51647
51744
|
* @param {*} [options] Override http request option.
|
|
51648
51745
|
* @throws {RequiredError}
|
|
51649
51746
|
*/
|
|
51650
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, _expand?: string, options?: any) {
|
|
51651
|
-
return OrderApiFp(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, _expand, options)(fetch, basePath);
|
|
51747
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any) {
|
|
51748
|
+
return OrderApiFp(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options)(fetch, basePath);
|
|
51652
51749
|
},
|
|
51653
51750
|
/**
|
|
51654
51751
|
* Create a replacement order based upon a previous order
|
|
@@ -51935,12 +52032,13 @@ export interface OrderApiInterface {
|
|
|
51935
52032
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
51936
52033
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
51937
52034
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
52035
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
51938
52036
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
51939
52037
|
* @param {*} [options] Override http request option.
|
|
51940
52038
|
* @throws {RequiredError}
|
|
51941
52039
|
* @memberof OrderApiInterface
|
|
51942
52040
|
*/
|
|
51943
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
52041
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
51944
52042
|
|
|
51945
52043
|
/**
|
|
51946
52044
|
* Create a replacement order based upon a previous order
|
|
@@ -52261,13 +52359,14 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
52261
52359
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
52262
52360
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
52263
52361
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
52362
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
52264
52363
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
52265
52364
|
* @param {*} [options] Override http request option.
|
|
52266
52365
|
* @throws {RequiredError}
|
|
52267
52366
|
* @memberof OrderApi
|
|
52268
52367
|
*/
|
|
52269
|
-
public refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, _expand?: string, options?: any) {
|
|
52270
|
-
return OrderApiFp(this.configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, _expand, options)(this.fetch, this.basePath);
|
|
52368
|
+
public refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any) {
|
|
52369
|
+
return OrderApiFp(this.configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options)(this.fetch, this.basePath);
|
|
52271
52370
|
}
|
|
52272
52371
|
|
|
52273
52372
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -10192,6 +10192,12 @@ export interface CustomerEditorValues {
|
|
|
10192
10192
|
* @memberof CustomerEditorValues
|
|
10193
10193
|
*/
|
|
10194
10194
|
countries?: Array<Country>;
|
|
10195
|
+
/**
|
|
10196
|
+
* loyalty_ledger_descriptions
|
|
10197
|
+
* @type {Array<string>}
|
|
10198
|
+
* @memberof CustomerEditorValues
|
|
10199
|
+
*/
|
|
10200
|
+
loyalty_ledger_descriptions?: Array<string>;
|
|
10195
10201
|
/**
|
|
10196
10202
|
* loyalty_program_type
|
|
10197
10203
|
* @type {string}
|
|
@@ -11843,6 +11849,18 @@ export interface EmailCampaign {
|
|
|
11843
11849
|
* @memberof EmailCampaign
|
|
11844
11850
|
*/
|
|
11845
11851
|
screenshot_large_full_url?: string;
|
|
11852
|
+
/**
|
|
11853
|
+
* Twilio Account UUID. Null for none
|
|
11854
|
+
* @type {string}
|
|
11855
|
+
* @memberof EmailCampaign
|
|
11856
|
+
*/
|
|
11857
|
+
sms_esp_twilio_uuid?: string;
|
|
11858
|
+
/**
|
|
11859
|
+
* Twilio SMS Phone Number. Null for none
|
|
11860
|
+
* @type {string}
|
|
11861
|
+
* @memberof EmailCampaign
|
|
11862
|
+
*/
|
|
11863
|
+
sms_phone_number?: string;
|
|
11846
11864
|
/**
|
|
11847
11865
|
* Status of the campaign of draft, archived, and sent
|
|
11848
11866
|
* @type {string}
|
|
@@ -12855,6 +12873,18 @@ export interface EmailCommseqResponse {
|
|
|
12855
12873
|
* @interface EmailCommseqSequenceTestRequest
|
|
12856
12874
|
*/
|
|
12857
12875
|
export interface EmailCommseqSequenceTestRequest {
|
|
12876
|
+
/**
|
|
12877
|
+
*
|
|
12878
|
+
* @type {string}
|
|
12879
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
12880
|
+
*/
|
|
12881
|
+
address_1?: string;
|
|
12882
|
+
/**
|
|
12883
|
+
*
|
|
12884
|
+
* @type {string}
|
|
12885
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
12886
|
+
*/
|
|
12887
|
+
address_2?: string;
|
|
12858
12888
|
/**
|
|
12859
12889
|
*
|
|
12860
12890
|
* @type {string}
|
|
@@ -12867,12 +12897,24 @@ export interface EmailCommseqSequenceTestRequest {
|
|
|
12867
12897
|
* @memberof EmailCommseqSequenceTestRequest
|
|
12868
12898
|
*/
|
|
12869
12899
|
cart_item_ids?: Array<string>;
|
|
12900
|
+
/**
|
|
12901
|
+
*
|
|
12902
|
+
* @type {string}
|
|
12903
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
12904
|
+
*/
|
|
12905
|
+
city?: string;
|
|
12870
12906
|
/**
|
|
12871
12907
|
*
|
|
12872
12908
|
* @type {string}
|
|
12873
12909
|
* @memberof EmailCommseqSequenceTestRequest
|
|
12874
12910
|
*/
|
|
12875
12911
|
esp_commseq_uuid?: string;
|
|
12912
|
+
/**
|
|
12913
|
+
*
|
|
12914
|
+
* @type {boolean}
|
|
12915
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
12916
|
+
*/
|
|
12917
|
+
mail_card?: boolean;
|
|
12876
12918
|
/**
|
|
12877
12919
|
*
|
|
12878
12920
|
* @type {string}
|
|
@@ -12891,6 +12933,12 @@ export interface EmailCommseqSequenceTestRequest {
|
|
|
12891
12933
|
* @memberof EmailCommseqSequenceTestRequest
|
|
12892
12934
|
*/
|
|
12893
12935
|
please_review?: boolean;
|
|
12936
|
+
/**
|
|
12937
|
+
*
|
|
12938
|
+
* @type {string}
|
|
12939
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
12940
|
+
*/
|
|
12941
|
+
postal_code?: string;
|
|
12894
12942
|
/**
|
|
12895
12943
|
*
|
|
12896
12944
|
* @type {string}
|
|
@@ -12903,6 +12951,12 @@ export interface EmailCommseqSequenceTestRequest {
|
|
|
12903
12951
|
* @memberof EmailCommseqSequenceTestRequest
|
|
12904
12952
|
*/
|
|
12905
12953
|
send_to_logged_in_user?: boolean;
|
|
12954
|
+
/**
|
|
12955
|
+
*
|
|
12956
|
+
* @type {string}
|
|
12957
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
12958
|
+
*/
|
|
12959
|
+
state?: string;
|
|
12906
12960
|
}
|
|
12907
12961
|
/**
|
|
12908
12962
|
*
|
|
@@ -13995,6 +14049,18 @@ export interface EmailFlow {
|
|
|
13995
14049
|
* @memberof EmailFlow
|
|
13996
14050
|
*/
|
|
13997
14051
|
screenshot_large_full_url?: string;
|
|
14052
|
+
/**
|
|
14053
|
+
* Twilio Account UUID. Null for none
|
|
14054
|
+
* @type {string}
|
|
14055
|
+
* @memberof EmailFlow
|
|
14056
|
+
*/
|
|
14057
|
+
sms_esp_twilio_uuid?: string;
|
|
14058
|
+
/**
|
|
14059
|
+
* Twilio SMS Phone Number. Null for none
|
|
14060
|
+
* @type {string}
|
|
14061
|
+
* @memberof EmailFlow
|
|
14062
|
+
*/
|
|
14063
|
+
sms_phone_number?: string;
|
|
13998
14064
|
/**
|
|
13999
14065
|
* Status of the campaign of draft, archived, active, and inactive
|
|
14000
14066
|
* @type {string}
|
|
@@ -16084,6 +16150,18 @@ export interface EmailSettings {
|
|
|
16084
16150
|
* @memberof EmailSettings
|
|
16085
16151
|
*/
|
|
16086
16152
|
postcard_from_state?: string;
|
|
16153
|
+
/**
|
|
16154
|
+
*
|
|
16155
|
+
* @type {string}
|
|
16156
|
+
* @memberof EmailSettings
|
|
16157
|
+
*/
|
|
16158
|
+
sms_esp_twilio_uuid?: string;
|
|
16159
|
+
/**
|
|
16160
|
+
*
|
|
16161
|
+
* @type {string}
|
|
16162
|
+
* @memberof EmailSettings
|
|
16163
|
+
*/
|
|
16164
|
+
sms_phone_number?: string;
|
|
16087
16165
|
/**
|
|
16088
16166
|
*
|
|
16089
16167
|
* @type {string}
|
|
@@ -17428,6 +17506,12 @@ export interface ExperimentVariation {
|
|
|
17428
17506
|
* @memberof ExperimentVariation
|
|
17429
17507
|
*/
|
|
17430
17508
|
session_count?: number;
|
|
17509
|
+
/**
|
|
17510
|
+
* SMS Opt Ins for this variation
|
|
17511
|
+
* @type {number}
|
|
17512
|
+
* @memberof ExperimentVariation
|
|
17513
|
+
*/
|
|
17514
|
+
sms_opt_ins?: number;
|
|
17431
17515
|
/**
|
|
17432
17516
|
* Percentage of the traffic this variation is currently receiving
|
|
17433
17517
|
* @type {number}
|
|
@@ -17525,6 +17609,12 @@ export interface ExperimentVariationStat {
|
|
|
17525
17609
|
* @memberof ExperimentVariationStat
|
|
17526
17610
|
*/
|
|
17527
17611
|
session_count?: number;
|
|
17612
|
+
/**
|
|
17613
|
+
* Total SMS opt in count for this variation
|
|
17614
|
+
* @type {number}
|
|
17615
|
+
* @memberof ExperimentVariationStat
|
|
17616
|
+
*/
|
|
17617
|
+
sms_opt_in_count?: number;
|
|
17528
17618
|
/**
|
|
17529
17619
|
* Date/time that the statistic was created
|
|
17530
17620
|
* @type {string}
|
|
@@ -40269,11 +40359,12 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
|
|
|
40269
40359
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
40270
40360
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
40271
40361
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
40362
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
40272
40363
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
40273
40364
|
* @param {*} [options] Override http request option.
|
|
40274
40365
|
* @throws {RequiredError}
|
|
40275
40366
|
*/
|
|
40276
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, _expand?: string, options?: any): FetchArgs;
|
|
40367
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): FetchArgs;
|
|
40277
40368
|
/**
|
|
40278
40369
|
* Create a replacement order based upon a previous order
|
|
40279
40370
|
* @summary Replacement order
|
|
@@ -40512,11 +40603,12 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
|
|
|
40512
40603
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
40513
40604
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
40514
40605
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
40606
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
40515
40607
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
40516
40608
|
* @param {*} [options] Override http request option.
|
|
40517
40609
|
* @throws {RequiredError}
|
|
40518
40610
|
*/
|
|
40519
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse>;
|
|
40611
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse>;
|
|
40520
40612
|
/**
|
|
40521
40613
|
* Create a replacement order based upon a previous order
|
|
40522
40614
|
* @summary Replacement order
|
|
@@ -40755,11 +40847,12 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
|
|
|
40755
40847
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
40756
40848
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
40757
40849
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
40850
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
40758
40851
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
40759
40852
|
* @param {*} [options] Override http request option.
|
|
40760
40853
|
* @throws {RequiredError}
|
|
40761
40854
|
*/
|
|
40762
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
40855
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
40763
40856
|
/**
|
|
40764
40857
|
* Create a replacement order based upon a previous order
|
|
40765
40858
|
* @summary Replacement order
|
|
@@ -41016,12 +41109,13 @@ export interface OrderApiInterface {
|
|
|
41016
41109
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
41017
41110
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
41018
41111
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
41112
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
41019
41113
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
41020
41114
|
* @param {*} [options] Override http request option.
|
|
41021
41115
|
* @throws {RequiredError}
|
|
41022
41116
|
* @memberof OrderApiInterface
|
|
41023
41117
|
*/
|
|
41024
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
41118
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
41025
41119
|
/**
|
|
41026
41120
|
* Create a replacement order based upon a previous order
|
|
41027
41121
|
* @summary Replacement order
|
|
@@ -41284,12 +41378,13 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
41284
41378
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
41285
41379
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
41286
41380
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
41381
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
41287
41382
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
41288
41383
|
* @param {*} [options] Override http request option.
|
|
41289
41384
|
* @throws {RequiredError}
|
|
41290
41385
|
* @memberof OrderApi
|
|
41291
41386
|
*/
|
|
41292
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
41387
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
41293
41388
|
/**
|
|
41294
41389
|
* Create a replacement order based upon a previous order
|
|
41295
41390
|
* @summary Replacement order
|
package/dist/api.js
CHANGED
|
@@ -14540,11 +14540,12 @@ var OrderApiFetchParamCreator = function (configuration) {
|
|
|
14540
14540
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
14541
14541
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
14542
14542
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
14543
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
14543
14544
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
14544
14545
|
* @param {*} [options] Override http request option.
|
|
14545
14546
|
* @throws {RequiredError}
|
|
14546
14547
|
*/
|
|
14547
|
-
refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, _expand, options) {
|
|
14548
|
+
refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options) {
|
|
14548
14549
|
if (options === void 0) { options = {}; }
|
|
14549
14550
|
// verify required parameter 'order' is not null or undefined
|
|
14550
14551
|
if (order === null || order === undefined) {
|
|
@@ -14593,6 +14594,9 @@ var OrderApiFetchParamCreator = function (configuration) {
|
|
|
14593
14594
|
if (reverse_affiliate_transactions !== undefined) {
|
|
14594
14595
|
localVarQueryParameter['reverse_affiliate_transactions'] = reverse_affiliate_transactions;
|
|
14595
14596
|
}
|
|
14597
|
+
if (issue_store_credit !== undefined) {
|
|
14598
|
+
localVarQueryParameter['issue_store_credit'] = issue_store_credit;
|
|
14599
|
+
}
|
|
14596
14600
|
if (_expand !== undefined) {
|
|
14597
14601
|
localVarQueryParameter['_expand'] = _expand;
|
|
14598
14602
|
}
|
|
@@ -15296,12 +15300,13 @@ var OrderApiFp = function (configuration) {
|
|
|
15296
15300
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
15297
15301
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
15298
15302
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
15303
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
15299
15304
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
15300
15305
|
* @param {*} [options] Override http request option.
|
|
15301
15306
|
* @throws {RequiredError}
|
|
15302
15307
|
*/
|
|
15303
|
-
refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, _expand, options) {
|
|
15304
|
-
var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, _expand, options);
|
|
15308
|
+
refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options) {
|
|
15309
|
+
var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options);
|
|
15305
15310
|
return function (fetch, basePath) {
|
|
15306
15311
|
if (fetch === void 0) { fetch = portableFetch; }
|
|
15307
15312
|
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
@@ -15660,12 +15665,13 @@ var OrderApiFactory = function (configuration, fetch, basePath) {
|
|
|
15660
15665
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
15661
15666
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
15662
15667
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
15668
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
15663
15669
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
15664
15670
|
* @param {*} [options] Override http request option.
|
|
15665
15671
|
* @throws {RequiredError}
|
|
15666
15672
|
*/
|
|
15667
|
-
refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, _expand, options) {
|
|
15668
|
-
return (0, exports.OrderApiFp)(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, _expand, options)(fetch, basePath);
|
|
15673
|
+
refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options) {
|
|
15674
|
+
return (0, exports.OrderApiFp)(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options)(fetch, basePath);
|
|
15669
15675
|
},
|
|
15670
15676
|
/**
|
|
15671
15677
|
* Create a replacement order based upon a previous order
|
|
@@ -15974,13 +15980,14 @@ var OrderApi = /** @class */ (function (_super) {
|
|
|
15974
15980
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
15975
15981
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
15976
15982
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
15983
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
15977
15984
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
15978
15985
|
* @param {*} [options] Override http request option.
|
|
15979
15986
|
* @throws {RequiredError}
|
|
15980
15987
|
* @memberof OrderApi
|
|
15981
15988
|
*/
|
|
15982
|
-
OrderApi.prototype.refundOrder = function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, _expand, options) {
|
|
15983
|
-
return (0, exports.OrderApiFp)(this.configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, _expand, options)(this.fetch, this.basePath);
|
|
15989
|
+
OrderApi.prototype.refundOrder = function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options) {
|
|
15990
|
+
return (0, exports.OrderApiFp)(this.configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options)(this.fetch, this.basePath);
|
|
15984
15991
|
};
|
|
15985
15992
|
/**
|
|
15986
15993
|
* Create a replacement order based upon a previous order
|