ultracart_rest_api_v2_typescript 4.1.18 → 4.1.20

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 (51) hide show
  1. package/.openapi-generator/FILES +5 -4
  2. package/README.md +4 -2
  3. package/dist/apis/DatawarehouseApi.d.ts +117 -1
  4. package/dist/apis/DatawarehouseApi.js +250 -0
  5. package/dist/apis/index.d.ts +0 -1
  6. package/dist/apis/index.js +0 -1
  7. package/dist/models/ConversationVirtualAgentCapabilities.d.ts +21 -2
  8. package/dist/models/ConversationVirtualAgentCapabilities.js +9 -2
  9. package/dist/models/ConversationVirtualAgentCapabilityZohoDeskDepartment.d.ts +37 -0
  10. package/dist/models/ConversationVirtualAgentCapabilityZohoDeskDepartment.js +52 -0
  11. package/dist/models/CustomDashboard.d.ts +7 -0
  12. package/dist/models/CustomDashboard.js +3 -0
  13. package/dist/models/CustomDashboardExecutionParameter.d.ts +49 -0
  14. package/dist/models/CustomDashboardExecutionParameter.js +56 -0
  15. package/dist/models/CustomDashboardSchedule.d.ts +55 -0
  16. package/dist/models/CustomDashboardSchedule.js +58 -0
  17. package/dist/models/CustomDashboardScheduleResponse.d.ts +59 -0
  18. package/dist/models/CustomDashboardScheduleResponse.js +62 -0
  19. package/dist/models/CustomDashboardSchedulesResponse.d.ts +59 -0
  20. package/dist/models/CustomDashboardSchedulesResponse.js +62 -0
  21. package/dist/models/CustomReport.d.ts +6 -0
  22. package/dist/models/CustomReport.js +2 -0
  23. package/dist/models/CustomReportExecutionParameter.d.ts +6 -0
  24. package/dist/models/CustomReportExecutionParameter.js +2 -0
  25. package/dist/models/EmailCampaign.d.ts +12 -0
  26. package/dist/models/EmailCampaign.js +4 -0
  27. package/dist/models/OrderPayment.d.ts +2 -0
  28. package/dist/models/OrderPayment.js +2 -0
  29. package/dist/models/index.d.ts +5 -3
  30. package/dist/models/index.js +5 -3
  31. package/package.json +1 -1
  32. package/src/apis/DatawarehouseApi.ts +282 -0
  33. package/src/apis/index.ts +0 -1
  34. package/src/models/ConversationVirtualAgentCapabilities.ts +33 -2
  35. package/src/models/ConversationVirtualAgentCapabilityZohoDeskDepartment.ts +75 -0
  36. package/src/models/CustomDashboard.ts +14 -0
  37. package/src/models/CustomDashboardExecutionParameter.ts +91 -0
  38. package/src/models/CustomDashboardSchedule.ts +99 -0
  39. package/src/models/{ChargebackDisputeResponse.ts → CustomDashboardScheduleResponse.ts} +25 -25
  40. package/src/models/{ChargebackDisputesResponse.ts → CustomDashboardSchedulesResponse.ts} +25 -25
  41. package/src/models/CustomReport.ts +8 -0
  42. package/src/models/CustomReportExecutionParameter.ts +8 -0
  43. package/src/models/EmailCampaign.ts +16 -0
  44. package/src/models/OrderPayment.ts +2 -0
  45. package/src/models/index.ts +5 -3
  46. package/dist/apis/ChargebackApi.d.ts +0 -191
  47. package/dist/models/ChargebackDispute.d.ts +0 -164
  48. package/dist/models/ChargebackDisputeResponse.d.ts +0 -59
  49. package/dist/models/ChargebackDisputesResponse.d.ts +0 -59
  50. package/src/apis/ChargebackApi.ts +0 -447
  51. package/src/models/ChargebackDispute.ts +0 -250
@@ -5,7 +5,6 @@ package.json
5
5
  src/apis/AffiliateApi.ts
