ultracart_rest_api_v2_typescript 3.10.45 → 3.10.46

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.45
1
+ ## ultracart_rest_api_v2_typescript@3.10.46
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.45 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.46 --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.46 | 09/13/2022 | storefront comms - postcard tracking |
57
58
  | 3.10.45 | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
58
59
  | 3.10.44 | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |
59
60
  | 3.10.43 | 09/02/2022 | customer editor added loyal ledger descriptions |
package/api.ts CHANGED
@@ -16008,6 +16008,202 @@ export interface EmailPostcardStat {
16008
16008
  view_count_formatted?: string;
16009
16009
  }
16010
16010
 
16011
+ /**
16012
+ *
16013
+ * @export
16014
+ * @interface EmailPostcardTracking
16015
+ */
16016
+ export interface EmailPostcardTracking {
16017
+ /**
16018
+ *
16019
+ * @type {string}
16020
+ * @memberof EmailPostcardTracking
16021
+ */
16022
+ commseq_postcard_uuid?: string;
16023
+ /**
16024
+ *
16025
+ * @type {string}
16026
+ * @memberof EmailPostcardTracking
16027
+ */
16028
+ commseq_step_uuid?: string;
16029
+ /**
16030
+ *
16031
+ * @type {string}
16032
+ * @memberof EmailPostcardTracking
16033
+ */
16034
+ commseq_uuid?: string;
16035
+ /**
16036
+ * Conversion date time.
16037
+ * @type {string}
16038
+ * @memberof EmailPostcardTracking
16039
+ */
16040
+ conversion_dts?: string;
16041
+ /**
16042
+ *
16043
+ * @type {number}
16044
+ * @memberof EmailPostcardTracking
16045
+ */
16046
+ cost?: number;
16047
+ /**
16048
+ *
16049
+ * @type {string}
16050
+ * @memberof EmailPostcardTracking
16051
+ */
16052
+ customer_uuid?: string;
16053
+ /**
16054
+ * Delivered date time.
16055
+ * @type {string}
16056
+ * @memberof EmailPostcardTracking
16057
+ */
16058
+ delivered_dts?: string;
16059
+ /**
16060
+ *
16061
+ * @type {string}
16062
+ * @memberof EmailPostcardTracking
16063
+ */
16064
+ from_address_line1?: string;
16065
+ /**
16066
+ *
16067
+ * @type {string}
16068
+ * @memberof EmailPostcardTracking
16069
+ */
16070
+ from_address_line2?: string;
16071
+ /**
16072
+ *
16073
+ * @type {string}
16074
+ * @memberof EmailPostcardTracking
16075
+ */
16076
+ from_city?: string;
16077
+ /**
16078
+ *
16079
+ * @type {string}
16080
+ * @memberof EmailPostcardTracking
16081
+ */
16082
+ from_name?: string;
16083
+ /**
16084
+ *
16085
+ * @type {string}
16086
+ * @memberof EmailPostcardTracking
16087
+ */
16088
+ from_state?: string;
16089
+ /**
16090
+ *
16091
+ * @type {string}
16092
+ * @memberof EmailPostcardTracking
16093
+ */
16094
+ from_zip?: string;
16095
+ /**
16096
+ * Mailed date time.
16097
+ * @type {string}
16098
+ * @memberof EmailPostcardTracking
16099
+ */
16100
+ mailed_dts?: string;
16101
+ /**
16102
+ *
16103
+ * @type {string}
16104
+ * @memberof EmailPostcardTracking
16105
+ */
16106
+ order_id?: string;
16107
+ /**
16108
+ *
16109
+ * @type {string}
16110
+ * @memberof EmailPostcardTracking
16111
+ */
16112
+ postcard_tracking_uuid?: string;
16113
+ /**
16114
+ *
16115
+ * @type {string}
16116
+ * @memberof EmailPostcardTracking
16117
+ */
16118
+ status?: string;
16119
+ /**
16120
+ * Submit date time.
16121
+ * @type {string}
16122
+ * @memberof EmailPostcardTracking
16123
+ */
16124
+ submit_dts?: string;
16125
+ /**
16126
+ *
16127
+ * @type {string}
16128
+ * @memberof EmailPostcardTracking
16129
+ */
16130
+ to_address_line1?: string;
16131
+ /**
16132
+ *
16133
+ * @type {string}
16134
+ * @memberof EmailPostcardTracking
16135
+ */
16136
+ to_address_line2?: string;
16137
+ /**
16138
+ *
16139
+ * @type {string}
16140
+ * @memberof EmailPostcardTracking
16141
+ */
16142
+ to_city?: string;
16143
+ /**
16144
+ *
16145
+ * @type {string}
16146
+ * @memberof EmailPostcardTracking
16147
+ */
16148
+ to_name?: string;
16149
+ /**
16150
+ *
16151
+ * @type {string}
16152
+ * @memberof EmailPostcardTracking
16153
+ */
16154
+ to_state?: string;
16155
+ /**
16156
+ *
16157
+ * @type {string}
16158
+ * @memberof EmailPostcardTracking
16159
+ */
16160
+ to_zip?: string;
16161
+ /**
16162
+ *
16163
+ * @type {string}
16164
+ * @memberof EmailPostcardTracking
16165
+ */
16166
+ tracking_description?: string;
16167
+ }
16168
+
16169
+ /**
16170
+ *
16171
+ * @export
16172
+ * @interface EmailPostcardTrackingResponse
16173
+ */
16174
+ export interface EmailPostcardTrackingResponse {
16175
+ /**
16176
+ *
16177
+ * @type {ModelError}
16178
+ * @memberof EmailPostcardTrackingResponse
16179
+ */
16180
+ error?: ModelError;
16181
+ /**
16182
+ *
16183
+ * @type {ResponseMetadata}
16184
+ * @memberof EmailPostcardTrackingResponse
16185
+ */
16186
+ metadata?: ResponseMetadata;
16187
+ /**
16188
+ * Indicates if API call was successful
16189
+ * @type {boolean}
16190
+ * @memberof EmailPostcardTrackingResponse
16191
+ */
16192
+ success?: boolean;
16193
+ /**
16194
+ *
16195
+ * @type {EmailPostcardTracking}
16196
+ * @memberof EmailPostcardTrackingResponse
16197
+ */
16198
+ tracking?: EmailPostcardTracking;
16199
+ /**
16200
+ *
16201
+ * @type {Warning}
16202
+ * @memberof EmailPostcardTrackingResponse
16203
+ */
16204
+ warning?: Warning;
16205
+ }
16206
+
16011
16207
  /**
16012
16208
  *
16013
16209
  * @export
@@ -55531,6 +55727,72 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
55531
55727
  options: localVarRequestOptions,
55532
55728
  };
55533
55729
  },
55730
+ /**
55731
+ *
55732
+ * @summary Get email communication postcard tracking
55733
+ * @param {number} storefront_oid
55734
+ * @param {string} commseq_postcard_uuid
55735
+ * @param {*} [options] Override http request option.
55736
+ * @throws {RequiredError}
55737
+ */
55738
+ getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options: any = {}): FetchArgs {
55739
+ // verify required parameter 'storefront_oid' is not null or undefined
55740
+ if (storefront_oid === null || storefront_oid === undefined) {
55741
+ throw new RequiredError('storefront_oid','Required parameter storefront_oid was null or undefined when calling getEmailCommseqPostcardTracking.');
55742
+ }
55743
+ // verify required parameter 'commseq_postcard_uuid' is not null or undefined
55744
+ if (commseq_postcard_uuid === null || commseq_postcard_uuid === undefined) {
55745
+ throw new RequiredError('commseq_postcard_uuid','Required parameter commseq_postcard_uuid was null or undefined when calling getEmailCommseqPostcardTracking.');
55746
+ }
55747
+ const localVarPath = `/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking`
55748
+ .replace(`{${"storefront_oid"}}`, encodeURIComponent(String(storefront_oid)))
55749
+ .replace(`{${"commseq_postcard_uuid"}}`, encodeURIComponent(String(commseq_postcard_uuid)));
55750
+ const localVarUrlObj = url.parse(localVarPath, true);
55751
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
55752
+ const localVarHeaderParameter = {} as any;
55753
+ const localVarQueryParameter = {} as any;
55754
+
55755
+ if(configuration && configuration.apiVersion) {
55756
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
55757
+ }
55758
+
55759
+
55760
+
55761
+ // authentication ultraCartBrowserApiKey required
55762
+ if (configuration && configuration.apiKey) {
55763
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
55764
+ ? configuration.apiKey("x-ultracart-browser-key")
55765
+ : configuration.apiKey;
55766
+ localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
55767
+ }
55768
+
55769
+ // authentication ultraCartOauth required
55770
+ // oauth required
55771
+ if (configuration && configuration.accessToken) {
55772
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
55773
+ ? configuration.accessToken("ultraCartOauth", ["storefront_read"])
55774
+ : configuration.accessToken;
55775
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
55776
+ }
55777
+
55778
+ // authentication ultraCartSimpleApiKey required
55779
+ if (configuration && configuration.apiKey) {
55780
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
55781
+ ? configuration.apiKey("x-ultracart-simple-key")
55782
+ : configuration.apiKey;
55783
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
55784
+ }
55785
+
55786
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
55787
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
55788
+ delete localVarUrlObj.search;
55789
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
55790
+
55791
+ return {
55792
+ url: url.format(localVarUrlObj),
55793
+ options: localVarRequestOptions,
55794
+ };
55795
+ },
55534
55796
  /**
55535
55797
  *
55536
55798
  * @summary Get communication sequence stats overall
@@ -64835,6 +65097,28 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
64835
65097
  });
64836
65098
  };
64837
65099
  },
65100
+ /**
65101
+ *
65102
+ * @summary Get email communication postcard tracking
65103
+ * @param {number} storefront_oid
65104
+ * @param {string} commseq_postcard_uuid
65105
+ * @param {*} [options] Override http request option.
65106
+ * @throws {RequiredError}
65107
+ */
65108
+ getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailPostcardTrackingResponse> {
65109
+ const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options);
65110
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
65111
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
65112
+
65113
+ if (response.status >= 200 && response.status < 300) {
65114
+ return response.json();
65115
+
65116
+ } else {
65117
+ throw response;
65118
+ }
65119
+ });
65120
+ };
65121
+ },
64838
65122
  /**
64839
65123
  *
64840
65124
  * @summary Get communication sequence stats overall
@@ -68054,6 +68338,17 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
68054
68338
  getEmailCommseqPostcardStats(storefront_oid: number, commseq_uuid: string, statsRequest: EmailStatPostcardSummaryRequest, options?: any) {
68055
68339
  return StorefrontApiFp(configuration).getEmailCommseqPostcardStats(storefront_oid, commseq_uuid, statsRequest, options)(fetch, basePath);
68056
68340
  },
68341
+ /**
68342
+ *
68343
+ * @summary Get email communication postcard tracking
68344
+ * @param {number} storefront_oid
68345
+ * @param {string} commseq_postcard_uuid
68346
+ * @param {*} [options] Override http request option.
68347
+ * @throws {RequiredError}
68348
+ */
68349
+ getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any) {
68350
+ return StorefrontApiFp(configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options)(fetch, basePath);
68351
+ },
68057
68352
  /**
68058
68353
  *
68059
68354
  * @summary Get communication sequence stats overall
@@ -69898,6 +70193,17 @@ export interface StorefrontApiInterface {
69898
70193
  */
