ultracart_rest_api_v2_typescript 3.10.206 → 3.10.208

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 CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@3.10.206
1
+ ## ultracart_rest_api_v2_typescript@3.10.208
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.206 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.208 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.10.208 | 05/30/2024 | add adult sig req. to the merchant item destination markup for items |
58
+ | 3.10.207 | 05/29/2024 | added methods getEmailCommseqRateLimiters, resetEmailCommseqRateLimiters |
57
59
  | 3.10.206 | 05/28/2024 | added property to OrderQuery object to allow querying from cache |
58
60
  | 3.10.205 | 05/17/2024 | conv.pbx time based config - changed name from default to default_mapping |
59
61
  | 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
@@ -29648,6 +29712,12 @@ export interface ItemShippingCase {
29648
29712
  * @interface ItemShippingDestinationMarkup
29649
29713
  */
29650
29714
  export interface ItemShippingDestinationMarkup {
29715
+ /**
29716
+ * Adult Signature Required (only updated if not-null value provided)
29717
+ * @type {boolean}
29718
+ * @memberof ItemShippingDestinationMarkup
29719
+ */
29720
+ adult_signature_required?: boolean;
29651
29721
  /**
29652
29722
  * Country code (ISO-3166 two letter)
29653
29723
  * @type {string}
@@ -78165,6 +78235,72 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
78165
78235
 
78166
78236
 
78167
78237
 
78238
+ // authentication ultraCartBrowserApiKey required
78239
+ if (configuration && configuration.apiKey) {
78240
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
78241
+ ? configuration.apiKey("x-ultracart-browser-key")
78242
+ : configuration.apiKey;
78243
+ localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
78244
+ }
78245
+
78246
+ // authentication ultraCartOauth required
78247
+ // oauth required
78248
+ if (configuration && configuration.accessToken) {
78249
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
78250
+ ? configuration.accessToken("ultraCartOauth", ["storefront_read"])
78251
+ : configuration.accessToken;
78252
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
78253
+ }
78254
+
78255
+ // authentication ultraCartSimpleApiKey required
78256
+ if (configuration && configuration.apiKey) {
78257
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
78258
+ ? configuration.apiKey("x-ultracart-simple-key")
78259
+ : configuration.apiKey;
78260
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
78261
+ }
78262
+
78263
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
78264
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
78265
+ delete localVarUrlObj.search;
78266
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
78267
+
78268
+ return {
78269
+ url: url.format(localVarUrlObj),
78270
+ options: localVarRequestOptions,
78271
+ };
78272
+ },
78273
+ /**
78274
+ *
78275
+ * @summary Get email commseq rate limiters
78276
+ * @param {number} storefront_oid
78277
+ * @param {string} commseq_uuid
78278
+ * @param {*} [options] Override http request option.
78279
+ * @throws {RequiredError}
78280
+ */
78281
+ getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options: any = {}): FetchArgs {
78282
+ // verify required parameter 'storefront_oid' is not null or undefined
78283
+ if (storefront_oid === null || storefront_oid === undefined) {
78284
+ throw new RequiredError('storefront_oid','Required parameter storefront_oid was null or undefined when calling getEmailCommseqRateLimiters.');
78285
+ }
78286
+ // verify required parameter 'commseq_uuid' is not null or undefined
78287
+ if (commseq_uuid === null || commseq_uuid === undefined) {
78288
+ throw new RequiredError('commseq_uuid','Required parameter commseq_uuid was null or undefined when calling getEmailCommseqRateLimiters.');
78289
+ }
78290
+ const localVarPath = `/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters`
78291
+ .replace(`{${"storefront_oid"}}`, encodeURIComponent(String(storefront_oid)))
78292
+ .replace(`{${"commseq_uuid"}}`, encodeURIComponent(String(commseq_uuid)));
78293
+ const localVarUrlObj = url.parse(localVarPath, true);
78294
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
78295
+ const localVarHeaderParameter = {} as any;
78296
+ const localVarQueryParameter = {} as any;
78297
+
78298
+ if(configuration && configuration.apiVersion) {
78299
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
78300
+ }
78301
+
78302
+
78303
+
78168
78304
  // authentication ultraCartBrowserApiKey required
78169
78305
  if (configuration && configuration.apiKey) {
78170
78306
  const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -84025,6 +84161,72 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
84025
84161
 
84026
84162
 
84027
84163
 
84164
+ // authentication ultraCartBrowserApiKey required
84165
+ if (configuration && configuration.apiKey) {
84166
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
84167
+ ? configuration.apiKey("x-ultracart-browser-key")
84168
+ : configuration.apiKey;
84169
+ localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
84170
+ }
84171
+
84172
+ // authentication ultraCartOauth required
84173
+ // oauth required
84174
+ if (configuration && configuration.accessToken) {
84175
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
84176
+ ? configuration.accessToken("ultraCartOauth", ["storefront_read"])
84177
+ : configuration.accessToken;
84178
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
84179
+ }
84180
+
84181
+ // authentication ultraCartSimpleApiKey required
84182
+ if (configuration && configuration.apiKey) {
84183
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
84184
+ ? configuration.apiKey("x-ultracart-simple-key")
84185
+ : configuration.apiKey;
84186
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
84187
+ }
84188
+
84189
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
84190
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
84191
+ delete localVarUrlObj.search;
84192
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
84193
+
84194
+ return {
84195
+ url: url.format(localVarUrlObj),
84196
+ options: localVarRequestOptions,
84197
+ };
84198
+ },
84199
+ /**
84200
+ *
84201
+ * @summary Reset email commseq rate limiters (only callable by UltraCart Support)
84202
+ * @param {number} storefront_oid
84203
+ * @param {string} commseq_uuid
84204
+ * @param {*} [options] Override http request option.
84205
+ * @throws {RequiredError}
84206
+ */
84207
+ resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options: any = {}): FetchArgs {
84208
+ // verify required parameter 'storefront_oid' is not null or undefined
84209
+ if (storefront_oid === null || storefront_oid === undefined) {
84210
+ throw new RequiredError('storefront_oid','Required parameter storefront_oid was null or undefined when calling resetEmailCommseqRateLimiters.');
84211
+ }
84212
+ // verify required parameter 'commseq_uuid' is not null or undefined
84213
+ if (commseq_uuid === null || commseq_uuid === undefined) {
84214
+ throw new RequiredError('commseq_uuid','Required parameter commseq_uuid was null or undefined when calling resetEmailCommseqRateLimiters.');
84215
+ }
84216
+ const localVarPath = `/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters`
84217
+ .replace(`{${"storefront_oid"}}`, encodeURIComponent(String(storefront_oid)))
84218
+ .replace(`{${"commseq_uuid"}}`, encodeURIComponent(String(commseq_uuid)));
84219
+ const localVarUrlObj = url.parse(localVarPath, true);
84220
+ const localVarRequestOptions = Object.assign({ method: 'DELETE' }, options);
84221
+ const localVarHeaderParameter = {} as any;
84222
+ const localVarQueryParameter = {} as any;
84223
+
84224
+ if(configuration && configuration.apiVersion) {
84225
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
84226
+ }
84227
+
84228
+
84229
+
84028
84230
  // authentication ultraCartBrowserApiKey required
84029
84231
  if (configuration && configuration.apiKey) {
84030
84232
  const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -88015,6 +88217,28 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
88015
88217
  });
88016
88218
  };
