ultracart_rest_api_v2_typescript 4.0.199 → 4.0.201

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.
Files changed (48) hide show
  1. package/.openapi-generator/FILES +5 -0
  2. package/README.md +4 -2
  3. package/dist/apis/StorefrontApi.d.ts +59 -1
  4. package/dist/apis/StorefrontApi.js +137 -0
  5. package/dist/models/ConversationAgentAuth.d.ts +24 -0
  6. package/dist/models/ConversationAgentAuth.js +8 -0
  7. package/dist/models/CouponAmountOffItems.d.ts +6 -0
  8. package/dist/models/CouponAmountOffItems.js +2 -0
  9. package/dist/models/CouponBuyOneGetOneLimit.d.ts +6 -0
  10. package/dist/models/CouponBuyOneGetOneLimit.js +2 -0
  11. package/dist/models/CouponDiscountItemWithItemPurchase.d.ts +12 -0
  12. package/dist/models/CouponDiscountItemWithItemPurchase.js +4 -0
  13. package/dist/models/CouponFreeItemWithItemPurchase.d.ts +12 -0
  14. package/dist/models/CouponFreeItemWithItemPurchase.js +4 -0
  15. package/dist/models/CouponPercentOffItemsWithItemsPurchase.d.ts +12 -0
  16. package/dist/models/CouponPercentOffItemsWithItemsPurchase.js +4 -0
  17. package/dist/models/EmailSmsOrder.d.ts +46 -0
  18. package/dist/models/EmailSmsOrder.js +49 -0
  19. package/dist/models/EmailSmsOrdersResponse.d.ts +55 -0
  20. package/dist/models/EmailSmsOrdersResponse.js +54 -0
  21. package/dist/models/EmailSmsStat.d.ts +201 -0
  22. package/dist/models/EmailSmsStat.js +100 -0
  23. package/dist/models/EmailStatSmsSummaryRequest.d.ts +33 -0
  24. package/dist/models/EmailStatSmsSummaryRequest.js +44 -0
  25. package/dist/models/EmailStatSmsSummaryResponse.d.ts +55 -0
  26. package/dist/models/EmailStatSmsSummaryResponse.js +54 -0
  27. package/dist/models/PricingTier.d.ts +6 -0
  28. package/dist/models/PricingTier.js +2 -0
  29. package/dist/models/Twilio.d.ts +54 -0
  30. package/dist/models/Twilio.js +18 -0
  31. package/dist/models/index.d.ts +5 -0
  32. package/dist/models/index.js +5 -0
  33. package/package.json +1 -1
  34. package/src/apis/StorefrontApi.ts +166 -0
  35. package/src/models/ConversationAgentAuth.ts +32 -0
  36. package/src/models/CouponAmountOffItems.ts +8 -0
  37. package/src/models/CouponBuyOneGetOneLimit.ts +8 -0
  38. package/src/models/CouponDiscountItemWithItemPurchase.ts +16 -0
  39. package/src/models/CouponFreeItemWithItemPurchase.ts +16 -0
  40. package/src/models/CouponPercentOffItemsWithItemsPurchase.ts +16 -0
  41. package/src/models/EmailSmsOrder.ts +87 -0
  42. package/src/models/EmailSmsOrdersResponse.ts +113 -0
  43. package/src/models/EmailSmsStat.ts +288 -0
  44. package/src/models/EmailStatSmsSummaryRequest.ts +64 -0
  45. package/src/models/EmailStatSmsSummaryResponse.ts +113 -0
  46. package/src/models/PricingTier.ts +8 -0
  47. package/src/models/Twilio.ts +72 -0
  48. package/src/models/index.ts +5 -0
@@ -415,9 +415,14 @@ src/models/EmailSendingDomainResponse.ts
415
415
  src/models/EmailSendingDomainsResponse.ts
416
416
  src/models/EmailSettings.ts
417
417
  src/models/EmailSettingsResponse.ts
418
+ src/models/EmailSmsOrder.ts
419
+ src/models/EmailSmsOrdersResponse.ts
420
+ src/models/EmailSmsStat.ts
418
421
  src/models/EmailStat.ts
419
422
  src/models/EmailStatPostcardSummaryRequest.ts
420
423
  src/models/EmailStatPostcardSummaryResponse.ts
424
+ src/models/EmailStatSmsSummaryRequest.ts
425
+ src/models/EmailStatSmsSummaryResponse.ts
421
426
  src/models/EmailStatSummaryRequest.ts