6
6
  src/apis/AutoOrderApi.ts
7
7
  src/apis/ChannelPartnerApi.ts
8
- src/apis/ChargebackApi.ts
9
8
  src/apis/CheckoutApi.ts
10
9
  src/apis/ConversationApi.ts
11
10
  src/apis/CouponApi.ts
@@ -145,9 +144,6 @@ src/models/ChannelPartnerShipToPreferenceResponse.ts
145
144
  src/models/ChannelPartnerShipToPreferencesResponse.ts
146
145
  src/models/ChannelPartnerShippingEstimate.ts
147
146
  src/models/ChannelPartnersResponse.ts
148
- src/models/ChargebackDispute.ts
149
- src/models/ChargebackDisputeResponse.ts
150
- src/models/ChargebackDisputesResponse.ts
151
147
  src/models/CheckoutAllowedCountriesResponse.ts
152
148
  src/models/CheckoutHandoffRequest.ts
153
149
  src/models/CheckoutHandoffResponse.ts
@@ -249,6 +245,7 @@ src/models/ConversationVirtualAgentBudget.ts
249
245
  src/models/ConversationVirtualAgentBudgetResponse.ts
250
246
  src/models/ConversationVirtualAgentCapabilities.ts
251
247
  src/models/ConversationVirtualAgentCapabilitiesResponse.ts
248
+ src/models/ConversationVirtualAgentCapabilityZohoDeskDepartment.ts
252
249
  src/models/ConversationWebchatContext.ts
253
250
  src/models/ConversationWebchatQueueStatus.ts
254
251
  src/models/ConversationWebchatQueueStatusAgent.ts
@@ -330,9 +327,13 @@ src/models/CouponsRequest.ts
330
327
  src/models/CouponsResponse.ts
331
328
  src/models/Currency.ts
332
329
  src/models/CustomDashboard.ts
330
+ src/models/CustomDashboardExecutionParameter.ts
333
331
  src/models/CustomDashboardPage.ts
334
332
  src/models/CustomDashboardPageReport.ts
335
333
  src/models/CustomDashboardResponse.ts
334
+ src/models/CustomDashboardSchedule.ts
335
+ src/models/CustomDashboardScheduleResponse.ts
336
+ src/models/CustomDashboardSchedulesResponse.ts
336
337
  src/models/CustomDashboardsResponse.ts
337
338
  src/models/CustomReport.ts
338
339
  src/models/CustomReportAccountConfig.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.18
2
+ ## ultracart_rest_api_v2_typescript@4.1.20
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.18 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.20 --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.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
89
+ | 4.1.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
88
90
  | 4.1.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
89
91
  | 4.1.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
90
92
  | 4.1.16 | 07/28/2025 | updated doc samples |
@@ -10,10 +10,14 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { CustomDashboard, CustomDashboardResponse, CustomDashboardsResponse, CustomReport, CustomReportAccountConfig, CustomReportAccountConfigResponse, CustomReportExecutionRequest, CustomReportExecutionResponse, CustomReportResponse, CustomReportsExecutionRequest, CustomReportsExecutionResponse, CustomReportsResponse, Report, ReportAuthResponse, ReportDataSetPageResponse, ReportDataSetResponse, ReportDryRunQueriesRequest, ReportDryRunQueriesResponse, ReportExecuteQueriesRequest, ReportResponse, ReportsResponse } from '../models';
13
+ import { CustomDashboard, CustomDashboardResponse, CustomDashboardSchedule, CustomDashboardScheduleResponse, CustomDashboardSchedulesResponse, CustomDashboardsResponse, CustomReport, CustomReportAccountConfig, CustomReportAccountConfigResponse, CustomReportExecutionRequest, CustomReportExecutionResponse, CustomReportResponse, CustomReportsExecutionRequest, CustomReportsExecutionResponse, CustomReportsResponse, Report, ReportAuthResponse, ReportDataSetPageResponse, ReportDataSetResponse, ReportDryRunQueriesRequest, ReportDryRunQueriesResponse, ReportExecuteQueriesRequest, ReportResponse, ReportsResponse } from '../models';
14
14
  export interface DeleteCustomDashboardRequest {
15
15
  customDashboardOid: number;
16
16
  }
17
+ export interface DeleteCustomDashboardScheduleRequest {
18
+ customDashboardScheduleOid: number;
19
+ customDashboardOid: number;
20
+ }
17
21
  export interface DeleteCustomReportRequest {
18
22
  customReportOid: number;
19
23
  }
@@ -36,6 +40,9 @@ export interface ExecuteReportQueriesRequest {
36
40
  export interface GetCustomDashboardRequest {
37
41
  customDashboardOid: number;
38
42
  }
43
+ export interface GetCustomDashboardSchedulesRequest {
44
+ customDashboardOid: number;
45
+ }
39
46
  export interface GetCustomReportRequest {
40
47
  customReportOid: number;
41
48
  }
@@ -52,6 +59,10 @@ export interface GetReportDataSetPageRequest {
52
59
  export interface InsertCustomDashboardRequest {
53
60
  dashboard: CustomDashboard;
54
61
  }
62
+ export interface InsertCustomDashboardScheduleRequest {
63
+ customDashboardOid: number;
64
+ dashboardSchedule: CustomDashboardSchedule;
65
+ }
55
66
  export interface InsertCustomReportRequest {
56
67
  report: CustomReport;
57
68
  }
@@ -62,6 +73,11 @@ export interface UpdateCustomDashboardRequest {
62
73
  customDashboardOid: number;
63
74
  dashboard: CustomDashboard;
64
75
  }
76
+ export interface UpdateCustomDashboardScheduleRequest {
77
+ customDashboardScheduleOid: number;
78
+ customDashboardOid: number;
79
+ dashboardSchedule: CustomDashboardSchedule;
80
+ }
65
81
  export interface UpdateCustomReportRequest {
66
82
  customReportOid: number;
67
83
  report: CustomReport;
@@ -94,6 +110,21 @@ export interface DatawarehouseApiInterface {
94
110
  * Delete a custom dashboard
95
111
  */
96
112
  deleteCustomDashboard(requestParameters: DeleteCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
113
+ /**
114
+ * delete a custom dashboard schedule on the UltraCart account.
115
+ * @summary Delete a custom dashboard schedule
116
+ * @param {number} customDashboardScheduleOid The dashboard schedule oid to delete.
117
+ * @param {number} customDashboardOid The dashboard oid that owns the schedule.
118
+ * @param {*} [options] Override http request option.
119
+ * @throws {RequiredError}
120
+ * @memberof DatawarehouseApiInterface
121
+ */
122
+ deleteCustomDashboardScheduleRaw(requestParameters: DeleteCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
123
+ /**
124
+ * delete a custom dashboard schedule on the UltraCart account.
125
+ * Delete a custom dashboard schedule
126
+ */
127
+ deleteCustomDashboardSchedule(requestParameters: DeleteCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
97
128
  /**
98
129
  * Delete a custom report on the UltraCart account.
99
130
  * @summary Delete a custom report
@@ -193,6 +224,20 @@ export interface DatawarehouseApiInterface {
193
224
  * Get a custom dashboard
194
225
  */
195
226
  getCustomDashboard(requestParameters: GetCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
227
+ /**
228
+ * Retrieve a custom dashboards
229
+ * @summary Get custom dashboards
230
+ * @param {number} customDashboardOid
231
+ * @param {*} [options] Override http request option.
232
+ * @throws {RequiredError}
233
+ * @memberof DatawarehouseApiInterface
234
+ */
235
+ getCustomDashboardSchedulesRaw(requestParameters: GetCustomDashboardSchedulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardSchedulesResponse>>;
236
+ /**
237
+ * Retrieve a custom dashboards
238
+ * Get custom dashboards
239
+ */
240
+ getCustomDashboardSchedules(requestParameters: GetCustomDashboardSchedulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardSchedulesResponse>;
196
241
  /**
197
242
  * Retrieve a custom dashboards
198
243
  * @summary Get custom dashboards
@@ -329,6 +374,21 @@ export interface DatawarehouseApiInterface {
329
374
  * Create a custom dashboard
330
375
  */
331
376
  insertCustomDashboard(requestParameters: InsertCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
377
+ /**
378
+ * Create a new custom dashboard schedule on the UltraCart account.
379
+ * @summary Create a custom dashboard schedule
380
+ * @param {number} customDashboardOid
381
+ * @param {CustomDashboardSchedule} dashboardSchedule Dashboard schedule to create
382
+ * @param {*} [options] Override http request option.
383
+ * @throws {RequiredError}
384
+ * @memberof DatawarehouseApiInterface
385
+ */
386
+ insertCustomDashboardScheduleRaw(requestParameters: InsertCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardScheduleResponse>>;
387
+ /**
388
+ * Create a new custom dashboard schedule on the UltraCart account.
389
+ * Create a custom dashboard schedule
390
+ */
391
+ insertCustomDashboardSchedule(requestParameters: InsertCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardScheduleResponse>;
332
392
  /**
333
393
  * Create a new custom report on the UltraCart account.
334
394
  * @summary Create a custom report
@@ -372,6 +432,22 @@ export interface DatawarehouseApiInterface {
372
432
  * Update a custom dashboard
373
433
  */
374
434
  updateCustomDashboard(requestParameters: UpdateCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
435
+ /**
436
+ * Update a custom dashboard schedule on the UltraCart account.
437
+ * @summary Update a custom dashboard schedule
438
+ * @param {number} customDashboardScheduleOid The dashboard schedule oid to update.
439
+ * @param {number} customDashboardOid The dashboard oid to update.
440
+ * @param {CustomDashboardSchedule} dashboardSchedule Dashboard schedule to update
441
+ * @param {*} [options] Override http request option.
442
+ * @throws {RequiredError}
443
+ * @memberof DatawarehouseApiInterface
444
+ */
445
+ updateCustomDashboardScheduleRaw(requestParameters: UpdateCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardResponse>>;
446
+ /**
447
+ * Update a custom dashboard schedule on the UltraCart account.
448
+ * Update a custom dashboard schedule
449
+ */
450
+ updateCustomDashboardSchedule(requestParameters: UpdateCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
375
451
  /**
376
452
  * Update a custom report on the UltraCart account.
377
453
  * @summary Update a custom report
@@ -431,6 +507,16 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
431
507
  * Delete a custom dashboard
432
508
  */
433
509
  deleteCustomDashboard(requestParameters: DeleteCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
510
+ /**
511
+ * delete a custom dashboard schedule on the UltraCart account.
512
+ * Delete a custom dashboard schedule
513
+ */
514
+ deleteCustomDashboardScheduleRaw(requestParameters: DeleteCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
515
+ /**
516
+ * delete a custom dashboard schedule on the UltraCart account.
517
+ * Delete a custom dashboard schedule
518
+ */
519
+ deleteCustomDashboardSchedule(requestParameters: DeleteCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
434
520
  /**
435
521
  * Delete a custom report on the UltraCart account.
436
522
  * Delete a custom report
@@ -501,6 +587,16 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
501
587
  * Get a custom dashboard
502
588
  */
503
589
  getCustomDashboard(requestParameters: GetCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
590
+ /**
591
+ * Retrieve a custom dashboards
592
+ * Get custom dashboards
593
+ */
594
+ getCustomDashboardSchedulesRaw(requestParameters: GetCustomDashboardSchedulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardSchedulesResponse>>;
595
+ /**
596
+ * Retrieve a custom dashboards
597
+ * Get custom dashboards
598
+ */
599
+ getCustomDashboardSchedules(requestParameters: GetCustomDashboardSchedulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardSchedulesResponse>;
504
600
  /**
505
601
  * Retrieve a custom dashboards
506
602
  * Get custom dashboards
@@ -601,6 +697,16 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
601
697
  * Create a custom dashboard
602
698
  */
603
699
  insertCustomDashboard(requestParameters: InsertCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
700
+ /**
701
+ * Create a new custom dashboard schedule on the UltraCart account.
702
+ * Create a custom dashboard schedule
703
+ */
704
+ insertCustomDashboardScheduleRaw(requestParameters: InsertCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardScheduleResponse>>;
705
+ /**
706
+ * Create a new custom dashboard schedule on the UltraCart account.
707
+ * Create a custom dashboard schedule
708
+ */
709
+ insertCustomDashboardSchedule(requestParameters: InsertCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardScheduleResponse>;
604
710
  /**
605
711
  * Create a new custom report on the UltraCart account.
606
712
  * Create a custom report
@@ -631,6 +737,16 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
631
737
  * Update a custom dashboard
632
738
  */
633
739
  updateCustomDashboard(requestParameters: UpdateCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
740
+ /**
741
+ * Update a custom dashboard schedule on the UltraCart account.
742
+ * Update a custom dashboard schedule
743
+ */
744
+ updateCustomDashboardScheduleRaw(requestParameters: UpdateCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardResponse>>;
745
+ /**
746
+ * Update a custom dashboard schedule on the UltraCart account.
747
+ * Update a custom dashboard schedule
748
+ */
749
+ updateCustomDashboardSchedule(requestParameters: UpdateCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
634
750
  /**
635
751
  * Update a custom report on the UltraCart account.
636
752
  * Update a custom report
@@ -132,6 +132,66 @@ var DatawarehouseApi = /** @class */ (function (_super) {
132
132
  });
133
133
  });
134
134
  };
135
+ /**
136
+ * delete a custom dashboard schedule on the UltraCart account.
137
+ * Delete a custom dashboard schedule
138
+ */
139
+ DatawarehouseApi.prototype.deleteCustomDashboardScheduleRaw = function (requestParameters, initOverrides) {
140
+ return __awaiter(this, void 0, void 0, function () {
141
+ var queryParameters, headerParameters, _a, _b, response;
142
+ return __generator(this, function (_c) {
143
+ switch (_c.label) {
144
+ case 0:
145
+ if (requestParameters.customDashboardScheduleOid === null || requestParameters.customDashboardScheduleOid === undefined) {
146
+ throw new runtime.RequiredError('customDashboardScheduleOid', 'Required parameter requestParameters.customDashboardScheduleOid was null or undefined when calling deleteCustomDashboardSchedule.');
147
+ }
148
+ if (requestParameters.customDashboardOid === null || requestParameters.customDashboardOid === undefined) {
149
+ throw new runtime.RequiredError('customDashboardOid', 'Required parameter requestParameters.customDashboardOid was null or undefined when calling deleteCustomDashboardSchedule.');
150
+ }
151
+ queryParameters = {};
152
+ headerParameters = {};
153
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
154
+ // oauth required
155
+ _a = headerParameters;
156
+ _b = "Authorization";
157
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
158
+ case 1:
159
+ // oauth required
160
+ _a[_b] = _c.sent();
161
+ _c.label = 2;
162
+ case 2:
163
+ if (this.configuration && this.configuration.apiKey) {
164
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
165
+ }
166
+ return [4 /*yield*/, this.request({
167
+ path: "/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid}".replace("{".concat("custom_dashboard_schedule_oid", "}"), encodeURIComponent(String(requestParameters.customDashboardScheduleOid))).replace("{".concat("custom_dashboard_oid", "}"), encodeURIComponent(String(requestParameters.customDashboardOid))),
168
+ method: 'DELETE',
169
+ headers: headerParameters,
170
+ query: queryParameters,
171
+ }, initOverrides)];
172
+ case 3:
173
+ response = _c.sent();
174
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
175
+ }
176
+ });
177
+ });
178
+ };
179
+ /**
180
+ * delete a custom dashboard schedule on the UltraCart account.
181
+ * Delete a custom dashboard schedule
182
+ */
183
+ DatawarehouseApi.prototype.deleteCustomDashboardSchedule = function (requestParameters, initOverrides) {
184
+ return __awaiter(this, void 0, void 0, function () {
185
+ return __generator(this, function (_a) {
186
+ switch (_a.label) {
187
+ case 0: return [4 /*yield*/, this.deleteCustomDashboardScheduleRaw(requestParameters, initOverrides)];
188
+ case 1:
189
+ _a.sent();
190
+ return [2 /*return*/];
191
+ }
192
+ });
193
+ });
194
+ };
135
195
  /**
136
196
  * Delete a custom report on the UltraCart account.
137
197
  * Delete a custom report
@@ -550,6 +610,65 @@ var DatawarehouseApi = /** @class */ (function (_super) {
550
610
  });
551
611
  });
552
612
  };
613
+ /**
614
+ * Retrieve a custom dashboards
615
+ * Get custom dashboards
616
+ */
617
+ DatawarehouseApi.prototype.getCustomDashboardSchedulesRaw = function (requestParameters, initOverrides) {
618
+ return __awaiter(this, void 0, void 0, function () {
619
+ var queryParameters, headerParameters, _a, _b, response;
620
+ return __generator(this, function (_c) {
621
+ switch (_c.label) {
622
+ case 0:
623
+ if (requestParameters.customDashboardOid === null || requestParameters.customDashboardOid === undefined) {
624
+ throw new runtime.RequiredError('customDashboardOid', 'Required parameter requestParameters.customDashboardOid was null or undefined when calling getCustomDashboardSchedules.');
625
+ }
626
+ queryParameters = {};
627
+ headerParameters = {};
628
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
629
+ // oauth required
630
+ _a = headerParameters;
631
+ _b = "Authorization";
632
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
633
+ case 1:
634
+ // oauth required
635
+ _a[_b] = _c.sent();
636
+ _c.label = 2;
637
+ case 2:
638
+ if (this.configuration && this.configuration.apiKey) {
639
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
640
+ }
641
+ return [4 /*yield*/, this.request({
642
+ path: "/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules".replace("{".concat("custom_dashboard_oid", "}"), encodeURIComponent(String(requestParameters.customDashboardOid))),
643
+ method: 'GET',
644
+ headers: headerParameters,
645
+ query: queryParameters,
646
+ }, initOverrides)];
647
+ case 3:
648
+ response = _c.sent();
649
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.CustomDashboardSchedulesResponseFromJSON)(jsonValue); })];
650
+ }
651
+ });
652
+ });
653
+ };
654
+ /**
655
+ * Retrieve a custom dashboards
656
+ * Get custom dashboards
657
+ */
658
+ DatawarehouseApi.prototype.getCustomDashboardSchedules = function (requestParameters, initOverrides) {
659
+ return __awaiter(this, void 0, void 0, function () {
660
+ var response;
661
+ return __generator(this, function (_a) {
662
+ switch (_a.label) {
663
+ case 0: return [4 /*yield*/, this.getCustomDashboardSchedulesRaw(requestParameters, initOverrides)];
664
+ case 1:
665
+ response = _a.sent();
666
+ return [4 /*yield*/, response.value()];
667
+ case 2: return [2 /*return*/, _a.sent()];
668
+ }
669
+ });
670
+ });
671
+ };
553
672
  /**
554
673
  * Retrieve a custom dashboards
555
674
  * Get custom dashboards
@@ -1130,6 +1249,70 @@ var DatawarehouseApi = /** @class */ (function (_super) {
1130
1249
  });
1131
1250
  });
1132
1251
  };
1252
+ /**
1253
+ * Create a new custom dashboard schedule on the UltraCart account.
1254
+ * Create a custom dashboard schedule
1255
+ */
1256
+ DatawarehouseApi.prototype.insertCustomDashboardScheduleRaw = function (requestParameters, initOverrides) {
1257
+ return __awaiter(this, void 0, void 0, function () {
1258
+ var queryParameters, headerParameters, _a, _b, response;
1259
+ return __generator(this, function (_c) {
1260
+ switch (_c.label) {
1261
+ case 0:
1262
+ if (requestParameters.customDashboardOid === null || requestParameters.customDashboardOid === undefined) {
1263
+ throw new runtime.RequiredError('customDashboardOid', 'Required parameter requestParameters.customDashboardOid was null or undefined when calling insertCustomDashboardSchedule.');
1264
+ }
1265
+ if (requestParameters.dashboardSchedule === null || requestParameters.dashboardSchedule === undefined) {
1266
+ throw new runtime.RequiredError('dashboardSchedule', 'Required parameter requestParameters.dashboardSchedule was null or undefined when calling insertCustomDashboardSchedule.');
1267
+ }
1268
+ queryParameters = {};
1269
+ headerParameters = {};
1270
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
1271
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
1272
+ // oauth required
1273
+ _a = headerParameters;
1274
+ _b = "Authorization";
1275
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
1276
+ case 1:
1277
+ // oauth required
1278
+ _a[_b] = _c.sent();
1279
+ _c.label = 2;
1280
+ case 2:
1281
+ if (this.configuration && this.configuration.apiKey) {
1282
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
1283
+ }
1284
+ return [4 /*yield*/, this.request({
1285
+ path: "/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules".replace("{".concat("custom_dashboard_oid", "}"), encodeURIComponent(String(requestParameters.customDashboardOid))),
1286
+ method: 'POST',
1287
+ headers: headerParameters,
1288
+ query: queryParameters,
1289
+ body: (0, models_1.CustomDashboardScheduleToJSON)(requestParameters.dashboardSchedule),
1290
+ }, initOverrides)];
1291
+ case 3:
1292
+ response = _c.sent();
1293
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.CustomDashboardScheduleResponseFromJSON)(jsonValue); })];
1294
+ }
1295
+ });
1296
+ });
1297
+ };
1298
+ /**
1299
+ * Create a new custom dashboard schedule on the UltraCart account.
1300
+ * Create a custom dashboard schedule
1301
+ */
1302
+ DatawarehouseApi.prototype.insertCustomDashboardSchedule = function (requestParameters, initOverrides) {
1303
+ return __awaiter(this, void 0, void 0, function () {
1304
+ var response;
1305
+ return __generator(this, function (_a) {
1306
+ switch (_a.label) {
1307
+ case 0: return [4 /*yield*/, this.insertCustomDashboardScheduleRaw(requestParameters, initOverrides)];
1308
+ case 1:
1309
+ response = _a.sent();
1310
+ return [4 /*yield*/, response.value()];
1311
+ case 2: return [2 /*return*/, _a.sent()];
1312
+ }
1313
+ });
1314
+ });
1315
+ };
1133
1316
  /**
1134
1317
  * Create a new custom report on the UltraCart account.
1135
1318
  * Create a custom report
@@ -1316,6 +1499,73 @@ var DatawarehouseApi = /** @class */ (function (_super) {
1316
1499
  });
1317
1500
  });
1318
1501
  };
1502
+ /**
1503
+ * Update a custom dashboard schedule on the UltraCart account.
1504
+ * Update a custom dashboard schedule
1505
+ */
1506
+ DatawarehouseApi.prototype.updateCustomDashboardScheduleRaw = function (requestParameters, initOverrides) {
1507
+ return __awaiter(this, void 0, void 0, function () {
1508
+ var queryParameters, headerParameters, _a, _b, response;
1509
+ return __generator(this, function (_c) {
1510
+ switch (_c.label) {
1511
+ case 0:
1512
+ if (requestParameters.customDashboardScheduleOid === null || requestParameters.customDashboardScheduleOid === undefined) {
1513
+ throw new runtime.RequiredError('customDashboardScheduleOid', 'Required parameter requestParameters.customDashboardScheduleOid was null or undefined when calling updateCustomDashboardSchedule.');
1514
+ }
1515
+ if (requestParameters.customDashboardOid === null || requestParameters.customDashboardOid === undefined) {
1516
+ throw new runtime.RequiredError('customDashboardOid', 'Required parameter requestParameters.customDashboardOid was null or undefined when calling updateCustomDashboardSchedule.');
1517
+ }
1518
+ if (requestParameters.dashboardSchedule === null || requestParameters.dashboardSchedule === undefined) {
1519
+ throw new runtime.RequiredError('dashboardSchedule', 'Required parameter requestParameters.dashboardSchedule was null or undefined when calling updateCustomDashboardSchedule.');
1520
+ }
1521
+ queryParameters = {};
1522
+ headerParameters = {};
1523
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
1524
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
1525
+ // oauth required
1526
+ _a = headerParameters;
1527
+ _b = "Authorization";
1528
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
1529
+ case 1:
1530
+ // oauth required
1531
+ _a[_b] = _c.sent();
1532
+ _c.label = 2;
1533
+ case 2:
1534
+ if (this.configuration && this.configuration.apiKey) {
1535
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
1536
+ }
1537
+ return [4 /*yield*/, this.request({
1538
+ path: "/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid}".replace("{".concat("custom_dashboard_schedule_oid", "}"), encodeURIComponent(String(requestParameters.customDashboardScheduleOid))).replace("{".concat("custom_dashboard_oid", "}"), encodeURIComponent(String(requestParameters.customDashboardOid))),
1539
+ method: 'PUT',
1540
+ headers: headerParameters,
1541
+ query: queryParameters,
1542
+ body: (0, models_1.CustomDashboardScheduleToJSON)(requestParameters.dashboardSchedule),
1543
+ }, initOverrides)];
1544
+ case 3:
1545
+ response = _c.sent();
1546
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.CustomDashboardResponseFromJSON)(jsonValue); })];
1547
+ }
1548
+ });
1549
+ });
1550
+ };
1551
+ /**
1552
+ * Update a custom dashboard schedule on the UltraCart account.
1553
+ * Update a custom dashboard schedule
1554
+ */
1555
+ DatawarehouseApi.prototype.updateCustomDashboardSchedule = function (requestParameters, initOverrides) {
1556
+ return __awaiter(this, void 0, void 0, function () {
1557
+ var response;
1558
+ return __generator(this, function (_a) {
1559
+ switch (_a.label) {
1560
+ case 0: return [4 /*yield*/, this.updateCustomDashboardScheduleRaw(requestParameters, initOverrides)];
1561
+ case 1:
1562
+ response = _a.sent();
1563
+ return [4 /*yield*/, response.value()];
1564
+ case 2: return [2 /*return*/, _a.sent()];
1565
+ }
1566
+ });
1567
+ });
1568
+ };
1319
1569
  /**
1320
1570
  * Update a custom report on the UltraCart account.
1321
1571
  * Update a custom report
@@ -1,7 +1,6 @@
1
1
  export * from './AffiliateApi';
2
2
  export * from './AutoOrderApi';
3
3
  export * from './ChannelPartnerApi';
4
- export * from './ChargebackApi';
5
4
  export * from './CheckoutApi';
6
5
  export * from './ConversationApi';
7
6
  export * from './CouponApi';
@@ -19,7 +19,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
19
19
  __exportStar(require("./AffiliateApi"), exports);
20
20
  __exportStar(require("./AutoOrderApi"), exports);
21
21
  __exportStar(require("./ChannelPartnerApi"), exports);
22
- __exportStar(require("./ChargebackApi"), exports);
23
22
  __exportStar(require("./CheckoutApi"), exports);
24
23
  __exportStar(require("./ConversationApi"), exports);
25
24
  __exportStar(require("./CouponApi"), exports);
@@ -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;