ultracart_rest_api_v2_typescript 3.10.206 → 3.10.207
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 +3 -2
- package/api.ts +310 -0
- package/dist/api.d.ts +156 -0
- package/dist/api.js +210 -0
- 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.207
|
|
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.207 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 3.10.207 | 05/29/2024 | added methods getEmailCommseqRateLimiters, resetEmailCommseqRateLimiters |
|
|
57
58
|
| 3.10.206 | 05/28/2024 | added property to OrderQuery object to allow querying from cache |
|
|
58
59
|
| 3.10.205 | 05/17/2024 | conv.pbx time based config - changed name from default to default_mapping |
|
|
59
60
|
| 3.10.204 | 05/16/2024 | OrderPayment - constants for payment method Amazon Pay and Link |
|
package/api.ts
CHANGED
|
@@ -21001,6 +21001,70 @@ export interface EmailPostcardTrackingResponse {
|
|
|
21001
21001
|
warning?: Warning;
|
|
21002
21002
|
}
|
|
21003
21003
|
|
|
21004
|
+
/**
|
|
21005
|
+
*
|
|
21006
|
+
* @export
|
|
21007
|
+
* @interface EmailRateLimiter
|
|
21008
|
+
*/
|
|
21009
|
+
export interface EmailRateLimiter {
|
|
21010
|
+
/**
|
|
21011
|
+
*
|
|
21012
|
+
* @type {number}
|
|
21013
|
+
* @memberof EmailRateLimiter
|
|
21014
|
+
*/
|
|
21015
|
+
available?: number;
|
|
21016
|
+
/**
|
|
21017
|
+
*
|
|
21018
|
+
* @type {number}
|
|
21019
|
+
* @memberof EmailRateLimiter
|
|
21020
|
+
*/
|
|
21021
|
+
limit?: number;
|
|
21022
|
+
/**
|
|
21023
|
+
*
|
|
21024
|
+
* @type {string}
|
|
21025
|
+
* @memberof EmailRateLimiter
|
|
21026
|
+
*/
|
|
21027
|
+
name?: string;
|
|
21028
|
+
}
|
|
21029
|
+
|
|
21030
|
+
/**
|
|
21031
|
+
*
|
|
21032
|
+
* @export
|
|
21033
|
+
* @interface EmailRateLimitersResponse
|
|
21034
|
+
*/
|
|
21035
|
+
export interface EmailRateLimitersResponse {
|
|
21036
|
+
/**
|
|
21037
|
+
*
|
|
21038
|
+
* @type {ModelError}
|
|
21039
|
+
* @memberof EmailRateLimitersResponse
|
|
21040
|
+
*/
|
|
21041
|
+
error?: ModelError;
|
|
21042
|
+
/**
|
|
21043
|
+
*
|
|
21044
|
+
* @type {ResponseMetadata}
|
|
21045
|
+
* @memberof EmailRateLimitersResponse
|
|
21046
|
+
*/
|
|
21047
|
+
metadata?: ResponseMetadata;
|
|
21048
|
+
/**
|
|
21049
|
+
*
|
|
21050
|
+
* @type {Array<EmailRateLimiter>}
|
|
21051
|
+
* @memberof EmailRateLimitersResponse
|
|
21052
|
+
*/
|
|
21053
|
+
rate_limiters?: Array<EmailRateLimiter>;
|
|
21054
|
+
/**
|
|
21055
|
+
* Indicates if API call was successful
|
|
21056
|
+
* @type {boolean}
|
|
21057
|
+
* @memberof EmailRateLimitersResponse
|
|
21058
|
+
*/
|
|
21059
|
+
success?: boolean;
|
|
21060
|
+
/**
|
|
21061
|
+
*
|
|
21062
|
+
* @type {Warning}
|
|
21063
|
+
* @memberof EmailRateLimitersResponse
|
|
21064
|
+
*/
|
|
21065
|
+
warning?: Warning;
|
|
21066
|
+
}
|
|
21067
|
+
|
|
21004
21068
|
/**
|
|
21005
21069
|
*
|
|
21006
21070
|
* @export
|
|
@@ -78165,6 +78229,72 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
|
|
|
78165
78229
|
|
|
78166
78230
|
|
|
78167
78231
|
|
|
78232
|
+
// authentication ultraCartBrowserApiKey required
|
|
78233
|
+
if (configuration && configuration.apiKey) {
|
|
78234
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
78235
|
+
? configuration.apiKey("x-ultracart-browser-key")
|
|
78236
|
+
: configuration.apiKey;
|
|
78237
|
+
localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
|
|
78238
|
+
}
|
|
78239
|
+
|
|
78240
|
+
// authentication ultraCartOauth required
|
|
78241
|
+
// oauth required
|
|
78242
|
+
if (configuration && configuration.accessToken) {
|
|
78243
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
78244
|
+
? configuration.accessToken("ultraCartOauth", ["storefront_read"])
|
|
78245
|
+
: configuration.accessToken;
|
|
78246
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
78247
|
+
}
|
|
78248
|
+
|
|
78249
|
+
// authentication ultraCartSimpleApiKey required
|
|
78250
|
+
if (configuration && configuration.apiKey) {
|
|
78251
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
78252
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
78253
|
+
: configuration.apiKey;
|
|
78254
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
78255
|
+
}
|
|
78256
|
+
|
|
78257
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
78258
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
78259
|
+
delete localVarUrlObj.search;
|
|
78260
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
78261
|
+
|
|
78262
|
+
return {
|
|
78263
|
+
url: url.format(localVarUrlObj),
|
|
78264
|
+
options: localVarRequestOptions,
|
|
78265
|
+
};
|
|
78266
|
+
},
|
|
78267
|
+
/**
|
|
78268
|
+
*
|
|
78269
|
+
* @summary Get email commseq rate limiters
|
|
78270
|
+
* @param {number} storefront_oid
|
|
78271
|
+
* @param {string} commseq_uuid
|
|
78272
|
+
* @param {*} [options] Override http request option.
|
|
78273
|
+
* @throws {RequiredError}
|
|
78274
|
+
*/
|
|
78275
|
+
getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options: any = {}): FetchArgs {
|
|
78276
|
+
// verify required parameter 'storefront_oid' is not null or undefined
|
|
78277
|
+
if (storefront_oid === null || storefront_oid === undefined) {
|
|
78278
|
+
throw new RequiredError('storefront_oid','Required parameter storefront_oid was null or undefined when calling getEmailCommseqRateLimiters.');
|
|
78279
|
+
}
|
|
78280
|
+
// verify required parameter 'commseq_uuid' is not null or undefined
|
|
78281
|
+
if (commseq_uuid === null || commseq_uuid === undefined) {
|
|
78282
|
+
throw new RequiredError('commseq_uuid','Required parameter commseq_uuid was null or undefined when calling getEmailCommseqRateLimiters.');
|
|
78283
|
+
}
|
|
78284
|
+
const localVarPath = `/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters`
|
|
78285
|
+
.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(storefront_oid)))
|
|
78286
|
+
.replace(`{${"commseq_uuid"}}`, encodeURIComponent(String(commseq_uuid)));
|
|
78287
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
78288
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
78289
|
+
const localVarHeaderParameter = {} as any;
|
|
78290
|
+
const localVarQueryParameter = {} as any;
|
|
78291
|
+
|
|
78292
|
+
if(configuration && configuration.apiVersion) {
|
|
78293
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
78294
|
+
}
|
|
78295
|
+
|
|
78296
|
+
|
|
78297
|
+
|
|
78168
78298
|
// authentication ultraCartBrowserApiKey required
|
|
78169
78299
|
if (configuration && configuration.apiKey) {
|
|
78170
78300
|
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
@@ -84025,6 +84155,72 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
|
|
|
84025
84155
|
|
|
84026
84156
|
|
|
84027
84157
|
|
|
84158
|
+
// authentication ultraCartBrowserApiKey required
|
|
84159
|
+
if (configuration && configuration.apiKey) {
|
|
84160
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
84161
|
+
? configuration.apiKey("x-ultracart-browser-key")
|
|
84162
|
+
: configuration.apiKey;
|
|
84163
|
+
localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
|
|
84164
|
+
}
|
|
84165
|
+
|
|
84166
|
+
// authentication ultraCartOauth required
|
|
84167
|
+
// oauth required
|
|
84168
|
+
if (configuration && configuration.accessToken) {
|
|
84169
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
84170
|
+
? configuration.accessToken("ultraCartOauth", ["storefront_read"])
|
|
84171
|
+
: configuration.accessToken;
|
|
84172
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
84173
|
+
}
|
|
84174
|
+
|
|
84175
|
+
// authentication ultraCartSimpleApiKey required
|
|
84176
|
+
if (configuration && configuration.apiKey) {
|
|
84177
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
84178
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
84179
|
+
: configuration.apiKey;
|
|
84180
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
84181
|
+
}
|
|
84182
|
+
|
|
84183
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
84184
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
84185
|
+
delete localVarUrlObj.search;
|
|
84186
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
84187
|
+
|
|
84188
|
+
return {
|
|
84189
|
+
url: url.format(localVarUrlObj),
|
|
84190
|
+
options: localVarRequestOptions,
|
|
84191
|
+
};
|
|
84192
|
+
},
|
|
84193
|
+
/**
|
|
84194
|
+
*
|
|
84195
|
+
* @summary Reset email commseq rate limiters (only callable by UltraCart Support)
|
|
84196
|
+
* @param {number} storefront_oid
|
|
84197
|
+
* @param {string} commseq_uuid
|
|
84198
|
+
* @param {*} [options] Override http request option.
|
|
84199
|
+
* @throws {RequiredError}
|
|
84200
|
+
*/
|
|
84201
|
+
resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options: any = {}): FetchArgs {
|
|
84202
|
+
// verify required parameter 'storefront_oid' is not null or undefined
|
|
84203
|
+
if (storefront_oid === null || storefront_oid === undefined) {
|
|
84204
|
+
throw new RequiredError('storefront_oid','Required parameter storefront_oid was null or undefined when calling resetEmailCommseqRateLimiters.');
|
|
84205
|
+
}
|
|
84206
|
+
// verify required parameter 'commseq_uuid' is not null or undefined
|
|
84207
|
+
if (commseq_uuid === null || commseq_uuid === undefined) {
|
|
84208
|
+
throw new RequiredError('commseq_uuid','Required parameter commseq_uuid was null or undefined when calling resetEmailCommseqRateLimiters.');
|
|
84209
|
+
}
|
|
84210
|
+
const localVarPath = `/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters`
|
|
84211
|
+
.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(storefront_oid)))
|
|
84212
|
+
.replace(`{${"commseq_uuid"}}`, encodeURIComponent(String(commseq_uuid)));
|
|
84213
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
84214
|
+
const localVarRequestOptions = Object.assign({ method: 'DELETE' }, options);
|
|
84215
|
+
const localVarHeaderParameter = {} as any;
|
|
84216
|
+
const localVarQueryParameter = {} as any;
|
|
84217
|
+
|
|
84218
|
+
if(configuration && configuration.apiVersion) {
|
|
84219
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
84220
|
+
}
|
|
84221
|
+
|
|
84222
|
+
|
|
84223
|
+
|
|
84028
84224
|
// authentication ultraCartBrowserApiKey required
|
|
84029
84225
|
if (configuration && configuration.apiKey) {
|
|
84030
84226
|
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
@@ -88015,6 +88211,28 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
|
|
|
88015
88211
|
});
|
|
88016
88212
|
};
|
|
88017
88213
|
},
|
|
88214
|
+
/**
|
|
88215
|
+
*
|
|
88216
|
+
* @summary Get email commseq rate limiters
|
|
88217
|
+
* @param {number} storefront_oid
|
|
88218
|
+
* @param {string} commseq_uuid
|
|
88219
|
+
* @param {*} [options] Override http request option.
|
|
88220
|
+
* @throws {RequiredError}
|
|
88221
|
+
*/
|
|
88222
|
+
getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailRateLimitersResponse> {
|
|
88223
|
+
const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).getEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options);
|
|
88224
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
88225
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
88226
|
+
|
|
88227
|
+
if (response.status >= 200 && response.status < 300) {
|
|
88228
|
+
return response.json();
|
|
88229
|
+
|
|
88230
|
+
} else {
|
|
88231
|
+
throw response;
|
|
88232
|
+
}
|
|
88233
|
+
});
|
|
88234
|
+
};
|
|
88235
|
+
},
|
|
88018
88236
|
/**
|
|
88019
88237
|
*
|
|
88020
88238
|
* @summary Get email communication sequence sms stats
|
|
@@ -89975,6 +90193,28 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
|
|
|
89975
90193
|
});
|
|
89976
90194
|
};
|
|
89977
90195
|
},
|
|
90196
|
+
/**
|
|
90197
|
+
*
|
|
90198
|
+
* @summary Reset email commseq rate limiters (only callable by UltraCart Support)
|
|
90199
|
+
* @param {number} storefront_oid
|
|
90200
|
+
* @param {string} commseq_uuid
|
|
90201
|
+
* @param {*} [options] Override http request option.
|
|
90202
|
+
* @throws {RequiredError}
|
|
90203
|
+
*/
|
|
90204
|
+
resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
|
|
90205
|
+
const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).resetEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options);
|
|
90206
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
90207
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
90208
|
+
|
|
90209
|
+
if (response.status >= 200 && response.status < 300) {
|
|
90210
|
+
return response;
|
|
90211
|
+
|
|
90212
|
+
} else {
|
|
90213
|
+
throw response;
|
|
90214
|
+
}
|
|
90215
|
+
});
|
|
90216
|
+
};
|
|
90217
|
+
},
|
|
89978
90218
|
/**
|
|
89979
90219
|
*
|
|
89980
90220
|
* @summary Request a review of an email
|
|
@@ -91408,6 +91648,17 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
|
|
|
91408
91648
|
getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any) {
|
|
91409
91649
|
return StorefrontApiFp(configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options)(fetch, basePath);
|
|
91410
91650
|
},
|
|
91651
|
+
/**
|
|
91652
|
+
*
|
|
91653
|
+
* @summary Get email commseq rate limiters
|
|
91654
|
+
* @param {number} storefront_oid
|
|
91655
|
+
* @param {string} commseq_uuid
|
|
91656
|
+
* @param {*} [options] Override http request option.
|
|
91657
|
+
* @throws {RequiredError}
|
|
91658
|
+
*/
|
|
91659
|
+
getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any) {
|
|
91660
|
+
return StorefrontApiFp(configuration).getEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options)(fetch, basePath);
|
|
91661
|
+
},
|
|
91411
91662
|
/**
|
|
91412
91663
|
*
|
|
91413
91664
|
* @summary Get email communication sequence sms stats
|
|
@@ -92389,6 +92640,17 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
|
|
|
92389
92640
|
releaseEmailCommseqStepWaiting(storefront_oid: number, commseq_uuid: string, commseq_step_uuid: string, options?: any) {
|
|
92390
92641
|
return StorefrontApiFp(configuration).releaseEmailCommseqStepWaiting(storefront_oid, commseq_uuid, commseq_step_uuid, options)(fetch, basePath);
|
|
92391
92642
|
},
|
|
92643
|
+
/**
|
|
92644
|
+
*
|
|
92645
|
+
* @summary Reset email commseq rate limiters (only callable by UltraCart Support)
|
|
92646
|
+
* @param {number} storefront_oid
|
|
92647
|
+
* @param {string} commseq_uuid
|
|
92648
|
+
* @param {*} [options] Override http request option.
|
|
92649
|
+
* @throws {RequiredError}
|
|
92650
|
+
*/
|
|
92651
|
+
resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any) {
|
|
92652
|
+
return StorefrontApiFp(configuration).resetEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options)(fetch, basePath);
|
|
92653
|
+
},
|
|
92392
92654
|
/**
|
|
92393
92655
|
*
|
|
92394
92656
|
* @summary Request a review of an email
|
|
@@ -93360,6 +93622,17 @@ export interface StorefrontApiInterface {
|
|
|
93360
93622
|
*/
|
|
93361
93623
|
getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
|
|
93362
93624
|
|
|
93625
|
+
/**
|
|
93626
|
+
*
|
|
93627
|
+
* @summary Get email commseq rate limiters
|
|
93628
|
+
* @param {number} storefront_oid
|
|
93629
|
+
* @param {string} commseq_uuid
|
|
93630
|
+
* @param {*} [options] Override http request option.
|
|
93631
|
+
* @throws {RequiredError}
|
|
93632
|
+
* @memberof StorefrontApiInterface
|
|
93633
|
+
*/
|
|
93634
|
+
getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailRateLimitersResponse>;
|
|
93635
|
+
|
|
93363
93636
|
/**
|
|
93364
93637
|
*
|
|
93365
93638
|
* @summary Get email communication sequence sms stats
|
|
@@ -94341,6 +94614,17 @@ export interface StorefrontApiInterface {
|
|
|
94341
94614
|
*/
|
|
94342
94615
|
releaseEmailCommseqStepWaiting(storefront_oid: number, commseq_uuid: string, commseq_step_uuid: string, options?: any): Promise<{}>;
|
|
94343
94616
|
|
|
94617
|
+
/**
|
|
94618
|
+
*
|
|
94619
|
+
* @summary Reset email commseq rate limiters (only callable by UltraCart Support)
|
|
94620
|
+
* @param {number} storefront_oid
|
|
94621
|
+
* @param {string} commseq_uuid
|
|
94622
|
+
* @param {*} [options] Override http request option.
|
|
94623
|
+
* @throws {RequiredError}
|
|
94624
|
+
* @memberof StorefrontApiInterface
|
|
94625
|
+
*/
|
|
94626
|
+
resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<{}>;
|
|
94627
|
+
|
|
94344
94628
|
/**
|
|
94345
94629
|
*
|
|
94346
94630
|
* @summary Request a review of an email
|
|
@@ -95398,6 +95682,19 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
|
|
|
95398
95682
|
return StorefrontApiFp(this.configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options)(this.fetch, this.basePath);
|
|
95399
95683
|
}
|
|
95400
95684
|
|
|
95685
|
+
/**
|
|
95686
|
+
*
|
|
95687
|
+
* @summary Get email commseq rate limiters
|
|
95688
|
+
* @param {number} storefront_oid
|
|
95689
|
+
* @param {string} commseq_uuid
|
|
95690
|
+
* @param {*} [options] Override http request option.
|
|
95691
|
+
* @throws {RequiredError}
|
|
95692
|
+
* @memberof StorefrontApi
|
|
95693
|
+
*/
|
|
95694
|
+
public getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any) {
|
|
95695
|
+
return StorefrontApiFp(this.configuration).getEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options)(this.fetch, this.basePath);
|
|
95696
|
+
}
|
|
95697
|
+
|
|
95401
95698
|
/**
|
|
95402
95699
|
*
|
|
95403
95700
|
* @summary Get email communication sequence sms stats
|
|
@@ -96557,6 +96854,19 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
|
|
|
96557
96854
|
return StorefrontApiFp(this.configuration).releaseEmailCommseqStepWaiting(storefront_oid, commseq_uuid, commseq_step_uuid, options)(this.fetch, this.basePath);
|
|
96558
96855
|
}
|
|
96559
96856
|
|
|
96857
|
+
/**
|
|
96858
|
+
*
|
|
96859
|
+
* @summary Reset email commseq rate limiters (only callable by UltraCart Support)
|
|
96860
|
+
* @param {number} storefront_oid
|
|
96861
|
+
* @param {string} commseq_uuid
|
|
96862
|
+
* @param {*} [options] Override http request option.
|
|
96863
|
+
* @throws {RequiredError}
|
|
96864
|
+
* @memberof StorefrontApi
|
|
96865
|
+
*/
|
|
96866
|
+
public resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any) {
|
|
96867
|
+
return StorefrontApiFp(this.configuration).resetEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options)(this.fetch, this.basePath);
|
|
96868
|
+
}
|
|
96869
|
+
|
|
96560
96870
|
/**
|
|
96561
96871
|
*
|
|
96562
96872
|
* @summary Request a review of an email
|
package/dist/api.d.ts
CHANGED
|
@@ -20530,6 +20530,68 @@ export interface EmailPostcardTrackingResponse {
|
|
|
20530
20530
|
*/
|
|
20531
20531
|
warning?: Warning;
|
|
20532
20532
|
}
|
|
20533
|
+
/**
|
|
20534
|
+
*
|
|
20535
|
+
* @export
|
|
20536
|
+
* @interface EmailRateLimiter
|
|
20537
|
+
*/
|
|
20538
|
+
export interface EmailRateLimiter {
|
|
20539
|
+
/**
|
|
20540
|
+
*
|
|
20541
|
+
* @type {number}
|
|
20542
|
+
* @memberof EmailRateLimiter
|
|
20543
|
+
*/
|
|
20544
|
+
available?: number;
|
|
20545
|
+
/**
|
|
20546
|
+
*
|
|
20547
|
+
* @type {number}
|
|
20548
|
+
* @memberof EmailRateLimiter
|
|
20549
|
+
*/
|
|
20550
|
+
limit?: number;
|
|
20551
|
+
/**
|
|
20552
|
+
*
|
|
20553
|
+
* @type {string}
|
|
20554
|
+
* @memberof EmailRateLimiter
|
|
20555
|
+
*/
|
|
20556
|
+
name?: string;
|
|
20557
|
+
}
|
|
20558
|
+
/**
|
|
20559
|
+
*
|
|
20560
|
+
* @export
|
|
20561
|
+
* @interface EmailRateLimitersResponse
|
|
20562
|
+
*/
|
|
20563
|
+
export interface EmailRateLimitersResponse {
|
|
20564
|
+
/**
|
|
20565
|
+
*
|
|
20566
|
+
* @type {ModelError}
|
|
20567
|
+
* @memberof EmailRateLimitersResponse
|
|
20568
|
+
*/
|
|
20569
|
+
error?: ModelError;
|
|
20570
|
+
/**
|
|
20571
|
+
*
|
|
20572
|
+
* @type {ResponseMetadata}
|
|
20573
|
+
* @memberof EmailRateLimitersResponse
|
|
20574
|
+
*/
|
|
20575
|
+
metadata?: ResponseMetadata;
|
|
20576
|
+
/**
|
|
20577
|
+
*
|
|
20578
|
+
* @type {Array<EmailRateLimiter>}
|
|
20579
|
+
* @memberof EmailRateLimitersResponse
|
|
20580
|
+
*/
|
|
20581
|
+
rate_limiters?: Array<EmailRateLimiter>;
|
|
20582
|
+
/**
|
|
20583
|
+
* Indicates if API call was successful
|
|
20584
|
+
* @type {boolean}
|
|
20585
|
+
* @memberof EmailRateLimitersResponse
|
|
20586
|
+
*/
|
|
20587
|
+
success?: boolean;
|
|
20588
|
+
/**
|
|
20589
|
+
*
|
|
20590
|
+
* @type {Warning}
|
|
20591
|
+
* @memberof EmailRateLimitersResponse
|
|
20592
|
+
*/
|
|
20593
|
+
warning?: Warning;
|
|
20594
|
+
}
|
|
20533
20595
|
/**
|
|
20534
20596
|
*
|
|
20535
20597
|
* @export
|
|
@@ -56841,6 +56903,15 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
|
|
|
56841
56903
|
* @throws {RequiredError}
|
|
56842
56904
|
*/
|
|
56843
56905
|
getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): FetchArgs;
|
|
56906
|
+
/**
|
|
56907
|
+
*
|
|
56908
|
+
* @summary Get email commseq rate limiters
|
|
56909
|
+
* @param {number} storefront_oid
|
|
56910
|
+
* @param {string} commseq_uuid
|
|
56911
|
+
* @param {*} [options] Override http request option.
|
|
56912
|
+
* @throws {RequiredError}
|
|
56913
|
+
*/
|
|
56914
|
+
getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): FetchArgs;
|
|
56844
56915
|
/**
|
|
56845
56916
|
*
|
|
56846
56917
|
* @summary Get email communication sequence sms stats
|
|
@@ -57644,6 +57715,15 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
|
|
|
57644
57715
|
* @throws {RequiredError}
|
|
57645
57716
|
*/
|
|
57646
57717
|
releaseEmailCommseqStepWaiting(storefront_oid: number, commseq_uuid: string, commseq_step_uuid: string, options?: any): FetchArgs;
|
|
57718
|
+
/**
|
|
57719
|
+
*
|
|
57720
|
+
* @summary Reset email commseq rate limiters (only callable by UltraCart Support)
|
|
57721
|
+
* @param {number} storefront_oid
|
|
57722
|
+
* @param {string} commseq_uuid
|
|
57723
|
+
* @param {*} [options] Override http request option.
|
|
57724
|
+
* @throws {RequiredError}
|
|
57725
|
+
*/
|
|
57726
|
+
resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): FetchArgs;
|
|
57647
57727
|
/**
|
|
57648
57728
|
*
|
|
57649
57729
|
* @summary Request a review of an email
|
|
@@ -58442,6 +58522,15 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
|
|
|
58442
58522
|
* @throws {RequiredError}
|
|
58443
58523
|
*/
|
|
58444
58524
|
getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailPostcardTrackingResponse>;
|
|
58525
|
+
/**
|
|
58526
|
+
*
|
|
58527
|
+
* @summary Get email commseq rate limiters
|
|
58528
|
+
* @param {number} storefront_oid
|
|
58529
|
+
* @param {string} commseq_uuid
|
|
58530
|
+
* @param {*} [options] Override http request option.
|
|
58531
|
+
* @throws {RequiredError}
|
|
58532
|
+
*/
|
|
58533
|
+
getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailRateLimitersResponse>;
|
|
58445
58534
|
/**
|
|
58446
58535
|
*
|
|
58447
58536
|
* @summary Get email communication sequence sms stats
|
|
@@ -59245,6 +59334,15 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
|
|
|
59245
59334
|
* @throws {RequiredError}
|
|
59246
59335
|
*/
|
|
59247
59336
|
releaseEmailCommseqStepWaiting(storefront_oid: number, commseq_uuid: string, commseq_step_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
|
|
59337
|
+
/**
|
|
59338
|
+
*
|
|
59339
|
+
* @summary Reset email commseq rate limiters (only callable by UltraCart Support)
|
|
59340
|
+
* @param {number} storefront_oid
|
|
59341
|
+
* @param {string} commseq_uuid
|
|
59342
|
+
* @param {*} [options] Override http request option.
|
|
59343
|
+
* @throws {RequiredError}
|
|
59344
|
+
*/
|
|
59345
|
+
resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
|
|
59248
59346
|
/**
|
|
59249
59347
|
*
|
|
59250
59348
|
* @summary Request a review of an email
|
|
@@ -60043,6 +60141,15 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
|
|
|
60043
60141
|
* @throws {RequiredError}
|
|
60044
60142
|
*/
|
|
60045
60143
|
getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
|
|
60144
|
+
/**
|
|
60145
|
+
*
|
|
60146
|
+
* @summary Get email commseq rate limiters
|
|
60147
|
+
* @param {number} storefront_oid
|
|
60148
|
+
* @param {string} commseq_uuid
|
|
60149
|
+
* @param {*} [options] Override http request option.
|
|
60150
|
+
* @throws {RequiredError}
|
|
60151
|
+
*/
|
|
60152
|
+
getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailRateLimitersResponse>;
|
|
60046
60153
|
/**
|
|
60047
60154
|
*
|
|
60048
60155
|
* @summary Get email communication sequence sms stats
|
|
@@ -60846,6 +60953,15 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
|
|
|
60846
60953
|
* @throws {RequiredError}
|
|
60847
60954
|
*/
|
|
60848
60955
|
releaseEmailCommseqStepWaiting(storefront_oid: number, commseq_uuid: string, commseq_step_uuid: string, options?: any): Promise<Response>;
|
|
60956
|
+
/**
|
|
60957
|
+
*
|
|
60958
|
+
* @summary Reset email commseq rate limiters (only callable by UltraCart Support)
|
|
60959
|
+
* @param {number} storefront_oid
|
|
60960
|
+
* @param {string} commseq_uuid
|
|
60961
|
+
* @param {*} [options] Override http request option.
|
|
60962
|
+
* @throws {RequiredError}
|
|
60963
|
+
*/
|
|
60964
|
+
resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<Response>;
|
|
60849
60965
|
/**
|
|
60850
60966
|
*
|
|
60851
60967
|
* @summary Request a review of an email
|
|
@@ -61688,6 +61804,16 @@ export interface StorefrontApiInterface {
|
|
|
61688
61804
|
* @memberof StorefrontApiInterface
|
|
61689
61805
|
*/
|
|
61690
61806
|
getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
|
|
61807
|
+
/**
|
|
61808
|
+
*
|
|
61809
|
+
* @summary Get email commseq rate limiters
|
|
61810
|
+
* @param {number} storefront_oid
|
|
61811
|
+
* @param {string} commseq_uuid
|
|
61812
|
+
* @param {*} [options] Override http request option.
|
|
61813
|
+
* @throws {RequiredError}
|
|
61814
|
+
* @memberof StorefrontApiInterface
|
|
61815
|
+
*/
|
|
61816
|
+
getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailRateLimitersResponse>;
|
|
61691
61817
|
/**
|
|
61692
61818
|
*
|
|
61693
61819
|
* @summary Get email communication sequence sms stats
|
|
@@ -62580,6 +62706,16 @@ export interface StorefrontApiInterface {
|
|
|
62580
62706
|
* @memberof StorefrontApiInterface
|
|
62581
62707
|
*/
|
|
62582
62708
|
releaseEmailCommseqStepWaiting(storefront_oid: number, commseq_uuid: string, commseq_step_uuid: string, options?: any): Promise<{}>;
|
|
62709
|
+
/**
|
|
62710
|
+
*
|
|
62711
|
+
* @summary Reset email commseq rate limiters (only callable by UltraCart Support)
|
|
62712
|
+
* @param {number} storefront_oid
|
|
62713
|
+
* @param {string} commseq_uuid
|
|
62714
|
+
* @param {*} [options] Override http request option.
|
|
62715
|
+
* @throws {RequiredError}
|
|
62716
|
+
* @memberof StorefrontApiInterface
|
|
62717
|
+
*/
|
|
62718
|
+
resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<{}>;
|
|
62583
62719
|
/**
|
|
62584
62720
|
*
|
|
62585
62721
|
* @summary Request a review of an email
|
|
@@ -63465,6 +63601,16 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
|
|
|
63465
63601
|
* @memberof StorefrontApi
|
|
63466
63602
|
*/
|
|
63467
63603
|
getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
|
|
63604
|
+
/**
|
|
63605
|
+
*
|
|
63606
|
+
* @summary Get email commseq rate limiters
|
|
63607
|
+
* @param {number} storefront_oid
|
|
63608
|
+
* @param {string} commseq_uuid
|
|
63609
|
+
* @param {*} [options] Override http request option.
|
|
63610
|
+
* @throws {RequiredError}
|
|
63611
|
+
* @memberof StorefrontApi
|
|
63612
|
+
*/
|
|
63613
|
+
getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailRateLimitersResponse>;
|
|
63468
63614
|
/**
|
|
63469
63615
|
*
|
|
63470
63616
|
* @summary Get email communication sequence sms stats
|
|
@@ -64357,6 +64503,16 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
|
|
|
64357
64503
|
* @memberof StorefrontApi
|
|
64358
64504
|
*/
|
|
64359
64505
|
releaseEmailCommseqStepWaiting(storefront_oid: number, commseq_uuid: string, commseq_step_uuid: string, options?: any): Promise<Response>;
|
|
64506
|
+
/**
|
|
64507
|
+
*
|
|
64508
|
+
* @summary Reset email commseq rate limiters (only callable by UltraCart Support)
|
|
64509
|
+
* @param {number} storefront_oid
|
|
64510
|
+
* @param {string} commseq_uuid
|
|
64511
|
+
* @param {*} [options] Override http request option.
|
|
64512
|
+
* @throws {RequiredError}
|
|
64513
|
+
* @memberof StorefrontApi
|
|
64514
|
+
*/
|
|
64515
|
+
resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<Response>;
|
|
64360
64516
|
/**
|
|
64361
64517
|
*
|
|
64362
64518
|
* @summary Request a review of an email
|
package/dist/api.js
CHANGED
|
@@ -30152,6 +30152,65 @@ var StorefrontApiFetchParamCreator = function (configuration) {
|
|
|
30152
30152
|
options: localVarRequestOptions,
|
|
30153
30153
|
};
|
|
30154
30154
|
},
|
|
30155
|
+
/**
|
|
30156
|
+
*
|
|
30157
|
+
* @summary Get email commseq rate limiters
|
|
30158
|
+
* @param {number} storefront_oid
|
|
30159
|
+
* @param {string} commseq_uuid
|
|
30160
|
+
* @param {*} [options] Override http request option.
|
|
30161
|
+
* @throws {RequiredError}
|
|
30162
|
+
*/
|
|
30163
|
+
getEmailCommseqRateLimiters: function (storefront_oid, commseq_uuid, options) {
|
|
30164
|
+
if (options === void 0) { options = {}; }
|
|
30165
|
+
// verify required parameter 'storefront_oid' is not null or undefined
|
|
30166
|
+
if (storefront_oid === null || storefront_oid === undefined) {
|
|
30167
|
+
throw new RequiredError('storefront_oid', 'Required parameter storefront_oid was null or undefined when calling getEmailCommseqRateLimiters.');
|
|
30168
|
+
}
|
|
30169
|
+
// verify required parameter 'commseq_uuid' is not null or undefined
|
|
30170
|
+
if (commseq_uuid === null || commseq_uuid === undefined) {
|
|
30171
|
+
throw new RequiredError('commseq_uuid', 'Required parameter commseq_uuid was null or undefined when calling getEmailCommseqRateLimiters.');
|
|
30172
|
+
}
|
|
30173
|
+
var localVarPath = "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters"
|
|
30174
|
+
.replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(storefront_oid)))
|
|
30175
|
+
.replace("{".concat("commseq_uuid", "}"), encodeURIComponent(String(commseq_uuid)));
|
|
30176
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
30177
|
+
var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
30178
|
+
var localVarHeaderParameter = {};
|
|
30179
|
+
var localVarQueryParameter = {};
|
|
30180
|
+
if (configuration && configuration.apiVersion) {
|
|
30181
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
30182
|
+
}
|
|
30183
|
+
// authentication ultraCartBrowserApiKey required
|
|
30184
|
+
if (configuration && configuration.apiKey) {
|
|
30185
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
30186
|
+
? configuration.apiKey("x-ultracart-browser-key")
|
|
30187
|
+
: configuration.apiKey;
|
|
30188
|
+
localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
|
|
30189
|
+
}
|
|
30190
|
+
// authentication ultraCartOauth required
|
|
30191
|
+
// oauth required
|
|
30192
|
+
if (configuration && configuration.accessToken) {
|
|
30193
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
30194
|
+
? configuration.accessToken("ultraCartOauth", ["storefront_read"])
|
|
30195
|
+
: configuration.accessToken;
|
|
30196
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
30197
|
+
}
|
|
30198
|
+
// authentication ultraCartSimpleApiKey required
|
|
30199
|
+
if (configuration && configuration.apiKey) {
|
|
30200
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
30201
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
30202
|
+
: configuration.apiKey;
|
|
30203
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
30204
|
+
}
|
|
30205
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
30206
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
30207
|
+
delete localVarUrlObj.search;
|
|
30208
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
30209
|
+
return {
|
|
30210
|
+
url: url.format(localVarUrlObj),
|
|
30211
|
+
options: localVarRequestOptions,
|
|
30212
|
+
};
|
|
30213
|
+
},
|
|
30155
30214
|
/**
|
|
30156
30215
|
*
|
|
30157
30216
|
* @summary Get email communication sequence sms stats
|
|
@@ -35343,6 +35402,65 @@ var StorefrontApiFetchParamCreator = function (configuration) {
|
|
|
35343
35402
|
options: localVarRequestOptions,
|
|
35344
35403
|
};
|
|
35345
35404
|
},
|
|
35405
|
+
/**
|
|
35406
|
+
*
|
|
35407
|
+
* @summary Reset email commseq rate limiters (only callable by UltraCart Support)
|
|
35408
|
+
* @param {number} storefront_oid
|
|
35409
|
+
* @param {string} commseq_uuid
|
|
35410
|
+
* @param {*} [options] Override http request option.
|
|
35411
|
+
* @throws {RequiredError}
|
|
35412
|
+
*/
|
|
35413
|
+
resetEmailCommseqRateLimiters: function (storefront_oid, commseq_uuid, options) {
|
|
35414
|
+
if (options === void 0) { options = {}; }
|
|
35415
|
+
// verify required parameter 'storefront_oid' is not null or undefined
|
|
35416
|
+
if (storefront_oid === null || storefront_oid === undefined) {
|
|
35417
|
+
throw new RequiredError('storefront_oid', 'Required parameter storefront_oid was null or undefined when calling resetEmailCommseqRateLimiters.');
|
|
35418
|
+
}
|
|
35419
|
+
// verify required parameter 'commseq_uuid' is not null or undefined
|
|
35420
|
+
if (commseq_uuid === null || commseq_uuid === undefined) {
|
|
35421
|
+
throw new RequiredError('commseq_uuid', 'Required parameter commseq_uuid was null or undefined when calling resetEmailCommseqRateLimiters.');
|
|
35422
|
+
}
|
|
35423
|
+
var localVarPath = "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters"
|
|
35424
|
+
.replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(storefront_oid)))
|
|
35425
|
+
.replace("{".concat("commseq_uuid", "}"), encodeURIComponent(String(commseq_uuid)));
|
|
35426
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
35427
|
+
var localVarRequestOptions = Object.assign({ method: 'DELETE' }, options);
|
|
35428
|
+
var localVarHeaderParameter = {};
|
|
35429
|
+
var localVarQueryParameter = {};
|
|
35430
|
+
if (configuration && configuration.apiVersion) {
|
|
35431
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
35432
|
+
}
|
|
35433
|
+
// authentication ultraCartBrowserApiKey required
|
|
35434
|
+
if (configuration && configuration.apiKey) {
|
|
35435
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
35436
|
+
? configuration.apiKey("x-ultracart-browser-key")
|
|
35437
|
+
: configuration.apiKey;
|
|
35438
|
+
localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
|
|
35439
|
+
}
|
|
35440
|
+
// authentication ultraCartOauth required
|
|
35441
|
+
// oauth required
|
|
35442
|
+
if (configuration && configuration.accessToken) {
|
|
35443
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
35444
|
+
? configuration.accessToken("ultraCartOauth", ["storefront_read"])
|
|
35445
|
+
: configuration.accessToken;
|
|
35446
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
35447
|
+
}
|
|
35448
|
+
// authentication ultraCartSimpleApiKey required
|
|
35449
|
+
if (configuration && configuration.apiKey) {
|
|
35450
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
35451
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
35452
|
+
: configuration.apiKey;
|
|
35453
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
35454
|
+
}
|
|
35455
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
35456
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
35457
|
+
delete localVarUrlObj.search;
|
|
35458
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
35459
|
+
return {
|
|
35460
|
+
url: url.format(localVarUrlObj),
|
|
35461
|
+
options: localVarRequestOptions,
|
|
35462
|
+
};
|
|
35463
|
+
},
|
|
35346
35464
|
/**
|
|
35347
35465
|
*
|
|
35348
35466
|
* @summary Request a review of an email
|
|
@@ -38998,6 +39116,29 @@ var StorefrontApiFp = function (configuration) {
|
|
|
38998
39116
|
});
|
|
38999
39117
|
};
|
|
39000
39118
|
},
|
|
39119
|
+
/**
|
|
39120
|
+
*
|
|
39121
|
+
* @summary Get email commseq rate limiters
|
|
39122
|
+
* @param {number} storefront_oid
|
|
39123
|
+
* @param {string} commseq_uuid
|
|
39124
|
+
* @param {*} [options] Override http request option.
|
|
39125
|
+
* @throws {RequiredError}
|
|
39126
|
+
*/
|
|
39127
|
+
getEmailCommseqRateLimiters: function (storefront_oid, commseq_uuid, options) {
|
|
39128
|
+
var localVarFetchArgs = (0, exports.StorefrontApiFetchParamCreator)(configuration).getEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options);
|
|
39129
|
+
return function (fetch, basePath) {
|
|
39130
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
39131
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
39132
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
39133
|
+
if (response.status >= 200 && response.status < 300) {
|
|
39134
|
+
return response.json();
|
|
39135
|
+
}
|
|
39136
|
+
else {
|
|
39137
|
+
throw response;
|
|
39138
|
+
}
|
|
39139
|
+
});
|
|
39140
|
+
};
|
|
39141
|
+
},
|
|
39001
39142
|
/**
|
|
39002
39143
|
*
|
|
39003
39144
|
* @summary Get email communication sequence sms stats
|
|
@@ -41047,6 +41188,29 @@ var StorefrontApiFp = function (configuration) {
|
|
|
41047
41188
|
});
|
|
41048
41189
|
};
|
|
41049
41190
|
},
|
|
41191
|
+
/**
|
|
41192
|
+
*
|
|
41193
|
+
* @summary Reset email commseq rate limiters (only callable by UltraCart Support)
|
|
41194
|
+
* @param {number} storefront_oid
|
|
41195
|
+
* @param {string} commseq_uuid
|
|
41196
|
+
* @param {*} [options] Override http request option.
|
|
41197
|
+
* @throws {RequiredError}
|
|
41198
|
+
*/
|
|
41199
|
+
resetEmailCommseqRateLimiters: function (storefront_oid, commseq_uuid, options) {
|
|
41200
|
+
var localVarFetchArgs = (0, exports.StorefrontApiFetchParamCreator)(configuration).resetEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options);
|
|
41201
|
+
return function (fetch, basePath) {
|
|
41202
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
41203
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
41204
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
41205
|
+
if (response.status >= 200 && response.status < 300) {
|
|
41206
|
+
return response;
|
|
41207
|
+
}
|
|
41208
|
+
else {
|
|
41209
|
+
throw response;
|
|
41210
|
+
}
|
|
41211
|
+
});
|
|
41212
|
+
};
|
|
41213
|
+
},
|
|
41050
41214
|
/**
|
|
41051
41215
|
*
|
|
41052
41216
|
* @summary Request a review of an email
|
|
@@ -42522,6 +42686,17 @@ var StorefrontApiFactory = function (configuration, fetch, basePath) {
|
|
|
42522
42686
|
getEmailCommseqPostcardTracking: function (storefront_oid, commseq_postcard_uuid, options) {
|
|
42523
42687
|
return (0, exports.StorefrontApiFp)(configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options)(fetch, basePath);
|
|
42524
42688
|
},
|
|
42689
|
+
/**
|
|
42690
|
+
*
|
|
42691
|
+
* @summary Get email commseq rate limiters
|
|
42692
|
+
* @param {number} storefront_oid
|
|
42693
|
+
* @param {string} commseq_uuid
|
|
42694
|
+
* @param {*} [options] Override http request option.
|
|
42695
|
+
* @throws {RequiredError}
|
|
42696
|
+
*/
|
|
42697
|
+
getEmailCommseqRateLimiters: function (storefront_oid, commseq_uuid, options) {
|
|
42698
|
+
return (0, exports.StorefrontApiFp)(configuration).getEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options)(fetch, basePath);
|
|
42699
|
+
},
|
|
42525
42700
|
/**
|
|
42526
42701
|
*
|
|
42527
42702
|
* @summary Get email communication sequence sms stats
|
|
@@ -43503,6 +43678,17 @@ var StorefrontApiFactory = function (configuration, fetch, basePath) {
|
|
|
43503
43678
|
releaseEmailCommseqStepWaiting: function (storefront_oid, commseq_uuid, commseq_step_uuid, options) {
|
|
43504
43679
|
return (0, exports.StorefrontApiFp)(configuration).releaseEmailCommseqStepWaiting(storefront_oid, commseq_uuid, commseq_step_uuid, options)(fetch, basePath);
|
|
43505
43680
|
},
|
|
43681
|
+
/**
|
|
43682
|
+
*
|
|
43683
|
+
* @summary Reset email commseq rate limiters (only callable by UltraCart Support)
|
|
43684
|
+
* @param {number} storefront_oid
|
|
43685
|
+
* @param {string} commseq_uuid
|
|
43686
|
+
* @param {*} [options] Override http request option.
|
|
43687
|
+
* @throws {RequiredError}
|
|
43688
|
+
*/
|
|
43689
|
+
resetEmailCommseqRateLimiters: function (storefront_oid, commseq_uuid, options) {
|
|
43690
|
+
return (0, exports.StorefrontApiFp)(configuration).resetEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options)(fetch, basePath);
|
|
43691
|
+
},
|
|
43506
43692
|
/**
|
|
43507
43693
|
*
|
|
43508
43694
|
* @summary Request a review of an email
|
|
@@ -44522,6 +44708,18 @@ var StorefrontApi = /** @class */ (function (_super) {
|
|
|
44522
44708
|
StorefrontApi.prototype.getEmailCommseqPostcardTracking = function (storefront_oid, commseq_postcard_uuid, options) {
|
|
44523
44709
|
return (0, exports.StorefrontApiFp)(this.configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options)(this.fetch, this.basePath);
|
|
44524
44710
|
};
|
|
44711
|
+
/**
|
|
44712
|
+
*
|
|
44713
|
+
* @summary Get email commseq rate limiters
|
|
44714
|
+
* @param {number} storefront_oid
|
|
44715
|
+
* @param {string} commseq_uuid
|
|
44716
|
+
* @param {*} [options] Override http request option.
|
|
44717
|
+
* @throws {RequiredError}
|
|
44718
|
+
* @memberof StorefrontApi
|
|
44719
|
+
*/
|
|
44720
|
+
StorefrontApi.prototype.getEmailCommseqRateLimiters = function (storefront_oid, commseq_uuid, options) {
|
|
44721
|
+
return (0, exports.StorefrontApiFp)(this.configuration).getEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options)(this.fetch, this.basePath);
|
|
44722
|
+
};
|
|
44525
44723
|
/**
|
|
44526
44724
|
*
|
|
44527
44725
|
* @summary Get email communication sequence sms stats
|
|
@@ -45592,6 +45790,18 @@ var StorefrontApi = /** @class */ (function (_super) {
|
|
|
45592
45790
|
StorefrontApi.prototype.releaseEmailCommseqStepWaiting = function (storefront_oid, commseq_uuid, commseq_step_uuid, options) {
|
|
45593
45791
|
return (0, exports.StorefrontApiFp)(this.configuration).releaseEmailCommseqStepWaiting(storefront_oid, commseq_uuid, commseq_step_uuid, options)(this.fetch, this.basePath);
|
|
45594
45792
|
};
|
|
45793
|
+
/**
|
|
45794
|
+
*
|
|
45795
|
+
* @summary Reset email commseq rate limiters (only callable by UltraCart Support)
|
|
45796
|
+
* @param {number} storefront_oid
|
|
45797
|
+
* @param {string} commseq_uuid
|
|
45798
|
+
* @param {*} [options] Override http request option.
|
|
45799
|
+
* @throws {RequiredError}
|
|
45800
|
+
* @memberof StorefrontApi
|
|
45801
|
+
*/
|
|
45802
|
+
StorefrontApi.prototype.resetEmailCommseqRateLimiters = function (storefront_oid, commseq_uuid, options) {
|
|
45803
|
+
return (0, exports.StorefrontApiFp)(this.configuration).resetEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options)(this.fetch, this.basePath);
|
|
45804
|
+
};
|
|
45595
45805
|
/**
|
|
45596
45806
|
*
|
|
45597
45807
|
* @summary Request a review of an email
|