422
427
  src/models/EmailStatSummaryResponse.ts
423
428
  src/models/EmailStepStat.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@4.0.199
1
+ ## ultracart_rest_api_v2_typescript@4.0.201
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.199 --save
39
+ npm install ultracart_rest_api_v2_typescript@4.0.201 --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
+ | 4.0.201 | 02/27/2024 | esp - sms statistic layer |
58
+ | 4.0.200 | 02/20/2024 | Add tag support to CouponAmountOffItems, CouponBuyOneGetOneLimit, CouponDiscountItemWithItemPurchase, CouponFreeItemWithItemPurchase, CouponPercentOffItemsWithItemsPurchase |
57
59
  | 4.0.199 | 01/16/2024 | order query - support searching by custom fields 8 through 10 |
58
60
  | 4.0.198 | 01/12/2024 | workflow task - add properties array |
59
61
  | 4.0.197 | 01/10/2024 | workflow tasks - support for searching by tags |
@@ -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, EmailCommseqSmsSendTestRequest, EmailCommseqSmsSendTestResponse, 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, FileManagerPageResponse, FileManagerUploadRequest, FileManagerUploadUrlResponse, 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';
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, EmailCommseqSmsSendTestRequest, EmailCommseqSmsSendTestResponse, 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, EmailSmsOrdersResponse, EmailStatPostcardSummaryRequest, EmailStatPostcardSummaryResponse, EmailStatSmsSummaryRequest, EmailStatSmsSummaryResponse, EmailStatSummaryRequest, EmailStatSummaryResponse, EmailStepStatRequest, EmailStepStatResponse, EmailStepWaitingRequest, EmailStepWaitingResponse, EmailTemplate, EmailTemplatesResponse, EmailThirdPartyListImportRequest, EmailThirdPartyProvidersResponse, EmailWebhookEditorValuesResponse, Experiment, ExperimentResponse, ExperimentsResponse, FileManagerPageResponse, FileManagerUploadRequest, FileManagerUploadUrlResponse, 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
  }
@@ -177,6 +177,11 @@ export interface GetEmailCommseqPostcardTrackingRequest {
177
177
  storefrontOid: number;
178
178
  commseqPostcardUuid: string;
179
179
  }