88017
88219
  },
88220
+ /**
88221
+ *
88222
+ * @summary Get email commseq rate limiters
88223
+ * @param {number} storefront_oid
88224
+ * @param {string} commseq_uuid
88225
+ * @param {*} [options] Override http request option.
88226
+ * @throws {RequiredError}
88227
+ */
88228
+ getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailRateLimitersResponse> {
88229
+ const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).getEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options);
88230
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
88231
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
88232
+
88233
+ if (response.status >= 200 && response.status < 300) {
88234
+ return response.json();
88235
+
88236
+ } else {
88237
+ throw response;
88238
+ }
88239
+ });
88240
+ };
88241
+ },
88018
88242
  /**
88019
88243
  *
88020
88244
  * @summary Get email communication sequence sms stats
@@ -89975,6 +90199,28 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
89975
90199
  });
89976
90200
  };
89977
90201
  },
90202
+ /**
90203
+ *
90204
+ * @summary Reset email commseq rate limiters (only callable by UltraCart Support)
90205
+ * @param {number} storefront_oid
90206
+ * @param {string} commseq_uuid
90207
+ * @param {*} [options] Override http request option.
90208
+ * @throws {RequiredError}
90209
+ */
90210
+ resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
90211
+ const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).resetEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options);
90212
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
90213
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
90214
+
90215
+ if (response.status >= 200 && response.status < 300) {
90216
+ return response;
90217
+
90218
+ } else {
90219
+ throw response;
90220
+ }
90221
+ });
90222
+ };
90223
+ },
89978
90224
  /**
89979
90225
  *
89980
90226
  * @summary Request a review of an email
@@ -91408,6 +91654,17 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
91408
91654
  getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any) {
91409
91655
  return StorefrontApiFp(configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options)(fetch, basePath);
91410
91656
  },
91657
+ /**
91658
+ *
91659
+ * @summary Get email commseq rate limiters
91660
+ * @param {number} storefront_oid
91661
+ * @param {string} commseq_uuid
91662
+ * @param {*} [options] Override http request option.
91663
+ * @throws {RequiredError}
91664
+ */
91665
+ getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any) {
91666
+ return StorefrontApiFp(configuration).getEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options)(fetch, basePath);
91667
+ },
91411
91668
  /**
91412
91669
  *
91413
91670
  * @summary Get email communication sequence sms stats
@@ -92389,6 +92646,17 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
92389
92646
  releaseEmailCommseqStepWaiting(storefront_oid: number, commseq_uuid: string, commseq_step_uuid: string, options?: any) {
92390
92647
  return StorefrontApiFp(configuration).releaseEmailCommseqStepWaiting(storefront_oid, commseq_uuid, commseq_step_uuid, options)(fetch, basePath);
92391
92648
  },
92649
+ /**
92650
+ *
92651
+ * @summary Reset email commseq rate limiters (only callable by UltraCart Support)
92652
+ * @param {number} storefront_oid
92653
+ * @param {string} commseq_uuid
92654
+ * @param {*} [options] Override http request option.
92655
+ * @throws {RequiredError}
92656
+ */
92657
+ resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any) {
92658
+ return StorefrontApiFp(configuration).resetEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options)(fetch, basePath);
92659
+ },
92392
92660
  /**
92393
92661
  *
92394
92662
  * @summary Request a review of an email
@@ -93360,6 +93628,17 @@ export interface StorefrontApiInterface {
93360
93628
  */
