ultracart_rest_api_v2_typescript 4.0.60-RC → 4.0.63-RC

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.
@@ -342,6 +342,8 @@ src/models/EmailPlan.ts
342
342
  src/models/EmailPlanAdditional.ts
343
343
  src/models/EmailPlanResponse.ts
344
344
  src/models/EmailPostcardStat.ts
345
+ src/models/EmailPostcardTracking.ts
346
+ src/models/EmailPostcardTrackingResponse.ts
345
347
  src/models/EmailSegment.ts
346
348
  src/models/EmailSegmentArchiveResponse.ts
347
349
  src/models/EmailSegmentCustomer.ts
@@ -573,6 +575,8 @@ src/models/RegisterAffiliateClickRequest.ts
573
575
  src/models/RegisterAffiliateClickResponse.ts
574
576
  src/models/ResponseMetadata.ts
575
577
  src/models/ResultSet.ts
578
+ src/models/RulerValidationRequest.ts
579
+ src/models/RulerValidationResponse.ts
576
580
  src/models/ScreenRecording.ts
577
581
  src/models/ScreenRecordingAdPlatform.ts
578
582
  src/models/ScreenRecordingFilter.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@4.0.60-RC
1
+ ## ultracart_rest_api_v2_typescript@4.0.63-RC
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@4.0.60-RC --save
39
+ npm install ultracart_rest_api_v2_typescript@4.0.63-RC --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 4.0.63-RC | 09/13/2022 | storefront comms - postcard tracking |
58
+ | 4.0.62-RC | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
59
+ | 4.0.61-RC | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |
57
60
  | 4.0.60-RC | 09/02/2022 | customer editor added loyal ledger descriptions |
58
61
  | 4.0.59-RC | 08/30/2022 | storefront comm fields for sms configuration |
59
62
  | 4.0.58-RC | 08/26/2022 | postcard address fields for comm sequence testing |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { AddLibraryItemRequest, ApplyLibraryItemRequest, ApplyLibraryItemResponse, BaseResponse, CountriesResponse, EmailBaseTemplateListResponse, EmailCampaign, EmailCampaignFolder, EmailCampaignFolderResponse, EmailCampaignFoldersResponse, EmailCampaignResponse, EmailCampaignsResponse, EmailClicksResponse, EmailCommseq, EmailCommseqEmail, EmailCommseqEmailResponse, EmailCommseqEmailSendTestRequest, EmailCommseqEmailSendTestResponse, EmailCommseqEmailsRequest, EmailCommseqEmailsResponse, EmailCommseqPostcard, EmailCommseqPostcardResponse, EmailCommseqPostcardSendTestRequest, EmailCommseqPostcardSendTestResponse, EmailCommseqPostcardsRequest, EmailCommseqPostcardsResponse, EmailCommseqResponse, EmailCommseqSequenceTestRequest, EmailCommseqSequenceTestResponse, EmailCommseqStatResponse, EmailCommseqStepLogsResponse, EmailCommseqWebhookSendTestRequest, EmailCommseqWebhookSendTestResponse, EmailCommseqsResponse, EmailCustomer, EmailCustomerEditorUrlResponse, EmailCustomersResponse, EmailDashboardActivityResponse, EmailDashboardStatsResponse, EmailDomain, EmailEditorTokenResponse, EmailFlow, EmailFlowBackPopulateRequest, EmailFlowBackPopulateResponse, EmailFlowFolder, EmailFlowFolderResponse, EmailFlowFoldersResponse, EmailFlowResponse, EmailFlowsResponse, EmailGlobalSettings, EmailGlobalSettingsResponse, EmailGlobalUnsubscribeRequest, EmailGlobalUnsubscribeResponse, EmailHistogramPropertyNamesResponse, EmailHistogramPropertyValuesResponse, EmailList, EmailListArchiveResponse, EmailListCustomersResponse, EmailListResponse, EmailListSegmentFolder, EmailListSegmentFolderResponse, EmailListSegmentFoldersResponse, EmailListSubscribeResponse, EmailListsResponse, EmailOrdersResponse, EmailPerformanceResponse, EmailPlan, EmailPlanResponse, EmailSegment, EmailSegmentArchiveResponse, EmailSegmentCustomersResponse, EmailSegmentDownloadPrepareResponse, EmailSegmentResponse, EmailSegmentsResponse, EmailSendingDomainResponse, EmailSendingDomainsResponse, EmailSettings, EmailSettingsResponse, EmailStatPostcardSummaryRequest, EmailStatPostcardSummaryResponse, EmailStatSummaryRequest, EmailStatSummaryResponse, EmailStepStatRequest, EmailStepStatResponse, EmailStepWaitingRequest, EmailStepWaitingResponse, EmailTemplate, EmailTemplatesResponse, EmailThirdPartyListImportRequest, EmailThirdPartyProvidersResponse, EmailWebhookEditorValuesResponse, Experiment, ExperimentResponse, ExperimentsResponse, GeocodeRequest, GeocodeResponse, LibraryFilterValuesResponse, LibraryItem, LibraryItemQuery, LibraryItemResponse, LibraryItemsResponse, LookupRequest, LookupResponse, PricingTiersResponse, PublishLibraryItemRequest, ScreenRecordingHeatmapIndexRequest, ScreenRecordingHeatmapIndexResponse, ScreenRecordingHeatmapRequest, ScreenRecordingHeatmapReset, ScreenRecordingHeatmapResponse, ScreenRecordingMerchantNotesRequest, ScreenRecordingPageViewDataResponse, ScreenRecordingQueryRequest, ScreenRecordingQueryResponse, ScreenRecordingResponse, ScreenRecordingSegment, ScreenRecordingSegmentResponse, ScreenRecordingSegmentsResponse, ScreenRecordingSettings, ScreenRecordingSettingsResponse, ScreenRecordingTagsRequest, ScreenRecordingTagsResponse, ScreenshotsResponse, StoreFrontsResponse, ThumbnailParametersRequest, ThumbnailParametersResponse, TransactionEmail, TransactionEmailListResponse, TransactionEmailResponse, Twilio, TwilioResponse, TwiliosResponse } from '../models';