180
+ export interface GetEmailCommseqSmsStatsRequest {
181
+ storefrontOid: number;
182
+ commseqUuid: string;
183
+ statsRequest: EmailStatSmsSummaryRequest;
184
+ }
180
185
  export interface GetEmailCommseqStatOverallRequest {
181
186
  storefrontOid: number;
182
187
  commseqUuid: string;
@@ -338,6 +343,12 @@ export interface GetEmailSendingDomainStatusRequest {
338
343
  export interface GetEmailSettingsRequest {
339
344
  storefrontOid: number;
340
345
  }
346
+ export interface GetEmailSmsOrdersRequest {
347
+ storefrontOid: number;
348
+ commseqUuid: string;
349
+ commseqStepUuid: string;
350
+ days?: number;
351
+ }
341
352
  export interface GetEmailTemplateRequest {
342
353
  storefrontOid: number;
343
354
  emailTemplateOid: number;
@@ -1322,6 +1333,21 @@ export interface StorefrontApiInterface {
1322
1333
  * Get email communication postcard tracking
1323
1334
  */
1324
1335
  getEmailCommseqPostcardTracking(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailPostcardTrackingResponse>;
1336
+ /**
1337
+ *
1338
+ * @summary Get email communication sequence sms stats
1339
+ * @param {number} storefrontOid
1340
+ * @param {string} commseqUuid
1341
+ * @param {EmailStatSmsSummaryRequest} statsRequest StatsRequest
1342
+ * @param {*} [options] Override http request option.
1343
+ * @throws {RequiredError}
1344
+ * @memberof StorefrontApiInterface
1345
+ */
1346
+ getEmailCommseqSmsStatsRaw(requestParameters: GetEmailCommseqSmsStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailStatSmsSummaryResponse>>;
1347
+ /**
1348
+ * Get email communication sequence sms stats
1349
+ */
1350
+ getEmailCommseqSmsStats(requestParameters: GetEmailCommseqSmsStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailStatSmsSummaryResponse>;
1325
1351
  /**
1326
1352
  *
1327
1353
  * @summary Get communication sequence stats overall
@@ -1897,6 +1923,22 @@ export interface StorefrontApiInterface {
1897
1923
  * Get email settings
1898
1924
  */
1899
1925
  getEmailSettings(requestParameters: GetEmailSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSettingsResponse>;
1926
+ /**
1927
+ *
1928
+ * @summary Get email sms orders
1929
+ * @param {number} storefrontOid
1930
+ * @param {string} commseqUuid
1931
+ * @param {string} commseqStepUuid
1932
+ * @param {number} [days]
1933
+ * @param {*} [options] Override http request option.
1934
+ * @throws {RequiredError}
1935
+ * @memberof StorefrontApiInterface
1936
+ */
1937
+ getEmailSmsOrdersRaw(requestParameters: GetEmailSmsOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSmsOrdersResponse>>;
1938
+ /**
1939
+ * Get email sms orders
1940
+ */
1941
+ getEmailSmsOrders(requestParameters: GetEmailSmsOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSmsOrdersResponse>;
1900
1942
  /**
1901
1943
  *
1902
1944
  * @summary Get email template
@@ -3537,6 +3579,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
3537
3579
  * Get email communication postcard tracking
3538
3580
  */
3539
3581
  getEmailCommseqPostcardTracking(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailPostcardTrackingResponse>;
3582
+ /**
3583
+ * Get email communication sequence sms stats
3584
+ */
3585
+ getEmailCommseqSmsStatsRaw(requestParameters: GetEmailCommseqSmsStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailStatSmsSummaryResponse>>;
3586
+ /**
3587
+ * Get email communication sequence sms stats
3588
+ */
3589
+ getEmailCommseqSmsStats(requestParameters: GetEmailCommseqSmsStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailStatSmsSummaryResponse>;
3540
3590
  /**
3541
3591
  * Get communication sequence stats overall
3542
3592
  */
@@ -3865,6 +3915,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
3865
3915
  * Get email settings
3866
3916
  */
3867
3917
  getEmailSettings(requestParameters: GetEmailSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSettingsResponse>;
3918
+ /**
3919
+ * Get email sms orders
3920
+ */
3921
+ getEmailSmsOrdersRaw(requestParameters: GetEmailSmsOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSmsOrdersResponse>>;
3922
+ /**
3923
+ * Get email sms orders
3924
+ */
3925
+ getEmailSmsOrders(requestParameters: GetEmailSmsOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSmsOrdersResponse>;
3868
3926
  /**
3869
3927
  * Get email template
3870
3928
  */
@@ -2772,6 +2772,74 @@ var StorefrontApi = /** @class */ (function (_super) {
2772
2772
  });
2773
2773
  });
2774
2774
  };
2775
+ /**
2776
+ * Get email communication sequence sms stats
2777
+ */
2778
+ StorefrontApi.prototype.getEmailCommseqSmsStatsRaw = function (requestParameters, initOverrides) {
2779
+ return __awaiter(this, void 0, void 0, function () {
2780
+ var queryParameters, headerParameters, _a, _b, response;
2781
+ return __generator(this, function (_c) {
2782
+ switch (_c.label) {
2783
+ case 0:
2784
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
2785
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailCommseqSmsStats.');
2786
+ }
2787
+ if (requestParameters.commseqUuid === null || requestParameters.commseqUuid === undefined) {
2788
+ throw new runtime.RequiredError('commseqUuid', 'Required parameter requestParameters.commseqUuid was null or undefined when calling getEmailCommseqSmsStats.');
2789
+ }
2790
+ if (requestParameters.statsRequest === null || requestParameters.statsRequest === undefined) {
2791
+ throw new runtime.RequiredError('statsRequest', 'Required parameter requestParameters.statsRequest was null or undefined when calling getEmailCommseqSmsStats.');
2792
+ }
2793
+ queryParameters = {};
2794
+ headerParameters = {};
2795
+ headerParameters['Content-Type'] = 'application/json';
2796
+ if (this.configuration && this.configuration.apiKey) {
2797
+ headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
2798
+ }
2799
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
2800
+ // oauth required
2801
+ _a = headerParameters;
2802
+ _b = "Authorization";
2803
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_read"])];
2804
+ case 1:
2805
+ // oauth required
2806
+ _a[_b] = _c.sent();
2807
+ _c.label = 2;
2808
+ case 2:
2809
+ if (this.configuration && this.configuration.apiKey) {
2810
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
2811
+ }
2812
+ return [4 /*yield*/, this.request({
2813
+ path: "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/smsStats".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("commseq_uuid", "}"), encodeURIComponent(String(requestParameters.commseqUuid))),
2814
+ method: 'POST',
2815
+ headers: headerParameters,
2816
+ query: queryParameters,
2817
+ body: (0, models_1.EmailStatSmsSummaryRequestToJSON)(requestParameters.statsRequest),
2818
+ }, initOverrides)];
2819
+ case 3:
2820
+ response = _c.sent();
2821
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.EmailStatSmsSummaryResponseFromJSON)(jsonValue); })];
2822
+ }
2823
+ });
2824
+ });
2825
+ };
2826
+ /**
2827
+ * Get email communication sequence sms stats
2828
+ */
2829
+ StorefrontApi.prototype.getEmailCommseqSmsStats = function (requestParameters, initOverrides) {
2830
+ return __awaiter(this, void 0, void 0, function () {
2831
+ var response;
2832
+ return __generator(this, function (_a) {
2833
+ switch (_a.label) {
2834
+ case 0: return [4 /*yield*/, this.getEmailCommseqSmsStatsRaw(requestParameters, initOverrides)];
2835
+ case 1:
2836
+ response = _a.sent();
2837
+ return [4 /*yield*/, response.value()];
2838
+ case 2: return [2 /*return*/, _a.sent()];
2839
+ }
2840
+ });
2841
+ });
2842
+ };
2775
2843
  /**
2776
2844
  * Get communication sequence stats overall
2777
2845
  */
@@ -5366,6 +5434,75 @@ var StorefrontApi = /** @class */ (function (_super) {
5366
5434
  });
5367
5435
  });
5368
5436
  };
5437
+ /**
5438
+ * Get email sms orders
5439
+ */
5440
+ StorefrontApi.prototype.getEmailSmsOrdersRaw = function (requestParameters, initOverrides) {
5441
+ return __awaiter(this, void 0, void 0, function () {
5442
+ var queryParameters, headerParameters, _a, _b, response;
5443
+ return __generator(this, function (_c) {
5444
+ switch (_c.label) {
5445
+ case 0:
5446
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
5447
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailSmsOrders.');
5448
+ }
5449
+ if (requestParameters.commseqUuid === null || requestParameters.commseqUuid === undefined) {
5450
+ throw new runtime.RequiredError('commseqUuid', 'Required parameter requestParameters.commseqUuid was null or undefined when calling getEmailSmsOrders.');
5451
+ }
5452
+ if (requestParameters.commseqStepUuid === null || requestParameters.commseqStepUuid === undefined) {
5453
+ throw new runtime.RequiredError('commseqStepUuid', 'Required parameter requestParameters.commseqStepUuid was null or undefined when calling getEmailSmsOrders.');
5454
+ }
5455
+ queryParameters = {};
5456
+ if (requestParameters.days !== undefined) {
5457
+ queryParameters['days'] = requestParameters.days;
5458
+ }
5459
+ headerParameters = {};
5460
+ if (this.configuration && this.configuration.apiKey) {
5461
+ headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
5462
+ }
5463
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
5464
+ // oauth required
5465
+ _a = headerParameters;
5466
+ _b = "Authorization";
5467
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_read"])];
5468
+ case 1:
5469
+ // oauth required
5470
+ _a[_b] = _c.sent();
5471
+ _c.label = 2;
5472
+ case 2:
5473
+ if (this.configuration && this.configuration.apiKey) {
5474
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
5475
+ }
5476
+ return [4 /*yield*/, this.request({
5477
+ path: "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/sms/orders".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("commseq_uuid", "}"), encodeURIComponent(String(requestParameters.commseqUuid))).replace("{".concat("commseq_step_uuid", "}"), encodeURIComponent(String(requestParameters.commseqStepUuid))),
5478
+ method: 'GET',
5479
+ headers: headerParameters,
5480
+ query: queryParameters,
5481
+ }, initOverrides)];
5482
+ case 3:
5483
+ response = _c.sent();
5484
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.EmailSmsOrdersResponseFromJSON)(jsonValue); })];
5485
+ }
5486
+ });
5487
+ });
5488
+ };
5489
+ /**
5490
+ * Get email sms orders
5491
+ */
5492
+ StorefrontApi.prototype.getEmailSmsOrders = function (requestParameters, initOverrides) {
5493
+ return __awaiter(this, void 0, void 0, function () {
5494
+ var response;
5495
+ return __generator(this, function (_a) {
5496
+ switch (_a.label) {
5497
+ case 0: return [4 /*yield*/, this.getEmailSmsOrdersRaw(requestParameters, initOverrides)];
5498
+ case 1:
5499
+ response = _a.sent();
5500
+ return [4 /*yield*/, response.value()];
5501
+ case 2: return [2 /*return*/, _a.sent()];
5502
+ }
5503
+ });
5504
+ });
5505
+ };
5369
5506
  /**
5370
5507
  * Get email template
5371
5508
  */