93361
93629
  getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
93362
93630
 
93631
+ /**
93632
+ *
93633
+ * @summary Get email commseq rate limiters
93634
+ * @param {number} storefront_oid
93635
+ * @param {string} commseq_uuid
93636
+ * @param {*} [options] Override http request option.
93637
+ * @throws {RequiredError}
93638
+ * @memberof StorefrontApiInterface
93639
+ */
93640
+ getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailRateLimitersResponse>;
93641
+
93363
93642
  /**
93364
93643
  *
93365
93644
  * @summary Get email communication sequence sms stats
@@ -94341,6 +94620,17 @@ export interface StorefrontApiInterface {
94341
94620
  */
94342
94621
  releaseEmailCommseqStepWaiting(storefront_oid: number, commseq_uuid: string, commseq_step_uuid: string, options?: any): Promise<{}>;
94343
94622
 
94623
+ /**
94624
+ *
94625
+ * @summary Reset email commseq rate limiters (only callable by UltraCart Support)
94626
+ * @param {number} storefront_oid
94627
+ * @param {string} commseq_uuid
94628
+ * @param {*} [options] Override http request option.
94629
+ * @throws {RequiredError}
94630
+ * @memberof StorefrontApiInterface
94631
+ */
94632
+ resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<{}>;
94633
+
94344
94634
  /**
94345
94635
  *
94346
94636
  * @summary Request a review of an email
@@ -95398,6 +95688,19 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
95398
95688
  return StorefrontApiFp(this.configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options)(this.fetch, this.basePath);
95399
95689
  }
95400
95690
 
95691
+ /**
95692
+ *
95693
+ * @summary Get email commseq rate limiters
95694
+ * @param {number} storefront_oid
95695
+ * @param {string} commseq_uuid
95696
+ * @param {*} [options] Override http request option.
95697
+ * @throws {RequiredError}
95698
+ * @memberof StorefrontApi
95699
+ */
95700
+ public getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any) {
95701
+ return StorefrontApiFp(this.configuration).getEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options)(this.fetch, this.basePath);
95702
+ }
95703
+
95401
95704
  /**
95402
95705
  *
95403
95706
  * @summary Get email communication sequence sms stats
@@ -96557,6 +96860,19 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
96557
96860
  return StorefrontApiFp(this.configuration).releaseEmailCommseqStepWaiting(storefront_oid, commseq_uuid, commseq_step_uuid, options)(this.fetch, this.basePath);
96558
96861
  }
96559
96862
 
96863
+ /**
96864
+ *
96865
+ * @summary Reset email commseq rate limiters (only callable by UltraCart Support)
96866
+ * @param {number} storefront_oid
96867
+ * @param {string} commseq_uuid
96868
+ * @param {*} [options] Override http request option.
96869
+ * @throws {RequiredError}
96870
+ * @memberof StorefrontApi
96871
+ */
96872
+ public resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any) {
96873
+ return StorefrontApiFp(this.configuration).resetEmailCommseqRateLimiters(storefront_oid, commseq_uuid, options)(this.fetch, this.basePath);
96874
+ }
96875
+
96560
96876
  /**
96561
96877
  *
96562
96878
  * @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
@@ -29025,6 +29087,12 @@ export interface ItemShippingCase {
29025
29087
  * @interface ItemShippingDestinationMarkup
29026
29088
  */