69899
70194
  getEmailCommseqPostcardStats(storefront_oid: number, commseq_uuid: string, statsRequest: EmailStatPostcardSummaryRequest, options?: any): Promise<EmailStatPostcardSummaryResponse>;
69900
70195
 
70196
+ /**
70197
+ *
70198
+ * @summary Get email communication postcard tracking
70199
+ * @param {number} storefront_oid
70200
+ * @param {string} commseq_postcard_uuid
70201
+ * @param {*} [options] Override http request option.
70202
+ * @throws {RequiredError}
70203
+ * @memberof StorefrontApiInterface
70204
+ */
70205
+ getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
70206
+
69901
70207
  /**
69902
70208
  *
69903
70209
  * @summary Get communication sequence stats overall
@@ -71822,6 +72128,19 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
71822
72128
  return StorefrontApiFp(this.configuration).getEmailCommseqPostcardStats(storefront_oid, commseq_uuid, statsRequest, options)(this.fetch, this.basePath);
71823
72129
  }
71824
72130
 
72131
+ /**
72132
+ *
72133
+ * @summary Get email communication postcard tracking
72134
+ * @param {number} storefront_oid
72135
+ * @param {string} commseq_postcard_uuid
72136
+ * @param {*} [options] Override http request option.
72137
+ * @throws {RequiredError}
72138
+ * @memberof StorefrontApi
72139
+ */
72140
+ public getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any) {
72141
+ return StorefrontApiFp(this.configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options)(this.fetch, this.basePath);
72142
+ }
72143
+
71825
72144
  /**
71826
72145
  *
71827
72146
  * @summary Get communication sequence stats overall
package/dist/api.d.ts CHANGED
@@ -15649,6 +15649,200 @@ export interface EmailPostcardStat {
15649
15649
  */