@@ -40,6 +40,30 @@ export interface ConversationAgentAuth {
40
40
  * @memberof ConversationAgentAuth
41
41
  */
42
42
  merchant_id?: string;
43
+ /**
44
+ *
45
+ * @type {string}
46
+ * @memberof ConversationAgentAuth
47
+ */
48
+ pbx_jwt?: string;
49
+ /**
50
+ *
51
+ * @type {string}
52
+ * @memberof ConversationAgentAuth
53
+ */
54
+ pbx_voice_identity?: string;
55
+ /**
56
+ *
57
+ * @type {string}
58
+ * @memberof ConversationAgentAuth
59
+ */
60
+ pbx_voice_token?: string;
61
+ /**
62
+ *
63
+ * @type {string}
64
+ * @memberof ConversationAgentAuth
65
+ */
66
+ pbx_worker_token?: string;
43
67
  /**
44
68
  *
45
69
  * @type {Array<ConversationTwilioAccount>}
@@ -29,6 +29,10 @@ function ConversationAgentAuthFromJSONTyped(json, ignoreDiscriminator) {
29
29
  'conversation_participant_name': !(0, runtime_1.exists)(json, 'conversation_participant_name') ? undefined : json['conversation_participant_name'],
30
30
  'jwt': !(0, runtime_1.exists)(json, 'jwt') ? undefined : json['jwt'],
31
31
  'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
32
+ 'pbx_jwt': !(0, runtime_1.exists)(json, 'pbx_jwt') ? undefined : json['pbx_jwt'],
33
+ 'pbx_voice_identity': !(0, runtime_1.exists)(json, 'pbx_voice_identity') ? undefined : json['pbx_voice_identity'],
34
+ 'pbx_voice_token': !(0, runtime_1.exists)(json, 'pbx_voice_token') ? undefined : json['pbx_voice_token'],
35
+ 'pbx_worker_token': !(0, runtime_1.exists)(json, 'pbx_worker_token') ? undefined : json['pbx_worker_token'],
32
36
  'twilio_accounts': !(0, runtime_1.exists)(json, 'twilio_accounts') ? undefined : (json['twilio_accounts'].map(ConversationTwilioAccount_1.ConversationTwilioAccountFromJSON)),
33
37
  'websocket_url': !(0, runtime_1.exists)(json, 'websocket_url') ? undefined : json['websocket_url'],
34
38
  };
@@ -46,6 +50,10 @@ function ConversationAgentAuthToJSON(value) {
46
50
  'conversation_participant_name': value.conversation_participant_name,
47
51
  'jwt': value.jwt,
48
52
  'merchant_id': value.merchant_id,
53
+ 'pbx_jwt': value.pbx_jwt,
54
+ 'pbx_voice_identity': value.pbx_voice_identity,
55
+ 'pbx_voice_token': value.pbx_voice_token,
56
+ 'pbx_worker_token': value.pbx_worker_token,
49
57
  'twilio_accounts': value.twilio_accounts === undefined ? undefined : (value.twilio_accounts.map(ConversationTwilioAccount_1.ConversationTwilioAccountToJSON)),
50
58
  'websocket_url': value.websocket_url,
51
59
  };
@@ -27,6 +27,12 @@ export interface CouponAmountOffItems {
27
27
  * @memberof CouponAmountOffItems
28
28
  */
29
29
  discount_amount?: number;
30
+ /**
31
+ * An optional list of item tags which will receive a discount.
32
+ * @type {Array<string>}
33
+ * @memberof CouponAmountOffItems
34
+ */
35
+ item_tags?: Array<string>;
30
36
  /**
31
37
  * A list of items which are eligible for the discount amount.
32
38
  * @type {Array<string>}
@@ -26,6 +26,7 @@ function CouponAmountOffItemsFromJSONTyped(json, ignoreDiscriminator) {
26
26
  return {
27
27
  'currency_code': !(0, runtime_1.exists)(json, 'currency_code') ? undefined : json['currency_code'],
28
28
  'discount_amount': !(0, runtime_1.exists)(json, 'discount_amount') ? undefined : json['discount_amount'],
29
+ 'item_tags': !(0, runtime_1.exists)(json, 'item_tags') ? undefined : json['item_tags'],
29
30
  'items': !(0, runtime_1.exists)(json, 'items') ? undefined : json['items'],
30
31
  'limit': !(0, runtime_1.exists)(json, 'limit') ? undefined : json['limit'],
31
32
  };
@@ -41,6 +42,7 @@ function CouponAmountOffItemsToJSON(value) {
41
42
  return {
42
43
  'currency_code': value.currency_code,
43
44
  'discount_amount': value.discount_amount,
45
+ 'item_tags': value.item_tags,
44
46
  'items': value.items,
45
47
  'limit': value.limit,
46
48
  };
@@ -15,6 +15,12 @@
15
15
  * @interface CouponBuyOneGetOneLimit
16
16
  */
17
17
  export interface CouponBuyOneGetOneLimit {
18
+ /**
19
+ * An optional list of item tags which will receive a discount.
20
+ * @type {Array<string>}
21
+ * @memberof CouponBuyOneGetOneLimit
22
+ */
23
+ item_tags?: Array<string>;
18
24
  /**
19
25
  * An optional list of items of which one must be purchased to receive free quantity of the same item.
20
26
  * @type {Array<string>}
@@ -24,6 +24,7 @@ function CouponBuyOneGetOneLimitFromJSONTyped(json, ignoreDiscriminator) {
24
24
  return json;
25
25
  }
26
26
  return {
27
+ 'item_tags': !(0, runtime_1.exists)(json, 'item_tags') ? undefined : json['item_tags'],
27
28
  'items': !(0, runtime_1.exists)(json, 'items') ? undefined : json['items'],
28
29
  'limit': !(0, runtime_1.exists)(json, 'limit') ? undefined : json['limit'],
29
30
  };
@@ -37,6 +38,7 @@ function CouponBuyOneGetOneLimitToJSON(value) {
37
38
  return null;
38
39
  }
39
40
  return {
41
+ 'item_tags': value.item_tags,
40
42
  'items': value.items,
41
43
  'limit': value.limit,
42
44
  };
@@ -27,6 +27,12 @@ export interface CouponDiscountItemWithItemPurchase {
27
27
  * @memberof CouponDiscountItemWithItemPurchase
28
28
  */
29
29
  discount_item?: string;
30
+ /**
31
+ * An optional list of item tags which will receive a discount of one of the required purchased items is purchased.
32
+ * @type {Array<string>}
33
+ * @memberof CouponDiscountItemWithItemPurchase
34
+ */
35
+ discount_item_tags?: Array<string>;
30
36
  /**
31
37
  * The price (unit cost) of the discounted item
32
38
  * @type {number}
@@ -45,6 +51,12 @@ export interface CouponDiscountItemWithItemPurchase {
45
51
  * @memberof CouponDiscountItemWithItemPurchase
46
52
  */
47
53
  required_purchase_item?: string;
54
+ /**
55
+ * An optional list of item tags which are required to be purchased.
56
+ * @type {Array<string>}
57
+ * @memberof CouponDiscountItemWithItemPurchase
58
+ */
59
+ required_purchase_items_tags?: Array<string>;
48
60
  }
49
61
  export declare function CouponDiscountItemWithItemPurchaseFromJSON(json: any): CouponDiscountItemWithItemPurchase;
50
62
  export declare function CouponDiscountItemWithItemPurchaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CouponDiscountItemWithItemPurchase;
@@ -26,9 +26,11 @@ function CouponDiscountItemWithItemPurchaseFromJSONTyped(json, ignoreDiscriminat
26
26
  return {
27
27
  'currency_code': !(0, runtime_1.exists)(json, 'currency_code') ? undefined : json['currency_code'],
28
28
  'discount_item': !(0, runtime_1.exists)(json, 'discount_item') ? undefined : json['discount_item'],
29
+ 'discount_item_tags': !(0, runtime_1.exists)(json, 'discount_item_tags') ? undefined : json['discount_item_tags'],
29
30
  'discount_price': !(0, runtime_1.exists)(json, 'discount_price') ? undefined : json['discount_price'],
30
31
  'limit': !(0, runtime_1.exists)(json, 'limit') ? undefined : json['limit'],
31
32
  'required_purchase_item': !(0, runtime_1.exists)(json, 'required_purchase_item') ? undefined : json['required_purchase_item'],
33
+ 'required_purchase_items_tags': !(0, runtime_1.exists)(json, 'required_purchase_items_tags') ? undefined : json['required_purchase_items_tags'],
32
34
  };
33
35
  }
34
36
  exports.CouponDiscountItemWithItemPurchaseFromJSONTyped = CouponDiscountItemWithItemPurchaseFromJSONTyped;
@@ -42,9 +44,11 @@ function CouponDiscountItemWithItemPurchaseToJSON(value) {
42
44
  return {
43
45
  'currency_code': value.currency_code,
44
46
  'discount_item': value.discount_item,
47
+ 'discount_item_tags': value.discount_item_tags,
45
48
  'discount_price': value.discount_price,
46
49
  'limit': value.limit,
47
50
  'required_purchase_item': value.required_purchase_item,
51
+ 'required_purchase_items_tags': value.required_purchase_items_tags,
48
52
  };
49
53
  }
50
54
  exports.CouponDiscountItemWithItemPurchaseToJSON = CouponDiscountItemWithItemPurchaseToJSON;
@@ -15,6 +15,12 @@
15
15
  * @interface CouponFreeItemWithItemPurchase
16
16
  */
17
17
  export interface CouponFreeItemWithItemPurchase {
18
+ /**
19
+ * An optional list of item tags which will receive a discount of one of the required purchased items is purchased.
20
+ * @type {Array<string>}
21
+ * @memberof CouponFreeItemWithItemPurchase
22
+ */
23
+ item_tags?: Array<string>;
18
24
  /**
19
25
  * A list of free items which will receive a discount if one of the required purchase items is purchased.
20
26
  * @type {Array<string>}
@@ -39,6 +45,12 @@ export interface CouponFreeItemWithItemPurchase {
39
45
  * @memberof CouponFreeItemWithItemPurchase
40
46
  */
41
47
  required_purchase_items?: Array<string>;
48
+ /**
49
+ * An optional list of item tags which are required to be purchased.
50
+ * @type {Array<string>}
51
+ * @memberof CouponFreeItemWithItemPurchase
52
+ */
53
+ required_purchase_items_tags?: Array<string>;
42
54
  }
43
55
  export declare function CouponFreeItemWithItemPurchaseFromJSON(json: any): CouponFreeItemWithItemPurchase;
44
56
  export declare function CouponFreeItemWithItemPurchaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CouponFreeItemWithItemPurchase;
@@ -24,10 +24,12 @@ function CouponFreeItemWithItemPurchaseFromJSONTyped(json, ignoreDiscriminator)
24
24
  return json;
25
25
  }