29027
29089
  export interface ItemShippingDestinationMarkup {
29090
+ /**
29091
+ * Adult Signature Required (only updated if not-null value provided)
29092
+ * @type {boolean}
29093
+ * @memberof ItemShippingDestinationMarkup
29094
+ */
29095
+ adult_signature_required?: boolean;
29028
29096
  /**
29029
29097
  * Country code (ISO-3166 two letter)
29030
29098
  * @type {string}
@@ -56841,6 +56909,15 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
56841
56909
  * @throws {RequiredError}
56842
56910
  */
56843
56911
  getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): FetchArgs;
56912
+ /**
56913
+ *
56914
+ * @summary Get email commseq rate limiters
56915
+ * @param {number} storefront_oid
56916
+ * @param {string} commseq_uuid
56917
+ * @param {*} [options] Override http request option.
56918
+ * @throws {RequiredError}
56919
+ */
56920
+ getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): FetchArgs;
56844
56921
  /**
56845
56922
  *
56846
56923
  * @summary Get email communication sequence sms stats
@@ -57644,6 +57721,15 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
57644
57721
  * @throws {RequiredError}
57645
57722
  */
57646
57723
  releaseEmailCommseqStepWaiting(storefront_oid: number, commseq_uuid: string, commseq_step_uuid: string, options?: any): FetchArgs;
57724
+ /**
57725
+ *
57726
+ * @summary Reset email commseq rate limiters (only callable by UltraCart Support)
57727
+ * @param {number} storefront_oid
57728
+ * @param {string} commseq_uuid
57729
+ * @param {*} [options] Override http request option.
57730
+ * @throws {RequiredError}
57731
+ */
57732
+ resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): FetchArgs;
57647
57733
  /**
57648
57734
  *
57649
57735
  * @summary Request a review of an email
@@ -58442,6 +58528,15 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
58442
58528
  * @throws {RequiredError}
58443
58529
  */
58444
58530
  getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailPostcardTrackingResponse>;
58531
+ /**
58532
+ *
58533
+ * @summary Get email commseq rate limiters
58534
+ * @param {number} storefront_oid
58535
+ * @param {string} commseq_uuid
58536
+ * @param {*} [options] Override http request option.
58537
+ * @throws {RequiredError}
58538
+ */
58539
+ getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailRateLimitersResponse>;
58445
58540
  /**
58446
58541
  *
58447
58542
  * @summary Get email communication sequence sms stats
@@ -59245,6 +59340,15 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
59245
59340
  * @throws {RequiredError}
59246
59341
  */