13
+ import { AddLibraryItemRequest, ApplyLibraryItemRequest, ApplyLibraryItemResponse, BaseResponse, CountriesResponse, EmailBaseTemplateListResponse, EmailCampaign, EmailCampaignFolder, EmailCampaignFolderResponse, EmailCampaignFoldersResponse, EmailCampaignResponse, EmailCampaignsResponse, EmailClicksResponse, EmailCommseq, EmailCommseqEmail, EmailCommseqEmailResponse, EmailCommseqEmailSendTestRequest, EmailCommseqEmailSendTestResponse, EmailCommseqEmailsRequest, EmailCommseqEmailsResponse, EmailCommseqPostcard, EmailCommseqPostcardResponse, EmailCommseqPostcardSendTestRequest, EmailCommseqPostcardSendTestResponse, EmailCommseqPostcardsRequest, EmailCommseqPostcardsResponse, EmailCommseqResponse, EmailCommseqSequenceTestRequest, EmailCommseqSequenceTestResponse, EmailCommseqStatResponse, EmailCommseqStepLogsResponse, EmailCommseqWebhookSendTestRequest, EmailCommseqWebhookSendTestResponse, EmailCommseqsResponse, EmailCustomer, EmailCustomerEditorUrlResponse, EmailCustomersResponse, EmailDashboardActivityResponse, EmailDashboardStatsResponse, EmailDomain, EmailEditorTokenResponse, EmailFlow, EmailFlowBackPopulateRequest, EmailFlowBackPopulateResponse, EmailFlowFolder, EmailFlowFolderResponse, EmailFlowFoldersResponse, EmailFlowResponse, EmailFlowsResponse, EmailGlobalSettings, EmailGlobalSettingsResponse, EmailGlobalUnsubscribeRequest, EmailGlobalUnsubscribeResponse, EmailHistogramPropertyNamesResponse, EmailHistogramPropertyValuesResponse, EmailList, EmailListArchiveResponse, EmailListCustomersResponse, EmailListResponse, EmailListSegmentFolder, EmailListSegmentFolderResponse, EmailListSegmentFoldersResponse, EmailListSubscribeResponse, EmailListsResponse, EmailOrdersResponse, EmailPerformanceResponse, EmailPlan, EmailPlanResponse, EmailPostcardTrackingResponse, EmailSegment, EmailSegmentArchiveResponse, EmailSegmentCustomersResponse, EmailSegmentDownloadPrepareResponse, EmailSegmentResponse, EmailSegmentsResponse, EmailSendingDomainResponse, EmailSendingDomainsResponse, EmailSettings, EmailSettingsResponse, EmailStatPostcardSummaryRequest, EmailStatPostcardSummaryResponse, EmailStatSummaryRequest, EmailStatSummaryResponse, EmailStepStatRequest, EmailStepStatResponse, EmailStepWaitingRequest, EmailStepWaitingResponse, EmailTemplate, EmailTemplatesResponse, EmailThirdPartyListImportRequest, EmailThirdPartyProvidersResponse, EmailWebhookEditorValuesResponse, Experiment, ExperimentResponse, ExperimentsResponse, GeocodeRequest, GeocodeResponse, LibraryFilterValuesResponse, LibraryItem, LibraryItemQuery, LibraryItemResponse, LibraryItemsResponse, LookupRequest, LookupResponse, PricingTiersResponse, PublishLibraryItemRequest, RulerValidationRequest, RulerValidationResponse, ScreenRecordingHeatmapIndexRequest, ScreenRecordingHeatmapIndexResponse, ScreenRecordingHeatmapRequest, ScreenRecordingHeatmapReset, ScreenRecordingHeatmapResponse, ScreenRecordingMerchantNotesRequest, ScreenRecordingPageViewDataResponse, ScreenRecordingQueryRequest, ScreenRecordingQueryResponse, ScreenRecordingResponse, ScreenRecordingSegment, ScreenRecordingSegmentResponse, ScreenRecordingSegmentsResponse, ScreenRecordingSettings, ScreenRecordingSettingsResponse, ScreenRecordingTagsRequest, ScreenRecordingTagsResponse, ScreenshotsResponse, StoreFrontsResponse, ThumbnailParametersRequest, ThumbnailParametersResponse, TransactionEmail, TransactionEmailListResponse, TransactionEmailResponse, Twilio, TwilioResponse, TwiliosResponse } from '../models';
14
14
  export interface AddToLibraryRequest {
15
15
  addLibraryRequest: AddLibraryItemRequest;
16
16
  }