26
26
  return {
27
+ 'item_tags': !(0, runtime_1.exists)(json, 'item_tags') ? undefined : json['item_tags'],
27
28
  'items': !(0, runtime_1.exists)(json, 'items') ? undefined : json['items'],
28
29
  'limit': !(0, runtime_1.exists)(json, 'limit') ? undefined : json['limit'],
29
30
  'match_required_purchase_item_to_free_item': !(0, runtime_1.exists)(json, 'match_required_purchase_item_to_free_item') ? undefined : json['match_required_purchase_item_to_free_item'],
30
31
  'required_purchase_items': !(0, runtime_1.exists)(json, 'required_purchase_items') ? undefined : json['required_purchase_items'],
32
+ 'required_purchase_items_tags': !(0, runtime_1.exists)(json, 'required_purchase_items_tags') ? undefined : json['required_purchase_items_tags'],
31
33
  };
32
34
  }
33
35
  exports.CouponFreeItemWithItemPurchaseFromJSONTyped = CouponFreeItemWithItemPurchaseFromJSONTyped;
@@ -39,10 +41,12 @@ function CouponFreeItemWithItemPurchaseToJSON(value) {
39
41
  return null;
40
42
  }
41
43
  return {
44
+ 'item_tags': value.item_tags,
42
45
  'items': value.items,
43
46
  'limit': value.limit,
44
47
  'match_required_purchase_item_to_free_item': value.match_required_purchase_item_to_free_item,
45
48
  'required_purchase_items': value.required_purchase_items,
49
+ 'required_purchase_items_tags': value.required_purchase_items_tags,
46
50
  };
47
51
  }
48
52
  exports.CouponFreeItemWithItemPurchaseToJSON = CouponFreeItemWithItemPurchaseToJSON;
@@ -21,6 +21,12 @@ export interface CouponPercentOffItemsWithItemsPurchase {
21
21
  * @memberof CouponPercentOffItemsWithItemsPurchase
22
22
  */
23
23
  discount_percent?: number;
24
+ /**
25
+ * An optional list of item tags which will receive a discount of one of the required purchased items is purchased.
26
+ * @type {Array<string>}
27
+ * @memberof CouponPercentOffItemsWithItemsPurchase
28
+ */
29
+ item_tags?: Array<string>;
24
30
  /**
25
31
  * A list of items which will receive a discount if one of the required purchase items is purchased.
26
32
  * @type {Array<string>}
@@ -39,6 +45,12 @@ export interface CouponPercentOffItemsWithItemsPurchase {
39
45
  * @memberof CouponPercentOffItemsWithItemsPurchase
40
46
  */
41
47
  required_purchase_items?: Array<string>;
48
+ /**
49
+ * An optional list of item tags which are required to be purchased.
50
+ * @type {Array<string>}
51
+ * @memberof CouponPercentOffItemsWithItemsPurchase
52
+ */
53
+ required_purchase_items_tags?: Array<string>;
42
54
  }
43
55
  export declare function CouponPercentOffItemsWithItemsPurchaseFromJSON(json: any): CouponPercentOffItemsWithItemsPurchase;
44
56
  export declare function CouponPercentOffItemsWithItemsPurchaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CouponPercentOffItemsWithItemsPurchase;
@@ -25,9 +25,11 @@ function CouponPercentOffItemsWithItemsPurchaseFromJSONTyped(json, ignoreDiscrim
25
25
  }
26
26
  return {
27
27
  'discount_percent': !(0, runtime_1.exists)(json, 'discount_percent') ? undefined : json['discount_percent'],
28
+ 'item_tags': !(0, runtime_1.exists)(json, 'item_tags') ? undefined : json['item_tags'],
28
29
  'items': !(0, runtime_1.exists)(json, 'items') ? undefined : json['items'],
29
30
  'limit': !(0, runtime_1.exists)(json, 'limit') ? undefined : json['limit'],
30
31
  'required_purchase_items': !(0, runtime_1.exists)(json, 'required_purchase_items') ? undefined : json['required_purchase_items'],
32
+ 'required_purchase_items_tags': !(0, runtime_1.exists)(json, 'required_purchase_items_tags') ? undefined : json['required_purchase_items_tags'],
31
33
  };
32
34
  }
33
35
  exports.CouponPercentOffItemsWithItemsPurchaseFromJSONTyped = CouponPercentOffItemsWithItemsPurchaseFromJSONTyped;
@@ -40,9 +42,11 @@ function CouponPercentOffItemsWithItemsPurchaseToJSON(value) {
40
42
  }
41
43
  return {
42
44
  'discount_percent': value.discount_percent,
45
+ 'item_tags': value.item_tags,
43
46
  'items': value.items,
44
47
  'limit': value.limit,
45
48
  'required_purchase_items': value.required_purchase_items,
49
+ 'required_purchase_items_tags': value.required_purchase_items_tags,
46
50
  };
47
51
  }
48
52
  exports.CouponPercentOffItemsWithItemsPurchaseToJSON = CouponPercentOffItemsWithItemsPurchaseToJSON;
@@ -0,0 +1,46 @@
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 { Currency } from './Currency';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface EmailSmsOrder
17
+ */
18
+ export interface EmailSmsOrder {
19
+ /**
20
+ * email
21
+ * @type {string}
22
+ * @memberof EmailSmsOrder
23
+ */
24
+ email?: string;
25
+ /**
26
+ * order_dts
27
+ * @type {string}
28
+ * @memberof EmailSmsOrder
29
+ */
30
+ order_dts?: string;
31
+ /**
32
+ * order_id
33
+ * @type {string}
34
+ * @memberof EmailSmsOrder
35
+ */
36
+ order_id?: string;
37
+ /**
38
+ *
39
+ * @type {Currency}
40
+ * @memberof EmailSmsOrder
41
+ */
42
+ total?: Currency;
43
+ }
44
+ export declare function EmailSmsOrderFromJSON(json: any): EmailSmsOrder;
45
+ export declare function EmailSmsOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailSmsOrder;
46
+ export declare function EmailSmsOrderToJSON(value?: EmailSmsOrder | null): any;