59247
59342
  releaseEmailCommseqStepWaiting(storefront_oid: number, commseq_uuid: string, commseq_step_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
59343
+ /**
59344
+ *
59345
+ * @summary Reset email commseq rate limiters (only callable by UltraCart Support)
59346
+ * @param {number} storefront_oid
59347
+ * @param {string} commseq_uuid
59348
+ * @param {*} [options] Override http request option.
59349
+ * @throws {RequiredError}
59350
+ */
59351
+ resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
59248
59352
  /**
59249
59353
  *
59250
59354
  * @summary Request a review of an email
@@ -60043,6 +60147,15 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
60043
60147
  * @throws {RequiredError}
60044
60148
  */
60045
60149
  getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
60150
+ /**
60151
+ *
60152
+ * @summary Get email commseq rate limiters
60153
+ * @param {number} storefront_oid
60154
+ * @param {string} commseq_uuid
60155
+ * @param {*} [options] Override http request option.
60156
+ * @throws {RequiredError}
60157
+ */
60158
+ getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailRateLimitersResponse>;
60046
60159
  /**
60047
60160
  *
60048
60161
  * @summary Get email communication sequence sms stats
@@ -60846,6 +60959,15 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
60846
60959
  * @throws {RequiredError}
60847
60960
  */
60848
60961
  releaseEmailCommseqStepWaiting(storefront_oid: number, commseq_uuid: string, commseq_step_uuid: string, options?: any): Promise<Response>;
60962
+ /**
60963
+ *
60964
+ * @summary Reset email commseq rate limiters (only callable by UltraCart Support)
60965
+ * @param {number} storefront_oid
60966
+ * @param {string} commseq_uuid
60967
+ * @param {*} [options] Override http request option.
60968
+ * @throws {RequiredError}
60969
+ */
60970
+ resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<Response>;
60849
60971
  /**
60850
60972
  *
60851
60973
  * @summary Request a review of an email
@@ -61688,6 +61810,16 @@ export interface StorefrontApiInterface {
61688
61810
  * @memberof StorefrontApiInterface
61689
61811
  */
61690
61812
  getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
61813
+ /**
61814
+ *
61815
+ * @summary Get email commseq rate limiters
61816
+ * @param {number} storefront_oid
61817
+ * @param {string} commseq_uuid
61818
+ * @param {*} [options] Override http request option.
61819
+ * @throws {RequiredError}
61820
+ * @memberof StorefrontApiInterface
61821
+ */
61822
+ getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailRateLimitersResponse>;
61691
61823
  /**
61692
61824
  *
61693
61825
  * @summary Get email communication sequence sms stats
@@ -62580,6 +62712,16 @@ export interface StorefrontApiInterface {
62580
62712
  * @memberof StorefrontApiInterface
62581
62713
  */
62582
62714
  releaseEmailCommseqStepWaiting(storefront_oid: number, commseq_uuid: string, commseq_step_uuid: string, options?: any): Promise<{}>;
62715
+ /**
62716
+ *
62717
+ * @summary Reset email commseq rate limiters (only callable by UltraCart Support)
62718
+ * @param {number} storefront_oid
62719
+ * @param {string} commseq_uuid
62720
+ * @param {*} [options] Override http request option.
62721
+ * @throws {RequiredError}
62722
+ * @memberof StorefrontApiInterface
62723
+ */
62724
+ resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<{}>;
62583
62725
  /**
62584
62726
  *
62585
62727
  * @summary Request a review of an email
@@ -63465,6 +63607,16 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
63465
63607
  * @memberof StorefrontApi
63466
63608
  */
63467
63609
  getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
63610
+ /**
63611
+ *
63612
+ * @summary Get email commseq rate limiters
63613
+ * @param {number} storefront_oid
63614
+ * @param {string} commseq_uuid
63615
+ * @param {*} [options] Override http request option.
63616
+ * @throws {RequiredError}
63617
+ * @memberof StorefrontApi
63618
+ */
63619
+ getEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailRateLimitersResponse>;
63468
63620
  /**
63469
63621
  *
63470
63622
  * @summary Get email communication sequence sms stats
@@ -64357,6 +64509,16 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
64357
64509
  * @memberof StorefrontApi
64358
64510
  */
64359
64511
  releaseEmailCommseqStepWaiting(storefront_oid: number, commseq_uuid: string, commseq_step_uuid: string, options?: any): Promise<Response>;
64512
+ /**
64513
+ *
64514
+ * @summary Reset email commseq rate limiters (only callable by UltraCart Support)
64515
+ * @param {number} storefront_oid
64516
+ * @param {string} commseq_uuid
64517
+ * @param {*} [options] Override http request option.
64518
+ * @throws {RequiredError}
64519
+ * @memberof StorefrontApi
64520
+ */
64521
+ resetEmailCommseqRateLimiters(storefront_oid: number, commseq_uuid: string, options?: any): Promise<Response>;
64360
64522
  /**
64361
64523
  *
64362
64524
  * @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
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.206",
3
+ "version": "3.10.208",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [