ultracart_rest_api_v2_typescript 3.9.5 → 3.9.8
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 +492 -1
- package/dist/api.d.ts +278 -1
- package/dist/api.js +323 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@3.9.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@3.9.8
|
|
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.9.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@3.9.8 --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.9.8 | 04/26/2022 | OrderApi.duplicateOrder |
|
|
58
|
+
| 3.9.7 | 04/25/2022 | integration logs method for zpl to pdf conversion |
|
|
59
|
+
| 3.9.6 | 04/25/2022 | storefront communications email magic link setting |
|
|
57
60
|
| 3.9.5 | 04/14/2022 | postcard screenshot bug fixes |
|
|
58
61
|
| 3.9.4 | 04/13/2022 | Added spf DNS record to the sending domain object |
|
|
59
62
|
| 3.9.3 | 04/06/2022 | fix return object on send webhook test method |
|
package/api.ts
CHANGED
|
@@ -546,6 +546,94 @@ export interface AddLibraryItemRequest {
|
|
|
546
546
|
uuid?: string;
|
|
547
547
|
}
|
|
548
548
|
|
|
549
|
+
/**
|
|
550
|
+
*
|
|
551
|
+
* @export
|
|
552
|
+
* @interface AdjustInternalCertificateRequest
|
|
553
|
+
*/
|
|
554
|
+
export interface AdjustInternalCertificateRequest {
|
|
555
|
+
/**
|
|
556
|
+
* The adjustment amount
|
|
557
|
+
* @type {number}
|
|
558
|
+
* @memberof AdjustInternalCertificateRequest
|
|
559
|
+
*/
|
|
560
|
+
adjustment_amount?: number;
|
|
561
|
+
/**
|
|
562
|
+
* Description of this adjustment, 50 characters max
|
|
563
|
+
* @type {string}
|
|
564
|
+
* @memberof AdjustInternalCertificateRequest
|
|
565
|
+
*/
|
|
566
|
+
description?: string;
|
|
567
|
+
/**
|
|
568
|
+
* Optional timestamp for the adjustment, defaults to current time
|
|
569
|
+
* @type {string}
|
|
570
|
+
* @memberof AdjustInternalCertificateRequest
|
|
571
|
+
*/
|
|
572
|
+
entry_dts?: string;
|
|
573
|
+
/**
|
|
574
|
+
* Optional expiration days from the entry_dts when these adjustment becomes worthless
|
|
575
|
+
* @type {number}
|
|
576
|
+
* @memberof AdjustInternalCertificateRequest
|
|
577
|
+
*/
|
|
578
|
+
expiration_days?: number;
|
|
579
|
+
/**
|
|
580
|
+
* Optional order id if this adjustment is related to a particular order
|
|
581
|
+
* @type {string}
|
|
582
|
+
* @memberof AdjustInternalCertificateRequest
|
|
583
|
+
*/
|
|
584
|
+
order_id?: string;
|
|
585
|
+
/**
|
|
586
|
+
* Optional days required for this adjustment to vest
|
|
587
|
+
* @type {number}
|
|
588
|
+
* @memberof AdjustInternalCertificateRequest
|
|
589
|
+
*/
|
|
590
|
+
vesting_days?: number;
|
|
591
|
+
}
|
|
592
|
+
|
|
593
|
+
/**
|
|
594
|
+
*
|
|
595
|
+
* @export
|
|
596
|
+
* @interface AdjustInternalCertificateResponse
|
|
597
|
+
*/
|
|
598
|
+
export interface AdjustInternalCertificateResponse {
|
|
599
|
+
/**
|
|
600
|
+
* The adjustment amount
|
|
601
|
+
* @type {number}
|
|
602
|
+
* @memberof AdjustInternalCertificateResponse
|
|
603
|
+
*/
|
|
604
|
+
adjustment_amount?: number;
|
|
605
|
+
/**
|
|
606
|
+
* The balance amount after the adjustment was made
|
|
607
|
+
* @type {number}
|
|
608
|
+
* @memberof AdjustInternalCertificateResponse
|
|
609
|
+
*/
|
|
610
|
+
balance_amount?: number;
|
|
611
|
+
/**
|
|
612
|
+
*
|
|
613
|
+
* @type {ModelError}
|
|
614
|
+
* @memberof AdjustInternalCertificateResponse
|
|
615
|
+
*/
|
|
616
|
+
error?: ModelError;
|
|
617
|
+
/**
|
|
618
|
+
*
|
|
619
|
+
* @type {ResponseMetadata}
|
|
620
|
+
* @memberof AdjustInternalCertificateResponse
|
|
621
|
+
*/
|
|
622
|
+
metadata?: ResponseMetadata;
|
|
623
|
+
/**
|
|
624
|
+
* Indicates if API call was successful
|
|
625
|
+
* @type {boolean}
|
|
626
|
+
* @memberof AdjustInternalCertificateResponse
|
|
627
|
+
*/
|
|
628
|
+
success?: boolean;
|
|
629
|
+
/**
|
|
630
|
+
*
|
|
631
|
+
* @type {Warning}
|
|
632
|
+
* @memberof AdjustInternalCertificateResponse
|
|
633
|
+
*/
|
|
634
|
+
warning?: Warning;
|
|
635
|
+
}
|
|
636
|
+
|
|
549
637
|
/**
|
|
550
638
|
*
|
|
551
639
|
* @export
|
|
@@ -1226,6 +1314,12 @@ export interface AutoOrder {
|
|
|
1226
1314
|
* @memberof AutoOrder
|
|
1227
1315
|
*/
|
|
1228
1316
|
cancel_downgrade?: boolean;
|
|
1317
|
+
/**
|
|
1318
|
+
* The reason this auto order was canceled by either merchant or customer
|
|
1319
|
+
* @type {string}
|
|
1320
|
+
* @memberof AutoOrder
|
|
1321
|
+
*/
|
|
1322
|
+
cancel_reason?: string;
|
|
1229
1323
|
/**
|
|
1230
1324
|
* True if the auto order was canceled because the customer purchased an upgrade item
|
|
1231
1325
|
* @type {boolean}
|
|
@@ -8327,11 +8421,17 @@ export interface CustomerEmailListChanges {
|
|
|
8327
8421
|
*/
|
|
8328
8422
|
export interface CustomerLoyalty {
|
|
8329
8423
|
/**
|
|
8330
|
-
* Current
|
|
8424
|
+
* Current points
|
|
8331
8425
|
* @type {number}
|
|
8332
8426
|
* @memberof CustomerLoyalty
|
|
8333
8427
|
*/
|
|
8334
8428
|
current_points?: number;
|
|
8429
|
+
/**
|
|
8430
|
+
*
|
|
8431
|
+
* @type {GiftCertificate}
|
|
8432
|
+
* @memberof CustomerLoyalty
|
|
8433
|
+
*/
|
|
8434
|
+
internal_gift_certificate?: GiftCertificate;
|
|
8335
8435
|
/**
|
|
8336
8436
|
* Loyalty Cashback / Store credit balance (internal gift certificate balance)
|
|
8337
8437
|
* @type {string}
|
|
@@ -10081,6 +10181,12 @@ export interface EmailCommseqEmail {
|
|
|
10081
10181
|
* @memberof EmailCommseqEmail
|
|
10082
10182
|
*/
|
|
10083
10183
|
library_item_oid?: number;
|
|
10184
|
+
/**
|
|
10185
|
+
* True if email links should contain magic link tokens to log the customer in automatically
|
|
10186
|
+
* @type {boolean}
|
|
10187
|
+
* @memberof EmailCommseqEmail
|
|
10188
|
+
*/
|
|
10189
|
+
magic_link?: boolean;
|
|
10084
10190
|
/**
|
|
10085
10191
|
* Merchant ID
|
|
10086
10192
|
* @type {string}
|
|
@@ -12776,6 +12882,12 @@ export interface EmailPerformance {
|
|
|
12776
12882
|
* @memberof EmailPerformance
|
|
12777
12883
|
*/
|
|
12778
12884
|
delivered_count?: number;
|
|
12885
|
+
/**
|
|
12886
|
+
* Loyalty Program Type
|
|
12887
|
+
* @type {string}
|
|
12888
|
+
* @memberof EmailPerformance
|
|
12889
|
+
*/
|
|
12890
|
+
loyalty_program_type?: EmailPerformance.LoyaltyProgramTypeEnum;
|
|
12779
12891
|
/**
|
|
12780
12892
|
* Maximum active customers allowed under their billing plan
|
|
12781
12893
|
* @type {number}
|
|
@@ -12862,6 +12974,22 @@ export interface EmailPerformance {
|
|
|
12862
12974
|
transactional_send_count?: number;
|
|
12863
12975
|
}
|
|
12864
12976
|
|
|
12977
|
+
/**
|
|
12978
|
+
* @export
|
|
12979
|
+
* @namespace EmailPerformance
|
|
12980
|
+
*/
|
|
12981
|
+
export namespace EmailPerformance {
|
|
12982
|
+
/**
|
|
12983
|
+
* @export
|
|
12984
|
+
* @enum {string}
|
|
12985
|
+
*/
|
|
12986
|
+
export enum LoyaltyProgramTypeEnum {
|
|
12987
|
+
Disabled = <any> 'disabled',
|
|
12988
|
+
Points = <any> 'points',
|
|
12989
|
+
Cashback = <any> 'cashback'
|
|
12990
|
+
}
|
|
12991
|
+
}
|
|
12992
|
+
|
|
12865
12993
|
/**
|
|
12866
12994
|
*
|
|
12867
12995
|
* @export
|
|
@@ -22344,6 +22472,12 @@ export interface OrderAutoOrder {
|
|
|
22344
22472
|
* @memberof OrderAutoOrder
|
|
22345
22473
|
*/
|
|
22346
22474
|
cancel_downgrade?: boolean;
|
|
22475
|
+
/**
|
|
22476
|
+
* The reason this auto order was canceled by either merchant or customer
|
|
22477
|
+
* @type {string}
|
|
22478
|
+
* @memberof OrderAutoOrder
|
|
22479
|
+
*/
|
|
22480
|
+
cancel_reason?: string;
|
|
22347
22481
|
/**
|
|
22348
22482
|
* True if the auto order was canceled because the customer purchased an upgrade item
|
|
22349
22483
|
* @type {boolean}
|
|
@@ -42952,6 +43086,67 @@ export class CouponApi extends BaseAPI implements CouponApiInterface {
|
|
|
42952
43086
|
*/
|
|
42953
43087
|
export const CustomerApiFetchParamCreator = function (configuration?: Configuration) {
|
|
42954
43088
|
return {
|
|
43089
|
+
/**
|
|
43090
|
+
* Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
|
43091
|
+
* @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
|
43092
|
+
* @param {number} customer_profile_oid The customer profile oid
|
|
43093
|
+
* @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
|
|
43094
|
+
* @param {*} [options] Override http request option.
|
|
43095
|
+
* @throws {RequiredError}
|
|
43096
|
+
*/
|
|
43097
|
+
adjustInternalCertificate(customer_profile_oid: number, adjust_internal_certificate_request: AdjustInternalCertificateRequest, options: any = {}): FetchArgs {
|
|
43098
|
+
// verify required parameter 'customer_profile_oid' is not null or undefined
|
|
43099
|
+
if (customer_profile_oid === null || customer_profile_oid === undefined) {
|
|
43100
|
+
throw new RequiredError('customer_profile_oid','Required parameter customer_profile_oid was null or undefined when calling adjustInternalCertificate.');
|
|
43101
|
+
}
|
|
43102
|
+
// verify required parameter 'adjust_internal_certificate_request' is not null or undefined
|
|
43103
|
+
if (adjust_internal_certificate_request === null || adjust_internal_certificate_request === undefined) {
|
|
43104
|
+
throw new RequiredError('adjust_internal_certificate_request','Required parameter adjust_internal_certificate_request was null or undefined when calling adjustInternalCertificate.');
|
|
43105
|
+
}
|
|
43106
|
+
const localVarPath = `/customer/customers/{customer_profile_oid}/adjust_cashback_balance`
|
|
43107
|
+
.replace(`{${"customer_profile_oid"}}`, encodeURIComponent(String(customer_profile_oid)));
|
|
43108
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
43109
|
+
const localVarRequestOptions = Object.assign({ method: 'POST' }, options);
|
|
43110
|
+
const localVarHeaderParameter = {} as any;
|
|
43111
|
+
const localVarQueryParameter = {} as any;
|
|
43112
|
+
|
|
43113
|
+
if(configuration && configuration.apiVersion) {
|
|
43114
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
43115
|
+
}
|
|
43116
|
+
|
|
43117
|
+
|
|
43118
|
+
|
|
43119
|
+
// authentication ultraCartOauth required
|
|
43120
|
+
// oauth required
|
|
43121
|
+
if (configuration && configuration.accessToken) {
|
|
43122
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
43123
|
+
? configuration.accessToken("ultraCartOauth", ["customer_write"])
|
|
43124
|
+
: configuration.accessToken;
|
|
43125
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
43126
|
+
}
|
|
43127
|
+
|
|
43128
|
+
// authentication ultraCartSimpleApiKey required
|
|
43129
|
+
if (configuration && configuration.apiKey) {
|
|
43130
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
43131
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
43132
|
+
: configuration.apiKey;
|
|
43133
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
43134
|
+
}
|
|
43135
|
+
|
|
43136
|
+
localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
|
|
43137
|
+
|
|
43138
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
43139
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
43140
|
+
delete localVarUrlObj.search;
|
|
43141
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
43142
|
+
const needsSerialization = (<any>"AdjustInternalCertificateRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
43143
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(adjust_internal_certificate_request || {}) : (adjust_internal_certificate_request || "");
|
|
43144
|
+
|
|
43145
|
+
return {
|
|
43146
|
+
url: url.format(localVarUrlObj),
|
|
43147
|
+
options: localVarRequestOptions,
|
|
43148
|
+
};
|
|
43149
|
+
},
|
|
42955
43150
|
/**
|
|
42956
43151
|
* Delete a customer on the UltraCart account.
|
|
42957
43152
|
* @summary Delete a customer
|
|
@@ -43853,6 +44048,28 @@ export const CustomerApiFetchParamCreator = function (configuration?: Configurat
|
|
|
43853
44048
|
*/
|
|
43854
44049
|
export const CustomerApiFp = function(configuration?: Configuration) {
|
|
43855
44050
|
return {
|
|
44051
|
+
/**
|
|
44052
|
+
* Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
|
44053
|
+
* @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
|
44054
|
+
* @param {number} customer_profile_oid The customer profile oid
|
|
44055
|
+
* @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
|
|
44056
|
+
* @param {*} [options] Override http request option.
|
|
44057
|
+
* @throws {RequiredError}
|
|
44058
|
+
*/
|
|
44059
|
+
adjustInternalCertificate(customer_profile_oid: number, adjust_internal_certificate_request: AdjustInternalCertificateRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AdjustInternalCertificateResponse> {
|
|
44060
|
+
const localVarFetchArgs = CustomerApiFetchParamCreator(configuration).adjustInternalCertificate(customer_profile_oid, adjust_internal_certificate_request, options);
|
|
44061
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
44062
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
44063
|
+
|
|
44064
|
+
if (response.status >= 200 && response.status < 300) {
|
|
44065
|
+
return response.json();
|
|
44066
|
+
|
|
44067
|
+
} else {
|
|
44068
|
+
throw response;
|
|
44069
|
+
}
|
|
44070
|
+
});
|
|
44071
|
+
};
|
|
44072
|
+
},
|
|
43856
44073
|
/**
|
|
43857
44074
|
* Delete a customer on the UltraCart account.
|
|
43858
44075
|
* @summary Delete a customer
|
|
@@ -44175,6 +44392,17 @@ export const CustomerApiFp = function(configuration?: Configuration) {
|
|
|
44175
44392
|
*/
|
|
44176
44393
|
export const CustomerApiFactory = function (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) {
|
|
44177
44394
|
return {
|
|
44395
|
+
/**
|
|
44396
|
+
* Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
|
44397
|
+
* @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
|
44398
|
+
* @param {number} customer_profile_oid The customer profile oid
|
|
44399
|
+
* @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
|
|
44400
|
+
* @param {*} [options] Override http request option.
|
|
44401
|
+
* @throws {RequiredError}
|
|
44402
|
+
*/
|
|
44403
|
+
adjustInternalCertificate(customer_profile_oid: number, adjust_internal_certificate_request: AdjustInternalCertificateRequest, options?: any) {
|
|
44404
|
+
return CustomerApiFp(configuration).adjustInternalCertificate(customer_profile_oid, adjust_internal_certificate_request, options)(fetch, basePath);
|
|
44405
|
+
},
|
|
44178
44406
|
/**
|
|
44179
44407
|
* Delete a customer on the UltraCart account.
|
|
44180
44408
|
* @summary Delete a customer
|
|
@@ -44354,6 +44582,17 @@ export const CustomerApiFactory = function (configuration?: Configuration, fetch
|
|
|
44354
44582
|
* @interface CustomerApi
|
|
44355
44583
|
*/
|
|
44356
44584
|
export interface CustomerApiInterface {
|
|
44585
|
+
/**
|
|
44586
|
+
* Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
|
44587
|
+
* @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
|
44588
|
+
* @param {number} customer_profile_oid The customer profile oid
|
|
44589
|
+
* @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
|
|
44590
|
+
* @param {*} [options] Override http request option.
|
|
44591
|
+
* @throws {RequiredError}
|
|
44592
|
+
* @memberof CustomerApiInterface
|
|
44593
|
+
*/
|
|
44594
|
+
adjustInternalCertificate(customer_profile_oid: number, adjust_internal_certificate_request: AdjustInternalCertificateRequest, options?: any): Promise<AdjustInternalCertificateResponse>;
|
|
44595
|
+
|
|
44357
44596
|
/**
|
|
44358
44597
|
* Delete a customer on the UltraCart account.
|
|
44359
44598
|
* @summary Delete a customer
|
|
@@ -44533,6 +44772,19 @@ export interface CustomerApiInterface {
|
|
|
44533
44772
|
* @extends {BaseAPI}
|
|
44534
44773
|
*/
|
|
44535
44774
|
export class CustomerApi extends BaseAPI implements CustomerApiInterface {
|
|
44775
|
+
/**
|
|
44776
|
+
* Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
|
44777
|
+
* @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
|
44778
|
+
* @param {number} customer_profile_oid The customer profile oid
|
|
44779
|
+
* @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
|
|
44780
|
+
* @param {*} [options] Override http request option.
|
|
44781
|
+
* @throws {RequiredError}
|
|
44782
|
+
* @memberof CustomerApi
|
|
44783
|
+
*/
|
|
44784
|
+
public adjustInternalCertificate(customer_profile_oid: number, adjust_internal_certificate_request: AdjustInternalCertificateRequest, options?: any) {
|
|
44785
|
+
return CustomerApiFp(this.configuration).adjustInternalCertificate(customer_profile_oid, adjust_internal_certificate_request, options)(this.fetch, this.basePath);
|
|
44786
|
+
}
|
|
44787
|
+
|
|
44536
44788
|
/**
|
|
44537
44789
|
* Delete a customer on the UltraCart account.
|
|
44538
44790
|
* @summary Delete a customer
|
|
@@ -46506,6 +46758,70 @@ export const IntegrationLogApiFetchParamCreator = function (configuration?: Conf
|
|
|
46506
46758
|
|
|
46507
46759
|
|
|
46508
46760
|
|
|
46761
|
+
// authentication ultraCartOauth required
|
|
46762
|
+
// oauth required
|
|
46763
|
+
if (configuration && configuration.accessToken) {
|
|
46764
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
46765
|
+
? configuration.accessToken("ultraCartOauth", ["integration_log_read"])
|
|
46766
|
+
: configuration.accessToken;
|
|
46767
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
46768
|
+
}
|
|
46769
|
+
|
|
46770
|
+
// authentication ultraCartSimpleApiKey required
|
|
46771
|
+
if (configuration && configuration.apiKey) {
|
|
46772
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
46773
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
46774
|
+
: configuration.apiKey;
|
|
46775
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
46776
|
+
}
|
|
46777
|
+
|
|
46778
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
46779
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
46780
|
+
delete localVarUrlObj.search;
|
|
46781
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
46782
|
+
|
|
46783
|
+
return {
|
|
46784
|
+
url: url.format(localVarUrlObj),
|
|
46785
|
+
options: localVarRequestOptions,
|
|
46786
|
+
};
|
|
46787
|
+
},
|
|
46788
|
+
/**
|
|
46789
|
+
* Retrieve an integration log file from the account based identifiers
|
|
46790
|
+
* @summary Retrieve an integration log file converted to PDF
|
|
46791
|
+
* @param {string} pk
|
|
46792
|
+
* @param {string} sk
|
|
46793
|
+
* @param {string} uuid
|
|
46794
|
+
* @param {*} [options] Override http request option.
|
|
46795
|
+
* @throws {RequiredError}
|
|
46796
|
+
*/
|
|
46797
|
+
getIntegrationLogFilePdf(pk: string, sk: string, uuid: string, options: any = {}): FetchArgs {
|
|
46798
|
+
// verify required parameter 'pk' is not null or undefined
|
|
46799
|
+
if (pk === null || pk === undefined) {
|
|
46800
|
+
throw new RequiredError('pk','Required parameter pk was null or undefined when calling getIntegrationLogFilePdf.');
|
|
46801
|
+
}
|
|
46802
|
+
// verify required parameter 'sk' is not null or undefined
|
|
46803
|
+
if (sk === null || sk === undefined) {
|
|
46804
|
+
throw new RequiredError('sk','Required parameter sk was null or undefined when calling getIntegrationLogFilePdf.');
|
|
46805
|
+
}
|
|
46806
|
+
// verify required parameter 'uuid' is not null or undefined
|
|
46807
|
+
if (uuid === null || uuid === undefined) {
|
|
46808
|
+
throw new RequiredError('uuid','Required parameter uuid was null or undefined when calling getIntegrationLogFilePdf.');
|
|
46809
|
+
}
|
|
46810
|
+
const localVarPath = `/integration_log/query/{pk}/{sk}/{uuid}/pdf`
|
|
46811
|
+
.replace(`{${"pk"}}`, encodeURIComponent(String(pk)))
|
|
46812
|
+
.replace(`{${"sk"}}`, encodeURIComponent(String(sk)))
|
|
46813
|
+
.replace(`{${"uuid"}}`, encodeURIComponent(String(uuid)));
|
|
46814
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
46815
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
46816
|
+
const localVarHeaderParameter = {} as any;
|
|
46817
|
+
const localVarQueryParameter = {} as any;
|
|
46818
|
+
|
|
46819
|
+
if(configuration && configuration.apiVersion) {
|
|
46820
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
46821
|
+
}
|
|
46822
|
+
|
|
46823
|
+
|
|
46824
|
+
|
|
46509
46825
|
// authentication ultraCartOauth required
|
|
46510
46826
|
// oauth required
|
|
46511
46827
|
if (configuration && configuration.accessToken) {
|
|
@@ -46712,6 +47028,29 @@ export const IntegrationLogApiFp = function(configuration?: Configuration) {
|
|
|
46712
47028
|
});
|
|
46713
47029
|
};
|
|
46714
47030
|
},
|
|
47031
|
+
/**
|
|
47032
|
+
* Retrieve an integration log file from the account based identifiers
|
|
47033
|
+
* @summary Retrieve an integration log file converted to PDF
|
|
47034
|
+
* @param {string} pk
|
|
47035
|
+
* @param {string} sk
|
|
47036
|
+
* @param {string} uuid
|
|
47037
|
+
* @param {*} [options] Override http request option.
|
|
47038
|
+
* @throws {RequiredError}
|
|
47039
|
+
*/
|
|
47040
|
+
getIntegrationLogFilePdf(pk: string, sk: string, uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Blob> {
|
|
47041
|
+
const localVarFetchArgs = IntegrationLogApiFetchParamCreator(configuration).getIntegrationLogFilePdf(pk, sk, uuid, options);
|
|
47042
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
47043
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
47044
|
+
|
|
47045
|
+
if (response.status >= 200 && response.status < 300) {
|
|
47046
|
+
|
|
47047
|
+
return response.blob();
|
|
47048
|
+
} else {
|
|
47049
|
+
throw response;
|
|
47050
|
+
}
|
|
47051
|
+
});
|
|
47052
|
+
};
|
|
47053
|
+
},
|
|
46715
47054
|
/**
|
|
46716
47055
|
* Retrieves a set of integration log summaries from the account based on a query object.
|
|
46717
47056
|
* @summary Retrieve integration log summaries
|
|
@@ -46789,6 +47128,18 @@ export const IntegrationLogApiFactory = function (configuration?: Configuration,
|
|
|
46789
47128
|
getIntegrationLogFile(pk: string, sk: string, uuid: string, options?: any) {
|
|
46790
47129
|
return IntegrationLogApiFp(configuration).getIntegrationLogFile(pk, sk, uuid, options)(fetch, basePath);
|
|
46791
47130
|
},
|
|
47131
|
+
/**
|
|
47132
|
+
* Retrieve an integration log file from the account based identifiers
|
|
47133
|
+
* @summary Retrieve an integration log file converted to PDF
|
|
47134
|
+
* @param {string} pk
|
|
47135
|
+
* @param {string} sk
|
|
47136
|
+
* @param {string} uuid
|
|
47137
|
+
* @param {*} [options] Override http request option.
|
|
47138
|
+
* @throws {RequiredError}
|
|
47139
|
+
*/
|
|
47140
|
+
getIntegrationLogFilePdf(pk: string, sk: string, uuid: string, options?: any) {
|
|
47141
|
+
return IntegrationLogApiFp(configuration).getIntegrationLogFilePdf(pk, sk, uuid, options)(fetch, basePath);
|
|
47142
|
+
},
|
|
46792
47143
|
/**
|
|
46793
47144
|
* Retrieves a set of integration log summaries from the account based on a query object.
|
|
46794
47145
|
* @summary Retrieve integration log summaries
|
|
@@ -46844,6 +47195,18 @@ export interface IntegrationLogApiInterface {
|
|
|
46844
47195
|
*/
|
|
46845
47196
|
getIntegrationLogFile(pk: string, sk: string, uuid: string, options?: any): Promise<Blob>;
|
|
46846
47197
|
|
|
47198
|
+
/**
|
|
47199
|
+
* Retrieve an integration log file from the account based identifiers
|
|
47200
|
+
* @summary Retrieve an integration log file converted to PDF
|
|
47201
|
+
* @param {string} pk
|
|
47202
|
+
* @param {string} sk
|
|
47203
|
+
* @param {string} uuid
|
|
47204
|
+
* @param {*} [options] Override http request option.
|
|
47205
|
+
* @throws {RequiredError}
|
|
47206
|
+
* @memberof IntegrationLogApiInterface
|
|
47207
|
+
*/
|
|
47208
|
+
getIntegrationLogFilePdf(pk: string, sk: string, uuid: string, options?: any): Promise<Blob>;
|
|
47209
|
+
|
|
46847
47210
|
/**
|
|
46848
47211
|
* Retrieves a set of integration log summaries from the account based on a query object.
|
|
46849
47212
|
* @summary Retrieve integration log summaries
|
|
@@ -46903,6 +47266,20 @@ export class IntegrationLogApi extends BaseAPI implements IntegrationLogApiInter
|
|
|
46903
47266
|
return IntegrationLogApiFp(this.configuration).getIntegrationLogFile(pk, sk, uuid, options)(this.fetch, this.basePath);
|
|
46904
47267
|
}
|
|
46905
47268
|
|
|
47269
|
+
/**
|
|
47270
|
+
* Retrieve an integration log file from the account based identifiers
|
|
47271
|
+
* @summary Retrieve an integration log file converted to PDF
|
|
47272
|
+
* @param {string} pk
|
|
47273
|
+
* @param {string} sk
|
|
47274
|
+
* @param {string} uuid
|
|
47275
|
+
* @param {*} [options] Override http request option.
|
|
47276
|
+
* @throws {RequiredError}
|
|
47277
|
+
* @memberof IntegrationLogApi
|
|
47278
|
+
*/
|
|
47279
|
+
public getIntegrationLogFilePdf(pk: string, sk: string, uuid: string, options?: any) {
|
|
47280
|
+
return IntegrationLogApiFp(this.configuration).getIntegrationLogFilePdf(pk, sk, uuid, options)(this.fetch, this.basePath);
|
|
47281
|
+
}
|
|
47282
|
+
|
|
46906
47283
|
/**
|
|
46907
47284
|
* Retrieves a set of integration log summaries from the account based on a query object.
|
|
46908
47285
|
* @summary Retrieve integration log summaries
|
|
@@ -48612,6 +48989,63 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
48612
48989
|
options: localVarRequestOptions,
|
|
48613
48990
|
};
|
|
48614
48991
|
},
|
|
48992
|
+
/**
|
|
48993
|
+
* Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
|
|
48994
|
+
* @summary Duplicate an order
|
|
48995
|
+
* @param {string} order_id The order id to duplicate.
|
|
48996
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
48997
|
+
* @param {*} [options] Override http request option.
|
|
48998
|
+
* @throws {RequiredError}
|
|
48999
|
+
*/
|
|
49000
|
+
duplicateOrder(order_id: string, _expand?: string, options: any = {}): FetchArgs {
|
|
49001
|
+
// verify required parameter 'order_id' is not null or undefined
|
|
49002
|
+
if (order_id === null || order_id === undefined) {
|
|
49003
|
+
throw new RequiredError('order_id','Required parameter order_id was null or undefined when calling duplicateOrder.');
|
|
49004
|
+
}
|
|
49005
|
+
const localVarPath = `/order/orders/{order_id}/duplicate`
|
|
49006
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
|
|
49007
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
49008
|
+
const localVarRequestOptions = Object.assign({ method: 'POST' }, options);
|
|
49009
|
+
const localVarHeaderParameter = {} as any;
|
|
49010
|
+
const localVarQueryParameter = {} as any;
|
|
49011
|
+
|
|
49012
|
+
if(configuration && configuration.apiVersion) {
|
|
49013
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
49014
|
+
}
|
|
49015
|
+
|
|
49016
|
+
|
|
49017
|
+
|
|
49018
|
+
// authentication ultraCartOauth required
|
|
49019
|
+
// oauth required
|
|
49020
|
+
if (configuration && configuration.accessToken) {
|
|
49021
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
49022
|
+
? configuration.accessToken("ultraCartOauth", ["order_write"])
|
|
49023
|
+
: configuration.accessToken;
|
|
49024
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
49025
|
+
}
|
|
49026
|
+
|
|
49027
|
+
// authentication ultraCartSimpleApiKey required
|
|
49028
|
+
if (configuration && configuration.apiKey) {
|
|
49029
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
49030
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
49031
|
+
: configuration.apiKey;
|
|
49032
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
49033
|
+
}
|
|
49034
|
+
|
|
49035
|
+
if (_expand !== undefined) {
|
|
49036
|
+
localVarQueryParameter['_expand'] = _expand;
|
|
49037
|
+
}
|
|
49038
|
+
|
|
49039
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
49040
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
49041
|
+
delete localVarUrlObj.search;
|
|
49042
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
49043
|
+
|
|
49044
|
+
return {
|
|
49045
|
+
url: url.format(localVarUrlObj),
|
|
49046
|
+
options: localVarRequestOptions,
|
|
49047
|
+
};
|
|
49048
|
+
},
|
|
48615
49049
|
/**
|
|
48616
49050
|
* Format the order for display at text or html
|
|
48617
49051
|
* @summary Format order
|
|
@@ -50021,6 +50455,28 @@ export const OrderApiFp = function(configuration?: Configuration) {
|
|
|
50021
50455
|
});
|
|
50022
50456
|
};
|
|
50023
50457
|
},
|
|
50458
|
+
/**
|
|
50459
|
+
* Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
|
|
50460
|
+
* @summary Duplicate an order
|
|
50461
|
+
* @param {string} order_id The order id to duplicate.
|
|
50462
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
50463
|
+
* @param {*} [options] Override http request option.
|
|
50464
|
+
* @throws {RequiredError}
|
|
50465
|
+
*/
|
|
50466
|
+
duplicateOrder(order_id: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse> {
|
|
50467
|
+
const localVarFetchArgs = OrderApiFetchParamCreator(configuration).duplicateOrder(order_id, _expand, options);
|
|
50468
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
50469
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
50470
|
+
|
|
50471
|
+
if (response.status >= 200 && response.status < 300) {
|
|
50472
|
+
return response.json();
|
|
50473
|
+
|
|
50474
|
+
} else {
|
|
50475
|
+
throw response;
|
|
50476
|
+
}
|
|
50477
|
+
});
|
|
50478
|
+
};
|
|
50479
|
+
},
|
|
50024
50480
|
/**
|
|
50025
50481
|
* Format the order for display at text or html
|
|
50026
50482
|
* @summary Format order
|
|
@@ -50523,6 +50979,17 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
|
|
|
50523
50979
|
deleteOrder(order_id: string, options?: any) {
|
|
50524
50980
|
return OrderApiFp(configuration).deleteOrder(order_id, options)(fetch, basePath);
|
|
50525
50981
|
},
|
|
50982
|
+
/**
|
|
50983
|
+
* Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
|
|
50984
|
+
* @summary Duplicate an order
|
|
50985
|
+
* @param {string} order_id The order id to duplicate.
|
|
50986
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
50987
|
+
* @param {*} [options] Override http request option.
|
|
50988
|
+
* @throws {RequiredError}
|
|
50989
|
+
*/
|
|
50990
|
+
duplicateOrder(order_id: string, _expand?: string, options?: any) {
|
|
50991
|
+
return OrderApiFp(configuration).duplicateOrder(order_id, _expand, options)(fetch, basePath);
|
|
50992
|
+
},
|
|
50526
50993
|
/**
|
|
50527
50994
|
* Format the order for display at text or html
|
|
50528
50995
|
* @summary Format order
|
|
@@ -50816,6 +51283,17 @@ export interface OrderApiInterface {
|
|
|
50816
51283
|
*/
|
|
50817
51284
|
deleteOrder(order_id: string, options?: any): Promise<{}>;
|
|
50818
51285
|
|
|
51286
|
+
/**
|
|
51287
|
+
* Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
|
|
51288
|
+
* @summary Duplicate an order
|
|
51289
|
+
* @param {string} order_id The order id to duplicate.
|
|
51290
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
51291
|
+
* @param {*} [options] Override http request option.
|
|
51292
|
+
* @throws {RequiredError}
|
|
51293
|
+
* @memberof OrderApiInterface
|
|
51294
|
+
*/
|
|
51295
|
+
duplicateOrder(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
51296
|
+
|
|
50819
51297
|
/**
|
|
50820
51298
|
* Format the order for display at text or html
|
|
50821
51299
|
* @summary Format order
|
|
@@ -51115,6 +51593,19 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
51115
51593
|
return OrderApiFp(this.configuration).deleteOrder(order_id, options)(this.fetch, this.basePath);
|
|
51116
51594
|
}
|
|
51117
51595
|
|
|
51596
|
+
/**
|
|
51597
|
+
* Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
|
|
51598
|
+
* @summary Duplicate an order
|
|
51599
|
+
* @param {string} order_id The order id to duplicate.
|
|
51600
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
51601
|
+
* @param {*} [options] Override http request option.
|
|
51602
|
+
* @throws {RequiredError}
|
|
51603
|
+
* @memberof OrderApi
|
|
51604
|
+
*/
|
|
51605
|
+
public duplicateOrder(order_id: string, _expand?: string, options?: any) {
|
|
51606
|
+
return OrderApiFp(this.configuration).duplicateOrder(order_id, _expand, options)(this.fetch, this.basePath);
|
|
51607
|
+
}
|
|
51608
|
+
|
|
51118
51609
|
/**
|
|
51119
51610
|
* Format the order for display at text or html
|
|
51120
51611
|
* @summary Format order
|