@@ -163,6 +163,10 @@ export interface GetEmailCommseqPostcardStatsRequest {
163
163
  commseqUuid: string;
164
164
  statsRequest: EmailStatPostcardSummaryRequest;
165
165
  }
166
+ export interface GetEmailCommseqPostcardTrackingRequest {
167
+ storefrontOid: number;
168
+ commseqPostcardUuid: string;
169
+ }
166
170
  export interface GetEmailCommseqStatOverallRequest {
167
171
  storefrontOid: number;
168
172
  commseqUuid: string;
@@ -678,6 +682,9 @@ export interface UpdateTwilioAccountRequest {
678
682
  espTwilioUuid: string;
679
683
  twilio: Twilio;
680
684
  }
685
+ export interface ValidateRulerRequest {
686
+ rulerValidateRequest: RulerValidationRequest;
687
+ }
681
688
  /**
682
689
  * StorefrontApi - interface
683
690
  *
@@ -1241,6 +1248,20 @@ export interface StorefrontApiInterface {
1241
1248
  * Get email communication sequence postcard stats
1242
1249
  */
1243
1250
  getEmailCommseqPostcardStats(requestParameters: GetEmailCommseqPostcardStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailStatPostcardSummaryResponse>;
1251
+ /**
1252
+ *
1253
+ * @summary Get email communication postcard tracking
1254
+ * @param {number} storefrontOid
1255
+ * @param {string} commseqPostcardUuid
1256
+ * @param {*} [options] Override http request option.
1257
+ * @throws {RequiredError}
1258
+ * @memberof StorefrontApiInterface
1259
+ */
1260
+ getEmailCommseqPostcardTrackingRaw(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailPostcardTrackingResponse>>;
1261
+ /**
1262
+ * Get email communication postcard tracking
1263
+ */
1264
+ getEmailCommseqPostcardTracking(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailPostcardTrackingResponse>;
1244
1265
  /**
1245
1266
  *
1246
1267
  * @summary Get communication sequence stats overall
@@ -3026,6 +3047,19 @@ export interface StorefrontApiInterface {
3026
3047
  * Update Twilio account
3027
3048
  */
3028
3049
  updateTwilioAccount(requestParameters: UpdateTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TwilioResponse>;
3050
+ /**
3051
+ *
3052
+ * @summary Validate AWS Event Ruler
3053
+ * @param {RulerValidationRequest} rulerValidateRequest Ruler Validate Request
3054
+ * @param {*} [options] Override http request option.
3055
+ * @throws {RequiredError}
3056
+ * @memberof StorefrontApiInterface
3057
+ */
3058
+ validateRulerRaw(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RulerValidationResponse>>;
3059
+ /**
3060
+ * Validate AWS Event Ruler
3061
+ */
3062
+ validateRuler(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RulerValidationResponse>;
3029
3063
  }
3030
3064
  /**
3031
3065
  *
@@ -3359,6 +3393,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
3359
3393
  * Get email communication sequence postcard stats
3360
3394
  */
3361
3395
  getEmailCommseqPostcardStats(requestParameters: GetEmailCommseqPostcardStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailStatPostcardSummaryResponse>;
3396
+ /**
3397
+ * Get email communication postcard tracking
3398
+ */
3399
+ getEmailCommseqPostcardTrackingRaw(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailPostcardTrackingResponse>>;
3400
+ /**
3401
+ * Get email communication postcard tracking
3402
+ */
3403
+ getEmailCommseqPostcardTracking(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailPostcardTrackingResponse>;
3362
3404
  /**
3363
3405
  * Get communication sequence stats overall
3364
3406
  */
@@ -4391,4 +4433,12 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
4391
4433
  * Update Twilio account
4392
4434
  */
4393
4435
  updateTwilioAccount(requestParameters: UpdateTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TwilioResponse>;
4436
+ /**
4437
+ * Validate AWS Event Ruler
4438
+ */
4439
+ validateRulerRaw(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RulerValidationResponse>>;
4440
+ /**
4441
+ * Validate AWS Event Ruler
4442
+ */
4443
+ validateRuler(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RulerValidationResponse>;
4394
4444
  }
@@ -2577,6 +2577,69 @@ var StorefrontApi = /** @class */ (function (_super) {
2577
2577
  });
2578
2578
  });
2579
2579
  };
2580
+ /**
2581
+ * Get email communication postcard tracking
2582
+ */
2583
+ StorefrontApi.prototype.getEmailCommseqPostcardTrackingRaw = function (requestParameters, initOverrides) {
2584
+ return __awaiter(this, void 0, void 0, function () {
2585
+ var queryParameters, headerParameters, _a, _b, response;
2586
+ return __generator(this, function (_c) {
2587
+ switch (_c.label) {
2588
+ case 0:
2589
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
2590
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailCommseqPostcardTracking.');
2591
+ }
2592
+ if (requestParameters.commseqPostcardUuid === null || requestParameters.commseqPostcardUuid === undefined) {
2593
+ throw new runtime.RequiredError('commseqPostcardUuid', 'Required parameter requestParameters.commseqPostcardUuid was null or undefined when calling getEmailCommseqPostcardTracking.');
2594
+ }
2595
+ queryParameters = {};
2596
+ headerParameters = {};
2597
+ if (this.configuration && this.configuration.apiKey) {
2598
+ headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
2599
+ }
2600
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
2601
+ // oauth required
2602
+ _a = headerParameters;
2603
+ _b = "Authorization";
2604
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_read"])];
2605
+ case 1:
2606
+ // oauth required
2607
+ _a[_b] = _c.sent();
2608
+ _c.label = 2;
2609
+ case 2:
2610
+ if (this.configuration && this.configuration.apiKey) {
2611
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
2612
+ }
2613
+ return [4 /*yield*/, this.request({
2614
+ path: "/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("commseq_postcard_uuid", "}"), encodeURIComponent(String(requestParameters.commseqPostcardUuid))),
2615
+ method: 'GET',
2616
+ headers: headerParameters,
2617
+ query: queryParameters,
2618
+ }, initOverrides)];
2619
+ case 3:
2620
+ response = _c.sent();
2621
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.EmailPostcardTrackingResponseFromJSON)(jsonValue); })];
2622
+ }
2623
+ });
2624
+ });
2625
+ };
2626
+ /**
2627
+ * Get email communication postcard tracking
2628
+ */
2629
+ StorefrontApi.prototype.getEmailCommseqPostcardTracking = function (requestParameters, initOverrides) {
2630
+ return __awaiter(this, void 0, void 0, function () {
2631
+ var response;
2632
+ return __generator(this, function (_a) {
2633
+ switch (_a.label) {
2634
+ case 0: return [4 /*yield*/, this.getEmailCommseqPostcardTrackingRaw(requestParameters, initOverrides)];
2635
+ case 1:
2636
+ response = _a.sent();
2637
+ return [4 /*yield*/, response.value()];
2638
+ case 2: return [2 /*return*/, _a.sent()];
2639
+ }
2640
+ });
2641
+ });
2642
+ };
2580
2643
  /**
2581
2644
  * Get communication sequence stats overall
2582
2645
  */
@@ -10573,6 +10636,68 @@ var StorefrontApi = /** @class */ (function (_super) {
10573
10636
  });
10574
10637
  });