15650
15650
  view_count_formatted?: string;
15651
15651
  }
15652
+ /**
15653
+ *
15654
+ * @export
15655
+ * @interface EmailPostcardTracking
15656
+ */
15657
+ export interface EmailPostcardTracking {
15658
+ /**
15659
+ *
15660
+ * @type {string}
15661
+ * @memberof EmailPostcardTracking
15662
+ */
15663
+ commseq_postcard_uuid?: string;
15664
+ /**
15665
+ *
15666
+ * @type {string}
15667
+ * @memberof EmailPostcardTracking
15668
+ */
15669
+ commseq_step_uuid?: string;
15670
+ /**
15671
+ *
15672
+ * @type {string}
15673
+ * @memberof EmailPostcardTracking
15674
+ */
15675
+ commseq_uuid?: string;
15676
+ /**
15677
+ * Conversion date time.
15678
+ * @type {string}
15679
+ * @memberof EmailPostcardTracking
15680
+ */
15681
+ conversion_dts?: string;
15682
+ /**
15683
+ *
15684
+ * @type {number}
15685
+ * @memberof EmailPostcardTracking
15686
+ */
15687
+ cost?: number;
15688
+ /**
15689
+ *
15690
+ * @type {string}
15691
+ * @memberof EmailPostcardTracking
15692
+ */
15693
+ customer_uuid?: string;
15694
+ /**
15695
+ * Delivered date time.
15696
+ * @type {string}
15697
+ * @memberof EmailPostcardTracking
15698
+ */
15699
+ delivered_dts?: string;
15700
+ /**
15701
+ *
15702
+ * @type {string}
15703
+ * @memberof EmailPostcardTracking
15704
+ */
15705
+ from_address_line1?: string;
15706
+ /**
15707
+ *
15708
+ * @type {string}
15709
+ * @memberof EmailPostcardTracking
15710
+ */
15711
+ from_address_line2?: string;
15712
+ /**
15713
+ *
15714
+ * @type {string}
15715
+ * @memberof EmailPostcardTracking
15716
+ */
15717
+ from_city?: string;
15718
+ /**
15719
+ *
15720
+ * @type {string}
15721
+ * @memberof EmailPostcardTracking
15722
+ */
15723
+ from_name?: string;
15724
+ /**
15725
+ *
15726
+ * @type {string}
15727
+ * @memberof EmailPostcardTracking
15728
+ */
15729
+ from_state?: string;
15730
+ /**
15731
+ *
15732
+ * @type {string}
15733
+ * @memberof EmailPostcardTracking
15734
+ */
15735
+ from_zip?: string;
15736
+ /**
15737
+ * Mailed date time.
15738
+ * @type {string}
15739
+ * @memberof EmailPostcardTracking
15740
+ */
15741
+ mailed_dts?: string;
15742
+ /**
15743
+ *
15744
+ * @type {string}
15745
+ * @memberof EmailPostcardTracking
15746
+ */
15747
+ order_id?: string;
15748
+ /**
15749
+ *
15750
+ * @type {string}
15751
+ * @memberof EmailPostcardTracking
15752
+ */
15753
+ postcard_tracking_uuid?: string;
15754
+ /**
15755
+ *
15756
+ * @type {string}
15757
+ * @memberof EmailPostcardTracking
15758
+ */
15759
+ status?: string;
15760
+ /**
15761
+ * Submit date time.
15762
+ * @type {string}
15763
+ * @memberof EmailPostcardTracking
15764
+ */
15765
+ submit_dts?: string;
15766
+ /**
15767
+ *
15768
+ * @type {string}
15769
+ * @memberof EmailPostcardTracking
15770
+ */
15771
+ to_address_line1?: string;
15772
+ /**
15773
+ *
15774
+ * @type {string}
15775
+ * @memberof EmailPostcardTracking
15776
+ */
15777
+ to_address_line2?: string;
15778
+ /**
15779
+ *
15780
+ * @type {string}
15781
+ * @memberof EmailPostcardTracking
15782
+ */
15783
+ to_city?: string;
15784
+ /**
15785
+ *
15786
+ * @type {string}
15787
+ * @memberof EmailPostcardTracking
15788
+ */
15789
+ to_name?: string;
15790
+ /**
15791
+ *
15792
+ * @type {string}
15793
+ * @memberof EmailPostcardTracking
15794
+ */
15795
+ to_state?: string;
15796
+ /**
15797
+ *
15798
+ * @type {string}
15799
+ * @memberof EmailPostcardTracking
15800
+ */
15801
+ to_zip?: string;
15802
+ /**
15803
+ *
15804
+ * @type {string}
15805
+ * @memberof EmailPostcardTracking
15806
+ */
15807
+ tracking_description?: string;
15808
+ }
15809
+ /**
15810
+ *
15811
+ * @export
15812
+ * @interface EmailPostcardTrackingResponse
15813
+ */
15814
+ export interface EmailPostcardTrackingResponse {
15815
+ /**
15816
+ *
15817
+ * @type {ModelError}
15818
+ * @memberof EmailPostcardTrackingResponse
15819
+ */
15820
+ error?: ModelError;
15821
+ /**
15822
+ *
15823
+ * @type {ResponseMetadata}
15824
+ * @memberof EmailPostcardTrackingResponse
15825
+ */
15826
+ metadata?: ResponseMetadata;
15827
+ /**
15828
+ * Indicates if API call was successful
15829
+ * @type {boolean}
15830
+ * @memberof EmailPostcardTrackingResponse
15831
+ */
15832
+ success?: boolean;
15833
+ /**
15834
+ *
15835
+ * @type {EmailPostcardTracking}
15836
+ * @memberof EmailPostcardTrackingResponse
15837
+ */
15838
+ tracking?: EmailPostcardTracking;
15839
+ /**
15840
+ *
15841
+ * @type {Warning}
15842
+ * @memberof EmailPostcardTrackingResponse
15843
+ */
15844
+ warning?: Warning;
15845
+ }
15652
15846
  /**
15653
15847
  *
15654
15848
  * @export
@@ -42020,6 +42214,15 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
42020
42214
  * @throws {RequiredError}
42021
42215
  */
