ultracart_rest_api_v2_typescript 3.10.36 → 3.10.39
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 +422 -2
- package/dist/api.d.ts +284 -2
- package/dist/api.js +205 -3
- 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.39
|
|
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.39 --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.39 | 08/19/2022 | order api - added cell phone fields for sms |
|
|
58
|
+
| 3.10.38 | 08/12/2022 | internal code to allow merchant login as customer |
|
|
59
|
+
| 3.10.37 | 08/11/2022 | fix entry_dts type on gift certificate ledger |
|
|
57
60
|
| 3.10.36 | 08/10/2022 | conversation event refactoring |
|
|
58
61
|
| 3.10.35 | 08/05/2022 | conversation adjustments for ES integration |
|
|
59
62
|
| 3.10.34 | 08/05/2022 | conversations query by medium and stats fixes |
|
package/api.ts
CHANGED
|
@@ -3859,6 +3859,12 @@ export interface CartMarketing {
|
|
|
3859
3859
|
* @memberof CartMarketing
|
|
3860
3860
|
*/
|
|
3861
3861
|
advertising_source?: string;
|
|
3862
|
+
/**
|
|
3863
|
+
* True if the customer agrees to receiving marketing SMS messages
|
|
3864
|
+
* @type {boolean}
|
|
3865
|
+
* @memberof CartMarketing
|
|
3866
|
+
*/
|
|
3867
|
+
cell_phone_opt_in?: boolean;
|
|
3862
3868
|
/**
|
|
3863
3869
|
* True if the customer agrees to receiving marketing emails
|
|
3864
3870
|
* @type {boolean}
|
|
@@ -6824,6 +6830,12 @@ export interface ConversationParticipant {
|
|
|
6824
6830
|
* @memberof ConversationParticipant
|
|
6825
6831
|
*/
|
|
6826
6832
|
left_dts?: string;
|
|
6833
|
+
/**
|
|
6834
|
+
*
|
|
6835
|
+
* @type {string}
|
|
6836
|
+
* @memberof ConversationParticipant
|
|
6837
|
+
*/
|
|
6838
|
+
profile_image_url?: string;
|
|
6827
6839
|
/**
|
|
6828
6840
|
*
|
|
6829
6841
|
* @type {string}
|
|
@@ -7148,11 +7160,11 @@ export interface ConversationWebchatQueueStatus {
|
|
|
7148
7160
|
*/
|
|
7149
7161
|
export interface ConversationWebchatQueueStatusAgent {
|
|
7150
7162
|
/**
|
|
7151
|
-
*
|
|
7163
|
+
* Status of the agent
|
|
7152
7164
|
* @type {string}
|
|
7153
7165
|
* @memberof ConversationWebchatQueueStatusAgent
|
|
7154
7166
|
*/
|
|
7155
|
-
agent_status?:
|
|
7167
|
+
agent_status?: ConversationWebchatQueueStatusAgent.AgentStatusEnum;
|
|
7156
7168
|
/**
|
|
7157
7169
|
*
|
|
7158
7170
|
* @type {string}
|
|
@@ -7177,6 +7189,28 @@ export interface ConversationWebchatQueueStatusAgent {
|
|
|
7177
7189
|
* @memberof ConversationWebchatQueueStatusAgent
|
|
7178
7190
|
*/
|
|
7179
7191
|
next_round_robin?: boolean;
|
|
7192
|
+
/**
|
|
7193
|
+
* Profile image URL
|
|
7194
|
+
* @type {string}
|
|
7195
|
+
* @memberof ConversationWebchatQueueStatusAgent
|
|
7196
|
+
*/
|
|
7197
|
+
profile_image_url?: string;
|
|
7198
|
+
}
|
|
7199
|
+
|
|
7200
|
+
/**
|
|
7201
|
+
* @export
|
|
7202
|
+
* @namespace ConversationWebchatQueueStatusAgent
|
|
7203
|
+
*/
|
|
7204
|
+
export namespace ConversationWebchatQueueStatusAgent {
|
|
7205
|
+
/**
|
|
7206
|
+
* @export
|
|
7207
|
+
* @enum {string}
|
|
7208
|
+
*/
|
|
7209
|
+
export enum AgentStatusEnum {
|
|
7210
|
+
Available = <any> 'available',
|
|
7211
|
+
Busy = <any> 'busy',
|
|
7212
|
+
Unavailable = <any> 'unavailable'
|
|
7213
|
+
}
|
|
7180
7214
|
}
|
|
7181
7215
|
|
|
7182
7216
|
/**
|
|
@@ -10738,6 +10772,44 @@ export interface CustomerLoyaltyRedemption {
|
|
|
10738
10772
|
remaining_balance?: number;
|
|
10739
10773
|
}
|
|
10740
10774
|
|
|
10775
|
+
/**
|
|
10776
|
+
*
|
|
10777
|
+
* @export
|
|
10778
|
+
* @interface CustomerMagicLinkResponse
|
|
10779
|
+
*/
|
|
10780
|
+
export interface CustomerMagicLinkResponse {
|
|
10781
|
+
/**
|
|
10782
|
+
*
|
|
10783
|
+
* @type {ModelError}
|
|
10784
|
+
* @memberof CustomerMagicLinkResponse
|
|
10785
|
+
*/
|
|
10786
|
+
error?: ModelError;
|
|
10787
|
+
/**
|
|
10788
|
+
*
|
|
10789
|
+
* @type {ResponseMetadata}
|
|
10790
|
+
* @memberof CustomerMagicLinkResponse
|
|
10791
|
+
*/
|
|
10792
|
+
metadata?: ResponseMetadata;
|
|
10793
|
+
/**
|
|
10794
|
+
* Indicates if API call was successful
|
|
10795
|
+
* @type {boolean}
|
|
10796
|
+
* @memberof CustomerMagicLinkResponse
|
|
10797
|
+
*/
|
|
10798
|
+
success?: boolean;
|
|
10799
|
+
/**
|
|
10800
|
+
* URL
|
|
10801
|
+
* @type {string}
|
|
10802
|
+
* @memberof CustomerMagicLinkResponse
|
|
10803
|
+
*/
|
|
10804
|
+
url?: string;
|
|
10805
|
+
/**
|
|
10806
|
+
*
|
|
10807
|
+
* @type {Warning}
|
|
10808
|
+
* @memberof CustomerMagicLinkResponse
|
|
10809
|
+
*/
|
|
10810
|
+
warning?: Warning;
|
|
10811
|
+
}
|
|
10812
|
+
|
|
10741
10813
|
/**
|
|
10742
10814
|
*
|
|
10743
10815
|
* @export
|
|
@@ -25022,6 +25094,18 @@ export interface OrderBilling {
|
|
|
25022
25094
|
* @memberof OrderBilling
|
|
25023
25095
|
*/
|
|
25024
25096
|
cc_emails?: Array<string>;
|
|
25097
|
+
/**
|
|
25098
|
+
* Cell phone
|
|
25099
|
+
* @type {string}
|
|
25100
|
+
* @memberof OrderBilling
|
|
25101
|
+
*/
|
|
25102
|
+
cell_phone?: string;
|
|
25103
|
+
/**
|
|
25104
|
+
* Cell phone (E164 format)
|
|
25105
|
+
* @type {string}
|
|
25106
|
+
* @memberof OrderBilling
|
|
25107
|
+
*/
|
|
25108
|
+
cell_phone_e164?: string;
|
|
25025
25109
|
/**
|
|
25026
25110
|
* City
|
|
25027
25111
|
* @type {string}
|
|
@@ -26553,6 +26637,12 @@ export interface OrderMarketing {
|
|
|
26553
26637
|
* @memberof OrderMarketing
|
|
26554
26638
|
*/
|
|
26555
26639
|
advertising_source?: string;
|
|
26640
|
+
/**
|
|
26641
|
+
* True if the customer has opted into SMS marketing
|
|
26642
|
+
* @type {boolean}
|
|
26643
|
+
* @memberof OrderMarketing
|
|
26644
|
+
*/
|
|
26645
|
+
cell_phone_opt_in?: boolean;
|
|
26556
26646
|
/**
|
|
26557
26647
|
* True if the customer has opted into mailing list subscription
|
|
26558
26648
|
* @type {boolean}
|
|
@@ -31679,6 +31769,118 @@ export interface StepWaiting {
|
|
|
31679
31769
|
number_waiting?: number;
|
|
31680
31770
|
}
|
|
31681
31771
|
|
|
31772
|
+
/**
|
|
31773
|
+
*
|
|
31774
|
+
* @export
|
|
31775
|
+
* @interface StoreFront
|
|
31776
|
+
*/
|
|
31777
|
+
export interface StoreFront {
|
|
31778
|
+
/**
|
|
31779
|
+
*
|
|
31780
|
+
* @type {string}
|
|
31781
|
+
* @memberof StoreFront
|
|
31782
|
+
*/
|
|
31783
|
+
host_alias1?: string;
|
|
31784
|
+
/**
|
|
31785
|
+
*
|
|
31786
|
+
* @type {string}
|
|
31787
|
+
* @memberof StoreFront
|
|
31788
|
+
*/
|
|
31789
|
+
host_alias2?: string;
|
|
31790
|
+
/**
|
|
31791
|
+
*
|
|
31792
|
+
* @type {string}
|
|
31793
|
+
* @memberof StoreFront
|
|
31794
|
+
*/
|
|
31795
|
+
host_alias3?: string;
|
|
31796
|
+
/**
|
|
31797
|
+
*
|
|
31798
|
+
* @type {string}
|
|
31799
|
+
* @memberof StoreFront
|
|
31800
|
+
*/
|
|
31801
|
+
host_alias4?: string;
|
|
31802
|
+
/**
|
|
31803
|
+
*
|
|
31804
|
+
* @type {string}
|
|
31805
|
+
* @memberof StoreFront
|
|
31806
|
+
*/
|
|
31807
|
+
host_alias5?: string;
|
|
31808
|
+
/**
|
|
31809
|
+
*
|
|
31810
|
+
* @type {string}
|
|
31811
|
+
* @memberof StoreFront
|
|
31812
|
+
*/
|
|
31813
|
+
host_name?: string;
|
|
31814
|
+
/**
|
|
31815
|
+
*
|
|
31816
|
+
* @type {boolean}
|
|
31817
|
+
* @memberof StoreFront
|
|
31818
|
+
*/
|
|
31819
|
+
locked?: boolean;
|
|
31820
|
+
/**
|
|
31821
|
+
*
|
|
31822
|
+
* @type {string}
|
|
31823
|
+
* @memberof StoreFront
|
|
31824
|
+
*/
|
|
31825
|
+
merchant_id?: string;
|
|
31826
|
+
/**
|
|
31827
|
+
*
|
|
31828
|
+
* @type {boolean}
|
|
31829
|
+
* @memberof StoreFront
|
|
31830
|
+
*/
|
|
31831
|
+
redirect_aliases?: boolean;
|
|
31832
|
+
/**
|
|
31833
|
+
*
|
|
31834
|
+
* @type {number}
|
|
31835
|
+
* @memberof StoreFront
|
|
31836
|
+
*/
|
|
31837
|
+
storefront_oid?: number;
|
|
31838
|
+
/**
|
|
31839
|
+
*
|
|
31840
|
+
* @type {string}
|
|
31841
|
+
* @memberof StoreFront
|
|
31842
|
+
*/
|
|
31843
|
+
unlock_password?: string;
|
|
31844
|
+
}
|
|
31845
|
+
|
|
31846
|
+
/**
|
|
31847
|
+
*
|
|
31848
|
+
* @export
|
|
31849
|
+
* @interface StoreFrontsResponse
|
|
31850
|
+
*/
|
|
31851
|
+
export interface StoreFrontsResponse {
|
|
31852
|
+
/**
|
|
31853
|
+
*
|
|
31854
|
+
* @type {ModelError}
|
|
31855
|
+
* @memberof StoreFrontsResponse
|
|
31856
|
+
*/
|
|
31857
|
+
error?: ModelError;
|
|
31858
|
+
/**
|
|
31859
|
+
*
|
|
31860
|
+
* @type {ResponseMetadata}
|
|
31861
|
+
* @memberof StoreFrontsResponse
|
|
31862
|
+
*/
|
|
31863
|
+
metadata?: ResponseMetadata;
|
|
31864
|
+
/**
|
|
31865
|
+
*
|
|
31866
|
+
* @type {Array<StoreFront>}
|
|
31867
|
+
* @memberof StoreFrontsResponse
|
|
31868
|
+
*/
|
|
31869
|
+
storeFronts?: Array<StoreFront>;
|
|
31870
|
+
/**
|
|
31871
|
+
* Indicates if API call was successful
|
|
31872
|
+
* @type {boolean}
|
|
31873
|
+
* @memberof StoreFrontsResponse
|
|
31874
|
+
*/
|
|
31875
|
+
success?: boolean;
|
|
31876
|
+
/**
|
|
31877
|
+
*
|
|
31878
|
+
* @type {Warning}
|
|
31879
|
+
* @memberof StoreFrontsResponse
|
|
31880
|
+
*/
|
|
31881
|
+
warning?: Warning;
|
|
31882
|
+
}
|
|
31883
|
+
|
|
31682
31884
|
/**
|
|
31683
31885
|
*
|
|
31684
31886
|
* @export
|
|
@@ -43435,6 +43637,64 @@ export const CustomerApiFetchParamCreator = function (configuration?: Configurat
|
|
|
43435
43637
|
options: localVarRequestOptions,
|
|
43436
43638
|
};
|
|
43437
43639
|
},
|
|
43640
|
+
/**
|
|
43641
|
+
* Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
|
43642
|
+
* @summary getMagicLink
|
|
43643
|
+
* @param {number} customer_profile_oid The customer_profile_oid of the customer.
|
|
43644
|
+
* @param {string} storefront_host_name The storefront to log into.
|
|
43645
|
+
* @param {*} [options] Override http request option.
|
|
43646
|
+
* @throws {RequiredError}
|
|
43647
|
+
*/
|
|
43648
|
+
getMagicLink(customer_profile_oid: number, storefront_host_name: string, options: any = {}): FetchArgs {
|
|
43649
|
+
// verify required parameter 'customer_profile_oid' is not null or undefined
|
|
43650
|
+
if (customer_profile_oid === null || customer_profile_oid === undefined) {
|
|
43651
|
+
throw new RequiredError('customer_profile_oid','Required parameter customer_profile_oid was null or undefined when calling getMagicLink.');
|
|
43652
|
+
}
|
|
43653
|
+
// verify required parameter 'storefront_host_name' is not null or undefined
|
|
43654
|
+
if (storefront_host_name === null || storefront_host_name === undefined) {
|
|
43655
|
+
throw new RequiredError('storefront_host_name','Required parameter storefront_host_name was null or undefined when calling getMagicLink.');
|
|
43656
|
+
}
|
|
43657
|
+
const localVarPath = `/customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name}`
|
|
43658
|
+
.replace(`{${"customer_profile_oid"}}`, encodeURIComponent(String(customer_profile_oid)))
|
|
43659
|
+
.replace(`{${"storefront_host_name"}}`, encodeURIComponent(String(storefront_host_name)));
|
|
43660
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
43661
|
+
const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
|
|
43662
|
+
const localVarHeaderParameter = {} as any;
|
|
43663
|
+
const localVarQueryParameter = {} as any;
|
|
43664
|
+
|
|
43665
|
+
if(configuration && configuration.apiVersion) {
|
|
43666
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
43667
|
+
}
|
|
43668
|
+
|
|
43669
|
+
|
|
43670
|
+
|
|
43671
|
+
// authentication ultraCartOauth required
|
|
43672
|
+
// oauth required
|
|
43673
|
+
if (configuration && configuration.accessToken) {
|
|
43674
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
43675
|
+
? configuration.accessToken("ultraCartOauth", ["customer_write"])
|
|
43676
|
+
: configuration.accessToken;
|
|
43677
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
43678
|
+
}
|
|
43679
|
+
|
|
43680
|
+
// authentication ultraCartSimpleApiKey required
|
|
43681
|
+
if (configuration && configuration.apiKey) {
|
|
43682
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
43683
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
43684
|
+
: configuration.apiKey;
|
|
43685
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
43686
|
+
}
|
|
43687
|
+
|
|
43688
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
43689
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
43690
|
+
delete localVarUrlObj.search;
|
|
43691
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
43692
|
+
|
|
43693
|
+
return {
|
|
43694
|
+
url: url.format(localVarUrlObj),
|
|
43695
|
+
options: localVarRequestOptions,
|
|
43696
|
+
};
|
|
43697
|
+
},
|
|
43438
43698
|
/**
|
|
43439
43699
|
* Insert a customer on the UltraCart account.
|
|
43440
43700
|
* @summary Insert a customer
|
|
@@ -44105,6 +44365,28 @@ export const CustomerApiFp = function(configuration?: Configuration) {
|
|
|
44105
44365
|
});
|
|
44106
44366
|
};
|
|
44107
44367
|
},
|
|
44368
|
+
/**
|
|
44369
|
+
* Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
|
44370
|
+
* @summary getMagicLink
|
|
44371
|
+
* @param {number} customer_profile_oid The customer_profile_oid of the customer.
|
|
44372
|
+
* @param {string} storefront_host_name The storefront to log into.
|
|
44373
|
+
* @param {*} [options] Override http request option.
|
|
44374
|
+
* @throws {RequiredError}
|
|
44375
|
+
*/
|
|
44376
|
+
getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CustomerMagicLinkResponse> {
|
|
44377
|
+
const localVarFetchArgs = CustomerApiFetchParamCreator(configuration).getMagicLink(customer_profile_oid, storefront_host_name, options);
|
|
44378
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
44379
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
44380
|
+
|
|
44381
|
+
if (response.status >= 200 && response.status < 300) {
|
|
44382
|
+
return response.json();
|
|
44383
|
+
|
|
44384
|
+
} else {
|
|
44385
|
+
throw response;
|
|
44386
|
+
}
|
|
44387
|
+
});
|
|
44388
|
+
};
|
|
44389
|
+
},
|
|
44108
44390
|
/**
|
|
44109
44391
|
* Insert a customer on the UltraCart account.
|
|
44110
44392
|
* @summary Insert a customer
|
|
@@ -44404,6 +44686,17 @@ export const CustomerApiFactory = function (configuration?: Configuration, fetch
|
|
|
44404
44686
|
getEmailVerificationToken(token_request: EmailVerifyTokenRequest, options?: any) {
|
|
44405
44687
|
return CustomerApiFp(configuration).getEmailVerificationToken(token_request, options)(fetch, basePath);
|
|
44406
44688
|
},
|
|
44689
|
+
/**
|
|
44690
|
+
* Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
|
44691
|
+
* @summary getMagicLink
|
|
44692
|
+
* @param {number} customer_profile_oid The customer_profile_oid of the customer.
|
|
44693
|
+
* @param {string} storefront_host_name The storefront to log into.
|
|
44694
|
+
* @param {*} [options] Override http request option.
|
|
44695
|
+
* @throws {RequiredError}
|
|
44696
|
+
*/
|
|
44697
|
+
getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any) {
|
|
44698
|
+
return CustomerApiFp(configuration).getMagicLink(customer_profile_oid, storefront_host_name, options)(fetch, basePath);
|
|
44699
|
+
},
|
|
44407
44700
|
/**
|
|
44408
44701
|
* Insert a customer on the UltraCart account.
|
|
44409
44702
|
* @summary Insert a customer
|
|
@@ -44637,6 +44930,17 @@ export interface CustomerApiInterface {
|
|
|
44637
44930
|
*/
|
|
44638
44931
|
getEmailVerificationToken(token_request: EmailVerifyTokenRequest, options?: any): Promise<EmailVerifyTokenResponse>;
|
|
44639
44932
|
|
|
44933
|
+
/**
|
|
44934
|
+
* Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
|
44935
|
+
* @summary getMagicLink
|
|
44936
|
+
* @param {number} customer_profile_oid The customer_profile_oid of the customer.
|
|
44937
|
+
* @param {string} storefront_host_name The storefront to log into.
|
|
44938
|
+
* @param {*} [options] Override http request option.
|
|
44939
|
+
* @throws {RequiredError}
|
|
44940
|
+
* @memberof CustomerApiInterface
|
|
44941
|
+
*/
|
|
44942
|
+
getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any): Promise<CustomerMagicLinkResponse>;
|
|
44943
|
+
|
|
44640
44944
|
/**
|
|
44641
44945
|
* Insert a customer on the UltraCart account.
|
|
44642
44946
|
* @summary Insert a customer
|
|
@@ -44894,6 +45198,19 @@ export class CustomerApi extends BaseAPI implements CustomerApiInterface {
|
|
|
44894
45198
|
return CustomerApiFp(this.configuration).getEmailVerificationToken(token_request, options)(this.fetch, this.basePath);
|
|
44895
45199
|
}
|
|
44896
45200
|
|
|
45201
|
+
/**
|
|
45202
|
+
* Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
|
45203
|
+
* @summary getMagicLink
|
|
45204
|
+
* @param {number} customer_profile_oid The customer_profile_oid of the customer.
|
|
45205
|
+
* @param {string} storefront_host_name The storefront to log into.
|
|
45206
|
+
* @param {*} [options] Override http request option.
|
|
45207
|
+
* @throws {RequiredError}
|
|
45208
|
+
* @memberof CustomerApi
|
|
45209
|
+
*/
|
|
45210
|
+
public getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any) {
|
|
45211
|
+
return CustomerApiFp(this.configuration).getMagicLink(customer_profile_oid, storefront_host_name, options)(this.fetch, this.basePath);
|
|
45212
|
+
}
|
|
45213
|
+
|
|
44897
45214
|
/**
|
|
44898
45215
|
* Insert a customer on the UltraCart account.
|
|
44899
45216
|
* @summary Insert a customer
|
|
@@ -58814,6 +59131,60 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
|
|
|
58814
59131
|
options: localVarRequestOptions,
|
|
58815
59132
|
};
|
|
58816
59133
|
},
|
|
59134
|
+
/**
|
|
59135
|
+
*
|
|
59136
|
+
* @summary Get storefronts (internal use only for security reasons)
|
|
59137
|
+
* @param {*} [options] Override http request option.
|
|
59138
|
+
* @throws {RequiredError}
|
|
59139
|
+
*/
|
|
59140
|
+
getStoreFronts(options: any = {}): FetchArgs {
|
|
59141
|
+
const localVarPath = `/storefront`;
|
|
59142
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
59143
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
59144
|
+
const localVarHeaderParameter = {} as any;
|
|
59145
|
+
const localVarQueryParameter = {} as any;
|
|
59146
|
+
|
|
59147
|
+
if(configuration && configuration.apiVersion) {
|
|
59148
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
59149
|
+
}
|
|
59150
|
+
|
|
59151
|
+
|
|
59152
|
+
|
|
59153
|
+
// authentication ultraCartBrowserApiKey required
|
|
59154
|
+
if (configuration && configuration.apiKey) {
|
|
59155
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
59156
|
+
? configuration.apiKey("x-ultracart-browser-key")
|
|
59157
|
+
: configuration.apiKey;
|
|
59158
|
+
localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
|
|
59159
|
+
}
|
|
59160
|
+
|
|
59161
|
+
// authentication ultraCartOauth required
|
|
59162
|
+
// oauth required
|
|
59163
|
+
if (configuration && configuration.accessToken) {
|
|
59164
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
59165
|
+
? configuration.accessToken("ultraCartOauth", ["ultrabooks_write", "auto_order_write", "coupon_read", "affiliate_read", "coupon_write", "channel_partner_read", "tax_read", "conversation_write", "fulfillment_write", "tax_write", "gift_certificate_write", "channel_partner_write", "item_read", "fulfillment_read", "webhook_write", "chargeback_write", "user_write", "gift_certificate_read", "checkout_write", "storefront_read", "webhook_read", "item_write", "auto_order_read", "customer_read", "user_read", "configuration_read", "customer_write", "order_read", "conversation_read", "affiliate_write", "storefront_write", "ultrabooks_read", "order_write", "chargeback_read", "integration_log_write", "configuration_write", "checkout_read", "integration_log_read"])
|
|
59166
|
+
: configuration.accessToken;
|
|
59167
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
59168
|
+
}
|
|
59169
|
+
|
|
59170
|
+
// authentication ultraCartSimpleApiKey required
|
|
59171
|
+
if (configuration && configuration.apiKey) {
|
|
59172
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
59173
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
59174
|
+
: configuration.apiKey;
|
|
59175
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
59176
|
+
}
|
|
59177
|
+
|
|
59178
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
59179
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
59180
|
+
delete localVarUrlObj.search;
|
|
59181
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
59182
|
+
|
|
59183
|
+
return {
|
|
59184
|
+
url: url.format(localVarUrlObj),
|
|
59185
|
+
options: localVarRequestOptions,
|
|
59186
|
+
};
|
|
59187
|
+
},
|
|
58817
59188
|
/**
|
|
58818
59189
|
*
|
|
58819
59190
|
* @summary Get thumbnail parameters
|
|
@@ -65371,6 +65742,26 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
|
|
|
65371
65742
|
});
|
|
65372
65743
|
};
|
|
65373
65744
|
},
|
|
65745
|
+
/**
|
|
65746
|
+
*
|
|
65747
|
+
* @summary Get storefronts (internal use only for security reasons)
|
|
65748
|
+
* @param {*} [options] Override http request option.
|
|
65749
|
+
* @throws {RequiredError}
|
|
65750
|
+
*/
|
|
65751
|
+
getStoreFronts(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<StoreFrontsResponse> {
|
|
65752
|
+
const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).getStoreFronts(options);
|
|
65753
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
65754
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
65755
|
+
|
|
65756
|
+
if (response.status >= 200 && response.status < 300) {
|
|
65757
|
+
return response.json();
|
|
65758
|
+
|
|
65759
|
+
} else {
|
|
65760
|
+
throw response;
|
|
65761
|
+
}
|
|
65762
|
+
});
|
|
65763
|
+
};
|
|
65764
|
+
},
|
|
65374
65765
|
/**
|
|
65375
65766
|
*
|
|
65376
65767
|
* @summary Get thumbnail parameters
|
|
@@ -67878,6 +68269,15 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
|
|
|
67878
68269
|
getStoreFrontPricingTiers(_expand?: string, options?: any) {
|
|
67879
68270
|
return StorefrontApiFp(configuration).getStoreFrontPricingTiers(_expand, options)(fetch, basePath);
|
|
67880
68271
|
},
|
|
68272
|
+
/**
|
|
68273
|
+
*
|
|
68274
|
+
* @summary Get storefronts (internal use only for security reasons)
|
|
68275
|
+
* @param {*} [options] Override http request option.
|
|
68276
|
+
* @throws {RequiredError}
|
|
68277
|
+
*/
|
|
68278
|
+
getStoreFronts(options?: any) {
|
|
68279
|
+
return StorefrontApiFp(configuration).getStoreFronts(options)(fetch, basePath);
|
|
68280
|
+
},
|
|
67881
68281
|
/**
|
|
67882
68282
|
*
|
|
67883
68283
|
* @summary Get thumbnail parameters
|
|
@@ -69703,6 +70103,15 @@ export interface StorefrontApiInterface {
|
|
|
69703
70103
|
*/
|
|
69704
70104
|
getStoreFrontPricingTiers(_expand?: string, options?: any): Promise<PricingTiersResponse>;
|
|
69705
70105
|
|
|
70106
|
+
/**
|
|
70107
|
+
*
|
|
70108
|
+
* @summary Get storefronts (internal use only for security reasons)
|
|
70109
|
+
* @param {*} [options] Override http request option.
|
|
70110
|
+
* @throws {RequiredError}
|
|
70111
|
+
* @memberof StorefrontApiInterface
|
|
70112
|
+
*/
|
|
70113
|
+
getStoreFronts(options?: any): Promise<StoreFrontsResponse>;
|
|
70114
|
+
|
|
69706
70115
|
/**
|
|
69707
70116
|
*
|
|
69708
70117
|
* @summary Get thumbnail parameters
|
|
@@ -71730,6 +72139,17 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
|
|
|
71730
72139
|
return StorefrontApiFp(this.configuration).getStoreFrontPricingTiers(_expand, options)(this.fetch, this.basePath);
|
|
71731
72140
|
}
|
|
71732
72141
|
|
|
72142
|
+
/**
|
|
72143
|
+
*
|
|
72144
|
+
* @summary Get storefronts (internal use only for security reasons)
|
|
72145
|
+
* @param {*} [options] Override http request option.
|
|
72146
|
+
* @throws {RequiredError}
|
|
72147
|
+
* @memberof StorefrontApi
|
|
72148
|
+
*/
|
|
72149
|
+
public getStoreFronts(options?: any) {
|
|
72150
|
+
return StorefrontApiFp(this.configuration).getStoreFronts(options)(this.fetch, this.basePath);
|
|
72151
|
+
}
|
|
72152
|
+
|
|
71733
72153
|
/**
|
|
71734
72154
|
*
|
|
71735
72155
|
* @summary Get thumbnail parameters
|
package/dist/api.d.ts
CHANGED
|
@@ -3768,6 +3768,12 @@ export interface CartMarketing {
|
|
|
3768
3768
|
* @memberof CartMarketing
|
|
3769
3769
|
*/
|
|
3770
3770
|
advertising_source?: string;
|
|
3771
|
+
/**
|
|
3772
|
+
* True if the customer agrees to receiving marketing SMS messages
|
|
3773
|
+
* @type {boolean}
|
|
3774
|
+
* @memberof CartMarketing
|
|
3775
|
+
*/
|
|
3776
|
+
cell_phone_opt_in?: boolean;
|
|
3771
3777
|
/**
|
|
3772
3778
|
* True if the customer agrees to receiving marketing emails
|
|
3773
3779
|
* @type {boolean}
|
|
@@ -6662,6 +6668,12 @@ export interface ConversationParticipant {
|
|
|
6662
6668
|
* @memberof ConversationParticipant
|
|
6663
6669
|
*/
|
|
6664
6670
|
left_dts?: string;
|
|
6671
|
+
/**
|
|
6672
|
+
*
|
|
6673
|
+
* @type {string}
|
|
6674
|
+
* @memberof ConversationParticipant
|
|
6675
|
+
*/
|
|
6676
|
+
profile_image_url?: string;
|
|
6665
6677
|
/**
|
|
6666
6678
|
*
|
|
6667
6679
|
* @type {string}
|
|
@@ -6978,11 +6990,11 @@ export interface ConversationWebchatQueueStatus {
|
|
|
6978
6990
|
*/
|
|
6979
6991
|
export interface ConversationWebchatQueueStatusAgent {
|
|
6980
6992
|
/**
|
|
6981
|
-
*
|
|
6993
|
+
* Status of the agent
|
|
6982
6994
|
* @type {string}
|
|
6983
6995
|
* @memberof ConversationWebchatQueueStatusAgent
|
|
6984
6996
|
*/
|
|
6985
|
-
agent_status?:
|
|
6997
|
+
agent_status?: ConversationWebchatQueueStatusAgent.AgentStatusEnum;
|
|
6986
6998
|
/**
|
|
6987
6999
|
*
|
|
6988
7000
|
* @type {string}
|
|
@@ -7007,6 +7019,27 @@ export interface ConversationWebchatQueueStatusAgent {
|
|
|
7007
7019
|
* @memberof ConversationWebchatQueueStatusAgent
|
|
7008
7020
|
*/
|
|
7009
7021
|
next_round_robin?: boolean;
|
|
7022
|
+
/**
|
|
7023
|
+
* Profile image URL
|
|
7024
|
+
* @type {string}
|
|
7025
|
+
* @memberof ConversationWebchatQueueStatusAgent
|
|
7026
|
+
*/
|
|
7027
|
+
profile_image_url?: string;
|
|
7028
|
+
}
|
|
7029
|
+
/**
|
|
7030
|
+
* @export
|
|
7031
|
+
* @namespace ConversationWebchatQueueStatusAgent
|
|
7032
|
+
*/
|
|
7033
|
+
export declare namespace ConversationWebchatQueueStatusAgent {
|
|
7034
|
+
/**
|
|
7035
|
+
* @export
|
|
7036
|
+
* @enum {string}
|
|
7037
|
+
*/
|
|
7038
|
+
enum AgentStatusEnum {
|
|
7039
|
+
Available,
|
|
7040
|
+
Busy,
|
|
7041
|
+
Unavailable
|
|
7042
|
+
}
|
|
7010
7043
|
}
|
|
7011
7044
|
/**
|
|
7012
7045
|
*
|
|
@@ -10483,6 +10516,43 @@ export interface CustomerLoyaltyRedemption {
|
|
|
10483
10516
|
*/
|
|
10484
10517
|
remaining_balance?: number;
|
|
10485
10518
|
}
|
|
10519
|
+
/**
|
|
10520
|
+
*
|
|
10521
|
+
* @export
|
|
10522
|
+
* @interface CustomerMagicLinkResponse
|
|
10523
|
+
*/
|
|
10524
|
+
export interface CustomerMagicLinkResponse {
|
|
10525
|
+
/**
|
|
10526
|
+
*
|
|
10527
|
+
* @type {ModelError}
|
|
10528
|
+
* @memberof CustomerMagicLinkResponse
|
|
10529
|
+
*/
|
|
10530
|
+
error?: ModelError;
|
|
10531
|
+
/**
|
|
10532
|
+
*
|
|
10533
|
+
* @type {ResponseMetadata}
|
|
10534
|
+
* @memberof CustomerMagicLinkResponse
|
|
10535
|
+
*/
|
|
10536
|
+
metadata?: ResponseMetadata;
|
|
10537
|
+
/**
|
|
10538
|
+
* Indicates if API call was successful
|
|
10539
|
+
* @type {boolean}
|
|
10540
|
+
* @memberof CustomerMagicLinkResponse
|
|
10541
|
+
*/
|
|
10542
|
+
success?: boolean;
|
|
10543
|
+
/**
|
|
10544
|
+
* URL
|
|
10545
|
+
* @type {string}
|
|
10546
|
+
* @memberof CustomerMagicLinkResponse
|
|
10547
|
+
*/
|
|
10548
|
+
url?: string;
|
|
10549
|
+
/**
|
|
10550
|
+
*
|
|
10551
|
+
* @type {Warning}
|
|
10552
|
+
* @memberof CustomerMagicLinkResponse
|
|
10553
|
+
*/
|
|
10554
|
+
warning?: Warning;
|
|
10555
|
+
}
|
|
10486
10556
|
/**
|
|
10487
10557
|
*
|
|
10488
10558
|
* @export
|
|
@@ -24482,6 +24552,18 @@ export interface OrderBilling {
|
|
|
24482
24552
|
* @memberof OrderBilling
|
|
24483
24553
|
*/
|
|
24484
24554
|
cc_emails?: Array<string>;
|
|
24555
|
+
/**
|
|
24556
|
+
* Cell phone
|
|
24557
|
+
* @type {string}
|
|
24558
|
+
* @memberof OrderBilling
|
|
24559
|
+
*/
|
|
24560
|
+
cell_phone?: string;
|
|
24561
|
+
/**
|
|
24562
|
+
* Cell phone (E164 format)
|
|
24563
|
+
* @type {string}
|
|
24564
|
+
* @memberof OrderBilling
|
|
24565
|
+
*/
|
|
24566
|
+
cell_phone_e164?: string;
|
|
24485
24567
|
/**
|
|
24486
24568
|
* City
|
|
24487
24569
|
* @type {string}
|
|
@@ -25985,6 +26067,12 @@ export interface OrderMarketing {
|
|
|
25985
26067
|
* @memberof OrderMarketing
|
|
25986
26068
|
*/
|
|
25987
26069
|
advertising_source?: string;
|
|
26070
|
+
/**
|
|
26071
|
+
* True if the customer has opted into SMS marketing
|
|
26072
|
+
* @type {boolean}
|
|
26073
|
+
* @memberof OrderMarketing
|
|
26074
|
+
*/
|
|
26075
|
+
cell_phone_opt_in?: boolean;
|
|
25988
26076
|
/**
|
|
25989
26077
|
* True if the customer has opted into mailing list subscription
|
|
25990
26078
|
* @type {boolean}
|
|
@@ -31010,6 +31098,116 @@ export interface StepWaiting {
|
|
|
31010
31098
|
*/
|
|
31011
31099
|
number_waiting?: number;
|
|
31012
31100
|
}
|
|
31101
|
+
/**
|
|
31102
|
+
*
|
|
31103
|
+
* @export
|
|
31104
|
+
* @interface StoreFront
|
|
31105
|
+
*/
|
|
31106
|
+
export interface StoreFront {
|
|
31107
|
+
/**
|
|
31108
|
+
*
|
|
31109
|
+
* @type {string}
|
|
31110
|
+
* @memberof StoreFront
|
|
31111
|
+
*/
|
|
31112
|
+
host_alias1?: string;
|
|
31113
|
+
/**
|
|
31114
|
+
*
|
|
31115
|
+
* @type {string}
|
|
31116
|
+
* @memberof StoreFront
|
|
31117
|
+
*/
|
|
31118
|
+
host_alias2?: string;
|
|
31119
|
+
/**
|
|
31120
|
+
*
|
|
31121
|
+
* @type {string}
|
|
31122
|
+
* @memberof StoreFront
|
|
31123
|
+
*/
|
|
31124
|
+
host_alias3?: string;
|
|
31125
|
+
/**
|
|
31126
|
+
*
|
|
31127
|
+
* @type {string}
|
|
31128
|
+
* @memberof StoreFront
|
|
31129
|
+
*/
|
|
31130
|
+
host_alias4?: string;
|
|
31131
|
+
/**
|
|
31132
|
+
*
|
|
31133
|
+
* @type {string}
|
|
31134
|
+
* @memberof StoreFront
|
|
31135
|
+
*/
|
|
31136
|
+
host_alias5?: string;
|
|
31137
|
+
/**
|
|
31138
|
+
*
|
|
31139
|
+
* @type {string}
|
|
31140
|
+
* @memberof StoreFront
|
|
31141
|
+
*/
|
|
31142
|
+
host_name?: string;
|
|
31143
|
+
/**
|
|
31144
|
+
*
|
|
31145
|
+
* @type {boolean}
|
|
31146
|
+
* @memberof StoreFront
|
|
31147
|
+
*/
|
|
31148
|
+
locked?: boolean;
|
|
31149
|
+
/**
|
|
31150
|
+
*
|
|
31151
|
+
* @type {string}
|
|
31152
|
+
* @memberof StoreFront
|
|
31153
|
+
*/
|
|
31154
|
+
merchant_id?: string;
|
|
31155
|
+
/**
|
|
31156
|
+
*
|
|
31157
|
+
* @type {boolean}
|
|
31158
|
+
* @memberof StoreFront
|
|
31159
|
+
*/
|
|
31160
|
+
redirect_aliases?: boolean;
|
|
31161
|
+
/**
|
|
31162
|
+
*
|
|
31163
|
+
* @type {number}
|
|
31164
|
+
* @memberof StoreFront
|
|
31165
|
+
*/
|
|
31166
|
+
storefront_oid?: number;
|
|
31167
|
+
/**
|
|
31168
|
+
*
|
|
31169
|
+
* @type {string}
|
|
31170
|
+
* @memberof StoreFront
|
|
31171
|
+
*/
|
|
31172
|
+
unlock_password?: string;
|
|
31173
|
+
}
|
|
31174
|
+
/**
|
|
31175
|
+
*
|
|
31176
|
+
* @export
|
|
31177
|
+
* @interface StoreFrontsResponse
|
|
31178
|
+
*/
|
|
31179
|
+
export interface StoreFrontsResponse {
|
|
31180
|
+
/**
|
|
31181
|
+
*
|
|
31182
|
+
* @type {ModelError}
|
|
31183
|
+
* @memberof StoreFrontsResponse
|
|
31184
|
+
*/
|
|
31185
|
+
error?: ModelError;
|
|
31186
|
+
/**
|
|
31187
|
+
*
|
|
31188
|
+
* @type {ResponseMetadata}
|
|
31189
|
+
* @memberof StoreFrontsResponse
|
|
31190
|
+
*/
|
|
31191
|
+
metadata?: ResponseMetadata;
|
|
31192
|
+
/**
|
|
31193
|
+
*
|
|
31194
|
+
* @type {Array<StoreFront>}
|
|
31195
|
+
* @memberof StoreFrontsResponse
|
|
31196
|
+
*/
|
|
31197
|
+
storeFronts?: Array<StoreFront>;
|
|
31198
|
+
/**
|
|
31199
|
+
* Indicates if API call was successful
|
|
31200
|
+
* @type {boolean}
|
|
31201
|
+
* @memberof StoreFrontsResponse
|
|
31202
|
+
*/
|
|
31203
|
+
success?: boolean;
|
|
31204
|
+
/**
|
|
31205
|
+
*
|
|
31206
|
+
* @type {Warning}
|
|
31207
|
+
* @memberof StoreFrontsResponse
|
|
31208
|
+
*/
|
|
31209
|
+
warning?: Warning;
|
|
31210
|
+
}
|
|
31013
31211
|
/**
|
|
31014
31212
|
*
|
|
31015
31213
|
* @export
|
|
@@ -37090,6 +37288,15 @@ export declare const CustomerApiFetchParamCreator: (configuration?: Configuratio
|
|
|
37090
37288
|
* @throws {RequiredError}
|
|
37091
37289
|
*/
|
|
37092
37290
|
getEmailVerificationToken(token_request: EmailVerifyTokenRequest, options?: any): FetchArgs;
|
|
37291
|
+
/**
|
|
37292
|
+
* Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
|
37293
|
+
* @summary getMagicLink
|
|
37294
|
+
* @param {number} customer_profile_oid The customer_profile_oid of the customer.
|
|
37295
|
+
* @param {string} storefront_host_name The storefront to log into.
|
|
37296
|
+
* @param {*} [options] Override http request option.
|
|
37297
|
+
* @throws {RequiredError}
|
|
37298
|
+
*/
|
|
37299
|
+
getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any): FetchArgs;
|
|
37093
37300
|
/**
|
|
37094
37301
|
* Insert a customer on the UltraCart account.
|
|
37095
37302
|
* @summary Insert a customer
|
|
@@ -37284,6 +37491,15 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
|
|
|
37284
37491
|
* @throws {RequiredError}
|
|
37285
37492
|
*/
|
|
37286
37493
|
getEmailVerificationToken(token_request: EmailVerifyTokenRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailVerifyTokenResponse>;
|
|
37494
|
+
/**
|
|
37495
|
+
* Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
|
37496
|
+
* @summary getMagicLink
|
|
37497
|
+
* @param {number} customer_profile_oid The customer_profile_oid of the customer.
|
|
37498
|
+
* @param {string} storefront_host_name The storefront to log into.
|
|
37499
|
+
* @param {*} [options] Override http request option.
|
|
37500
|
+
* @throws {RequiredError}
|
|
37501
|
+
*/
|
|
37502
|
+
getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CustomerMagicLinkResponse>;
|
|
37287
37503
|
/**
|
|
37288
37504
|
* Insert a customer on the UltraCart account.
|
|
37289
37505
|
* @summary Insert a customer
|
|
@@ -37478,6 +37694,15 @@ export declare const CustomerApiFactory: (configuration?: Configuration, fetch?:
|
|
|
37478
37694
|
* @throws {RequiredError}
|
|
37479
37695
|
*/
|
|
37480
37696
|
getEmailVerificationToken(token_request: EmailVerifyTokenRequest, options?: any): Promise<EmailVerifyTokenResponse>;
|
|
37697
|
+
/**
|
|
37698
|
+
* Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
|
37699
|
+
* @summary getMagicLink
|
|
37700
|
+
* @param {number} customer_profile_oid The customer_profile_oid of the customer.
|
|
37701
|
+
* @param {string} storefront_host_name The storefront to log into.
|
|
37702
|
+
* @param {*} [options] Override http request option.
|
|
37703
|
+
* @throws {RequiredError}
|
|
37704
|
+
*/
|
|
37705
|
+
getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any): Promise<CustomerMagicLinkResponse>;
|
|
37481
37706
|
/**
|
|
37482
37707
|
* Insert a customer on the UltraCart account.
|
|
37483
37708
|
* @summary Insert a customer
|
|
@@ -37685,6 +37910,16 @@ export interface CustomerApiInterface {
|
|
|
37685
37910
|
* @memberof CustomerApiInterface
|
|
37686
37911
|
*/
|
|
37687
37912
|
getEmailVerificationToken(token_request: EmailVerifyTokenRequest, options?: any): Promise<EmailVerifyTokenResponse>;
|
|
37913
|
+
/**
|
|
37914
|
+
* Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
|
37915
|
+
* @summary getMagicLink
|
|
37916
|
+
* @param {number} customer_profile_oid The customer_profile_oid of the customer.
|
|
37917
|
+
* @param {string} storefront_host_name The storefront to log into.
|
|
37918
|
+
* @param {*} [options] Override http request option.
|
|
37919
|
+
* @throws {RequiredError}
|
|
37920
|
+
* @memberof CustomerApiInterface
|
|
37921
|
+
*/
|
|
37922
|
+
getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any): Promise<CustomerMagicLinkResponse>;
|
|
37688
37923
|
/**
|
|
37689
37924
|
* Insert a customer on the UltraCart account.
|
|
37690
37925
|
* @summary Insert a customer
|
|
@@ -37899,6 +38134,16 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
|
|
|
37899
38134
|
* @memberof CustomerApi
|
|
37900
38135
|
*/
|
|
37901
38136
|
getEmailVerificationToken(token_request: EmailVerifyTokenRequest, options?: any): Promise<EmailVerifyTokenResponse>;
|
|
38137
|
+
/**
|
|
38138
|
+
* Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
|
38139
|
+
* @summary getMagicLink
|
|
38140
|
+
* @param {number} customer_profile_oid The customer_profile_oid of the customer.
|
|
38141
|
+
* @param {string} storefront_host_name The storefront to log into.
|
|
38142
|
+
* @param {*} [options] Override http request option.
|
|
38143
|
+
* @throws {RequiredError}
|
|
38144
|
+
* @memberof CustomerApi
|
|
38145
|
+
*/
|
|
38146
|
+
getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any): Promise<CustomerMagicLinkResponse>;
|
|
37902
38147
|
/**
|
|
37903
38148
|
* Insert a customer on the UltraCart account.
|
|
37904
38149
|
* @summary Insert a customer
|
|
@@ -41959,6 +42204,13 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
|
|
|
41959
42204
|
* @throws {RequiredError}
|
|
41960
42205
|
*/
|
|
41961
42206
|
getStoreFrontPricingTiers(_expand?: string, options?: any): FetchArgs;
|
|
42207
|
+
/**
|
|
42208
|
+
*
|
|
42209
|
+
* @summary Get storefronts (internal use only for security reasons)
|
|
42210
|
+
* @param {*} [options] Override http request option.
|
|
42211
|
+
* @throws {RequiredError}
|
|
42212
|
+
*/
|
|
42213
|
+
getStoreFronts(options?: any): FetchArgs;
|
|
41962
42214
|
/**
|
|
41963
42215
|
*
|
|
41964
42216
|
* @summary Get thumbnail parameters
|
|
@@ -43455,6 +43707,13 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
|
|
|
43455
43707
|
* @throws {RequiredError}
|
|
43456
43708
|
*/
|
|
43457
43709
|
getStoreFrontPricingTiers(_expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<PricingTiersResponse>;
|
|
43710
|
+
/**
|
|
43711
|
+
*
|
|
43712
|
+
* @summary Get storefronts (internal use only for security reasons)
|
|
43713
|
+
* @param {*} [options] Override http request option.
|
|
43714
|
+
* @throws {RequiredError}
|
|
43715
|
+
*/
|
|
43716
|
+
getStoreFronts(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<StoreFrontsResponse>;
|
|
43458
43717
|
/**
|
|
43459
43718
|
*
|
|
43460
43719
|
* @summary Get thumbnail parameters
|
|
@@ -44951,6 +45210,13 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
|
|
|
44951
45210
|
* @throws {RequiredError}
|
|
44952
45211
|
*/
|
|
44953
45212
|
getStoreFrontPricingTiers(_expand?: string, options?: any): Promise<PricingTiersResponse>;
|
|
45213
|
+
/**
|
|
45214
|
+
*
|
|
45215
|
+
* @summary Get storefronts (internal use only for security reasons)
|
|
45216
|
+
* @param {*} [options] Override http request option.
|
|
45217
|
+
* @throws {RequiredError}
|
|
45218
|
+
*/
|
|
45219
|
+
getStoreFronts(options?: any): Promise<StoreFrontsResponse>;
|
|
44954
45220
|
/**
|
|
44955
45221
|
*
|
|
44956
45222
|
* @summary Get thumbnail parameters
|
|
@@ -46549,6 +46815,14 @@ export interface StorefrontApiInterface {
|
|
|
46549
46815
|
* @memberof StorefrontApiInterface
|
|
46550
46816
|
*/
|
|
46551
46817
|
getStoreFrontPricingTiers(_expand?: string, options?: any): Promise<PricingTiersResponse>;
|
|
46818
|
+
/**
|
|
46819
|
+
*
|
|
46820
|
+
* @summary Get storefronts (internal use only for security reasons)
|
|
46821
|
+
* @param {*} [options] Override http request option.
|
|
46822
|
+
* @throws {RequiredError}
|
|
46823
|
+
* @memberof StorefrontApiInterface
|
|
46824
|
+
*/
|
|
46825
|
+
getStoreFronts(options?: any): Promise<StoreFrontsResponse>;
|
|
46552
46826
|
/**
|
|
46553
46827
|
*
|
|
46554
46828
|
* @summary Get thumbnail parameters
|
|
@@ -48210,6 +48484,14 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
|
|
|
48210
48484
|
* @memberof StorefrontApi
|
|
48211
48485
|
*/
|
|
48212
48486
|
getStoreFrontPricingTiers(_expand?: string, options?: any): Promise<PricingTiersResponse>;
|
|
48487
|
+
/**
|
|
48488
|
+
*
|
|
48489
|
+
* @summary Get storefronts (internal use only for security reasons)
|
|
48490
|
+
* @param {*} [options] Override http request option.
|
|
48491
|
+
* @throws {RequiredError}
|
|
48492
|
+
* @memberof StorefrontApi
|
|
48493
|
+
*/
|
|
48494
|
+
getStoreFronts(options?: any): Promise<StoreFrontsResponse>;
|
|
48213
48495
|
/**
|
|
48214
48496
|
*
|
|
48215
48497
|
* @summary Get thumbnail parameters
|
package/dist/api.js
CHANGED
|
@@ -28,9 +28,9 @@ var __extends = (this && this.__extends) || (function () {
|
|
|
28
28
|
};
|
|
29
29
|
})();
|
|
30
30
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
31
|
-
exports.
|
|
32
|
-
exports.
|
|
33
|
-
exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = void 0;
|
|
31
|
+
exports.TempMultimedia = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.ConversationWebsocketMessage = exports.ConversationWebchatQueueStatusAgent = exports.ConversationSummary = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationEventRRWeb = exports.Conversation = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
|
|
32
|
+
exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.Weight = exports.Webhook = void 0;
|
|
33
|
+
exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = void 0;
|
|
34
34
|
var url = require("url");
|
|
35
35
|
var portableFetch = require("portable-fetch");
|
|
36
36
|
var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
|
|
@@ -448,6 +448,23 @@ var ConversationSummary;
|
|
|
448
448
|
MediumEnum[MediumEnum["Websocket"] = 'websocket'] = "Websocket";
|
|
449
449
|
})(MediumEnum = ConversationSummary.MediumEnum || (ConversationSummary.MediumEnum = {}));
|
|
450
450
|
})(ConversationSummary = exports.ConversationSummary || (exports.ConversationSummary = {}));
|
|
451
|
+
/**
|
|
452
|
+
* @export
|
|
453
|
+
* @namespace ConversationWebchatQueueStatusAgent
|
|
454
|
+
*/
|
|
455
|
+
var ConversationWebchatQueueStatusAgent;
|
|
456
|
+
(function (ConversationWebchatQueueStatusAgent) {
|
|
457
|
+
/**
|
|
458
|
+
* @export
|
|
459
|
+
* @enum {string}
|
|
460
|
+
*/
|
|
461
|
+
var AgentStatusEnum;
|
|
462
|
+
(function (AgentStatusEnum) {
|
|
463
|
+
AgentStatusEnum[AgentStatusEnum["Available"] = 'available'] = "Available";
|
|
464
|
+
AgentStatusEnum[AgentStatusEnum["Busy"] = 'busy'] = "Busy";
|
|
465
|
+
AgentStatusEnum[AgentStatusEnum["Unavailable"] = 'unavailable'] = "Unavailable";
|
|
466
|
+
})(AgentStatusEnum = ConversationWebchatQueueStatusAgent.AgentStatusEnum || (ConversationWebchatQueueStatusAgent.AgentStatusEnum = {}));
|
|
467
|
+
})(ConversationWebchatQueueStatusAgent = exports.ConversationWebchatQueueStatusAgent || (exports.ConversationWebchatQueueStatusAgent = {}));
|
|
451
468
|
/**
|
|
452
469
|
* @export
|
|
453
470
|
* @namespace ConversationWebsocketMessage
|
|
@@ -8927,6 +8944,58 @@ var CustomerApiFetchParamCreator = function (configuration) {
|
|
|
8927
8944
|
options: localVarRequestOptions,
|
|
8928
8945
|
};
|
|
8929
8946
|
},
|
|
8947
|
+
/**
|
|
8948
|
+
* Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
|
8949
|
+
* @summary getMagicLink
|
|
8950
|
+
* @param {number} customer_profile_oid The customer_profile_oid of the customer.
|
|
8951
|
+
* @param {string} storefront_host_name The storefront to log into.
|
|
8952
|
+
* @param {*} [options] Override http request option.
|
|
8953
|
+
* @throws {RequiredError}
|
|
8954
|
+
*/
|
|
8955
|
+
getMagicLink: function (customer_profile_oid, storefront_host_name, options) {
|
|
8956
|
+
if (options === void 0) { options = {}; }
|
|
8957
|
+
// verify required parameter 'customer_profile_oid' is not null or undefined
|
|
8958
|
+
if (customer_profile_oid === null || customer_profile_oid === undefined) {
|
|
8959
|
+
throw new RequiredError('customer_profile_oid', 'Required parameter customer_profile_oid was null or undefined when calling getMagicLink.');
|
|
8960
|
+
}
|
|
8961
|
+
// verify required parameter 'storefront_host_name' is not null or undefined
|
|
8962
|
+
if (storefront_host_name === null || storefront_host_name === undefined) {
|
|
8963
|
+
throw new RequiredError('storefront_host_name', 'Required parameter storefront_host_name was null or undefined when calling getMagicLink.');
|
|
8964
|
+
}
|
|
8965
|
+
var localVarPath = "/customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name}"
|
|
8966
|
+
.replace("{".concat("customer_profile_oid", "}"), encodeURIComponent(String(customer_profile_oid)))
|
|
8967
|
+
.replace("{".concat("storefront_host_name", "}"), encodeURIComponent(String(storefront_host_name)));
|
|
8968
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
8969
|
+
var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
|
|
8970
|
+
var localVarHeaderParameter = {};
|
|
8971
|
+
var localVarQueryParameter = {};
|
|
8972
|
+
if (configuration && configuration.apiVersion) {
|
|
8973
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
8974
|
+
}
|
|
8975
|
+
// authentication ultraCartOauth required
|
|
8976
|
+
// oauth required
|
|
8977
|
+
if (configuration && configuration.accessToken) {
|
|
8978
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
8979
|
+
? configuration.accessToken("ultraCartOauth", ["customer_write"])
|
|
8980
|
+
: configuration.accessToken;
|
|
8981
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
8982
|
+
}
|
|
8983
|
+
// authentication ultraCartSimpleApiKey required
|
|
8984
|
+
if (configuration && configuration.apiKey) {
|
|
8985
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
8986
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
8987
|
+
: configuration.apiKey;
|
|
8988
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
8989
|
+
}
|
|
8990
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
8991
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
8992
|
+
delete localVarUrlObj.search;
|
|
8993
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
8994
|
+
return {
|
|
8995
|
+
url: url.format(localVarUrlObj),
|
|
8996
|
+
options: localVarRequestOptions,
|
|
8997
|
+
};
|
|
8998
|
+
},
|
|
8930
8999
|
/**
|
|
8931
9000
|
* Insert a customer on the UltraCart account.
|
|
8932
9001
|
* @summary Insert a customer
|
|
@@ -9563,6 +9632,29 @@ var CustomerApiFp = function (configuration) {
|
|
|
9563
9632
|
});
|
|
9564
9633
|
};
|
|
9565
9634
|
},
|
|
9635
|
+
/**
|
|
9636
|
+
* Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
|
9637
|
+
* @summary getMagicLink
|
|
9638
|
+
* @param {number} customer_profile_oid The customer_profile_oid of the customer.
|
|
9639
|
+
* @param {string} storefront_host_name The storefront to log into.
|
|
9640
|
+
* @param {*} [options] Override http request option.
|
|
9641
|
+
* @throws {RequiredError}
|
|
9642
|
+
*/
|
|
9643
|
+
getMagicLink: function (customer_profile_oid, storefront_host_name, options) {
|
|
9644
|
+
var localVarFetchArgs = (0, exports.CustomerApiFetchParamCreator)(configuration).getMagicLink(customer_profile_oid, storefront_host_name, options);
|
|
9645
|
+
return function (fetch, basePath) {
|
|
9646
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
9647
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
9648
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
9649
|
+
if (response.status >= 200 && response.status < 300) {
|
|
9650
|
+
return response.json();
|
|
9651
|
+
}
|
|
9652
|
+
else {
|
|
9653
|
+
throw response;
|
|
9654
|
+
}
|
|
9655
|
+
});
|
|
9656
|
+
};
|
|
9657
|
+
},
|
|
9566
9658
|
/**
|
|
9567
9659
|
* Insert a customer on the UltraCart account.
|
|
9568
9660
|
* @summary Insert a customer
|
|
@@ -9868,6 +9960,17 @@ var CustomerApiFactory = function (configuration, fetch, basePath) {
|
|
|
9868
9960
|
getEmailVerificationToken: function (token_request, options) {
|
|
9869
9961
|
return (0, exports.CustomerApiFp)(configuration).getEmailVerificationToken(token_request, options)(fetch, basePath);
|
|
9870
9962
|
},
|
|
9963
|
+
/**
|
|
9964
|
+
* Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
|
9965
|
+
* @summary getMagicLink
|
|
9966
|
+
* @param {number} customer_profile_oid The customer_profile_oid of the customer.
|
|
9967
|
+
* @param {string} storefront_host_name The storefront to log into.
|
|
9968
|
+
* @param {*} [options] Override http request option.
|
|
9969
|
+
* @throws {RequiredError}
|
|
9970
|
+
*/
|
|
9971
|
+
getMagicLink: function (customer_profile_oid, storefront_host_name, options) {
|
|
9972
|
+
return (0, exports.CustomerApiFp)(configuration).getMagicLink(customer_profile_oid, storefront_host_name, options)(fetch, basePath);
|
|
9973
|
+
},
|
|
9871
9974
|
/**
|
|
9872
9975
|
* Insert a customer on the UltraCart account.
|
|
9873
9976
|
* @summary Insert a customer
|
|
@@ -10118,6 +10221,18 @@ var CustomerApi = /** @class */ (function (_super) {
|
|
|
10118
10221
|
CustomerApi.prototype.getEmailVerificationToken = function (token_request, options) {
|
|
10119
10222
|
return (0, exports.CustomerApiFp)(this.configuration).getEmailVerificationToken(token_request, options)(this.fetch, this.basePath);
|
|
10120
10223
|
};
|
|
10224
|
+
/**
|
|
10225
|
+
* Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
|
|
10226
|
+
* @summary getMagicLink
|
|
10227
|
+
* @param {number} customer_profile_oid The customer_profile_oid of the customer.
|
|
10228
|
+
* @param {string} storefront_host_name The storefront to log into.
|
|
10229
|
+
* @param {*} [options] Override http request option.
|
|
10230
|
+
* @throws {RequiredError}
|
|
10231
|
+
* @memberof CustomerApi
|
|
10232
|
+
*/
|
|
10233
|
+
CustomerApi.prototype.getMagicLink = function (customer_profile_oid, storefront_host_name, options) {
|
|
10234
|
+
return (0, exports.CustomerApiFp)(this.configuration).getMagicLink(customer_profile_oid, storefront_host_name, options)(this.fetch, this.basePath);
|
|
10235
|
+
};
|
|
10121
10236
|
/**
|
|
10122
10237
|
* Insert a customer on the UltraCart account.
|
|
10123
10238
|
* @summary Insert a customer
|
|
@@ -22152,6 +22267,53 @@ var StorefrontApiFetchParamCreator = function (configuration) {
|
|
|
22152
22267
|
options: localVarRequestOptions,
|
|
22153
22268
|
};
|
|
22154
22269
|
},
|
|
22270
|
+
/**
|
|
22271
|
+
*
|
|
22272
|
+
* @summary Get storefronts (internal use only for security reasons)
|
|
22273
|
+
* @param {*} [options] Override http request option.
|
|
22274
|
+
* @throws {RequiredError}
|
|
22275
|
+
*/
|
|
22276
|
+
getStoreFronts: function (options) {
|
|
22277
|
+
if (options === void 0) { options = {}; }
|
|
22278
|
+
var localVarPath = "/storefront";
|
|
22279
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
22280
|
+
var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
22281
|
+
var localVarHeaderParameter = {};
|
|
22282
|
+
var localVarQueryParameter = {};
|
|
22283
|
+
if (configuration && configuration.apiVersion) {
|
|
22284
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
22285
|
+
}
|
|
22286
|
+
// authentication ultraCartBrowserApiKey required
|
|
22287
|
+
if (configuration && configuration.apiKey) {
|
|
22288
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
22289
|
+
? configuration.apiKey("x-ultracart-browser-key")
|
|
22290
|
+
: configuration.apiKey;
|
|
22291
|
+
localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
|
|
22292
|
+
}
|
|
22293
|
+
// authentication ultraCartOauth required
|
|
22294
|
+
// oauth required
|
|
22295
|
+
if (configuration && configuration.accessToken) {
|
|
22296
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
22297
|
+
? configuration.accessToken("ultraCartOauth", ["ultrabooks_write", "auto_order_write", "coupon_read", "affiliate_read", "coupon_write", "channel_partner_read", "tax_read", "conversation_write", "fulfillment_write", "tax_write", "gift_certificate_write", "channel_partner_write", "item_read", "fulfillment_read", "webhook_write", "chargeback_write", "user_write", "gift_certificate_read", "checkout_write", "storefront_read", "webhook_read", "item_write", "auto_order_read", "customer_read", "user_read", "configuration_read", "customer_write", "order_read", "conversation_read", "affiliate_write", "storefront_write", "ultrabooks_read", "order_write", "chargeback_read", "integration_log_write", "configuration_write", "checkout_read", "integration_log_read"])
|
|
22298
|
+
: configuration.accessToken;
|
|
22299
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
22300
|
+
}
|
|
22301
|
+
// authentication ultraCartSimpleApiKey required
|
|
22302
|
+
if (configuration && configuration.apiKey) {
|
|
22303
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
22304
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
22305
|
+
: configuration.apiKey;
|
|
22306
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
22307
|
+
}
|
|
22308
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
22309
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
22310
|
+
delete localVarUrlObj.search;
|
|
22311
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
22312
|
+
return {
|
|
22313
|
+
url: url.format(localVarUrlObj),
|
|
22314
|
+
options: localVarRequestOptions,
|
|
22315
|
+
};
|
|
22316
|
+
},
|
|
22155
22317
|
/**
|
|
22156
22318
|
*
|
|
22157
22319
|
* @summary Get thumbnail parameters
|
|
@@ -28314,6 +28476,27 @@ var StorefrontApiFp = function (configuration) {
|
|
|
28314
28476
|
});
|
|
28315
28477
|
};
|
|
28316
28478
|
},
|
|
28479
|
+
/**
|
|
28480
|
+
*
|
|
28481
|
+
* @summary Get storefronts (internal use only for security reasons)
|
|
28482
|
+
* @param {*} [options] Override http request option.
|
|
28483
|
+
* @throws {RequiredError}
|
|
28484
|
+
*/
|
|
28485
|
+
getStoreFronts: function (options) {
|
|
28486
|
+
var localVarFetchArgs = (0, exports.StorefrontApiFetchParamCreator)(configuration).getStoreFronts(options);
|
|
28487
|
+
return function (fetch, basePath) {
|
|
28488
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
28489
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
28490
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
28491
|
+
if (response.status >= 200 && response.status < 300) {
|
|
28492
|
+
return response.json();
|
|
28493
|
+
}
|
|
28494
|
+
else {
|
|
28495
|
+
throw response;
|
|
28496
|
+
}
|
|
28497
|
+
});
|
|
28498
|
+
};
|
|
28499
|
+
},
|
|
28317
28500
|
/**
|
|
28318
28501
|
*
|
|
28319
28502
|
* @summary Get thumbnail parameters
|
|
@@ -30883,6 +31066,15 @@ var StorefrontApiFactory = function (configuration, fetch, basePath) {
|
|
|
30883
31066
|
getStoreFrontPricingTiers: function (_expand, options) {
|
|
30884
31067
|
return (0, exports.StorefrontApiFp)(configuration).getStoreFrontPricingTiers(_expand, options)(fetch, basePath);
|
|
30885
31068
|
},
|
|
31069
|
+
/**
|
|
31070
|
+
*
|
|
31071
|
+
* @summary Get storefronts (internal use only for security reasons)
|
|
31072
|
+
* @param {*} [options] Override http request option.
|
|
31073
|
+
* @throws {RequiredError}
|
|
31074
|
+
*/
|
|
31075
|
+
getStoreFronts: function (options) {
|
|
31076
|
+
return (0, exports.StorefrontApiFp)(configuration).getStoreFronts(options)(fetch, basePath);
|
|
31077
|
+
},
|
|
30886
31078
|
/**
|
|
30887
31079
|
*
|
|
30888
31080
|
* @summary Get thumbnail parameters
|
|
@@ -32814,6 +33006,16 @@ var StorefrontApi = /** @class */ (function (_super) {
|
|
|
32814
33006
|
StorefrontApi.prototype.getStoreFrontPricingTiers = function (_expand, options) {
|
|
32815
33007
|
return (0, exports.StorefrontApiFp)(this.configuration).getStoreFrontPricingTiers(_expand, options)(this.fetch, this.basePath);
|
|
32816
33008
|
};
|
|
33009
|
+
/**
|
|
33010
|
+
*
|
|
33011
|
+
* @summary Get storefronts (internal use only for security reasons)
|
|
33012
|
+
* @param {*} [options] Override http request option.
|
|
33013
|
+
* @throws {RequiredError}
|
|
33014
|
+
* @memberof StorefrontApi
|
|
33015
|
+
*/
|
|
33016
|
+
StorefrontApi.prototype.getStoreFronts = function (options) {
|
|
33017
|
+
return (0, exports.StorefrontApiFp)(this.configuration).getStoreFronts(options)(this.fetch, this.basePath);
|
|
33018
|
+
};
|
|
32817
33019
|
/**
|
|
32818
33020
|
*
|
|
32819
33021
|
* @summary Get thumbnail parameters
|