ultracart_rest_api_v2_typescript 3.10.39 → 3.10.42
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 +337 -8
- package/dist/api.d.ts +329 -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.42
|
|
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.42 --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.42 | 08/30/2022 | storefront comm fields for sms configuration |
|
|
58
|
+
| 3.10.41 | 08/26/2022 | postcard address fields for comm sequence testing |
|
|
59
|
+
| 3.10.40 | 08/22/2022 | exposing individual reviews within item.review object |
|
|
57
60
|
| 3.10.39 | 08/19/2022 | order api - added cell phone fields for sms |
|
|
58
61
|
| 3.10.38 | 08/12/2022 | internal code to allow merchant login as customer |
|
|
59
62
|
| 3.10.37 | 08/11/2022 | fix entry_dts type on gift certificate ledger |
|
package/api.ts
CHANGED
|
@@ -12123,6 +12123,18 @@ export interface EmailCampaign {
|
|
|
12123
12123
|
* @memberof EmailCampaign
|
|
12124
12124
|
*/
|
|
12125
12125
|
screenshot_large_full_url?: string;
|
|
12126
|
+
/**
|
|
12127
|
+
* Twilio Account UUID. Null for none
|
|
12128
|
+
* @type {string}
|
|
12129
|
+
* @memberof EmailCampaign
|
|
12130
|
+
*/
|
|
12131
|
+
sms_esp_twilio_uuid?: string;
|
|
12132
|
+
/**
|
|
12133
|
+
* Twilio SMS Phone Number. Null for none
|
|
12134
|
+
* @type {string}
|
|
12135
|
+
* @memberof EmailCampaign
|
|
12136
|
+
*/
|
|
12137
|
+
sms_phone_number?: string;
|
|
12126
12138
|
/**
|
|
12127
12139
|
* Status of the campaign of draft, archived, and sent
|
|
12128
12140
|
* @type {string}
|
|
@@ -13157,6 +13169,18 @@ export interface EmailCommseqResponse {
|
|
|
13157
13169
|
* @interface EmailCommseqSequenceTestRequest
|
|
13158
13170
|
*/
|
|
13159
13171
|
export interface EmailCommseqSequenceTestRequest {
|
|
13172
|
+
/**
|
|
13173
|
+
*
|
|
13174
|
+
* @type {string}
|
|
13175
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
13176
|
+
*/
|
|
13177
|
+
address_1?: string;
|
|
13178
|
+
/**
|
|
13179
|
+
*
|
|
13180
|
+
* @type {string}
|
|
13181
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
13182
|
+
*/
|
|
13183
|
+
address_2?: string;
|
|
13160
13184
|
/**
|
|
13161
13185
|
*
|
|
13162
13186
|
* @type {string}
|
|
@@ -13169,12 +13193,24 @@ export interface EmailCommseqSequenceTestRequest {
|
|
|
13169
13193
|
* @memberof EmailCommseqSequenceTestRequest
|
|
13170
13194
|
*/
|
|
13171
13195
|
cart_item_ids?: Array<string>;
|
|
13196
|
+
/**
|
|
13197
|
+
*
|
|
13198
|
+
* @type {string}
|
|
13199
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
13200
|
+
*/
|
|
13201
|
+
city?: string;
|
|
13172
13202
|
/**
|
|
13173
13203
|
*
|
|
13174
13204
|
* @type {string}
|
|
13175
13205
|
* @memberof EmailCommseqSequenceTestRequest
|
|
13176
13206
|
*/
|
|
13177
13207
|
esp_commseq_uuid?: string;
|
|
13208
|
+
/**
|
|
13209
|
+
*
|
|
13210
|
+
* @type {boolean}
|
|
13211
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
13212
|
+
*/
|
|
13213
|
+
mail_card?: boolean;
|
|
13178
13214
|
/**
|
|
13179
13215
|
*
|
|
13180
13216
|
* @type {string}
|
|
@@ -13193,6 +13229,12 @@ export interface EmailCommseqSequenceTestRequest {
|
|
|
13193
13229
|
* @memberof EmailCommseqSequenceTestRequest
|
|
13194
13230
|
*/
|
|
13195
13231
|
please_review?: boolean;
|
|
13232
|
+
/**
|
|
13233
|
+
*
|
|
13234
|
+
* @type {string}
|
|
13235
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
13236
|
+
*/
|
|
13237
|
+
postal_code?: string;
|
|
13196
13238
|
/**
|
|
13197
13239
|
*
|
|
13198
13240
|
* @type {string}
|
|
@@ -13205,6 +13247,12 @@ export interface EmailCommseqSequenceTestRequest {
|
|
|
13205
13247
|
* @memberof EmailCommseqSequenceTestRequest
|
|
13206
13248
|
*/
|
|
13207
13249
|
send_to_logged_in_user?: boolean;
|
|
13250
|
+
/**
|
|
13251
|
+
*
|
|
13252
|
+
* @type {string}
|
|
13253
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
13254
|
+
*/
|
|
13255
|
+
state?: string;
|
|
13208
13256
|
}
|
|
13209
13257
|
|
|
13210
13258
|
/**
|
|
@@ -14316,6 +14364,18 @@ export interface EmailFlow {
|
|
|
14316
14364
|
* @memberof EmailFlow
|
|
14317
14365
|
*/
|
|
14318
14366
|
screenshot_large_full_url?: string;
|
|
14367
|
+
/**
|
|
14368
|
+
* Twilio Account UUID. Null for none
|
|
14369
|
+
* @type {string}
|
|
14370
|
+
* @memberof EmailFlow
|
|
14371
|
+
*/
|
|
14372
|
+
sms_esp_twilio_uuid?: string;
|
|
14373
|
+
/**
|
|
14374
|
+
* Twilio SMS Phone Number. Null for none
|
|
14375
|
+
* @type {string}
|
|
14376
|
+
* @memberof EmailFlow
|
|
14377
|
+
*/
|
|
14378
|
+
sms_phone_number?: string;
|
|
14319
14379
|
/**
|
|
14320
14380
|
* Status of the campaign of draft, archived, active, and inactive
|
|
14321
14381
|
* @type {string}
|
|
@@ -16452,6 +16512,18 @@ export interface EmailSettings {
|
|
|
16452
16512
|
* @memberof EmailSettings
|
|
16453
16513
|
*/
|
|
16454
16514
|
postcard_from_state?: string;
|
|
16515
|
+
/**
|
|
16516
|
+
*
|
|
16517
|
+
* @type {string}
|
|
16518
|
+
* @memberof EmailSettings
|
|
16519
|
+
*/
|
|
16520
|
+
sms_esp_twilio_uuid?: string;
|
|
16521
|
+
/**
|
|
16522
|
+
*
|
|
16523
|
+
* @type {string}
|
|
16524
|
+
* @memberof EmailSettings
|
|
16525
|
+
*/
|
|
16526
|
+
sms_phone_number?: string;
|
|
16455
16527
|
/**
|
|
16456
16528
|
*
|
|
16457
16529
|
* @type {string}
|
|
@@ -17824,6 +17896,12 @@ export interface ExperimentVariation {
|
|
|
17824
17896
|
* @memberof ExperimentVariation
|
|
17825
17897
|
*/
|
|
17826
17898
|
session_count?: number;
|
|
17899
|
+
/**
|
|
17900
|
+
* SMS Opt Ins for this variation
|
|
17901
|
+
* @type {number}
|
|
17902
|
+
* @memberof ExperimentVariation
|
|
17903
|
+
*/
|
|
17904
|
+
sms_opt_ins?: number;
|
|
17827
17905
|
/**
|
|
17828
17906
|
* Percentage of the traffic this variation is currently receiving
|
|
17829
17907
|
* @type {number}
|
|
@@ -17922,6 +18000,12 @@ export interface ExperimentVariationStat {
|
|
|
17922
18000
|
* @memberof ExperimentVariationStat
|
|
17923
18001
|
*/
|
|
17924
18002
|
session_count?: number;
|
|
18003
|
+
/**
|
|
18004
|
+
* Total SMS opt in count for this variation
|
|
18005
|
+
* @type {number}
|
|
18006
|
+
* @memberof ExperimentVariationStat
|
|
18007
|
+
*/
|
|
18008
|
+
sms_opt_in_count?: number;
|
|
17925
18009
|
/**
|
|
17926
18010
|
* Date/time that the statistic was created
|
|
17927
18011
|
* @type {string}
|
|
@@ -22376,6 +22460,236 @@ export interface ItemRevguard {
|
|
|
22376
22460
|
revguard_web_prompt_group?: number;
|
|
22377
22461
|
}
|
|
22378
22462
|
|
|
22463
|
+
/**
|
|
22464
|
+
*
|
|
22465
|
+
* @export
|
|
22466
|
+
* @interface ItemReview
|
|
22467
|
+
*/
|
|
22468
|
+
export interface ItemReview {
|
|
22469
|
+
/**
|
|
22470
|
+
* Customer profile object identifier
|
|
22471
|
+
* @type {number}
|
|
22472
|
+
* @memberof ItemReview
|
|
22473
|
+
*/
|
|
22474
|
+
customer_profile_oid?: number;
|
|
22475
|
+
/**
|
|
22476
|
+
*
|
|
22477
|
+
* @type {boolean}
|
|
22478
|
+
* @memberof ItemReview
|
|
22479
|
+
*/
|
|
22480
|
+
featured?: boolean;
|
|
22481
|
+
/**
|
|
22482
|
+
*
|
|
22483
|
+
* @type {number}
|
|
22484
|
+
* @memberof ItemReview
|
|
22485
|
+
*/
|
|
22486
|
+
helperful_no_votes?: number;
|
|
22487
|
+
/**
|
|
22488
|
+
*
|
|
22489
|
+
* @type {number}
|
|
22490
|
+
* @memberof ItemReview
|
|
22491
|
+
*/
|
|
22492
|
+
helpful_yes_votes?: number;
|
|
22493
|
+
/**
|
|
22494
|
+
*
|
|
22495
|
+
* @type {string}
|
|
22496
|
+
* @memberof ItemReview
|
|
22497
|
+
*/
|
|
22498
|
+
order_id?: string;
|
|
22499
|
+
/**
|
|
22500
|
+
*
|
|
22501
|
+
* @type {number}
|
|
22502
|
+
* @memberof ItemReview
|
|
22503
|
+
*/
|
|
22504
|
+
overall?: number;
|
|
22505
|
+
/**
|
|
22506
|
+
*
|
|
22507
|
+
* @type {string}
|
|
22508
|
+
* @memberof ItemReview
|
|
22509
|
+
*/
|
|
22510
|
+
rating_name1?: string;
|
|
22511
|
+
/**
|
|
22512
|
+
*
|
|
22513
|
+
* @type {string}
|
|
22514
|
+
* @memberof ItemReview
|
|
22515
|
+
*/
|
|
22516
|
+
rating_name10?: string;
|
|
22517
|
+
/**
|
|
22518
|
+
*
|
|
22519
|
+
* @type {string}
|
|
22520
|
+
* @memberof ItemReview
|
|
22521
|
+
*/
|
|
22522
|
+
rating_name2?: string;
|
|
22523
|
+
/**
|
|
22524
|
+
*
|
|
22525
|
+
* @type {string}
|
|
22526
|
+
* @memberof ItemReview
|
|
22527
|
+
*/
|
|
22528
|
+
rating_name3?: string;
|
|
22529
|
+
/**
|
|
22530
|
+
*
|
|
22531
|
+
* @type {string}
|
|
22532
|
+
* @memberof ItemReview
|
|
22533
|
+
*/
|
|
22534
|
+
rating_name4?: string;
|
|
22535
|
+
/**
|
|
22536
|
+
*
|
|
22537
|
+
* @type {string}
|
|
22538
|
+
* @memberof ItemReview
|
|
22539
|
+
*/
|
|
22540
|
+
rating_name5?: string;
|
|
22541
|
+
/**
|
|
22542
|
+
*
|
|
22543
|
+
* @type {string}
|
|
22544
|
+
* @memberof ItemReview
|
|
22545
|
+
*/
|
|
22546
|
+
rating_name6?: string;
|
|
22547
|
+
/**
|
|
22548
|
+
*
|
|
22549
|
+
* @type {string}
|
|
22550
|
+
* @memberof ItemReview
|
|
22551
|
+
*/
|
|
22552
|
+
rating_name7?: string;
|
|
22553
|
+
/**
|
|
22554
|
+
*
|
|
22555
|
+
* @type {string}
|
|
22556
|
+
* @memberof ItemReview
|
|
22557
|
+
*/
|
|
22558
|
+
rating_name8?: string;
|
|
22559
|
+
/**
|
|
22560
|
+
*
|
|
22561
|
+
* @type {string}
|
|
22562
|
+
* @memberof ItemReview
|
|
22563
|
+
*/
|
|
22564
|
+
rating_name9?: string;
|
|
22565
|
+
/**
|
|
22566
|
+
*
|
|
22567
|
+
* @type {number}
|
|
22568
|
+
* @memberof ItemReview
|
|
22569
|
+
*/
|
|
22570
|
+
rating_score1?: number;
|
|
22571
|
+
/**
|
|
22572
|
+
*
|
|
22573
|
+
* @type {number}
|
|
22574
|
+
* @memberof ItemReview
|
|
22575
|
+
*/
|
|
22576
|
+
rating_score10?: number;
|
|
22577
|
+
/**
|
|
22578
|
+
*
|
|
22579
|
+
* @type {number}
|
|
22580
|
+
* @memberof ItemReview
|
|
22581
|
+
*/
|
|
22582
|
+
rating_score2?: number;
|
|
22583
|
+
/**
|
|
22584
|
+
*
|
|
22585
|
+
* @type {number}
|
|
22586
|
+
* @memberof ItemReview
|
|
22587
|
+
*/
|
|
22588
|
+
rating_score3?: number;
|
|
22589
|
+
/**
|
|
22590
|
+
*
|
|
22591
|
+
* @type {number}
|
|
22592
|
+
* @memberof ItemReview
|
|
22593
|
+
*/
|
|
22594
|
+
rating_score4?: number;
|
|
22595
|
+
/**
|
|
22596
|
+
*
|
|
22597
|
+
* @type {number}
|
|
22598
|
+
* @memberof ItemReview
|
|
22599
|
+
*/
|
|
22600
|
+
rating_score5?: number;
|
|
22601
|
+
/**
|
|
22602
|
+
*
|
|
22603
|
+
* @type {number}
|
|
22604
|
+
* @memberof ItemReview
|
|
22605
|
+
*/
|
|
22606
|
+
rating_score6?: number;
|
|
22607
|
+
/**
|
|
22608
|
+
*
|
|
22609
|
+
* @type {number}
|
|
22610
|
+
* @memberof ItemReview
|
|
22611
|
+
*/
|
|
22612
|
+
rating_score7?: number;
|
|
22613
|
+
/**
|
|
22614
|
+
*
|
|
22615
|
+
* @type {number}
|
|
22616
|
+
* @memberof ItemReview
|
|
22617
|
+
*/
|
|
22618
|
+
rating_score8?: number;
|
|
22619
|
+
/**
|
|
22620
|
+
*
|
|
22621
|
+
* @type {number}
|
|
22622
|
+
* @memberof ItemReview
|
|
22623
|
+
*/
|
|
22624
|
+
rating_score9?: number;
|
|
22625
|
+
/**
|
|
22626
|
+
*
|
|
22627
|
+
* @type {number}
|
|
22628
|
+
* @memberof ItemReview
|
|
22629
|
+
*/
|
|
22630
|
+
recommend_store_to_friend?: number;
|
|
22631
|
+
/**
|
|
22632
|
+
*
|
|
22633
|
+
* @type {boolean}
|
|
22634
|
+
* @memberof ItemReview
|
|
22635
|
+
*/
|
|
22636
|
+
recommend_to_friend?: boolean;
|
|
22637
|
+
/**
|
|
22638
|
+
*
|
|
22639
|
+
* @type {string}
|
|
22640
|
+
* @memberof ItemReview
|
|
22641
|
+
*/
|
|
22642
|
+
review?: string;
|
|
22643
|
+
/**
|
|
22644
|
+
*
|
|
22645
|
+
* @type {number}
|
|
22646
|
+
* @memberof ItemReview
|
|
22647
|
+
*/
|
|
22648
|
+
review_oid?: number;
|
|
22649
|
+
/**
|
|
22650
|
+
*
|
|
22651
|
+
* @type {string}
|
|
22652
|
+
* @memberof ItemReview
|
|
22653
|
+
*/
|
|
22654
|
+
reviewed_nickname?: string;
|
|
22655
|
+
/**
|
|
22656
|
+
*
|
|
22657
|
+
* @type {string}
|
|
22658
|
+
* @memberof ItemReview
|
|
22659
|
+
*/
|
|
22660
|
+
reviewer_email?: string;
|
|
22661
|
+
/**
|
|
22662
|
+
*
|
|
22663
|
+
* @type {string}
|
|
22664
|
+
* @memberof ItemReview
|
|
22665
|
+
*/
|
|
22666
|
+
reviewer_location?: string;
|
|
22667
|
+
/**
|
|
22668
|
+
*
|
|
22669
|
+
* @type {string}
|
|
22670
|
+
* @memberof ItemReview
|
|
22671
|
+
*/
|
|
22672
|
+
status?: string;
|
|
22673
|
+
/**
|
|
22674
|
+
*
|
|
22675
|
+
* @type {string}
|
|
22676
|
+
* @memberof ItemReview
|
|
22677
|
+
*/
|
|
22678
|
+
store_feedback?: string;
|
|
22679
|
+
/**
|
|
22680
|
+
* Date/time of review submission
|
|
22681
|
+
* @type {string}
|
|
22682
|
+
* @memberof ItemReview
|
|
22683
|
+
*/
|
|
22684
|
+
submitted_dts?: string;
|
|
22685
|
+
/**
|
|
22686
|
+
*
|
|
22687
|
+
* @type {string}
|
|
22688
|
+
* @memberof ItemReview
|
|
22689
|
+
*/
|
|
22690
|
+
title?: string;
|
|
22691
|
+
}
|
|
22692
|
+
|
|
22379
22693
|
/**
|
|
22380
22694
|
*
|
|
22381
22695
|
* @export
|
|
@@ -22394,6 +22708,12 @@ export interface ItemReviews {
|
|
|
22394
22708
|
* @memberof ItemReviews
|
|
22395
22709
|
*/
|
|
22396
22710
|
has_review?: boolean;
|
|
22711
|
+
/**
|
|
22712
|
+
*
|
|
22713
|
+
* @type {Array<ItemReview>}
|
|
22714
|
+
* @memberof ItemReviews
|
|
22715
|
+
*/
|
|
22716
|
+
individual_reviews?: Array<ItemReview>;
|
|
22397
22717
|
/**
|
|
22398
22718
|
* Number of approved reviews
|
|
22399
22719
|
* @type {number}
|
|
@@ -50263,11 +50583,12 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
50263
50583
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
50264
50584
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
50265
50585
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
50586
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
50266
50587
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
50267
50588
|
* @param {*} [options] Override http request option.
|
|
50268
50589
|
* @throws {RequiredError}
|
|
50269
50590
|
*/
|
|
50270
|
-
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 {
|
|
50591
|
+
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 {
|
|
50271
50592
|
// verify required parameter 'order' is not null or undefined
|
|
50272
50593
|
if (order === null || order === undefined) {
|
|
50273
50594
|
throw new RequiredError('order','Required parameter order was null or undefined when calling refundOrder.');
|
|
@@ -50326,6 +50647,10 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
50326
50647
|
localVarQueryParameter['reverse_affiliate_transactions'] = reverse_affiliate_transactions;
|
|
50327
50648
|
}
|
|
50328
50649
|
|
|
50650
|
+
if (issue_store_credit !== undefined) {
|
|
50651
|
+
localVarQueryParameter['issue_store_credit'] = issue_store_credit;
|
|
50652
|
+
}
|
|
50653
|
+
|
|
50329
50654
|
if (_expand !== undefined) {
|
|
50330
50655
|
localVarQueryParameter['_expand'] = _expand;
|
|
50331
50656
|
}
|
|
@@ -51049,12 +51374,13 @@ export const OrderApiFp = function(configuration?: Configuration) {
|
|
|
51049
51374
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
51050
51375
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
51051
51376
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
51377
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
51052
51378
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
51053
51379
|
* @param {*} [options] Override http request option.
|
|
51054
51380
|
* @throws {RequiredError}
|
|
51055
51381
|
*/
|
|
51056
|
-
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> {
|
|
51057
|
-
const localVarFetchArgs = OrderApiFetchParamCreator(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, _expand, options);
|
|
51382
|
+
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> {
|
|
51383
|
+
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);
|
|
51058
51384
|
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
51059
51385
|
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
51060
51386
|
|
|
@@ -51407,12 +51733,13 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
|
|
|
51407
51733
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
51408
51734
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
51409
51735
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
51736
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
51410
51737
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
51411
51738
|
* @param {*} [options] Override http request option.
|
|
51412
51739
|
* @throws {RequiredError}
|
|
51413
51740
|
*/
|
|
51414
|
-
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) {
|
|
51415
|
-
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);
|
|
51741
|
+
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) {
|
|
51742
|
+
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);
|
|
51416
51743
|
},
|
|
51417
51744
|
/**
|
|
51418
51745
|
* Create a replacement order based upon a previous order
|
|
@@ -51699,12 +52026,13 @@ export interface OrderApiInterface {
|
|
|
51699
52026
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
51700
52027
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
51701
52028
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
52029
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
51702
52030
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
51703
52031
|
* @param {*} [options] Override http request option.
|
|
51704
52032
|
* @throws {RequiredError}
|
|
51705
52033
|
* @memberof OrderApiInterface
|
|
51706
52034
|
*/
|
|
51707
|
-
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>;
|
|
52035
|
+
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>;
|
|
51708
52036
|
|
|
51709
52037
|
/**
|
|
51710
52038
|
* Create a replacement order based upon a previous order
|
|
@@ -52025,13 +52353,14 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
52025
52353
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
52026
52354
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
52027
52355
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
52356
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
52028
52357
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
52029
52358
|
* @param {*} [options] Override http request option.
|
|
52030
52359
|
* @throws {RequiredError}
|
|
52031
52360
|
* @memberof OrderApi
|
|
52032
52361
|
*/
|
|
52033
|
-
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) {
|
|
52034
|
-
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);
|
|
52362
|
+
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) {
|
|
52363
|
+
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);
|
|
52035
52364
|
}
|
|
52036
52365
|
|
|
52037
52366
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -11843,6 +11843,18 @@ export interface EmailCampaign {
|
|
|
11843
11843
|
* @memberof EmailCampaign
|
|
11844
11844
|
*/
|
|
11845
11845
|
screenshot_large_full_url?: string;
|
|
11846
|
+
/**
|
|
11847
|
+
* Twilio Account UUID. Null for none
|
|
11848
|
+
* @type {string}
|
|
11849
|
+
* @memberof EmailCampaign
|
|
11850
|
+
*/
|
|
11851
|
+
sms_esp_twilio_uuid?: string;
|
|
11852
|
+
/**
|
|
11853
|
+
* Twilio SMS Phone Number. Null for none
|
|
11854
|
+
* @type {string}
|
|
11855
|
+
* @memberof EmailCampaign
|
|
11856
|
+
*/
|
|
11857
|
+
sms_phone_number?: string;
|
|
11846
11858
|
/**
|
|
11847
11859
|
* Status of the campaign of draft, archived, and sent
|
|
11848
11860
|
* @type {string}
|
|
@@ -12855,6 +12867,18 @@ export interface EmailCommseqResponse {
|
|
|
12855
12867
|
* @interface EmailCommseqSequenceTestRequest
|
|
12856
12868
|
*/
|
|
12857
12869
|
export interface EmailCommseqSequenceTestRequest {
|
|
12870
|
+
/**
|
|
12871
|
+
*
|
|
12872
|
+
* @type {string}
|
|
12873
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
12874
|
+
*/
|
|
12875
|
+
address_1?: string;
|
|
12876
|
+
/**
|
|
12877
|
+
*
|
|
12878
|
+
* @type {string}
|
|
12879
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
12880
|
+
*/
|
|
12881
|
+
address_2?: string;
|
|
12858
12882
|
/**
|
|
12859
12883
|
*
|
|
12860
12884
|
* @type {string}
|
|
@@ -12867,12 +12891,24 @@ export interface EmailCommseqSequenceTestRequest {
|
|
|
12867
12891
|
* @memberof EmailCommseqSequenceTestRequest
|
|
12868
12892
|
*/
|
|
12869
12893
|
cart_item_ids?: Array<string>;
|
|
12894
|
+
/**
|
|
12895
|
+
*
|
|
12896
|
+
* @type {string}
|
|
12897
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
12898
|
+
*/
|
|
12899
|
+
city?: string;
|
|
12870
12900
|
/**
|
|
12871
12901
|
*
|
|
12872
12902
|
* @type {string}
|
|
12873
12903
|
* @memberof EmailCommseqSequenceTestRequest
|
|
12874
12904
|
*/
|
|
12875
12905
|
esp_commseq_uuid?: string;
|
|
12906
|
+
/**
|
|
12907
|
+
*
|
|
12908
|
+
* @type {boolean}
|
|
12909
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
12910
|
+
*/
|
|
12911
|
+
mail_card?: boolean;
|
|
12876
12912
|
/**
|
|
12877
12913
|
*
|
|
12878
12914
|
* @type {string}
|
|
@@ -12891,6 +12927,12 @@ export interface EmailCommseqSequenceTestRequest {
|
|
|
12891
12927
|
* @memberof EmailCommseqSequenceTestRequest
|
|
12892
12928
|
*/
|
|
12893
12929
|
please_review?: boolean;
|
|
12930
|
+
/**
|
|
12931
|
+
*
|
|
12932
|
+
* @type {string}
|
|
12933
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
12934
|
+
*/
|
|
12935
|
+
postal_code?: string;
|
|
12894
12936
|
/**
|
|
12895
12937
|
*
|
|
12896
12938
|
* @type {string}
|
|
@@ -12903,6 +12945,12 @@ export interface EmailCommseqSequenceTestRequest {
|
|
|
12903
12945
|
* @memberof EmailCommseqSequenceTestRequest
|
|
12904
12946
|
*/
|
|
12905
12947
|
send_to_logged_in_user?: boolean;
|
|
12948
|
+
/**
|
|
12949
|
+
*
|
|
12950
|
+
* @type {string}
|
|
12951
|
+
* @memberof EmailCommseqSequenceTestRequest
|
|
12952
|
+
*/
|
|
12953
|
+
state?: string;
|
|
12906
12954
|
}
|
|
12907
12955
|
/**
|
|
12908
12956
|
*
|
|
@@ -13995,6 +14043,18 @@ export interface EmailFlow {
|
|
|
13995
14043
|
* @memberof EmailFlow
|
|
13996
14044
|
*/
|
|
13997
14045
|
screenshot_large_full_url?: string;
|
|
14046
|
+
/**
|
|
14047
|
+
* Twilio Account UUID. Null for none
|
|
14048
|
+
* @type {string}
|
|
14049
|
+
* @memberof EmailFlow
|
|
14050
|
+
*/
|
|
14051
|
+
sms_esp_twilio_uuid?: string;
|
|
14052
|
+
/**
|
|
14053
|
+
* Twilio SMS Phone Number. Null for none
|
|
14054
|
+
* @type {string}
|
|
14055
|
+
* @memberof EmailFlow
|
|
14056
|
+
*/
|
|
14057
|
+
sms_phone_number?: string;
|
|
13998
14058
|
/**
|
|
13999
14059
|
* Status of the campaign of draft, archived, active, and inactive
|
|
14000
14060
|
* @type {string}
|
|
@@ -16084,6 +16144,18 @@ export interface EmailSettings {
|
|
|
16084
16144
|
* @memberof EmailSettings
|
|
16085
16145
|
*/
|
|
16086
16146
|
postcard_from_state?: string;
|
|
16147
|
+
/**
|
|
16148
|
+
*
|
|
16149
|
+
* @type {string}
|
|
16150
|
+
* @memberof EmailSettings
|
|
16151
|
+
*/
|
|
16152
|
+
sms_esp_twilio_uuid?: string;
|
|
16153
|
+
/**
|
|
16154
|
+
*
|
|
16155
|
+
* @type {string}
|
|
16156
|
+
* @memberof EmailSettings
|
|
16157
|
+
*/
|
|
16158
|
+
sms_phone_number?: string;
|
|
16087
16159
|
/**
|
|
16088
16160
|
*
|
|
16089
16161
|
* @type {string}
|
|
@@ -17428,6 +17500,12 @@ export interface ExperimentVariation {
|
|
|
17428
17500
|
* @memberof ExperimentVariation
|
|
17429
17501
|
*/
|
|
17430
17502
|
session_count?: number;
|
|
17503
|
+
/**
|
|
17504
|
+
* SMS Opt Ins for this variation
|
|
17505
|
+
* @type {number}
|
|
17506
|
+
* @memberof ExperimentVariation
|
|
17507
|
+
*/
|
|
17508
|
+
sms_opt_ins?: number;
|
|
17431
17509
|
/**
|
|
17432
17510
|
* Percentage of the traffic this variation is currently receiving
|
|
17433
17511
|
* @type {number}
|
|
@@ -17525,6 +17603,12 @@ export interface ExperimentVariationStat {
|
|
|
17525
17603
|
* @memberof ExperimentVariationStat
|
|
17526
17604
|
*/
|
|
17527
17605
|
session_count?: number;
|
|
17606
|
+
/**
|
|
17607
|
+
* Total SMS opt in count for this variation
|
|
17608
|
+
* @type {number}
|
|
17609
|
+
* @memberof ExperimentVariationStat
|
|
17610
|
+
*/
|
|
17611
|
+
sms_opt_in_count?: number;
|
|
17528
17612
|
/**
|
|
17529
17613
|
* Date/time that the statistic was created
|
|
17530
17614
|
* @type {string}
|
|
@@ -21891,6 +21975,235 @@ export interface ItemRevguard {
|
|
|
21891
21975
|
*/
|
|
21892
21976
|
revguard_web_prompt_group?: number;
|
|
21893
21977
|
}
|
|
21978
|
+
/**
|
|
21979
|
+
*
|
|
21980
|
+
* @export
|
|
21981
|
+
* @interface ItemReview
|
|
21982
|
+
*/
|
|
21983
|
+
export interface ItemReview {
|
|
21984
|
+
/**
|
|
21985
|
+
* Customer profile object identifier
|
|
21986
|
+
* @type {number}
|
|
21987
|
+
* @memberof ItemReview
|
|
21988
|
+
*/
|
|
21989
|
+
customer_profile_oid?: number;
|
|
21990
|
+
/**
|
|
21991
|
+
*
|
|
21992
|
+
* @type {boolean}
|
|
21993
|
+
* @memberof ItemReview
|
|
21994
|
+
*/
|
|
21995
|
+
featured?: boolean;
|
|
21996
|
+
/**
|
|
21997
|
+
*
|
|
21998
|
+
* @type {number}
|
|
21999
|
+
* @memberof ItemReview
|
|
22000
|
+
*/
|
|
22001
|
+
helperful_no_votes?: number;
|
|
22002
|
+
/**
|
|
22003
|
+
*
|
|
22004
|
+
* @type {number}
|
|
22005
|
+
* @memberof ItemReview
|
|
22006
|
+
*/
|
|
22007
|
+
helpful_yes_votes?: number;
|
|
22008
|
+
/**
|
|
22009
|
+
*
|
|
22010
|
+
* @type {string}
|
|
22011
|
+
* @memberof ItemReview
|
|
22012
|
+
*/
|
|
22013
|
+
order_id?: string;
|
|
22014
|
+
/**
|
|
22015
|
+
*
|
|
22016
|
+
* @type {number}
|
|
22017
|
+
* @memberof ItemReview
|
|
22018
|
+
*/
|
|
22019
|
+
overall?: number;
|
|
22020
|
+
/**
|
|
22021
|
+
*
|
|
22022
|
+
* @type {string}
|
|
22023
|
+
* @memberof ItemReview
|
|
22024
|
+
*/
|
|
22025
|
+
rating_name1?: string;
|
|
22026
|
+
/**
|
|
22027
|
+
*
|
|
22028
|
+
* @type {string}
|
|
22029
|
+
* @memberof ItemReview
|
|
22030
|
+
*/
|
|
22031
|
+
rating_name10?: string;
|
|
22032
|
+
/**
|
|
22033
|
+
*
|
|
22034
|
+
* @type {string}
|
|
22035
|
+
* @memberof ItemReview
|
|
22036
|
+
*/
|
|
22037
|
+
rating_name2?: string;
|
|
22038
|
+
/**
|
|
22039
|
+
*
|
|
22040
|
+
* @type {string}
|
|
22041
|
+
* @memberof ItemReview
|
|
22042
|
+
*/
|
|
22043
|
+
rating_name3?: string;
|
|
22044
|
+
/**
|
|
22045
|
+
*
|
|
22046
|
+
* @type {string}
|
|
22047
|
+
* @memberof ItemReview
|
|
22048
|
+
*/
|
|
22049
|
+
rating_name4?: string;
|
|
22050
|
+
/**
|
|
22051
|
+
*
|
|
22052
|
+
* @type {string}
|
|
22053
|
+
* @memberof ItemReview
|
|
22054
|
+
*/
|
|
22055
|
+
rating_name5?: string;
|
|
22056
|
+
/**
|
|
22057
|
+
*
|
|
22058
|
+
* @type {string}
|
|
22059
|
+
* @memberof ItemReview
|
|
22060
|
+
*/
|
|
22061
|
+
rating_name6?: string;
|
|
22062
|
+
/**
|
|
22063
|
+
*
|
|
22064
|
+
* @type {string}
|
|
22065
|
+
* @memberof ItemReview
|
|
22066
|
+
*/
|
|
22067
|
+
rating_name7?: string;
|
|
22068
|
+
/**
|
|
22069
|
+
*
|
|
22070
|
+
* @type {string}
|
|
22071
|
+
* @memberof ItemReview
|
|
22072
|
+
*/
|
|
22073
|
+
rating_name8?: string;
|
|
22074
|
+
/**
|
|
22075
|
+
*
|
|
22076
|
+
* @type {string}
|
|
22077
|
+
* @memberof ItemReview
|
|
22078
|
+
*/
|
|
22079
|
+
rating_name9?: string;
|
|
22080
|
+
/**
|
|
22081
|
+
*
|
|
22082
|
+
* @type {number}
|
|
22083
|
+
* @memberof ItemReview
|
|
22084
|
+
*/
|
|
22085
|
+
rating_score1?: number;
|
|
22086
|
+
/**
|
|
22087
|
+
*
|
|
22088
|
+
* @type {number}
|
|
22089
|
+
* @memberof ItemReview
|
|
22090
|
+
*/
|
|
22091
|
+
rating_score10?: number;
|
|
22092
|
+
/**
|
|
22093
|
+
*
|
|
22094
|
+
* @type {number}
|
|
22095
|
+
* @memberof ItemReview
|
|
22096
|
+
*/
|
|
22097
|
+
rating_score2?: number;
|
|
22098
|
+
/**
|
|
22099
|
+
*
|
|
22100
|
+
* @type {number}
|
|
22101
|
+
* @memberof ItemReview
|
|
22102
|
+
*/
|
|
22103
|
+
rating_score3?: number;
|
|
22104
|
+
/**
|
|
22105
|
+
*
|
|
22106
|
+
* @type {number}
|
|
22107
|
+
* @memberof ItemReview
|
|
22108
|
+
*/
|
|
22109
|
+
rating_score4?: number;
|
|
22110
|
+
/**
|
|
22111
|
+
*
|
|
22112
|
+
* @type {number}
|
|
22113
|
+
* @memberof ItemReview
|
|
22114
|
+
*/
|
|
22115
|
+
rating_score5?: number;
|
|
22116
|
+
/**
|
|
22117
|
+
*
|
|
22118
|
+
* @type {number}
|
|
22119
|
+
* @memberof ItemReview
|
|
22120
|
+
*/
|
|
22121
|
+
rating_score6?: number;
|
|
22122
|
+
/**
|
|
22123
|
+
*
|
|
22124
|
+
* @type {number}
|
|
22125
|
+
* @memberof ItemReview
|
|
22126
|
+
*/
|
|
22127
|
+
rating_score7?: number;
|
|
22128
|
+
/**
|
|
22129
|
+
*
|
|
22130
|
+
* @type {number}
|
|
22131
|
+
* @memberof ItemReview
|
|
22132
|
+
*/
|
|
22133
|
+
rating_score8?: number;
|
|
22134
|
+
/**
|
|
22135
|
+
*
|
|
22136
|
+
* @type {number}
|
|
22137
|
+
* @memberof ItemReview
|
|
22138
|
+
*/
|
|
22139
|
+
rating_score9?: number;
|
|
22140
|
+
/**
|
|
22141
|
+
*
|
|
22142
|
+
* @type {number}
|
|
22143
|
+
* @memberof ItemReview
|
|
22144
|
+
*/
|
|
22145
|
+
recommend_store_to_friend?: number;
|
|
22146
|
+
/**
|
|
22147
|
+
*
|
|
22148
|
+
* @type {boolean}
|
|
22149
|
+
* @memberof ItemReview
|
|
22150
|
+
*/
|
|
22151
|
+
recommend_to_friend?: boolean;
|
|
22152
|
+
/**
|
|
22153
|
+
*
|
|
22154
|
+
* @type {string}
|
|
22155
|
+
* @memberof ItemReview
|
|
22156
|
+
*/
|
|
22157
|
+
review?: string;
|
|
22158
|
+
/**
|
|
22159
|
+
*
|
|
22160
|
+
* @type {number}
|
|
22161
|
+
* @memberof ItemReview
|
|
22162
|
+
*/
|
|
22163
|
+
review_oid?: number;
|
|
22164
|
+
/**
|
|
22165
|
+
*
|
|
22166
|
+
* @type {string}
|
|
22167
|
+
* @memberof ItemReview
|
|
22168
|
+
*/
|
|
22169
|
+
reviewed_nickname?: string;
|
|
22170
|
+
/**
|
|
22171
|
+
*
|
|
22172
|
+
* @type {string}
|
|
22173
|
+
* @memberof ItemReview
|
|
22174
|
+
*/
|
|
22175
|
+
reviewer_email?: string;
|
|
22176
|
+
/**
|
|
22177
|
+
*
|
|
22178
|
+
* @type {string}
|
|
22179
|
+
* @memberof ItemReview
|
|
22180
|
+
*/
|
|
22181
|
+
reviewer_location?: string;
|
|
22182
|
+
/**
|
|
22183
|
+
*
|
|
22184
|
+
* @type {string}
|
|
22185
|
+
* @memberof ItemReview
|
|
22186
|
+
*/
|
|
22187
|
+
status?: string;
|
|
22188
|
+
/**
|
|
22189
|
+
*
|
|
22190
|
+
* @type {string}
|
|
22191
|
+
* @memberof ItemReview
|
|
22192
|
+
*/
|
|
22193
|
+
store_feedback?: string;
|
|
22194
|
+
/**
|
|
22195
|
+
* Date/time of review submission
|
|
22196
|
+
* @type {string}
|
|
22197
|
+
* @memberof ItemReview
|
|
22198
|
+
*/
|
|
22199
|
+
submitted_dts?: string;
|
|
22200
|
+
/**
|
|
22201
|
+
*
|
|
22202
|
+
* @type {string}
|
|
22203
|
+
* @memberof ItemReview
|
|
22204
|
+
*/
|
|
22205
|
+
title?: string;
|
|
22206
|
+
}
|
|
21894
22207
|
/**
|
|
21895
22208
|
*
|
|
21896
22209
|
* @export
|
|
@@ -21909,6 +22222,12 @@ export interface ItemReviews {
|
|
|
21909
22222
|
* @memberof ItemReviews
|
|
21910
22223
|
*/
|
|
21911
22224
|
has_review?: boolean;
|
|
22225
|
+
/**
|
|
22226
|
+
*
|
|
22227
|
+
* @type {Array<ItemReview>}
|
|
22228
|
+
* @memberof ItemReviews
|
|
22229
|
+
*/
|
|
22230
|
+
individual_reviews?: Array<ItemReview>;
|
|
21912
22231
|
/**
|
|
21913
22232
|
* Number of approved reviews
|
|
21914
22233
|
* @type {number}
|
|
@@ -40034,11 +40353,12 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
|
|
|
40034
40353
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
40035
40354
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
40036
40355
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
40356
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
40037
40357
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
40038
40358
|
* @param {*} [options] Override http request option.
|
|
40039
40359
|
* @throws {RequiredError}
|
|
40040
40360
|
*/
|
|
40041
|
-
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;
|
|
40361
|
+
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;
|
|
40042
40362
|
/**
|
|
40043
40363
|
* Create a replacement order based upon a previous order
|
|
40044
40364
|
* @summary Replacement order
|
|
@@ -40277,11 +40597,12 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
|
|
|
40277
40597
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
40278
40598
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
40279
40599
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
40600
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
40280
40601
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
40281
40602
|
* @param {*} [options] Override http request option.
|
|
40282
40603
|
* @throws {RequiredError}
|
|
40283
40604
|
*/
|
|
40284
|
-
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>;
|
|
40605
|
+
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>;
|
|
40285
40606
|
/**
|
|
40286
40607
|
* Create a replacement order based upon a previous order
|
|
40287
40608
|
* @summary Replacement order
|
|
@@ -40520,11 +40841,12 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
|
|
|
40520
40841
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
40521
40842
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
40522
40843
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
40844
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
40523
40845
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
40524
40846
|
* @param {*} [options] Override http request option.
|
|
40525
40847
|
* @throws {RequiredError}
|
|
40526
40848
|
*/
|
|
40527
|
-
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>;
|
|
40849
|
+
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>;
|
|
40528
40850
|
/**
|
|
40529
40851
|
* Create a replacement order based upon a previous order
|
|
40530
40852
|
* @summary Replacement order
|
|
@@ -40781,12 +41103,13 @@ export interface OrderApiInterface {
|
|
|
40781
41103
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
40782
41104
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
40783
41105
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
41106
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
40784
41107
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
40785
41108
|
* @param {*} [options] Override http request option.
|
|
40786
41109
|
* @throws {RequiredError}
|
|
40787
41110
|
* @memberof OrderApiInterface
|
|
40788
41111
|
*/
|
|
40789
|
-
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>;
|
|
41112
|
+
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>;
|
|
40790
41113
|
/**
|
|
40791
41114
|
* Create a replacement order based upon a previous order
|
|
40792
41115
|
* @summary Replacement order
|
|
@@ -41049,12 +41372,13 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
41049
41372
|
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
41050
41373
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
41051
41374
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
41375
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
41052
41376
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
41053
41377
|
* @param {*} [options] Override http request option.
|
|
41054
41378
|
* @throws {RequiredError}
|
|
41055
41379
|
* @memberof OrderApi
|
|
41056
41380
|
*/
|
|
41057
|
-
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>;
|
|
41381
|
+
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>;
|
|
41058
41382
|
/**
|
|
41059
41383
|
* Create a replacement order based upon a previous order
|
|
41060
41384
|
* @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
|