ultracart_rest_api_v2_typescript 4.1.17 → 4.1.19

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 (30) hide show
  1. package/.openapi-generator/FILES +3 -0
  2. package/README.md +4 -2
  3. package/dist/apis/StorefrontApi.d.ts +25 -1
  4. package/dist/apis/StorefrontApi.js +60 -0
  5. package/dist/models/ConversationVirtualAgentCapabilities.d.ts +21 -2
  6. package/dist/models/ConversationVirtualAgentCapabilities.js +9 -2
  7. package/dist/models/ConversationVirtualAgentCapabilityZohoDeskDepartment.d.ts +37 -0
  8. package/dist/models/ConversationVirtualAgentCapabilityZohoDeskDepartment.js +52 -0
  9. package/dist/models/CustomDashboard.d.ts +7 -0
  10. package/dist/models/CustomDashboard.js +3 -0
  11. package/dist/models/CustomDashboardExecutionParameter.d.ts +49 -0
  12. package/dist/models/CustomDashboardExecutionParameter.js +56 -0
  13. package/dist/models/CustomReportExecutionParameter.d.ts +6 -0
  14. package/dist/models/CustomReportExecutionParameter.js +2 -0
  15. package/dist/models/EmailEditorValuesResponse.d.ts +58 -0
  16. package/dist/models/EmailEditorValuesResponse.js +61 -0
  17. package/dist/models/EmailWebhookEditorValuesResponse.d.ts +0 -6
  18. package/dist/models/EmailWebhookEditorValuesResponse.js +0 -2
  19. package/dist/models/index.d.ts +3 -0
  20. package/dist/models/index.js +3 -0
  21. package/package.json +1 -1
  22. package/src/apis/StorefrontApi.ts +65 -0
  23. package/src/models/ConversationVirtualAgentCapabilities.ts +33 -2
  24. package/src/models/ConversationVirtualAgentCapabilityZohoDeskDepartment.ts +75 -0
  25. package/src/models/CustomDashboard.ts +14 -0
  26. package/src/models/CustomDashboardExecutionParameter.ts +91 -0
  27. package/src/models/CustomReportExecutionParameter.ts +8 -0
  28. package/src/models/EmailEditorValuesResponse.ts +118 -0
  29. package/src/models/EmailWebhookEditorValuesResponse.ts +0 -8
  30. package/src/models/index.ts +3 -0
@@ -249,6 +249,7 @@ src/models/ConversationVirtualAgentBudget.ts
249
249
  src/models/ConversationVirtualAgentBudgetResponse.ts
250
250
  src/models/ConversationVirtualAgentCapabilities.ts
251
251
  src/models/ConversationVirtualAgentCapabilitiesResponse.ts
252
+ src/models/ConversationVirtualAgentCapabilityZohoDeskDepartment.ts
252
253
  src/models/ConversationWebchatContext.ts
253
254
  src/models/ConversationWebchatQueueStatus.ts
254
255
  src/models/ConversationWebchatQueueStatusAgent.ts
@@ -330,6 +331,7 @@ src/models/CouponsRequest.ts
330
331
  src/models/CouponsResponse.ts
331
332
  src/models/Currency.ts
332
333
  src/models/CustomDashboard.ts
334
+ src/models/CustomDashboardExecutionParameter.ts
333
335
  src/models/CustomDashboardPage.ts
334
336
  src/models/CustomDashboardPageReport.ts
335
337
  src/models/CustomDashboardResponse.ts
@@ -431,6 +433,7 @@ src/models/EmailDashboardActivityResponse.ts
431
433
  src/models/EmailDashboardStatsResponse.ts
432
434
  src/models/EmailDomain.ts
433
435
  src/models/EmailEditorTokenResponse.ts
436
+ src/models/EmailEditorValuesResponse.ts
434
437
  src/models/EmailFlow.ts
435
438
  src/models/EmailFlowBackPopulateRequest.ts
436
439
  src/models/EmailFlowBackPopulateResponse.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.17
2
+ ## ultracart_rest_api_v2_typescript@4.1.19
3
3
 
4
4
  Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
5
5
 
6
6
  Installation
7
7
 
8
8
  ```
9
- npm install ultracart_rest_api_v2_typescript@4.1.17 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.19 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
89
+ | 4.1.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
88
90
  | 4.1.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
89
91
  | 4.1.16 | 07/28/2025 | updated doc samples |
90
92
  | 4.1.15 | 07/28/2025 | new order methods for blocking and unblocking refunds |
@@ -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, EmailRateLimitersResponse, 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, StoreFrontPageContentAttribute, 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, EmailEditorValuesResponse, 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, EmailRateLimitersResponse, 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, StoreFrontPageContentAttribute, 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,9 @@ export interface GetEmailCommseqRequest {
163
163
  storefrontOid: number;
164
164
  commseqUuid: string;
165
165
  }
166
+ export interface GetEmailCommseqEditorValuesRequest {
167
+ storefrontOid: number;
168
+ }
166
169
  export interface GetEmailCommseqEmailStatsRequest {
167
170
  storefrontOid: number;
168
171
  commseqUuid: string;
@@ -1306,6 +1309,19 @@ export interface StorefrontApiInterface {
1306
1309
  * Get email commseq
1307
1310
  */
1308
1311
  getEmailCommseq(requestParameters: GetEmailCommseqRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCommseqResponse>;
1312
+ /**
1313
+ *
1314
+ * @summary Get email merchant specific editor values
1315
+ * @param {number} storefrontOid
1316
+ * @param {*} [options] Override http request option.
1317
+ * @throws {RequiredError}
1318
+ * @memberof StorefrontApiInterface
1319
+ */
1320
+ getEmailCommseqEditorValuesRaw(requestParameters: GetEmailCommseqEditorValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailEditorValuesResponse>>;
1321
+ /**
1322
+ * Get email merchant specific editor values
1323
+ */
1324
+ getEmailCommseqEditorValues(requestParameters: GetEmailCommseqEditorValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailEditorValuesResponse>;
1309
1325
  /**
1310
1326
  *
1311
1327
  * @summary Get email communication sequence emails stats
@@ -3630,6 +3646,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
3630
3646
  * Get email commseq
3631
3647
  */
3632
3648
  getEmailCommseq(requestParameters: GetEmailCommseqRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCommseqResponse>;
3649
+ /**
3650
+ * Get email merchant specific editor values
3651
+ */
3652
+ getEmailCommseqEditorValuesRaw(requestParameters: GetEmailCommseqEditorValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailEditorValuesResponse>>;
3653
+ /**
3654
+ * Get email merchant specific editor values
3655
+ */
3656
+ getEmailCommseqEditorValues(requestParameters: GetEmailCommseqEditorValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailEditorValuesResponse>;
3633
3657
  /**
3634
3658
  * Get email communication sequence emails stats
3635
3659
  */
@@ -2573,6 +2573,66 @@ var StorefrontApi = /** @class */ (function (_super) {
2573
2573
  });
2574
2574
  });
2575
2575
  };
2576
+ /**
2577
+ * Get email merchant specific editor values
2578
+ */
2579
+ StorefrontApi.prototype.getEmailCommseqEditorValuesRaw = function (requestParameters, initOverrides) {
2580
+ return __awaiter(this, void 0, void 0, function () {
2581
+ var queryParameters, headerParameters, _a, _b, response;
2582
+ return __generator(this, function (_c) {
2583
+ switch (_c.label) {
2584
+ case 0:
2585
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
2586
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailCommseqEditorValues.');
2587
+ }
2588
+ queryParameters = {};
2589
+ headerParameters = {};
2590
+ if (this.configuration && this.configuration.apiKey) {
2591
+ headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
2592
+ }
2593
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
2594
+ // oauth required
2595
+ _a = headerParameters;
2596
+ _b = "Authorization";
2597
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_read"])];
2598
+ case 1:
2599
+ // oauth required
2600
+ _a[_b] = _c.sent();
2601
+ _c.label = 2;
2602
+ case 2:
2603
+ if (this.configuration && this.configuration.apiKey) {
2604
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
2605
+ }
2606
+ return [4 /*yield*/, this.request({
2607
+ path: "/storefront/{storefront_oid}/email/commseqs/editorValues".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
2608
+ method: 'GET',
2609
+ headers: headerParameters,
2610
+ query: queryParameters,
2611
+ }, initOverrides)];
2612
+ case 3:
2613
+ response = _c.sent();
2614
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.EmailEditorValuesResponseFromJSON)(jsonValue); })];
2615
+ }
2616
+ });
2617
+ });
2618
+ };
2619
+ /**
2620
+ * Get email merchant specific editor values
2621
+ */
2622
+ StorefrontApi.prototype.getEmailCommseqEditorValues = function (requestParameters, initOverrides) {
2623
+ return __awaiter(this, void 0, void 0, function () {
2624
+ var response;
2625
+ return __generator(this, function (_a) {
2626
+ switch (_a.label) {
2627
+ case 0: return [4 /*yield*/, this.getEmailCommseqEditorValuesRaw(requestParameters, initOverrides)];
2628
+ case 1:
2629
+ response = _a.sent();
2630
+ return [4 /*yield*/, response.value()];
2631
+ case 2: return [2 /*return*/, _a.sent()];
2632
+ }
2633
+ });
2634
+ });
2635
+ };
2576
2636
  /**
2577
2637
  * Get email communication sequence emails stats
2578
2638
  */
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { ConversationVirtualAgentCapabilityZohoDeskDepartment } from './ConversationVirtualAgentCapabilityZohoDeskDepartment';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -57,6 +58,12 @@ export interface ConversationVirtualAgentCapabilities {
57
58
  * @memberof ConversationVirtualAgentCapabilities
58
59
  */
59
60
  open_support_ticket_channel_email?: string;
61
+ /**
62
+ * Department ID to open a Zoho Desk ticket for
63
+ * @type {string}
64
+ * @memberof ConversationVirtualAgentCapabilities
65
+ */
66
+ open_support_ticket_zoho_desk_department_id?: string;
60
67
  /**
61
68
  *
62
69
  * @type {boolean}
@@ -81,6 +88,18 @@ export interface ConversationVirtualAgentCapabilities {
81
88
  * @memberof ConversationVirtualAgentCapabilities
82
89
  */
83
90
  update_subscription_credit_card?: boolean;
91
+ /**
92
+ * True if Zoho Desk is connected to UltraCart
93
+ * @type {boolean}
94
+ * @memberof ConversationVirtualAgentCapabilities
95
+ */
96
+ zoho_desk_available?: boolean;
97
+ /**
98
+ * Array of Zoho Desk Department if zoho desk is connected to UltraCart
99
+ * @type {Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>}
100
+ * @memberof ConversationVirtualAgentCapabilities
101
+ */
102
+ zoho_desk_departments?: Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>;
84
103
  }
85
104
  /**
86
105
  * @export
@@ -88,8 +107,8 @@ export interface ConversationVirtualAgentCapabilities {
88
107
  export declare const ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum: {
89
108
  readonly None: "none";
90
109
  readonly Email: "email";
91
- readonly UltraCartTask: "UltraCart Task";
92
- readonly ZohoDeskTicket: "Zoho Desk Ticket";
110
+ readonly UltracartTask: "ultracart_task";
111
+ readonly ZohoDeskTicket: "zoho_desk_ticket";
93
112
  };
94
113
  export type ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum = typeof ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum[keyof typeof ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum];
95
114
  /**
@@ -15,14 +15,15 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.ConversationVirtualAgentCapabilitiesToJSON = exports.ConversationVirtualAgentCapabilitiesFromJSONTyped = exports.ConversationVirtualAgentCapabilitiesFromJSON = exports.instanceOfConversationVirtualAgentCapabilities = exports.ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum = void 0;
17
17
  var runtime_1 = require("../runtime");
18
+ var ConversationVirtualAgentCapabilityZohoDeskDepartment_1 = require("./ConversationVirtualAgentCapabilityZohoDeskDepartment");
18
19
  /**
19
20
  * @export
20
21
  */
21
22
  exports.ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum = {
22
23
  None: 'none',
23
24
  Email: 'email',
24
- UltraCartTask: 'UltraCart Task',
25
- ZohoDeskTicket: 'Zoho Desk Ticket'
25
+ UltracartTask: 'ultracart_task',
26
+ ZohoDeskTicket: 'zoho_desk_ticket'
26
27
  };
27
28
  /**
28
29
  * Check if a given object implements the ConversationVirtualAgentCapabilities interface.
@@ -48,10 +49,13 @@ function ConversationVirtualAgentCapabilitiesFromJSONTyped(json, ignoreDiscrimin
48
49
  'open_support_ticket': !(0, runtime_1.exists)(json, 'open_support_ticket') ? undefined : json['open_support_ticket'],
49
50
  'open_support_ticket_channel': !(0, runtime_1.exists)(json, 'open_support_ticket_channel') ? undefined : json['open_support_ticket_channel'],
50
51
  'open_support_ticket_channel_email': !(0, runtime_1.exists)(json, 'open_support_ticket_channel_email') ? undefined : json['open_support_ticket_channel_email'],
52
+ 'open_support_ticket_zoho_desk_department_id': !(0, runtime_1.exists)(json, 'open_support_ticket_zoho_desk_department_id') ? undefined : json['open_support_ticket_zoho_desk_department_id'],
51
53
  'pause_subscription': !(0, runtime_1.exists)(json, 'pause_subscription') ? undefined : json['pause_subscription'],
52
54
  'resume_subscription': !(0, runtime_1.exists)(json, 'resume_subscription') ? undefined : json['resume_subscription'],
53
55
  'transfer_chat_to_live_agent': !(0, runtime_1.exists)(json, 'transfer_chat_to_live_agent') ? undefined : json['transfer_chat_to_live_agent'],
54
56
  'update_subscription_credit_card': !(0, runtime_1.exists)(json, 'update_subscription_credit_card') ? undefined : json['update_subscription_credit_card'],
57
+ 'zoho_desk_available': !(0, runtime_1.exists)(json, 'zoho_desk_available') ? undefined : json['zoho_desk_available'],
58
+ 'zoho_desk_departments': !(0, runtime_1.exists)(json, 'zoho_desk_departments') ? undefined : (json['zoho_desk_departments'].map(ConversationVirtualAgentCapabilityZohoDeskDepartment_1.ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON)),
55
59
  };
56
60
  }
57
61
  exports.ConversationVirtualAgentCapabilitiesFromJSONTyped = ConversationVirtualAgentCapabilitiesFromJSONTyped;
@@ -70,10 +74,13 @@ function ConversationVirtualAgentCapabilitiesToJSON(value) {
70
74
  'open_support_ticket': value.open_support_ticket,
71
75
  'open_support_ticket_channel': value.open_support_ticket_channel,
72
76
  'open_support_ticket_channel_email': value.open_support_ticket_channel_email,
77
+ 'open_support_ticket_zoho_desk_department_id': value.open_support_ticket_zoho_desk_department_id,
73
78
  'pause_subscription': value.pause_subscription,
74
79
  'resume_subscription': value.resume_subscription,
75
80
  'transfer_chat_to_live_agent': value.transfer_chat_to_live_agent,
76
81
  'update_subscription_credit_card': value.update_subscription_credit_card,
82
+ 'zoho_desk_available': value.zoho_desk_available,
83
+ 'zoho_desk_departments': value.zoho_desk_departments === undefined ? undefined : (value.zoho_desk_departments.map(ConversationVirtualAgentCapabilityZohoDeskDepartment_1.ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON)),
77
84
  };
78
85
  }
79
86
  exports.ConversationVirtualAgentCapabilitiesToJSON = ConversationVirtualAgentCapabilitiesToJSON;
@@ -0,0 +1,37 @@
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 ConversationVirtualAgentCapabilityZohoDeskDepartment
16
+ */
17
+ export interface ConversationVirtualAgentCapabilityZohoDeskDepartment {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof ConversationVirtualAgentCapabilityZohoDeskDepartment
22
+ */
23
+ department_id?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof ConversationVirtualAgentCapabilityZohoDeskDepartment
28
+ */
29
+ department_name?: string;
30
+ }
31
+ /**
32
+ * Check if a given object implements the ConversationVirtualAgentCapabilityZohoDeskDepartment interface.
33
+ */
34
+ export declare function instanceOfConversationVirtualAgentCapabilityZohoDeskDepartment(value: object): boolean;
35
+ export declare function ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON(json: any): ConversationVirtualAgentCapabilityZohoDeskDepartment;
36
+ export declare function ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationVirtualAgentCapabilityZohoDeskDepartment;
37
+ export declare function ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON(value?: ConversationVirtualAgentCapabilityZohoDeskDepartment | null): any;
@@ -0,0 +1,52 @@
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.ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON = exports.ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped = exports.ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON = exports.instanceOfConversationVirtualAgentCapabilityZohoDeskDepartment = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the ConversationVirtualAgentCapabilityZohoDeskDepartment interface.
20
+ */
21
+ function instanceOfConversationVirtualAgentCapabilityZohoDeskDepartment(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfConversationVirtualAgentCapabilityZohoDeskDepartment = instanceOfConversationVirtualAgentCapabilityZohoDeskDepartment;
26
+ function ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON(json) {
27
+ return ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped(json, false);
28
+ }
29
+ exports.ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON = ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON;
30
+ function ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'department_id': !(0, runtime_1.exists)(json, 'department_id') ? undefined : json['department_id'],
36
+ 'department_name': !(0, runtime_1.exists)(json, 'department_name') ? undefined : json['department_name'],
37
+ };
38
+ }
39
+ exports.ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped = ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped;
40
+ function ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON(value) {
41
+ if (value === undefined) {
42
+ return undefined;
43
+ }
44
+ if (value === null) {
45
+ return null;
46
+ }
47
+ return {
48
+ 'department_id': value.department_id,
49
+ 'department_name': value.department_name,
50
+ };
51
+ }
52
+ exports.ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON = ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON;
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { CustomDashboardExecutionParameter } from './CustomDashboardExecutionParameter';
12
13
  import { CustomDashboardPage } from './CustomDashboardPage';
13
14
  /**
14
15
  *
@@ -40,6 +41,12 @@ export interface CustomDashboard {
40
41
  * @memberof CustomDashboard
41
42
  */
42
43
  pages?: Array<CustomDashboardPage>;
44
+ /**
45
+ *
46
+ * @type {Array<CustomDashboardExecutionParameter>}
47
+ * @memberof CustomDashboard
48
+ */
49
+ parameters?: Array<CustomDashboardExecutionParameter>;
43
50
  }
44
51
  /**
45
52
  * Check if a given object implements the CustomDashboard interface.
@@ -15,6 +15,7 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.CustomDashboardToJSON = exports.CustomDashboardFromJSONTyped = exports.CustomDashboardFromJSON = exports.instanceOfCustomDashboard = void 0;
17
17
  var runtime_1 = require("../runtime");
18
+ var CustomDashboardExecutionParameter_1 = require("./CustomDashboardExecutionParameter");
18
19
  var CustomDashboardPage_1 = require("./CustomDashboardPage");
19
20
  /**
20
21
  * Check if a given object implements the CustomDashboard interface.
@@ -37,6 +38,7 @@ function CustomDashboardFromJSONTyped(json, ignoreDiscriminator) {
37
38
  'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
38
39
  'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
39
40
  'pages': !(0, runtime_1.exists)(json, 'pages') ? undefined : (json['pages'].map(CustomDashboardPage_1.CustomDashboardPageFromJSON)),
41
+ 'parameters': !(0, runtime_1.exists)(json, 'parameters') ? undefined : (json['parameters'].map(CustomDashboardExecutionParameter_1.CustomDashboardExecutionParameterFromJSON)),
40
42
  };
41
43
  }
42
44
  exports.CustomDashboardFromJSONTyped = CustomDashboardFromJSONTyped;
@@ -52,6 +54,7 @@ function CustomDashboardToJSON(value) {
52
54
  'merchant_id': value.merchant_id,
53
55
  'name': value.name,
54
56
  'pages': value.pages === undefined ? undefined : (value.pages.map(CustomDashboardPage_1.CustomDashboardPageToJSON)),
57
+ 'parameters': value.parameters === undefined ? undefined : (value.parameters.map(CustomDashboardExecutionParameter_1.CustomDashboardExecutionParameterToJSON)),
55
58
  };
56
59
  }
57
60
  exports.CustomDashboardToJSON = CustomDashboardToJSON;
@@ -0,0 +1,49 @@
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 CustomDashboardExecutionParameter
16
+ */
17
+ export interface CustomDashboardExecutionParameter {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof CustomDashboardExecutionParameter
22
+ */
23
+ name?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof CustomDashboardExecutionParameter
28
+ */
29
+ quick_pick_key?: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof CustomDashboardExecutionParameter
34
+ */
35
+ type?: string;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof CustomDashboardExecutionParameter
40
+ */
41
+ value?: string;
42
+ }
43
+ /**
44
+ * Check if a given object implements the CustomDashboardExecutionParameter interface.
45
+ */
46
+ export declare function instanceOfCustomDashboardExecutionParameter(value: object): boolean;
47
+ export declare function CustomDashboardExecutionParameterFromJSON(json: any): CustomDashboardExecutionParameter;
48
+ export declare function CustomDashboardExecutionParameterFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomDashboardExecutionParameter;
49
+ export declare function CustomDashboardExecutionParameterToJSON(value?: CustomDashboardExecutionParameter | null): any;
@@ -0,0 +1,56 @@
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.CustomDashboardExecutionParameterToJSON = exports.CustomDashboardExecutionParameterFromJSONTyped = exports.CustomDashboardExecutionParameterFromJSON = exports.instanceOfCustomDashboardExecutionParameter = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the CustomDashboardExecutionParameter interface.
20
+ */
21
+ function instanceOfCustomDashboardExecutionParameter(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfCustomDashboardExecutionParameter = instanceOfCustomDashboardExecutionParameter;
26
+ function CustomDashboardExecutionParameterFromJSON(json) {
27
+ return CustomDashboardExecutionParameterFromJSONTyped(json, false);
28
+ }
29
+ exports.CustomDashboardExecutionParameterFromJSON = CustomDashboardExecutionParameterFromJSON;
30
+ function CustomDashboardExecutionParameterFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
36
+ 'quick_pick_key': !(0, runtime_1.exists)(json, 'quick_pick_key') ? undefined : json['quick_pick_key'],
37
+ 'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
38
+ 'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
39
+ };
40
+ }
41
+ exports.CustomDashboardExecutionParameterFromJSONTyped = CustomDashboardExecutionParameterFromJSONTyped;
42
+ function CustomDashboardExecutionParameterToJSON(value) {
43
+ if (value === undefined) {
44
+ return undefined;
45
+ }
46
+ if (value === null) {
47
+ return null;
48
+ }
49
+ return {
50
+ 'name': value.name,
51
+ 'quick_pick_key': value.quick_pick_key,
52
+ 'type': value.type,
53
+ 'value': value.value,
54
+ };
55
+ }
56
+ exports.CustomDashboardExecutionParameterToJSON = CustomDashboardExecutionParameterToJSON;
@@ -21,6 +21,12 @@ export interface CustomReportExecutionParameter {
21
21
  * @memberof CustomReportExecutionParameter
22
22
  */
23
23
  name?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof CustomReportExecutionParameter
28
+ */
29
+ quick_pick_key?: string;
24
30
  /**
25
31
  *
26
32
  * @type {string}
@@ -33,6 +33,7 @@ function CustomReportExecutionParameterFromJSONTyped(json, ignoreDiscriminator)
33
33
  }
34
34
  return {
35
35
  'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
36
+ 'quick_pick_key': !(0, runtime_1.exists)(json, 'quick_pick_key') ? undefined : json['quick_pick_key'],
36
37
  'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
37
38
  'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
38
39
  };
@@ -47,6 +48,7 @@ function CustomReportExecutionParameterToJSON(value) {
47
48
  }
48
49
  return {
49
50
  'name': value.name,
51
+ 'quick_pick_key': value.quick_pick_key,
50
52
  'type': value.type,
51
53
  'value': value.value,
52
54
  };
@@ -0,0 +1,58 @@
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 { ModelError } from './ModelError';
13
+ import { ResponseMetadata } from './ResponseMetadata';
14
+ import { Warning } from './Warning';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface EmailEditorValuesResponse
19
+ */
20
+ export interface EmailEditorValuesResponse {
21
+ /**
22
+ *
23
+ * @type {ModelError}
24
+ * @memberof EmailEditorValuesResponse
25
+ */
26
+ error?: ModelError;
27
+ /**
28
+ *
29
+ * @type {Array<string>}
30
+ * @memberof EmailEditorValuesResponse
31
+ */
32
+ loyalty_tiers?: Array<string>;
33
+ /**
34
+ *
35
+ * @type {ResponseMetadata}
36
+ * @memberof EmailEditorValuesResponse
37
+ */
38
+ metadata?: ResponseMetadata;
39
+ /**
40
+ * Indicates if API call was successful
41
+ * @type {boolean}
42
+ * @memberof EmailEditorValuesResponse
43
+ */
44
+ success?: boolean;
45
+ /**
46
+ *
47
+ * @type {Warning}
48
+ * @memberof EmailEditorValuesResponse
49
+ */
50
+ warning?: Warning;
51
+ }
52
+ /**
53
+ * Check if a given object implements the EmailEditorValuesResponse interface.
54
+ */
55
+ export declare function instanceOfEmailEditorValuesResponse(value: object): boolean;
56
+ export declare function EmailEditorValuesResponseFromJSON(json: any): EmailEditorValuesResponse;
57
+ export declare function EmailEditorValuesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailEditorValuesResponse;
58
+ export declare function EmailEditorValuesResponseToJSON(value?: EmailEditorValuesResponse | null): any;