10575
10638
  };
10639
+ /**
10640
+ * Validate AWS Event Ruler
10641
+ */
10642
+ StorefrontApi.prototype.validateRulerRaw = function (requestParameters, initOverrides) {
10643
+ return __awaiter(this, void 0, void 0, function () {
10644
+ var queryParameters, headerParameters, _a, _b, response;
10645
+ return __generator(this, function (_c) {
10646
+ switch (_c.label) {
10647
+ case 0:
10648
+ if (requestParameters.rulerValidateRequest === null || requestParameters.rulerValidateRequest === undefined) {
10649
+ throw new runtime.RequiredError('rulerValidateRequest', 'Required parameter requestParameters.rulerValidateRequest was null or undefined when calling validateRuler.');
10650
+ }
10651
+ queryParameters = {};
10652
+ headerParameters = {};
10653
+ headerParameters['Content-Type'] = 'application/json';
10654
+ if (this.configuration && this.configuration.apiKey) {
10655
+ headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
10656
+ }
10657
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
10658
+ // oauth required
10659
+ _a = headerParameters;
10660
+ _b = "Authorization";
10661
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_write"])];
10662
+ case 1:
10663
+ // oauth required
10664
+ _a[_b] = _c.sent();
10665
+ _c.label = 2;
10666
+ case 2:
10667
+ if (this.configuration && this.configuration.apiKey) {
10668
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
10669
+ }
10670
+ return [4 /*yield*/, this.request({
10671
+ path: "/storefront/ruler/validate",
10672
+ method: 'POST',
10673
+ headers: headerParameters,
10674
+ query: queryParameters,
10675
+ body: (0, models_1.RulerValidationRequestToJSON)(requestParameters.rulerValidateRequest),
10676
+ }, initOverrides)];
10677
+ case 3:
10678
+ response = _c.sent();
10679
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.RulerValidationResponseFromJSON)(jsonValue); })];
10680
+ }
10681
+ });
10682
+ });
10683
+ };
10684
+ /**
10685
+ * Validate AWS Event Ruler
10686
+ */
10687
+ StorefrontApi.prototype.validateRuler = function (requestParameters, initOverrides) {
10688
+ return __awaiter(this, void 0, void 0, function () {
10689
+ var response;
10690
+ return __generator(this, function (_a) {
10691
+ switch (_a.label) {
10692
+ case 0: return [4 /*yield*/, this.validateRulerRaw(requestParameters, initOverrides)];
10693
+ case 1:
10694
+ response = _a.sent();
10695
+ return [4 /*yield*/, response.value()];
10696
+ case 2: return [2 /*return*/, _a.sent()];
10697
+ }
10698
+ });
10699
+ });
10700
+ };
10576
10701
  return StorefrontApi;