42022
42216
  getEmailCommseqPostcardStats(storefront_oid: number, commseq_uuid: string, statsRequest: EmailStatPostcardSummaryRequest, options?: any): FetchArgs;
42217
+ /**
42218
+ *
42219
+ * @summary Get email communication postcard tracking
42220
+ * @param {number} storefront_oid
42221
+ * @param {string} commseq_postcard_uuid
42222
+ * @param {*} [options] Override http request option.
42223
+ * @throws {RequiredError}
42224
+ */
42225
+ getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): FetchArgs;
42023
42226
  /**
42024
42227
  *
42025
42228
  * @summary Get communication sequence stats overall
@@ -43531,6 +43734,15 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
43531
43734
  * @throws {RequiredError}
43532
43735
  */
43533
43736
  getEmailCommseqPostcardStats(storefront_oid: number, commseq_uuid: string, statsRequest: EmailStatPostcardSummaryRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailStatPostcardSummaryResponse>;
43737
+ /**
43738
+ *
43739
+ * @summary Get email communication postcard tracking
43740
+ * @param {number} storefront_oid
43741
+ * @param {string} commseq_postcard_uuid
43742
+ * @param {*} [options] Override http request option.
43743
+ * @throws {RequiredError}
43744
+ */
43745
+ getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailPostcardTrackingResponse>;
43534
43746
  /**
43535
43747
  *
43536
43748
  * @summary Get communication sequence stats overall
@@ -45042,6 +45254,15 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
45042
45254
  * @throws {RequiredError}
45043
45255
  */
45044
45256
  getEmailCommseqPostcardStats(storefront_oid: number, commseq_uuid: string, statsRequest: EmailStatPostcardSummaryRequest, options?: any): Promise<EmailStatPostcardSummaryResponse>;
45257
+ /**
45258
+ *
45259
+ * @summary Get email communication postcard tracking
45260
+ * @param {number} storefront_oid
45261
+ * @param {string} commseq_postcard_uuid
45262
+ * @param {*} [options] Override http request option.
45263
+ * @throws {RequiredError}
45264
+ */
45265
+ getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
45045
45266
  /**
45046
45267
  *
45047
45268
  * @summary Get communication sequence stats overall
@@ -46594,6 +46815,16 @@ export interface StorefrontApiInterface {
46594
46815
  * @memberof StorefrontApiInterface
46595
46816
  */
46596
46817
  getEmailCommseqPostcardStats(storefront_oid: number, commseq_uuid: string, statsRequest: EmailStatPostcardSummaryRequest, options?: any): Promise<EmailStatPostcardSummaryResponse>;
46818
+ /**
46819
+ *
46820
+ * @summary Get email communication postcard tracking
46821
+ * @param {number} storefront_oid
46822
+ * @param {string} commseq_postcard_uuid
46823
+ * @param {*} [options] Override http request option.
46824
+ * @throws {RequiredError}
46825
+ * @memberof StorefrontApiInterface
46826
+ */
46827
+ getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
46597
46828
  /**
46598
46829
  *
46599
46830
  * @summary Get communication sequence stats overall
@@ -48272,6 +48503,16 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
48272
48503
  * @memberof StorefrontApi
48273
48504
  */
48274
48505
  getEmailCommseqPostcardStats(storefront_oid: number, commseq_uuid: string, statsRequest: EmailStatPostcardSummaryRequest, options?: any): Promise<EmailStatPostcardSummaryResponse>;
48506
+ /**
48507
+ *
48508
+ * @summary Get email communication postcard tracking
48509
+ * @param {number} storefront_oid
48510
+ * @param {string} commseq_postcard_uuid
48511
+ * @param {*} [options] Override http request option.
48512
+ * @throws {RequiredError}
48513
+ * @memberof StorefrontApi
48514
+ */
48515
+ getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
48275
48516
  /**
48276
48517
  *
48277
48518
  * @summary Get communication sequence stats overall
package/dist/api.js CHANGED
@@ -18751,6 +18751,65 @@ var StorefrontApiFetchParamCreator = function (configuration) {
18751
18751
  options: localVarRequestOptions,
18752
18752
  };
18753
18753
  },
18754
+ /**
18755
+ *
18756
+ * @summary Get email communication postcard tracking
18757
+ * @param {number} storefront_oid
18758
+ * @param {string} commseq_postcard_uuid
18759
+ * @param {*} [options] Override http request option.
18760
+ * @throws {RequiredError}
18761
+ */
18762
+ getEmailCommseqPostcardTracking: function (storefront_oid, commseq_postcard_uuid, options) {
18763
+ if (options === void 0) { options = {}; }
18764
+ // verify required parameter 'storefront_oid' is not null or undefined
18765
+ if (storefront_oid === null || storefront_oid === undefined) {
18766
+ throw new RequiredError('storefront_oid', 'Required parameter storefront_oid was null or undefined when calling getEmailCommseqPostcardTracking.');
18767
+ }
18768
+ // verify required parameter 'commseq_postcard_uuid' is not null or undefined
18769
+ if (commseq_postcard_uuid === null || commseq_postcard_uuid === undefined) {
18770
+ throw new RequiredError('commseq_postcard_uuid', 'Required parameter commseq_postcard_uuid was null or undefined when calling getEmailCommseqPostcardTracking.');
18771
+ }
18772
+ var localVarPath = "/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking"
18773
+ .replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(storefront_oid)))
18774
+ .replace("{".concat("commseq_postcard_uuid", "}"), encodeURIComponent(String(commseq_postcard_uuid)));
18775
+ var localVarUrlObj = url.parse(localVarPath, true);
18776
+ var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
18777
+ var localVarHeaderParameter = {};
18778
+ var localVarQueryParameter = {};
18779
+ if (configuration && configuration.apiVersion) {
18780
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
18781
+ }
18782
+ // authentication ultraCartBrowserApiKey required
18783
+ if (configuration && configuration.apiKey) {
18784
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
18785
+ ? configuration.apiKey("x-ultracart-browser-key")
18786
+ : configuration.apiKey;
18787
+ localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
18788
+ }
18789
+ // authentication ultraCartOauth required
18790
+ // oauth required
18791
+ if (configuration && configuration.accessToken) {
18792
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
18793
+ ? configuration.accessToken("ultraCartOauth", ["storefront_read"])
18794
+ : configuration.accessToken;
18795
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
18796
+ }
18797
+ // authentication ultraCartSimpleApiKey required
18798
+ if (configuration && configuration.apiKey) {
18799
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
18800
+ ? configuration.apiKey("x-ultracart-simple-key")
18801
+ : configuration.apiKey;
18802
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
18803
+ }
18804
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
18805
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
18806
+ delete localVarUrlObj.search;
18807
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
18808
+ return {
18809
+ url: url.format(localVarUrlObj),
18810
+ options: localVarRequestOptions,
18811
+ };
18812
+ },
18754
18813
  /**
18755
18814
  *
18756
18815
  * @summary Get communication sequence stats overall
@@ -27132,6 +27191,29 @@ var StorefrontApiFp = function (configuration) {
27132
27191
  });
27133
27192
  };
27134
27193
  },
27194
+ /**
27195
+ *
27196
+ * @summary Get email communication postcard tracking
27197
+ * @param {number} storefront_oid
27198
+ * @param {string} commseq_postcard_uuid
27199
+ * @param {*} [options] Override http request option.
27200
+ * @throws {RequiredError}
27201
+ */
27202
+ getEmailCommseqPostcardTracking: function (storefront_oid, commseq_postcard_uuid, options) {
27203
+ var localVarFetchArgs = (0, exports.StorefrontApiFetchParamCreator)(configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options);
27204
+ return function (fetch, basePath) {
27205
+ if (fetch === void 0) { fetch = portableFetch; }
27206
+ if (basePath === void 0) { basePath = BASE_PATH; }
27207
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
27208
+ if (response.status >= 200 && response.status < 300) {
27209
+ return response.json();
27210
+ }
27211
+ else {
27212
+ throw response;
27213
+ }
27214
+ });
27215
+ };
27216
+ },
27135
27217
  /**
27136
27218
  *
27137
27219
  * @summary Get communication sequence stats overall
@@ -30476,6 +30558,17 @@ var StorefrontApiFactory = function (configuration, fetch, basePath) {
30476
30558
  getEmailCommseqPostcardStats: function (storefront_oid, commseq_uuid, statsRequest, options) {
30477
30559
  return (0, exports.StorefrontApiFp)(configuration).getEmailCommseqPostcardStats(storefront_oid, commseq_uuid, statsRequest, options)(fetch, basePath);
30478
30560
  },
30561
+ /**
30562
+ *
30563
+ * @summary Get email communication postcard tracking
30564
+ * @param {number} storefront_oid
30565
+ * @param {string} commseq_postcard_uuid
30566
+ * @param {*} [options] Override http request option.
30567
+ * @throws {RequiredError}
30568
+ */
30569
+ getEmailCommseqPostcardTracking: function (storefront_oid, commseq_postcard_uuid, options) {
30570
+ return (0, exports.StorefrontApiFp)(configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options)(fetch, basePath);
30571
+ },
30479
30572
  /**
30480
30573
  *
30481
30574
  * @summary Get communication sequence stats overall
@@ -32365,6 +32458,18 @@ var StorefrontApi = /** @class */ (function (_super) {
32365
32458
  StorefrontApi.prototype.getEmailCommseqPostcardStats = function (storefront_oid, commseq_uuid, statsRequest, options) {
32366
32459
  return (0, exports.StorefrontApiFp)(this.configuration).getEmailCommseqPostcardStats(storefront_oid, commseq_uuid, statsRequest, options)(this.fetch, this.basePath);
32367
32460
  };
32461
+ /**
32462
+ *
32463
+ * @summary Get email communication postcard tracking
32464
+ * @param {number} storefront_oid
32465
+ * @param {string} commseq_postcard_uuid
32466
+ * @param {*} [options] Override http request option.
32467
+ * @throws {RequiredError}
32468
+ * @memberof StorefrontApi
32469
+ */
32470
+ StorefrontApi.prototype.getEmailCommseqPostcardTracking = function (storefront_oid, commseq_postcard_uuid, options) {
32471
+ return (0, exports.StorefrontApiFp)(this.configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options)(this.fetch, this.basePath);
32472
+ };
32368
32473
  /**
32369
32474
  *
32370
32475
  * @summary Get communication sequence stats overall
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.45",
3
+ "version": "3.10.46",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [