ultracart_rest_api_v2_typescript 4.0.59-RC → 4.0.62-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.
@@ -573,6 +573,8 @@ src/models/RegisterAffiliateClickRequest.ts
573
573
  src/models/RegisterAffiliateClickResponse.ts
574
574
  src/models/ResponseMetadata.ts
575
575
  src/models/ResultSet.ts
576
+ src/models/RulerValidationRequest.ts
577
+ src/models/RulerValidationResponse.ts
576
578
  src/models/ScreenRecording.ts
577
579
  src/models/ScreenRecordingAdPlatform.ts
578
580
  src/models/ScreenRecordingFilter.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@4.0.59-RC
1
+ ## ultracart_rest_api_v2_typescript@4.0.62-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.59-RC --save
39
+ npm install ultracart_rest_api_v2_typescript@4.0.62-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.62-RC | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
58
+ | 4.0.61-RC | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |
59
+ | 4.0.60-RC | 09/02/2022 | customer editor added loyal ledger descriptions |
57
60
  | 4.0.59-RC | 08/30/2022 | storefront comm fields for sms configuration |
58
61
  | 4.0.58-RC | 08/26/2022 | postcard address fields for comm sequence testing |
59
62
  | 4.0.57-RC | 08/22/2022 | exposing individual reviews within item.review object |
@@ -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, 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
  }
@@ -678,6 +678,9 @@ export interface UpdateTwilioAccountRequest {
678
678
  espTwilioUuid: string;
679
679
  twilio: Twilio;
680
680
  }
681
+ export interface ValidateRulerRequest {
682
+ rulerValidateRequest: RulerValidationRequest;
683
+ }
681
684
  /**
682
685
  * StorefrontApi - interface
683
686
  *
@@ -3026,6 +3029,19 @@ export interface StorefrontApiInterface {
3026
3029
  * Update Twilio account
3027
3030
  */
3028
3031
  updateTwilioAccount(requestParameters: UpdateTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TwilioResponse>;
3032
+ /**
3033
+ *
3034
+ * @summary Validate AWS Event Ruler
3035
+ * @param {RulerValidationRequest} rulerValidateRequest Ruler Validate Request
3036
+ * @param {*} [options] Override http request option.
3037
+ * @throws {RequiredError}
3038
+ * @memberof StorefrontApiInterface
3039
+ */
3040
+ validateRulerRaw(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RulerValidationResponse>>;
3041
+ /**
3042
+ * Validate AWS Event Ruler
3043
+ */
3044
+ validateRuler(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RulerValidationResponse>;
3029
3045
  }
3030
3046
  /**
3031
3047
  *
@@ -4391,4 +4407,12 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
4391
4407
  * Update Twilio account
4392
4408
  */
4393
4409
  updateTwilioAccount(requestParameters: UpdateTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TwilioResponse>;
4410
+ /**
4411
+ * Validate AWS Event Ruler
4412
+ */
4413
+ validateRulerRaw(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RulerValidationResponse>>;
4414
+ /**
4415
+ * Validate AWS Event Ruler
4416
+ */
4417
+ validateRuler(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RulerValidationResponse>;
4394
4418
  }
@@ -10573,6 +10573,68 @@ var StorefrontApi = /** @class */ (function (_super) {
10573
10573
  });
10574
10574
  });
10575
10575
  };
10576
+ /**
10577
+ * Validate AWS Event Ruler
10578
+ */
10579
+ StorefrontApi.prototype.validateRulerRaw = function (requestParameters, initOverrides) {
10580
+ return __awaiter(this, void 0, void 0, function () {
10581
+ var queryParameters, headerParameters, _a, _b, response;
10582
+ return __generator(this, function (_c) {
10583
+ switch (_c.label) {
10584
+ case 0:
10585
+ if (requestParameters.rulerValidateRequest === null || requestParameters.rulerValidateRequest === undefined) {
10586
+ throw new runtime.RequiredError('rulerValidateRequest', 'Required parameter requestParameters.rulerValidateRequest was null or undefined when calling validateRuler.');
10587
+ }
10588
+ queryParameters = {};
10589
+ headerParameters = {};
10590
+ headerParameters['Content-Type'] = 'application/json';
10591
+ if (this.configuration && this.configuration.apiKey) {
10592
+ headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
10593
+ }
10594
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
10595
+ // oauth required
10596
+ _a = headerParameters;
10597
+ _b = "Authorization";
10598
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_write"])];
10599
+ case 1:
10600
+ // oauth required
10601
+ _a[_b] = _c.sent();
10602
+ _c.label = 2;
10603
+ case 2:
10604
+ if (this.configuration && this.configuration.apiKey) {
10605
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
10606
+ }
10607
+ return [4 /*yield*/, this.request({
10608
+ path: "/storefront/ruler/validate",
10609
+ method: 'POST',
10610
+ headers: headerParameters,
10611
+ query: queryParameters,
10612
+ body: (0, models_1.RulerValidationRequestToJSON)(requestParameters.rulerValidateRequest),
10613
+ }, initOverrides)];
10614
+ case 3:
10615
+ response = _c.sent();
10616
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.RulerValidationResponseFromJSON)(jsonValue); })];
10617
+ }
10618
+ });
10619
+ });
10620
+ };
10621
+ /**
10622
+ * Validate AWS Event Ruler
10623
+ */
10624
+ StorefrontApi.prototype.validateRuler = function (requestParameters, initOverrides) {
10625
+ return __awaiter(this, void 0, void 0, function () {
10626
+ var response;
10627
+ return __generator(this, function (_a) {
10628
+ switch (_a.label) {
10629
+ case 0: return [4 /*yield*/, this.validateRulerRaw(requestParameters, initOverrides)];
10630
+ case 1:
10631
+ response = _a.sent();
10632
+ return [4 /*yield*/, response.value()];
10633
+ case 2: return [2 /*return*/, _a.sent()];
10634
+ }
10635
+ });
10636
+ });
10637
+ };
10576
10638
  return StorefrontApi;
10577
10639
  }(runtime.BaseAPI));
10578
10640
  exports.StorefrontApi = StorefrontApi;
@@ -47,6 +47,12 @@ export interface CustomerEditorValues {
47
47
  * @memberof CustomerEditorValues
48
48
  */
49
49
  countries?: Array<Country>;
50
+ /**
51
+ * loyalty_ledger_descriptions
52
+ * @type {Array<string>}
53
+ * @memberof CustomerEditorValues
54
+ */
55
+ loyalty_ledger_descriptions?: Array<string>;
50
56
  /**
51
57
  * loyalty_program_type
52
58
  * @type {string}
@@ -31,6 +31,7 @@ function CustomerEditorValuesFromJSONTyped(json, ignoreDiscriminator) {
31
31
  'card_exp_years': !(0, runtime_1.exists)(json, 'card_exp_years') ? undefined : json['card_exp_years'],
32
32
  'card_types': !(0, runtime_1.exists)(json, 'card_types') ? undefined : json['card_types'],
33
33
  'countries': !(0, runtime_1.exists)(json, 'countries') ? undefined : (json['countries'].map(Country_1.CountryFromJSON)),
34
+ 'loyalty_ledger_descriptions': !(0, runtime_1.exists)(json, 'loyalty_ledger_descriptions') ? undefined : json['loyalty_ledger_descriptions'],
34
35
  'loyalty_program_type': !(0, runtime_1.exists)(json, 'loyalty_program_type') ? undefined : json['loyalty_program_type'],
35
36
  'qb_classes': !(0, runtime_1.exists)(json, 'qb_classes') ? undefined : json['qb_classes'],
36
37
  'sales_rep_codes': !(0, runtime_1.exists)(json, 'sales_rep_codes') ? undefined : json['sales_rep_codes'],
@@ -52,6 +53,7 @@ function CustomerEditorValuesToJSON(value) {
52
53
  'card_exp_years': value.card_exp_years,
53
54
  'card_types': value.card_types,
54
55
  'countries': value.countries === undefined ? undefined : (value.countries.map(Country_1.CountryToJSON)),
56
+ 'loyalty_ledger_descriptions': value.loyalty_ledger_descriptions,
55
57
  'loyalty_program_type': value.loyalty_program_type,
56
58
  'qb_classes': value.qb_classes,
57
59
  'sales_rep_codes': value.sales_rep_codes,
@@ -69,6 +69,12 @@ export interface EmailSettings {
69
69
  * @memberof EmailSettings
70
70
  */
71
71
  postcard_from_state?: string;
72
+ /**
73
+ * True if the Reviews.io integration is configured
74
+ * @type {boolean}
75
+ * @memberof EmailSettings
76
+ */
77
+ reviews_io_configured?: boolean;
72
78
  /**
73
79
  *
74
80
  * @type {string}
@@ -33,6 +33,7 @@ function EmailSettingsFromJSONTyped(json, ignoreDiscriminator) {
33
33
  'postcard_from_name': !(0, runtime_1.exists)(json, 'postcard_from_name') ? undefined : json['postcard_from_name'],
34
34
  'postcard_from_postal_code': !(0, runtime_1.exists)(json, 'postcard_from_postal_code') ? undefined : json['postcard_from_postal_code'],
35
35
  'postcard_from_state': !(0, runtime_1.exists)(json, 'postcard_from_state') ? undefined : json['postcard_from_state'],
36
+ 'reviews_io_configured': !(0, runtime_1.exists)(json, 'reviews_io_configured') ? undefined : json['reviews_io_configured'],
36
37
  'sms_esp_twilio_uuid': !(0, runtime_1.exists)(json, 'sms_esp_twilio_uuid') ? undefined : json['sms_esp_twilio_uuid'],
37
38
  'sms_phone_number': !(0, runtime_1.exists)(json, 'sms_phone_number') ? undefined : json['sms_phone_number'],
38
39
  'transactional_esp_domain_user': !(0, runtime_1.exists)(json, 'transactional_esp_domain_user') ? undefined : json['transactional_esp_domain_user'],
@@ -58,6 +59,7 @@ function EmailSettingsToJSON(value) {
58
59
  'postcard_from_name': value.postcard_from_name,
59
60
  'postcard_from_postal_code': value.postcard_from_postal_code,
60
61
  'postcard_from_state': value.postcard_from_state,
62
+ 'reviews_io_configured': value.reviews_io_configured,
61
63
  'sms_esp_twilio_uuid': value.sms_esp_twilio_uuid,
62
64
  'sms_phone_number': value.sms_phone_number,
63
65
  'transactional_esp_domain_user': value.transactional_esp_domain_user,
@@ -0,0 +1,27 @@
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 RulerValidationRequest
16
+ */
17
+ export interface RulerValidationRequest {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof RulerValidationRequest
22
+ */
23
+ ruler?: string;
24
+ }
25
+ export declare function RulerValidationRequestFromJSON(json: any): RulerValidationRequest;
26
+ export declare function RulerValidationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RulerValidationRequest;
27
+ export declare function RulerValidationRequestToJSON(value?: RulerValidationRequest | null): any;
@@ -0,0 +1,42 @@
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.RulerValidationRequestToJSON = exports.RulerValidationRequestFromJSONTyped = exports.RulerValidationRequestFromJSON = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ function RulerValidationRequestFromJSON(json) {
19
+ return RulerValidationRequestFromJSONTyped(json, false);
20
+ }
21
+ exports.RulerValidationRequestFromJSON = RulerValidationRequestFromJSON;
22
+ function RulerValidationRequestFromJSONTyped(json, ignoreDiscriminator) {
23
+ if ((json === undefined) || (json === null)) {
24
+ return json;
25
+ }
26
+ return {
27
+ 'ruler': !(0, runtime_1.exists)(json, 'ruler') ? undefined : json['ruler'],
28
+ };
29
+ }
30
+ exports.RulerValidationRequestFromJSONTyped = RulerValidationRequestFromJSONTyped;
31
+ function RulerValidationRequestToJSON(value) {
32
+ if (value === undefined) {
33
+ return undefined;
34
+ }
35
+ if (value === null) {
36
+ return null;
37
+ }
38
+ return {
39
+ 'ruler': value.ruler,
40
+ };
41
+ }
42
+ exports.RulerValidationRequestToJSON = RulerValidationRequestToJSON;
@@ -0,0 +1,33 @@
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 RulerValidationResponse
16
+ */
17
+ export interface RulerValidationResponse {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof RulerValidationResponse
22
+ */
23
+ error_message?: string;
24
+ /**
25
+ *
26
+ * @type {boolean}
27
+ * @memberof RulerValidationResponse
28
+ */
29
+ valid?: boolean;
30
+ }
31
+ export declare function RulerValidationResponseFromJSON(json: any): RulerValidationResponse;
32
+ export declare function RulerValidationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RulerValidationResponse;
33
+ export declare function RulerValidationResponseToJSON(value?: RulerValidationResponse | null): any;
@@ -0,0 +1,44 @@
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.RulerValidationResponseToJSON = exports.RulerValidationResponseFromJSONTyped = exports.RulerValidationResponseFromJSON = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ function RulerValidationResponseFromJSON(json) {
19
+ return RulerValidationResponseFromJSONTyped(json, false);
20
+ }
21
+ exports.RulerValidationResponseFromJSON = RulerValidationResponseFromJSON;
22
+ function RulerValidationResponseFromJSONTyped(json, ignoreDiscriminator) {
23
+ if ((json === undefined) || (json === null)) {
24
+ return json;
25
+ }
26
+ return {
27
+ 'error_message': !(0, runtime_1.exists)(json, 'error_message') ? undefined : json['error_message'],
28
+ 'valid': !(0, runtime_1.exists)(json, 'valid') ? undefined : json['valid'],
29
+ };
30
+ }
31
+ exports.RulerValidationResponseFromJSONTyped = RulerValidationResponseFromJSONTyped;
32
+ function RulerValidationResponseToJSON(value) {
33
+ if (value === undefined) {
34
+ return undefined;
35
+ }
36
+ if (value === null) {
37
+ return null;
38
+ }
39
+ return {
40
+ 'error_message': value.error_message,
41
+ 'valid': value.valid,
42
+ };
43
+ }
44
+ exports.RulerValidationResponseToJSON = RulerValidationResponseToJSON;
@@ -548,6 +548,8 @@ export * from './RegisterAffiliateClickRequest';
548
548
  export * from './RegisterAffiliateClickResponse';
549
549
  export * from './ResponseMetadata';
550
550
  export * from './ResultSet';
551
+ export * from './RulerValidationRequest';
552
+ export * from './RulerValidationResponse';
551
553
  export * from './ScreenRecording';
552
554
  export * from './ScreenRecordingAdPlatform';
553
555
  export * from './ScreenRecordingFilter';
@@ -566,6 +566,8 @@ __exportStar(require("./RegisterAffiliateClickRequest"), exports);
566
566
  __exportStar(require("./RegisterAffiliateClickResponse"), exports);
567
567
  __exportStar(require("./ResponseMetadata"), exports);
568
568
  __exportStar(require("./ResultSet"), exports);
569
+ __exportStar(require("./RulerValidationRequest"), exports);
570
+ __exportStar(require("./RulerValidationResponse"), exports);
569
571
  __exportStar(require("./ScreenRecording"), exports);
570
572
  __exportStar(require("./ScreenRecordingAdPlatform"), exports);
571
573
  __exportStar(require("./ScreenRecordingFilter"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "4.0.59-RC",
3
+ "version": "4.0.62-RC",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "repository": {
@@ -333,6 +333,12 @@ import {
333
333
  PublishLibraryItemRequest,
334
334
  PublishLibraryItemRequestFromJSON,
335
335
  PublishLibraryItemRequestToJSON,
336
+ RulerValidationRequest,
337
+ RulerValidationRequestFromJSON,
338
+ RulerValidationRequestToJSON,
339
+ RulerValidationResponse,
340
+ RulerValidationResponseFromJSON,
341
+ RulerValidationResponseToJSON,
336
342
  ScreenRecordingHeatmapIndexRequest,
337
343
  ScreenRecordingHeatmapIndexRequestFromJSON,
338
344
  ScreenRecordingHeatmapIndexRequestToJSON,
@@ -1242,6 +1248,10 @@ export interface UpdateTwilioAccountRequest {
1242
1248
  twilio: Twilio;
1243
1249
  }
1244
1250
 
1251
+ export interface ValidateRulerRequest {
1252
+ rulerValidateRequest: RulerValidationRequest;
1253
+ }
1254
+
1245
1255
  /**
1246
1256
  * StorefrontApi - interface
1247
1257
  *
@@ -3918,6 +3928,21 @@ export interface StorefrontApiInterface {
3918
3928
  */
3919
3929
  updateTwilioAccount(requestParameters: UpdateTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TwilioResponse>;
3920
3930
 
3931
+ /**
3932
+ *
3933
+ * @summary Validate AWS Event Ruler
3934
+ * @param {RulerValidationRequest} rulerValidateRequest Ruler Validate Request
3935
+ * @param {*} [options] Override http request option.
3936
+ * @throws {RequiredError}
3937
+ * @memberof StorefrontApiInterface
3938
+ */
3939
+ validateRulerRaw(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RulerValidationResponse>>;
3940
+
3941
+ /**
3942
+ * Validate AWS Event Ruler
3943
+ */
3944
+ validateRuler(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RulerValidationResponse>;
3945
+
3921
3946
  }
3922
3947
 
3923
3948
  /**
@@ -11879,4 +11904,50 @@ export class StorefrontApi extends runtime.BaseAPI implements StorefrontApiInter
11879
11904
  return await response.value();
11880
11905
  }
11881
11906
 
11907
+ /**
11908
+ * Validate AWS Event Ruler
11909
+ */
11910
+ async validateRulerRaw(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RulerValidationResponse>> {
11911
+ if (requestParameters.rulerValidateRequest === null || requestParameters.rulerValidateRequest === undefined) {
11912
+ throw new runtime.RequiredError('rulerValidateRequest','Required parameter requestParameters.rulerValidateRequest was null or undefined when calling validateRuler.');
11913
+ }
11914
+
11915
+ const queryParameters: any = {};
11916
+
11917
+ const headerParameters: runtime.HTTPHeaders = {};
11918
+
11919
+ headerParameters['Content-Type'] = 'application/json';
11920
+
11921
+ if (this.configuration && this.configuration.apiKey) {
11922
+ headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
11923
+ }
11924
+
11925
+ if (this.configuration && this.configuration.accessToken) {
11926
+ // oauth required
11927
+ headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["storefront_write"]);
11928
+ }
11929
+
11930
+ if (this.configuration && this.configuration.apiKey) {
11931
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
11932
+ }
11933
+
11934
+ const response = await this.request({
11935
+ path: `/storefront/ruler/validate`,
11936
+ method: 'POST',
11937
+ headers: headerParameters,
11938
+ query: queryParameters,
11939
+ body: RulerValidationRequestToJSON(requestParameters.rulerValidateRequest),
11940
+ }, initOverrides);
11941
+
11942
+ return new runtime.JSONApiResponse(response, (jsonValue) => RulerValidationResponseFromJSON(jsonValue));
11943
+ }
11944
+
11945
+ /**
11946
+ * Validate AWS Event Ruler
11947
+ */
11948
+ async validateRuler(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RulerValidationResponse> {
11949
+ const response = await this.validateRulerRaw(requestParameters, initOverrides);
11950
+ return await response.value();
11951
+ }
11952
+
11882
11953
  }
@@ -62,6 +62,12 @@ export interface CustomerEditorValues {
62
62
  * @memberof CustomerEditorValues
63
63
  */
64
64
  countries?: Array<Country>;
65
+ /**
66
+ * loyalty_ledger_descriptions
67
+ * @type {Array<string>}
68
+ * @memberof CustomerEditorValues
69
+ */
70
+ loyalty_ledger_descriptions?: Array<string>;
65
71
  /**
66
72
  * loyalty_program_type
67
73
  * @type {string}
@@ -109,6 +115,7 @@ export function CustomerEditorValuesFromJSONTyped(json: any, ignoreDiscriminator
109
115
  'card_exp_years': !exists(json, 'card_exp_years') ? undefined : json['card_exp_years'],
110
116
  'card_types': !exists(json, 'card_types') ? undefined : json['card_types'],
111
117
  'countries': !exists(json, 'countries') ? undefined : ((json['countries'] as Array<any>).map(CountryFromJSON)),
118
+ 'loyalty_ledger_descriptions': !exists(json, 'loyalty_ledger_descriptions') ? undefined : json['loyalty_ledger_descriptions'],
112
119
  'loyalty_program_type': !exists(json, 'loyalty_program_type') ? undefined : json['loyalty_program_type'],
113
120
  'qb_classes': !exists(json, 'qb_classes') ? undefined : json['qb_classes'],
114
121
  'sales_rep_codes': !exists(json, 'sales_rep_codes') ? undefined : json['sales_rep_codes'],
@@ -131,6 +138,7 @@ export function CustomerEditorValuesToJSON(value?: CustomerEditorValues | null):
131
138
  'card_exp_years': value.card_exp_years,
132
139
  'card_types': value.card_types,
133
140
  'countries': value.countries === undefined ? undefined : ((value.countries as Array<any>).map(CountryToJSON)),
141
+ 'loyalty_ledger_descriptions': value.loyalty_ledger_descriptions,
134
142
  'loyalty_program_type': value.loyalty_program_type,
135
143
  'qb_classes': value.qb_classes,
136
144
  'sales_rep_codes': value.sales_rep_codes,
@@ -73,6 +73,12 @@ export interface EmailSettings {
73
73
  * @memberof EmailSettings
74
74
  */
75
75
  postcard_from_state?: string;
76
+ /**
77
+ * True if the Reviews.io integration is configured
78
+ * @type {boolean}
79
+ * @memberof EmailSettings
80
+ */
81
+ reviews_io_configured?: boolean;
76
82
  /**
77
83
  *
78
84
  * @type {string}
@@ -124,6 +130,7 @@ export function EmailSettingsFromJSONTyped(json: any, ignoreDiscriminator: boole
124
130
  'postcard_from_name': !exists(json, 'postcard_from_name') ? undefined : json['postcard_from_name'],
125
131
  'postcard_from_postal_code': !exists(json, 'postcard_from_postal_code') ? undefined : json['postcard_from_postal_code'],
126
132
  'postcard_from_state': !exists(json, 'postcard_from_state') ? undefined : json['postcard_from_state'],
133
+ 'reviews_io_configured': !exists(json, 'reviews_io_configured') ? undefined : json['reviews_io_configured'],
127
134
  'sms_esp_twilio_uuid': !exists(json, 'sms_esp_twilio_uuid') ? undefined : json['sms_esp_twilio_uuid'],
128
135
  'sms_phone_number': !exists(json, 'sms_phone_number') ? undefined : json['sms_phone_number'],
129
136
  'transactional_esp_domain_user': !exists(json, 'transactional_esp_domain_user') ? undefined : json['transactional_esp_domain_user'],
@@ -150,6 +157,7 @@ export function EmailSettingsToJSON(value?: EmailSettings | null): any {
150
157
  'postcard_from_name': value.postcard_from_name,
151
158
  'postcard_from_postal_code': value.postcard_from_postal_code,
152
159
  'postcard_from_state': value.postcard_from_state,
160
+ 'reviews_io_configured': value.reviews_io_configured,
153
161
  'sms_esp_twilio_uuid': value.sms_esp_twilio_uuid,
154
162
  'sms_phone_number': value.sms_phone_number,
155
163
  'transactional_esp_domain_user': value.transactional_esp_domain_user,
@@ -0,0 +1,56 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface RulerValidationRequest
20
+ */
21
+ export interface RulerValidationRequest {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof RulerValidationRequest
26
+ */
27
+ ruler?: string;
28
+ }
29
+
30
+ export function RulerValidationRequestFromJSON(json: any): RulerValidationRequest {
31
+ return RulerValidationRequestFromJSONTyped(json, false);
32
+ }
33
+
34
+ export function RulerValidationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RulerValidationRequest {
35
+ if ((json === undefined) || (json === null)) {
36
+ return json;
37
+ }
38
+ return {
39
+
40
+ 'ruler': !exists(json, 'ruler') ? undefined : json['ruler'],
41
+ };
42
+ }
43
+
44
+ export function RulerValidationRequestToJSON(value?: RulerValidationRequest | null): any {
45
+ if (value === undefined) {
46
+ return undefined;
47
+ }
48
+ if (value === null) {
49
+ return null;
50
+ }
51
+ return {
52
+
53
+ 'ruler': value.ruler,
54
+ };
55
+ }
56
+
@@ -0,0 +1,64 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface RulerValidationResponse
20
+ */
21
+ export interface RulerValidationResponse {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof RulerValidationResponse
26
+ */
27
+ error_message?: string;
28
+ /**
29
+ *
30
+ * @type {boolean}
31
+ * @memberof RulerValidationResponse
32
+ */
33
+ valid?: boolean;
34
+ }
35
+
36
+ export function RulerValidationResponseFromJSON(json: any): RulerValidationResponse {
37
+ return RulerValidationResponseFromJSONTyped(json, false);
38
+ }
39
+
40
+ export function RulerValidationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RulerValidationResponse {
41
+ if ((json === undefined) || (json === null)) {
42
+ return json;
43
+ }
44
+ return {
45
+
46
+ 'error_message': !exists(json, 'error_message') ? undefined : json['error_message'],
47
+ 'valid': !exists(json, 'valid') ? undefined : json['valid'],
48
+ };
49
+ }
50
+
51
+ export function RulerValidationResponseToJSON(value?: RulerValidationResponse | null): any {
52
+ if (value === undefined) {
53
+ return undefined;
54
+ }
55
+ if (value === null) {
56
+ return null;
57
+ }
58
+ return {
59
+
60
+ 'error_message': value.error_message,
61
+ 'valid': value.valid,
62
+ };
63
+ }
64
+
@@ -550,6 +550,8 @@ export * from './RegisterAffiliateClickRequest';
550
550
  export * from './RegisterAffiliateClickResponse';
551
551
  export * from './ResponseMetadata';
552
552
  export * from './ResultSet';
553
+ export * from './RulerValidationRequest';
554
+ export * from './RulerValidationResponse';
553
555
  export * from './ScreenRecording';
554
556
  export * from './ScreenRecordingAdPlatform';
555
557
  export * from './ScreenRecordingFilter';