10577
10702
  }(runtime.BaseAPI));
10578
10703
  exports.StorefrontApi = StorefrontApi;
@@ -0,0 +1,171 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface EmailPostcardTracking
16
+ */
17
+ export interface EmailPostcardTracking {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof EmailPostcardTracking
22
+ */
23
+ commseq_postcard_uuid?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof EmailPostcardTracking
28
+ */
29
+ commseq_step_uuid?: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof EmailPostcardTracking
34
+ */
35
+ commseq_uuid?: string;
36
+ /**
37
+ * Conversion date time.
38
+ * @type {string}
39
+ * @memberof EmailPostcardTracking
40
+ */
41
+ conversion_dts?: string;
42
+ /**
43
+ *
44
+ * @type {number}
45
+ * @memberof EmailPostcardTracking
46
+ */
47
+ cost?: number;
48
+ /**
49
+ *
50
+ * @type {string}
51
+ * @memberof EmailPostcardTracking
52
+ */
53
+ customer_uuid?: string;
54
+ /**
55
+ * Delivered date time.
56
+ * @type {string}
57
+ * @memberof EmailPostcardTracking
58
+ */
59
+ delivered_dts?: string;
60
+ /**
61
+ *
62
+ * @type {string}
63
+ * @memberof EmailPostcardTracking
64
+ */
65
+ from_address_line1?: string;
66
+ /**
67
+ *
68
+ * @type {string}
69
+ * @memberof EmailPostcardTracking
70
+ */
71
+ from_address_line2?: string;
72
+ /**
73
+ *
74
+ * @type {string}
75
+ * @memberof EmailPostcardTracking
76
+ */
77
+ from_city?: string;
78
+ /**
79
+ *
80
+ * @type {string}
81
+ * @memberof EmailPostcardTracking
82
+ */
83
+ from_name?: string;
84
+ /**
85
+ *
86
+ * @type {string}
87
+ * @memberof EmailPostcardTracking
88
+ */
89
+ from_state?: string;
90
+ /**
91
+ *
92
+ * @type {string}
93
+ * @memberof EmailPostcardTracking
94
+ */
95
+ from_zip?: string;
96
+ /**
97
+ * Mailed date time.
98
+ * @type {string}
99
+ * @memberof EmailPostcardTracking
100
+ */
101
+ mailed_dts?: string;
102
+ /**
103
+ *
104
+ * @type {string}
105
+ * @memberof EmailPostcardTracking
106
+ */
107
+ order_id?: string;
108
+ /**
109
+ *
110
+ * @type {string}
111
+ * @memberof EmailPostcardTracking
112
+ */
113
+ postcard_tracking_uuid?: string;
114
+ /**
115
+ *
116
+ * @type {string}
117
+ * @memberof EmailPostcardTracking
118
+ */
119
+ status?: string;
120
+ /**
121
+ * Submit date time.
122
+ * @type {string}
123
+ * @memberof EmailPostcardTracking
124
+ */
125
+ submit_dts?: string;
126
+ /**
127
+ *
128
+ * @type {string}
129
+ * @memberof EmailPostcardTracking
130
+ */
131
+ to_address_line1?: string;
132
+ /**
133
+ *
134
+ * @type {string}
135
+ * @memberof EmailPostcardTracking
136
+ */
137
+ to_address_line2?: string;
138
+ /**
139
+ *
140
+ * @type {string}
141
+ * @memberof EmailPostcardTracking
142
+ */
143
+ to_city?: string;
144
+ /**
145
+ *
146
+ * @type {string}
147
+ * @memberof EmailPostcardTracking
148
+ */
149
+ to_name?: string;
150
+ /**
151
+ *
152
+ * @type {string}
153
+ * @memberof EmailPostcardTracking
154
+ */
155
+ to_state?: string;
156
+ /**
157
+ *
158
+ * @type {string}
159
+ * @memberof EmailPostcardTracking
160
+ */
161
+ to_zip?: string;
162
+ /**
163
+ *
164
+ * @type {string}
165
+ * @memberof EmailPostcardTracking
166
+ */
167
+ tracking_description?: string;
168
+ }
169
+ export declare function EmailPostcardTrackingFromJSON(json: any): EmailPostcardTracking;
170
+ export declare function EmailPostcardTrackingFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailPostcardTracking;
171
+ export declare function EmailPostcardTrackingToJSON(value?: EmailPostcardTracking | null): any;
@@ -0,0 +1,90 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.EmailPostcardTrackingToJSON = exports.EmailPostcardTrackingFromJSONTyped = exports.EmailPostcardTrackingFromJSON = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ function EmailPostcardTrackingFromJSON(json) {
19
+ return EmailPostcardTrackingFromJSONTyped(json, false);
20
+ }
21
+ exports.EmailPostcardTrackingFromJSON = EmailPostcardTrackingFromJSON;
22
+ function EmailPostcardTrackingFromJSONTyped(json, ignoreDiscriminator) {
23
+ if ((json === undefined) || (json === null)) {
24
+ return json;
25
+ }
26
+ return {
27
+ 'commseq_postcard_uuid': !(0, runtime_1.exists)(json, 'commseq_postcard_uuid') ? undefined : json['commseq_postcard_uuid'],
28
+ 'commseq_step_uuid': !(0, runtime_1.exists)(json, 'commseq_step_uuid') ? undefined : json['commseq_step_uuid'],
29
+ 'commseq_uuid': !(0, runtime_1.exists)(json, 'commseq_uuid') ? undefined : json['commseq_uuid'],
30
+ 'conversion_dts': !(0, runtime_1.exists)(json, 'conversion_dts') ? undefined : json['conversion_dts'],
31
+ 'cost': !(0, runtime_1.exists)(json, 'cost') ? undefined : json['cost'],
32
+ 'customer_uuid': !(0, runtime_1.exists)(json, 'customer_uuid') ? undefined : json['customer_uuid'],
33
+ 'delivered_dts': !(0, runtime_1.exists)(json, 'delivered_dts') ? undefined : json['delivered_dts'],
34
+ 'from_address_line1': !(0, runtime_1.exists)(json, 'from_address_line1') ? undefined : json['from_address_line1'],
35
+ 'from_address_line2': !(0, runtime_1.exists)(json, 'from_address_line2') ? undefined : json['from_address_line2'],
36
+ 'from_city': !(0, runtime_1.exists)(json, 'from_city') ? undefined : json['from_city'],
37
+ 'from_name': !(0, runtime_1.exists)(json, 'from_name') ? undefined : json['from_name'],
38
+ 'from_state': !(0, runtime_1.exists)(json, 'from_state') ? undefined : json['from_state'],
39
+ 'from_zip': !(0, runtime_1.exists)(json, 'from_zip') ? undefined : json['from_zip'],
40
+ 'mailed_dts': !(0, runtime_1.exists)(json, 'mailed_dts') ? undefined : json['mailed_dts'],
41
+ 'order_id': !(0, runtime_1.exists)(json, 'order_id') ? undefined : json['order_id'],
42
+ 'postcard_tracking_uuid': !(0, runtime_1.exists)(json, 'postcard_tracking_uuid') ? undefined : json['postcard_tracking_uuid'],
43
+ 'status': !(0, runtime_1.exists)(json, 'status') ? undefined : json['status'],
44
+ 'submit_dts': !(0, runtime_1.exists)(json, 'submit_dts') ? undefined : json['submit_dts'],
45
+ 'to_address_line1': !(0, runtime_1.exists)(json, 'to_address_line1') ? undefined : json['to_address_line1'],
46
+ 'to_address_line2': !(0, runtime_1.exists)(json, 'to_address_line2') ? undefined : json['to_address_line2'],
47
+ 'to_city': !(0, runtime_1.exists)(json, 'to_city') ? undefined : json['to_city'],
48
+ 'to_name': !(0, runtime_1.exists)(json, 'to_name') ? undefined : json['to_name'],
49
+ 'to_state': !(0, runtime_1.exists)(json, 'to_state') ? undefined : json['to_state'],
50
+ 'to_zip': !(0, runtime_1.exists)(json, 'to_zip') ? undefined : json['to_zip'],
51
+ 'tracking_description': !(0, runtime_1.exists)(json, 'tracking_description') ? undefined : json['tracking_description'],
52
+ };
53
+ }
54
+ exports.EmailPostcardTrackingFromJSONTyped = EmailPostcardTrackingFromJSONTyped;
55
+ function EmailPostcardTrackingToJSON(value) {
56
+ if (value === undefined) {
57
+ return undefined;
58
+ }
59
+ if (value === null) {
60
+ return null;
61
+ }
62
+ return {
63
+ 'commseq_postcard_uuid': value.commseq_postcard_uuid,
64
+ 'commseq_step_uuid': value.commseq_step_uuid,
65
+ 'commseq_uuid': value.commseq_uuid,
66
+ 'conversion_dts': value.conversion_dts,
67
+ 'cost': value.cost,
68
+ 'customer_uuid': value.customer_uuid,
69
+ 'delivered_dts': value.delivered_dts,
70
+ 'from_address_line1': value.from_address_line1,
71
+ 'from_address_line2': value.from_address_line2,
72
+ 'from_city': value.from_city,
73
+ 'from_name': value.from_name,
74
+ 'from_state': value.from_state,
75
+ 'from_zip': value.from_zip,
76
+ 'mailed_dts': value.mailed_dts,
77
+ 'order_id': value.order_id,
78
+ 'postcard_tracking_uuid': value.postcard_tracking_uuid,
79
+ 'status': value.status,
80
+ 'submit_dts': value.submit_dts,
81
+ 'to_address_line1': value.to_address_line1,
82
+ 'to_address_line2': value.to_address_line2,
83
+ 'to_city': value.to_city,
84
+ 'to_name': value.to_name,
85
+ 'to_state': value.to_state,
86
+ 'to_zip': value.to_zip,
87
+ 'tracking_description': value.tracking_description,
88
+ };
89
+ }
90
+ exports.EmailPostcardTrackingToJSON = EmailPostcardTrackingToJSON;
@@ -0,0 +1,55 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { EmailPostcardTracking } from './EmailPostcardTracking';
13
+ import { ModelError } from './ModelError';
14
+ import { ResponseMetadata } from './ResponseMetadata';
15
+ import { Warning } from './Warning';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface EmailPostcardTrackingResponse
20
+ */
21
+ export interface EmailPostcardTrackingResponse {
22
+ /**
23
+ *
24
+ * @type {ModelError}
25
+ * @memberof EmailPostcardTrackingResponse
26
+ */
27
+ error?: ModelError;
28
+ /**
29
+ *
30
+ * @type {ResponseMetadata}
31
+ * @memberof EmailPostcardTrackingResponse
32
+ */
33
+ metadata?: ResponseMetadata;
34
+ /**
35
+ * Indicates if API call was successful
36
+ * @type {boolean}
37
+ * @memberof EmailPostcardTrackingResponse
38
+ */
39
+ success?: boolean;
40
+ /**
41
+ *
42
+ * @type {EmailPostcardTracking}
43
+ * @memberof EmailPostcardTrackingResponse
44
+ */
45
+ tracking?: EmailPostcardTracking;
46
+ /**
47
+ *
48
+ * @type {Warning}
49
+ * @memberof EmailPostcardTrackingResponse
50
+ */
51
+ warning?: Warning;
52
+ }
53
+ export declare function EmailPostcardTrackingResponseFromJSON(json: any): EmailPostcardTrackingResponse;
54
+ export declare function EmailPostcardTrackingResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailPostcardTrackingResponse;
55
+ export declare function EmailPostcardTrackingResponseToJSON(value?: EmailPostcardTrackingResponse | null): any;
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.EmailPostcardTrackingResponseToJSON = exports.EmailPostcardTrackingResponseFromJSONTyped = exports.EmailPostcardTrackingResponseFromJSON = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ var EmailPostcardTracking_1 = require("./EmailPostcardTracking");
19
+ var ModelError_1 = require("./ModelError");
20
+ var ResponseMetadata_1 = require("./ResponseMetadata");
21
+ var Warning_1 = require("./Warning");
22
+ function EmailPostcardTrackingResponseFromJSON(json) {
23
+ return EmailPostcardTrackingResponseFromJSONTyped(json, false);
24
+ }
25
+ exports.EmailPostcardTrackingResponseFromJSON = EmailPostcardTrackingResponseFromJSON;
26
+ function EmailPostcardTrackingResponseFromJSONTyped(json, ignoreDiscriminator) {
27
+ if ((json === undefined) || (json === null)) {
28
+ return json;
29
+ }
30
+ return {
31
+ 'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
32
+ 'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
33
+ 'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
34
+ 'tracking': !(0, runtime_1.exists)(json, 'tracking') ? undefined : (0, EmailPostcardTracking_1.EmailPostcardTrackingFromJSON)(json['tracking']),
35
+ 'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
36
+ };
37
+ }
38
+ exports.EmailPostcardTrackingResponseFromJSONTyped = EmailPostcardTrackingResponseFromJSONTyped;
39
+ function EmailPostcardTrackingResponseToJSON(value) {
40
+ if (value === undefined) {
41
+ return undefined;
42
+ }
43
+ if (value === null) {
44
+ return null;
45
+ }
46
+ return {
47
+ 'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
48
+ 'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
49
+ 'success': value.success,
50
+ 'tracking': (0, EmailPostcardTracking_1.EmailPostcardTrackingToJSON)(value.tracking),
51
+ 'warning': (0, Warning_1.WarningToJSON)(value.warning),
52
+ };
53
+ }
54
+ exports.EmailPostcardTrackingResponseToJSON = EmailPostcardTrackingResponseToJSON;