ultracart_rest_api_v2_typescript 4.0.209 → 4.0.210

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.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@4.0.209
1
+ ## ultracart_rest_api_v2_typescript@4.0.210
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.209 --save
39
+ npm install ultracart_rest_api_v2_typescript@4.0.210 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 4.0.210 | 04/04/2024 | AutoOrder.calculated_next_shipment_dts |
57
58
  | 4.0.209 | 04/01/2024 | added merchant_id as read-only top level property of AutoOrder object |
58
59
  | 4.0.208 | 03/26/2024 | WorkflowTask - added assigned_to_user_or_group field |
59
60
  | 4.0.207 | 03/25/2024 | workflowtask - add global_task_number and object_task_number |
@@ -38,6 +38,10 @@ export interface DeletePbxPhoneNumberRequest {
38
38
  export interface DeletePbxQueueRequest {
39
39
  conversationPbxQueueUuid: string;
40
40
  }
41
+ export interface DeletePbxQueueVoicemailRequest {
42
+ queueUuid: string;
43
+ recordingSid: string;
44
+ }
41
45
  export interface DeletePbxTimeBasedRequest {
42
46
  conversationPbxTimeBasedUuid: string;
43
47
  }
@@ -160,6 +164,10 @@ export interface LeaveConversationRequest {
160
164
  export interface ListenedPbxAgentVoicemailRequest {
161
165
  recordingSid: string;
162
166
  }
167
+ export interface ListenedPbxQueueVoicemailRequest {
168
+ queueUuid: string;
169
+ recordingSid: string;
170
+ }
163
171
  export interface MarkReadConversationRequest {
164
172
  conversationUuid: string;
165
173
  }
@@ -359,6 +367,21 @@ export interface ConversationApiInterface {
359
367
  * Delete pbx queue
360
368
  */
361
369
  deletePbxQueue(requestParameters: DeletePbxQueueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxQueueResponse>;
370
+ /**
371
+ * Delete pbx queue Voicemail
372
+ * @summary Delete Queue Voicemail
373
+ * @param {string} queueUuid
374
+ * @param {string} recordingSid
375
+ * @param {*} [options] Override http request option.
376
+ * @throws {RequiredError}
377
+ * @memberof ConversationApiInterface
378
+ */
379
+ deletePbxQueueVoicemailRaw(requestParameters: DeletePbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
380
+ /**
381
+ * Delete pbx queue Voicemail
382
+ * Delete Queue Voicemail
383
+ */
384
+ deletePbxQueueVoicemail(requestParameters: DeletePbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
362
385
  /**
363
386
  * Delete a pbx timeBased
364
387
  * @summary Delete pbx timeBased
@@ -1146,6 +1169,21 @@ export interface ConversationApiInterface {
1146
1169
  * Listened Agent Voicemail
1147
1170
  */
1148
1171
  listenedPbxAgentVoicemail(requestParameters: ListenedPbxAgentVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1172
+ /**
1173
+ * Listened pbx queue Voicemail
1174
+ * @summary Listened Queue Voicemail
1175
+ * @param {string} queueUuid
1176
+ * @param {string} recordingSid
1177
+ * @param {*} [options] Override http request option.
1178
+ * @throws {RequiredError}
1179
+ * @memberof ConversationApiInterface
1180
+ */
1181
+ listenedPbxQueueVoicemailRaw(requestParameters: ListenedPbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
1182
+ /**
1183
+ * Listened pbx queue Voicemail
1184
+ * Listened Queue Voicemail
1185
+ */
1186
+ listenedPbxQueueVoicemail(requestParameters: ListenedPbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1149
1187
  /**
1150
1188
  * Mark a conversation as read
1151
1189
  * @summary Mark a conversation as read
@@ -1505,6 +1543,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
1505
1543
  * Delete pbx queue
1506
1544
  */
1507
1545
  deletePbxQueue(requestParameters: DeletePbxQueueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxQueueResponse>;
1546
+ /**
1547
+ * Delete pbx queue Voicemail
1548
+ * Delete Queue Voicemail
1549
+ */
1550
+ deletePbxQueueVoicemailRaw(requestParameters: DeletePbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
1551
+ /**
1552
+ * Delete pbx queue Voicemail
1553
+ * Delete Queue Voicemail
1554
+ */
1555
+ deletePbxQueueVoicemail(requestParameters: DeletePbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1508
1556
  /**
1509
1557
  * Delete a pbx timeBased
1510
1558
  * Delete pbx timeBased
@@ -2075,6 +2123,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
2075
2123
  * Listened Agent Voicemail
2076
2124
  */
2077
2125
  listenedPbxAgentVoicemail(requestParameters: ListenedPbxAgentVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
2126
+ /**
2127
+ * Listened pbx queue Voicemail
2128
+ * Listened Queue Voicemail
2129
+ */
2130
+ listenedPbxQueueVoicemailRaw(requestParameters: ListenedPbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
2131
+ /**
2132
+ * Listened pbx queue Voicemail
2133
+ * Listened Queue Voicemail
2134
+ */
2135
+ listenedPbxQueueVoicemail(requestParameters: ListenedPbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
2078
2136
  /**
2079
2137
  * Mark a conversation as read
2080
2138
  * Mark a conversation as read
@@ -598,6 +598,66 @@ var ConversationApi = /** @class */ (function (_super) {
598
598
  });
599
599
  });
600
600
  };
601
+ /**
602
+ * Delete pbx queue Voicemail
603
+ * Delete Queue Voicemail
604
+ */
605
+ ConversationApi.prototype.deletePbxQueueVoicemailRaw = function (requestParameters, initOverrides) {
606
+ return __awaiter(this, void 0, void 0, function () {
607
+ var queryParameters, headerParameters, _a, _b, response;
608
+ return __generator(this, function (_c) {
609
+ switch (_c.label) {
610
+ case 0:
611
+ if (requestParameters.queueUuid === null || requestParameters.queueUuid === undefined) {
612
+ throw new runtime.RequiredError('queueUuid', 'Required parameter requestParameters.queueUuid was null or undefined when calling deletePbxQueueVoicemail.');
613
+ }
614
+ if (requestParameters.recordingSid === null || requestParameters.recordingSid === undefined) {
615
+ throw new runtime.RequiredError('recordingSid', 'Required parameter requestParameters.recordingSid was null or undefined when calling deletePbxQueueVoicemail.');
616
+ }
617
+ queryParameters = {};
618
+ headerParameters = {};
619
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
620
+ // oauth required
621
+ _a = headerParameters;
622
+ _b = "Authorization";
623
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_write"])];
624
+ case 1:
625
+ // oauth required
626
+ _a[_b] = _c.sent();
627
+ _c.label = 2;
628
+ case 2:
629
+ if (this.configuration && this.configuration.apiKey) {
630
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
631
+ }
632
+ return [4 /*yield*/, this.request({
633
+ path: "/conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}".replace("{".concat("queue_uuid", "}"), encodeURIComponent(String(requestParameters.queueUuid))).replace("{".concat("recording_sid", "}"), encodeURIComponent(String(requestParameters.recordingSid))),
634
+ method: 'DELETE',
635
+ headers: headerParameters,
636
+ query: queryParameters,
637
+ }, initOverrides)];
638
+ case 3:
639
+ response = _c.sent();
640
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
641
+ }
642
+ });
643
+ });
644
+ };
645
+ /**
646
+ * Delete pbx queue Voicemail
647
+ * Delete Queue Voicemail
648
+ */
649
+ ConversationApi.prototype.deletePbxQueueVoicemail = function (requestParameters, initOverrides) {
650
+ return __awaiter(this, void 0, void 0, function () {
651
+ return __generator(this, function (_a) {
652
+ switch (_a.label) {
653
+ case 0: return [4 /*yield*/, this.deletePbxQueueVoicemailRaw(requestParameters, initOverrides)];
654
+ case 1:
655
+ _a.sent();
656
+ return [2 /*return*/];
657
+ }
658
+ });
659
+ });
660
+ };
601
661
  /**
602
662
  * Delete a pbx timeBased
603
663
  * Delete pbx timeBased
@@ -3948,6 +4008,66 @@ var ConversationApi = /** @class */ (function (_super) {
3948
4008
  });
3949
4009
  });
3950
4010
  };
4011
+ /**
4012
+ * Listened pbx queue Voicemail
4013
+ * Listened Queue Voicemail
4014
+ */
4015
+ ConversationApi.prototype.listenedPbxQueueVoicemailRaw = function (requestParameters, initOverrides) {
4016
+ return __awaiter(this, void 0, void 0, function () {
4017
+ var queryParameters, headerParameters, _a, _b, response;
4018
+ return __generator(this, function (_c) {
4019
+ switch (_c.label) {
4020
+ case 0:
4021
+ if (requestParameters.queueUuid === null || requestParameters.queueUuid === undefined) {
4022
+ throw new runtime.RequiredError('queueUuid', 'Required parameter requestParameters.queueUuid was null or undefined when calling listenedPbxQueueVoicemail.');
4023
+ }
4024
+ if (requestParameters.recordingSid === null || requestParameters.recordingSid === undefined) {
4025
+ throw new runtime.RequiredError('recordingSid', 'Required parameter requestParameters.recordingSid was null or undefined when calling listenedPbxQueueVoicemail.');
4026
+ }
4027
+ queryParameters = {};
4028
+ headerParameters = {};
4029
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
4030
+ // oauth required
4031
+ _a = headerParameters;
4032
+ _b = "Authorization";
4033
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_write"])];
4034
+ case 1:
4035
+ // oauth required
4036
+ _a[_b] = _c.sent();
4037
+ _c.label = 2;
4038
+ case 2:
4039
+ if (this.configuration && this.configuration.apiKey) {
4040
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
4041
+ }
4042
+ return [4 /*yield*/, this.request({
4043
+ path: "/conversation/pbx/{queue_uuid}/voicemails/voicemails/{recording_sid}/listened".replace("{".concat("queue_uuid", "}"), encodeURIComponent(String(requestParameters.queueUuid))).replace("{".concat("recording_sid", "}"), encodeURIComponent(String(requestParameters.recordingSid))),
4044
+ method: 'GET',
4045
+ headers: headerParameters,
4046
+ query: queryParameters,
4047
+ }, initOverrides)];
4048
+ case 3:
4049
+ response = _c.sent();
4050
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
4051
+ }
4052
+ });
4053
+ });
4054
+ };
4055
+ /**
4056
+ * Listened pbx queue Voicemail
4057
+ * Listened Queue Voicemail
4058
+ */
4059
+ ConversationApi.prototype.listenedPbxQueueVoicemail = function (requestParameters, initOverrides) {
4060
+ return __awaiter(this, void 0, void 0, function () {
4061
+ return __generator(this, function (_a) {
4062
+ switch (_a.label) {
4063
+ case 0: return [4 /*yield*/, this.listenedPbxQueueVoicemailRaw(requestParameters, initOverrides)];
4064
+ case 1:
4065
+ _a.sent();
4066
+ return [2 /*return*/];
4067
+ }
4068
+ });
4069
+ });
4070
+ };
3951
4071
  /**
3952
4072
  * Mark a conversation as read
3953
4073
  * Mark a conversation as read
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { Item, ItemDigitalItem, ItemDigitalItemResponse, ItemDigitalItemsResponse, ItemResponse, ItemReview, ItemReviewResponse, ItemReviewsResponse, ItemsRequest, ItemsResponse, PricingTiersResponse, TempMultimediaResponse } from '../models';
13
+ import { Item, ItemContentAttribute, ItemDigitalItem, ItemDigitalItemResponse, ItemDigitalItemsResponse, ItemResponse, ItemReview, ItemReviewResponse, ItemReviewsResponse, ItemsRequest, ItemsResponse, PricingTiersResponse, TempMultimediaResponse } from '../models';
14
14
  export interface DeleteDigitalItemRequest {
15
15
  digitalItemOid: number;
16
16
  }
@@ -85,6 +85,10 @@ export interface InsertReviewRequest {
85
85
  merchantItemOid: number;
86
86
  review: ItemReview;
87
87
  }
88
+ export interface InsertUpdateItemContentAttributeRequest {
89
+ merchantItemOid: number;
90
+ itemAttribute: ItemContentAttribute;
91
+ }
88
92
  export interface UpdateDigitalItemRequest {
89
93
  digitalItemOid: number;
90
94
  digitalItem: ItemDigitalItem;
@@ -366,6 +370,21 @@ export interface ItemApiInterface {
366
370
  * Insert a review
367
371
  */
368
372
  insertReview(requestParameters: InsertReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewResponse>;
373
+ /**
374
+ * Update an item content attribute, creating it new if it does not yet exist.
375
+ * @summary Upsert an item content attribute
376
+ * @param {number} merchantItemOid The item oid to modify.
377
+ * @param {ItemContentAttribute} itemAttribute Item content attribute to upsert
378
+ * @param {*} [options] Override http request option.
379
+ * @throws {RequiredError}
380
+ * @memberof ItemApiInterface
381
+ */
382
+ insertUpdateItemContentAttributeRaw(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
383
+ /**
384
+ * Update an item content attribute, creating it new if it does not yet exist.
385
+ * Upsert an item content attribute
386
+ */
387
+ insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
369
388
  /**
370
389
  * Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
371
390
  * @summary Updates a file within the digital library
@@ -610,6 +629,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
610
629
  * Insert a review
611
630
  */
612
631
  insertReview(requestParameters: InsertReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewResponse>;
632
+ /**
633
+ * Update an item content attribute, creating it new if it does not yet exist.
634
+ * Upsert an item content attribute
635
+ */
636
+ insertUpdateItemContentAttributeRaw(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
637
+ /**
638
+ * Update an item content attribute, creating it new if it does not yet exist.
639
+ * Upsert an item content attribute
640
+ */
641
+ insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
613
642
  /**
614
643
  * Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
615
644
  * Updates a file within the digital library
@@ -1101,6 +1101,68 @@ var ItemApi = /** @class */ (function (_super) {
1101
1101
  });
1102
1102
  });
1103
1103
  };
1104
+ /**
1105
+ * Update an item content attribute, creating it new if it does not yet exist.
1106
+ * Upsert an item content attribute
1107
+ */
1108
+ ItemApi.prototype.insertUpdateItemContentAttributeRaw = function (requestParameters, initOverrides) {
1109
+ return __awaiter(this, void 0, void 0, function () {
1110
+ var queryParameters, headerParameters, _a, _b, response;
1111
+ return __generator(this, function (_c) {
1112
+ switch (_c.label) {
1113
+ case 0:
1114
+ if (requestParameters.merchantItemOid === null || requestParameters.merchantItemOid === undefined) {
1115
+ throw new runtime.RequiredError('merchantItemOid', 'Required parameter requestParameters.merchantItemOid was null or undefined when calling insertUpdateItemContentAttribute.');
1116
+ }
1117
+ if (requestParameters.itemAttribute === null || requestParameters.itemAttribute === undefined) {
1118
+ throw new runtime.RequiredError('itemAttribute', 'Required parameter requestParameters.itemAttribute was null or undefined when calling insertUpdateItemContentAttribute.');
1119
+ }
1120
+ queryParameters = {};
1121
+ headerParameters = {};
1122
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
1123
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
1124
+ // oauth required
1125
+ _a = headerParameters;
1126
+ _b = "Authorization";
1127
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["item_write"])];
1128
+ case 1:
1129
+ // oauth required
1130
+ _a[_b] = _c.sent();
1131
+ _c.label = 2;
1132
+ case 2:
1133
+ if (this.configuration && this.configuration.apiKey) {
1134
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
1135
+ }
1136
+ return [4 /*yield*/, this.request({
1137
+ path: "/item/items/{merchant_item_oid}/content/attributes".replace("{".concat("merchant_item_oid", "}"), encodeURIComponent(String(requestParameters.merchantItemOid))),
1138
+ method: 'POST',
1139
+ headers: headerParameters,
1140
+ query: queryParameters,
1141
+ body: (0, models_1.ItemContentAttributeToJSON)(requestParameters.itemAttribute),
1142
+ }, initOverrides)];
1143
+ case 3:
1144
+ response = _c.sent();
1145
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
1146
+ }
1147
+ });
1148
+ });
1149
+ };
1150
+ /**
1151
+ * Update an item content attribute, creating it new if it does not yet exist.
1152
+ * Upsert an item content attribute
1153
+ */
1154
+ ItemApi.prototype.insertUpdateItemContentAttribute = function (requestParameters, initOverrides) {
1155
+ return __awaiter(this, void 0, void 0, function () {
1156
+ return __generator(this, function (_a) {
1157
+ switch (_a.label) {
1158
+ case 0: return [4 /*yield*/, this.insertUpdateItemContentAttributeRaw(requestParameters, initOverrides)];
1159
+ case 1:
1160
+ _a.sent();
1161
+ return [2 /*return*/];
1162
+ }
1163
+ });
1164
+ });
1165
+ };
1104
1166
  /**
1105
1167
  * Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
1106
1168
  * Updates a file within the digital library
@@ -60,6 +60,12 @@ export interface AutoOrderItem {
60
60
  * @memberof AutoOrderItem
61
61
  */
62
62
  auto_order_item_oid?: number;
63
+ /**
64
+ * Calculated Date/time that this item is scheduled to rebill. Will be null if no more shipments are going to occur on this item
65
+ * @type {string}
66
+ * @memberof AutoOrderItem
67
+ */
68
+ calculated_next_shipment_dts?: string;
63
69
  /**
64
70
  * Date/time of the first order of this item. Null if item added to auto order and has not been rebilled yet.
65
71
  * @type {string}
@@ -55,6 +55,7 @@ function AutoOrderItemFromJSONTyped(json, ignoreDiscriminator) {
55
55
  'arbitrary_unit_cost': !(0, runtime_1.exists)(json, 'arbitrary_unit_cost') ? undefined : json['arbitrary_unit_cost'],
56
56
  'arbitrary_unit_cost_remaining_orders': !(0, runtime_1.exists)(json, 'arbitrary_unit_cost_remaining_orders') ? undefined : json['arbitrary_unit_cost_remaining_orders'],
57
57
  'auto_order_item_oid': !(0, runtime_1.exists)(json, 'auto_order_item_oid') ? undefined : json['auto_order_item_oid'],
58
+ 'calculated_next_shipment_dts': !(0, runtime_1.exists)(json, 'calculated_next_shipment_dts') ? undefined : json['calculated_next_shipment_dts'],
58
59
  'first_order_dts': !(0, runtime_1.exists)(json, 'first_order_dts') ? undefined : json['first_order_dts'],
59
60
  'frequency': !(0, runtime_1.exists)(json, 'frequency') ? undefined : json['frequency'],
60
61
  'future_schedules': !(0, runtime_1.exists)(json, 'future_schedules') ? undefined : (json['future_schedules'].map(AutoOrderItemFutureSchedule_1.AutoOrderItemFutureScheduleFromJSON)),
@@ -93,6 +94,7 @@ function AutoOrderItemToJSON(value) {
93
94
  'arbitrary_unit_cost': value.arbitrary_unit_cost,
94
95
  'arbitrary_unit_cost_remaining_orders': value.arbitrary_unit_cost_remaining_orders,
95
96
  'auto_order_item_oid': value.auto_order_item_oid,
97
+ 'calculated_next_shipment_dts': value.calculated_next_shipment_dts,
96
98
  'first_order_dts': value.first_order_dts,
97
99
  'frequency': value.frequency,
98
100
  'future_schedules': value.future_schedules === undefined ? undefined : (value.future_schedules.map(AutoOrderItemFutureSchedule_1.AutoOrderItemFutureScheduleToJSON)),
@@ -93,7 +93,7 @@ export interface WorkflowTask {
93
93
  */
94
94
  expiration_dts?: string;
95
95
  /**
96
- * Global task numer
96
+ * Global task number
97
97
  * @type {number}
98
98
  * @memberof WorkflowTask
99
99
  */
@@ -135,7 +135,7 @@ export interface WorkflowTask {
135
135
  */
136
136
  object_id?: string;
137
137
  /**
138
- * Object specific task numer
138
+ * Object specific task number
139
139
  * @type {number}
140
140
  * @memberof WorkflowTask
141
141
  */
@@ -16,6 +16,12 @@ import { WorkflowUser } from './WorkflowUser';
16
16
  * @interface WorkflowTasksRequest
17
17
  */
18
18
  export interface WorkflowTasksRequest {
19
+ /**
20
+ * Assigned to group
21
+ * @type {string}
22
+ * @memberof WorkflowTasksRequest
23
+ */
24
+ assigned_to_group?: string;
19
25
  /**
20
26
  * Assigned to group ID
21
27
  * @type {number}
@@ -28,6 +34,12 @@ export interface WorkflowTasksRequest {
28
34
  * @memberof WorkflowTasksRequest
29
35
  */
30
36
  assigned_to_me?: boolean;
37
+ /**
38
+ * Assigned to user
39
+ * @type {string}
40
+ * @memberof WorkflowTasksRequest
41
+ */
42
+ assigned_to_user?: string;
31
43
  /**
32
44
  * Assigned to user ID
33
45
  * @type {number}
@@ -52,8 +52,10 @@ function WorkflowTasksRequestFromJSONTyped(json, ignoreDiscriminator) {
52
52
  return json;
53
53
  }
54
54
  return {
55
+ 'assigned_to_group': !(0, runtime_1.exists)(json, 'assigned_to_group') ? undefined : json['assigned_to_group'],
55
56
  'assigned_to_group_id': !(0, runtime_1.exists)(json, 'assigned_to_group_id') ? undefined : json['assigned_to_group_id'],
56
57
  'assigned_to_me': !(0, runtime_1.exists)(json, 'assigned_to_me') ? undefined : json['assigned_to_me'],
58
+ 'assigned_to_user': !(0, runtime_1.exists)(json, 'assigned_to_user') ? undefined : json['assigned_to_user'],
57
59
  'assigned_to_user_id': !(0, runtime_1.exists)(json, 'assigned_to_user_id') ? undefined : json['assigned_to_user_id'],
58
60
  'created_by': !(0, runtime_1.exists)(json, 'created_by') ? undefined : (0, WorkflowUser_1.WorkflowUserFromJSON)(json['created_by']),
59
61
  'created_dts_begin': !(0, runtime_1.exists)(json, 'created_dts_begin') ? undefined : json['created_dts_begin'],
@@ -81,8 +83,10 @@ function WorkflowTasksRequestToJSON(value) {
81
83
  return null;
82
84
  }
83
85
  return {
86
+ 'assigned_to_group': value.assigned_to_group,
84
87
  'assigned_to_group_id': value.assigned_to_group_id,
85
88
  'assigned_to_me': value.assigned_to_me,
89
+ 'assigned_to_user': value.assigned_to_user,
86
90
  'assigned_to_user_id': value.assigned_to_user_id,
87
91
  'created_by': (0, WorkflowUser_1.WorkflowUserToJSON)(value.created_by),
88
92
  'created_dts_begin': value.created_dts_begin,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "4.0.209",
3
+ "version": "4.0.210",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "repository": {
@@ -230,6 +230,11 @@ export interface DeletePbxQueueRequest {
230
230
  conversationPbxQueueUuid: string;
231
231
  }
232
232
 
233
+ export interface DeletePbxQueueVoicemailRequest {
234
+ queueUuid: string;
235
+ recordingSid: string;
236
+ }
237
+
233
238
  export interface DeletePbxTimeBasedRequest {
234
239
  conversationPbxTimeBasedUuid: string;
235
240
  }
@@ -390,6 +395,11 @@ export interface ListenedPbxAgentVoicemailRequest {
390
395
  recordingSid: string;
391
396
  }
392
397
 
398
+ export interface ListenedPbxQueueVoicemailRequest {
399
+ queueUuid: string;
400
+ recordingSid: string;
401
+ }
402
+
393
403
  export interface MarkReadConversationRequest {
394
404
  conversationUuid: string;
395
405
  }
@@ -625,6 +635,23 @@ export interface ConversationApiInterface {
625
635
  */
626
636
  deletePbxQueue(requestParameters: DeletePbxQueueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxQueueResponse>;
627
637
 
638
+ /**
639
+ * Delete pbx queue Voicemail
640
+ * @summary Delete Queue Voicemail
641
+ * @param {string} queueUuid
642
+ * @param {string} recordingSid
643
+ * @param {*} [options] Override http request option.
644
+ * @throws {RequiredError}
645
+ * @memberof ConversationApiInterface
646
+ */
647
+ deletePbxQueueVoicemailRaw(requestParameters: DeletePbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
648
+
649
+ /**
650
+ * Delete pbx queue Voicemail
651
+ * Delete Queue Voicemail
652
+ */
653
+ deletePbxQueueVoicemail(requestParameters: DeletePbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
654
+
628
655
  /**
629
656
  * Delete a pbx timeBased
630
657
  * @summary Delete pbx timeBased
@@ -1526,6 +1553,23 @@ export interface ConversationApiInterface {
1526
1553
  */
1527
1554
  listenedPbxAgentVoicemail(requestParameters: ListenedPbxAgentVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1528
1555
 
1556
+ /**
1557
+ * Listened pbx queue Voicemail
1558
+ * @summary Listened Queue Voicemail
1559
+ * @param {string} queueUuid
1560
+ * @param {string} recordingSid
1561
+ * @param {*} [options] Override http request option.
1562
+ * @throws {RequiredError}
1563
+ * @memberof ConversationApiInterface
1564
+ */
1565
+ listenedPbxQueueVoicemailRaw(requestParameters: ListenedPbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
1566
+
1567
+ /**
1568
+ * Listened pbx queue Voicemail
1569
+ * Listened Queue Voicemail
1570
+ */
1571
+ listenedPbxQueueVoicemail(requestParameters: ListenedPbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1572
+
1529
1573
  /**
1530
1574
  * Mark a conversation as read
1531
1575
  * @summary Mark a conversation as read
@@ -2198,6 +2242,50 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
2198
2242
  return await response.value();
2199
2243
  }
2200
2244
 
2245
+ /**
2246
+ * Delete pbx queue Voicemail
2247
+ * Delete Queue Voicemail
2248
+ */
2249
+ async deletePbxQueueVoicemailRaw(requestParameters: DeletePbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
2250
+ if (requestParameters.queueUuid === null || requestParameters.queueUuid === undefined) {
2251
+ throw new runtime.RequiredError('queueUuid','Required parameter requestParameters.queueUuid was null or undefined when calling deletePbxQueueVoicemail.');
2252
+ }
2253
+
2254
+ if (requestParameters.recordingSid === null || requestParameters.recordingSid === undefined) {
2255
+ throw new runtime.RequiredError('recordingSid','Required parameter requestParameters.recordingSid was null or undefined when calling deletePbxQueueVoicemail.');
2256
+ }
2257
+
2258
+ const queryParameters: any = {};
2259
+
2260
+ const headerParameters: runtime.HTTPHeaders = {};
2261
+
2262
+ if (this.configuration && this.configuration.accessToken) {
2263
+ // oauth required
2264
+ headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_write"]);
2265
+ }
2266
+
2267
+ if (this.configuration && this.configuration.apiKey) {
2268
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
2269
+ }
2270
+
2271
+ const response = await this.request({
2272
+ path: `/conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}`.replace(`{${"queue_uuid"}}`, encodeURIComponent(String(requestParameters.queueUuid))).replace(`{${"recording_sid"}}`, encodeURIComponent(String(requestParameters.recordingSid))),
2273
+ method: 'DELETE',
2274
+ headers: headerParameters,
2275
+ query: queryParameters,
2276
+ }, initOverrides);
2277
+
2278
+ return new runtime.VoidApiResponse(response);
2279
+ }
2280
+
2281
+ /**
2282
+ * Delete pbx queue Voicemail
2283
+ * Delete Queue Voicemail
2284
+ */
2285
+ async deletePbxQueueVoicemail(requestParameters: DeletePbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
2286
+ await this.deletePbxQueueVoicemailRaw(requestParameters, initOverrides);
2287
+ }
2288
+
2201
2289
  /**
2202
2290
  * Delete a pbx timeBased
2203
2291
  * Delete pbx timeBased
@@ -4528,6 +4616,50 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
4528
4616
  await this.listenedPbxAgentVoicemailRaw(requestParameters, initOverrides);
4529
4617
  }
4530
4618
 
4619
+ /**
4620
+ * Listened pbx queue Voicemail
4621
+ * Listened Queue Voicemail
4622
+ */
4623
+ async listenedPbxQueueVoicemailRaw(requestParameters: ListenedPbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
4624
+ if (requestParameters.queueUuid === null || requestParameters.queueUuid === undefined) {
4625
+ throw new runtime.RequiredError('queueUuid','Required parameter requestParameters.queueUuid was null or undefined when calling listenedPbxQueueVoicemail.');
4626
+ }
4627
+
4628
+ if (requestParameters.recordingSid === null || requestParameters.recordingSid === undefined) {
4629
+ throw new runtime.RequiredError('recordingSid','Required parameter requestParameters.recordingSid was null or undefined when calling listenedPbxQueueVoicemail.');
4630
+ }
4631
+
4632
+ const queryParameters: any = {};
4633
+
4634
+ const headerParameters: runtime.HTTPHeaders = {};
4635
+
4636
+ if (this.configuration && this.configuration.accessToken) {
4637
+ // oauth required
4638
+ headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_write"]);
4639
+ }
4640
+
4641
+ if (this.configuration && this.configuration.apiKey) {
4642
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
4643
+ }
4644
+
4645
+ const response = await this.request({
4646
+ path: `/conversation/pbx/{queue_uuid}/voicemails/voicemails/{recording_sid}/listened`.replace(`{${"queue_uuid"}}`, encodeURIComponent(String(requestParameters.queueUuid))).replace(`{${"recording_sid"}}`, encodeURIComponent(String(requestParameters.recordingSid))),
4647
+ method: 'GET',
4648
+ headers: headerParameters,
4649
+ query: queryParameters,
4650
+ }, initOverrides);
4651
+
4652
+ return new runtime.VoidApiResponse(response);
4653
+ }
4654
+
4655
+ /**
4656
+ * Listened pbx queue Voicemail
4657
+ * Listened Queue Voicemail
4658
+ */
4659
+ async listenedPbxQueueVoicemail(requestParameters: ListenedPbxQueueVoicemailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
4660
+ await this.listenedPbxQueueVoicemailRaw(requestParameters, initOverrides);
4661
+ }
4662
+
4531
4663
  /**
4532
4664
  * Mark a conversation as read
4533
4665
  * Mark a conversation as read
@@ -21,6 +21,9 @@ import {
21
21
  Item,
22
22
  ItemFromJSON,
23
23
  ItemToJSON,
24
+ ItemContentAttribute,
25
+ ItemContentAttributeFromJSON,
26
+ ItemContentAttributeToJSON,
24
27
  ItemDigitalItem,
25
28
  ItemDigitalItemFromJSON,
26
29
  ItemDigitalItemToJSON,
@@ -146,6 +149,11 @@ export interface InsertReviewRequest {
146
149
  review: ItemReview;
147
150
  }
148
151
 
152
+ export interface InsertUpdateItemContentAttributeRequest {
153
+ merchantItemOid: number;
154
+ itemAttribute: ItemContentAttribute;
155
+ }
156
+
149
157
  export interface UpdateDigitalItemRequest {
150
158
  digitalItemOid: number;
151
159
  digitalItem: ItemDigitalItem;
@@ -464,6 +472,23 @@ export interface ItemApiInterface {
464
472
  */
465
473
  insertReview(requestParameters: InsertReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewResponse>;
466
474
 
475
+ /**
476
+ * Update an item content attribute, creating it new if it does not yet exist.
477
+ * @summary Upsert an item content attribute
478
+ * @param {number} merchantItemOid The item oid to modify.
479
+ * @param {ItemContentAttribute} itemAttribute Item content attribute to upsert
480
+ * @param {*} [options] Override http request option.
481
+ * @throws {RequiredError}
482
+ * @memberof ItemApiInterface
483
+ */
484
+ insertUpdateItemContentAttributeRaw(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
485
+
486
+ /**
487
+ * Update an item content attribute, creating it new if it does not yet exist.
488
+ * Upsert an item content attribute
489
+ */
490
+ insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
491
+
467
492
  /**
468
493
  * Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
469
494
  * @summary Updates a file within the digital library
@@ -1326,6 +1351,53 @@ export class ItemApi extends runtime.BaseAPI implements ItemApiInterface {
1326
1351
  return await response.value();
1327
1352
  }
1328
1353
 
1354
+ /**
1355
+ * Update an item content attribute, creating it new if it does not yet exist.
1356
+ * Upsert an item content attribute
1357
+ */
1358
+ async insertUpdateItemContentAttributeRaw(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
1359
+ if (requestParameters.merchantItemOid === null || requestParameters.merchantItemOid === undefined) {
1360
+ throw new runtime.RequiredError('merchantItemOid','Required parameter requestParameters.merchantItemOid was null or undefined when calling insertUpdateItemContentAttribute.');
1361
+ }
1362
+
1363
+ if (requestParameters.itemAttribute === null || requestParameters.itemAttribute === undefined) {
1364
+ throw new runtime.RequiredError('itemAttribute','Required parameter requestParameters.itemAttribute was null or undefined when calling insertUpdateItemContentAttribute.');
1365
+ }
1366
+
1367
+ const queryParameters: any = {};
1368
+
1369
+ const headerParameters: runtime.HTTPHeaders = {};
1370
+
1371
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
1372
+
1373
+ if (this.configuration && this.configuration.accessToken) {
1374
+ // oauth required
1375
+ headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["item_write"]);
1376
+ }
1377
+
1378
+ if (this.configuration && this.configuration.apiKey) {
1379
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
1380
+ }
1381
+
1382
+ const response = await this.request({
1383
+ path: `/item/items/{merchant_item_oid}/content/attributes`.replace(`{${"merchant_item_oid"}}`, encodeURIComponent(String(requestParameters.merchantItemOid))),
1384
+ method: 'POST',
1385
+ headers: headerParameters,
1386
+ query: queryParameters,
1387
+ body: ItemContentAttributeToJSON(requestParameters.itemAttribute),
1388
+ }, initOverrides);
1389
+
1390
+ return new runtime.VoidApiResponse(response);
1391
+ }
1392
+
1393
+ /**
1394
+ * Update an item content attribute, creating it new if it does not yet exist.
1395
+ * Upsert an item content attribute
1396
+ */
1397
+ async insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
1398
+ await this.insertUpdateItemContentAttributeRaw(requestParameters, initOverrides);
1399
+ }
1400
+
1329
1401
  /**
1330
1402
  * Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
1331
1403
  * Updates a file within the digital library
@@ -80,6 +80,12 @@ export interface AutoOrderItem {
80
80
  * @memberof AutoOrderItem
81
81
  */
82
82
  auto_order_item_oid?: number;
83
+ /**
84
+ * Calculated Date/time that this item is scheduled to rebill. Will be null if no more shipments are going to occur on this item
85
+ * @type {string}
86
+ * @memberof AutoOrderItem
87
+ */
88
+ calculated_next_shipment_dts?: string;
83
89
  /**
84
90
  * Date/time of the first order of this item. Null if item added to auto order and has not been rebilled yet.
85
91
  * @type {string}
@@ -244,6 +250,7 @@ export function AutoOrderItemFromJSONTyped(json: any, ignoreDiscriminator: boole
244
250
  'arbitrary_unit_cost': !exists(json, 'arbitrary_unit_cost') ? undefined : json['arbitrary_unit_cost'],
245
251
  'arbitrary_unit_cost_remaining_orders': !exists(json, 'arbitrary_unit_cost_remaining_orders') ? undefined : json['arbitrary_unit_cost_remaining_orders'],
246
252
  'auto_order_item_oid': !exists(json, 'auto_order_item_oid') ? undefined : json['auto_order_item_oid'],
253
+ 'calculated_next_shipment_dts': !exists(json, 'calculated_next_shipment_dts') ? undefined : json['calculated_next_shipment_dts'],
247
254
  'first_order_dts': !exists(json, 'first_order_dts') ? undefined : json['first_order_dts'],
248
255
  'frequency': !exists(json, 'frequency') ? undefined : json['frequency'],
249
256
  'future_schedules': !exists(json, 'future_schedules') ? undefined : ((json['future_schedules'] as Array<any>).map(AutoOrderItemFutureScheduleFromJSON)),
@@ -283,6 +290,7 @@ export function AutoOrderItemToJSON(value?: AutoOrderItem | null): any {
283
290
  'arbitrary_unit_cost': value.arbitrary_unit_cost,
284
291
  'arbitrary_unit_cost_remaining_orders': value.arbitrary_unit_cost_remaining_orders,
285
292
  'auto_order_item_oid': value.auto_order_item_oid,
293
+ 'calculated_next_shipment_dts': value.calculated_next_shipment_dts,
286
294
  'first_order_dts': value.first_order_dts,
287
295
  'frequency': value.frequency,
288
296
  'future_schedules': value.future_schedules === undefined ? undefined : ((value.future_schedules as Array<any>).map(AutoOrderItemFutureScheduleToJSON)),
@@ -123,7 +123,7 @@ export interface WorkflowTask {
123
123
  */
124
124
  expiration_dts?: string;
125
125
  /**
126
- * Global task numer
126
+ * Global task number
127
127
  * @type {number}
128
128
  * @memberof WorkflowTask
129
129
  */
@@ -165,7 +165,7 @@ export interface WorkflowTask {
165
165
  */
166
166
  object_id?: string;
167
167
  /**
168
- * Object specific task numer
168
+ * Object specific task number
169
169
  * @type {number}
170
170
  * @memberof WorkflowTask
171
171
  */
@@ -26,6 +26,12 @@ import {
26
26
  * @interface WorkflowTasksRequest
27
27
  */
28
28
  export interface WorkflowTasksRequest {
29
+ /**
30
+ * Assigned to group
31
+ * @type {string}
32
+ * @memberof WorkflowTasksRequest
33
+ */
34
+ assigned_to_group?: string;
29
35
  /**
30
36
  * Assigned to group ID
31
37
  * @type {number}
@@ -38,6 +44,12 @@ export interface WorkflowTasksRequest {
38
44
  * @memberof WorkflowTasksRequest
39
45
  */
40
46
  assigned_to_me?: boolean;
47
+ /**
48
+ * Assigned to user
49
+ * @type {string}
50
+ * @memberof WorkflowTasksRequest
51
+ */
52
+ assigned_to_user?: string;
41
53
  /**
42
54
  * Assigned to user ID
43
55
  * @type {number}
@@ -181,8 +193,10 @@ export function WorkflowTasksRequestFromJSONTyped(json: any, ignoreDiscriminator
181
193
  }
182
194
  return {
183
195
 
196
+ 'assigned_to_group': !exists(json, 'assigned_to_group') ? undefined : json['assigned_to_group'],
184
197
  'assigned_to_group_id': !exists(json, 'assigned_to_group_id') ? undefined : json['assigned_to_group_id'],
185
198
  'assigned_to_me': !exists(json, 'assigned_to_me') ? undefined : json['assigned_to_me'],
199
+ 'assigned_to_user': !exists(json, 'assigned_to_user') ? undefined : json['assigned_to_user'],
186
200
  'assigned_to_user_id': !exists(json, 'assigned_to_user_id') ? undefined : json['assigned_to_user_id'],
187
201
  'created_by': !exists(json, 'created_by') ? undefined : WorkflowUserFromJSON(json['created_by']),
188
202
  'created_dts_begin': !exists(json, 'created_dts_begin') ? undefined : json['created_dts_begin'],
@@ -211,8 +225,10 @@ export function WorkflowTasksRequestToJSON(value?: WorkflowTasksRequest | null):
211
225
  }
212
226
  return {
213
227
 
228
+ 'assigned_to_group': value.assigned_to_group,
214
229
  'assigned_to_group_id': value.assigned_to_group_id,
215
230
  'assigned_to_me': value.assigned_to_me,
231
+ 'assigned_to_user': value.assigned_to_user,
216
232
  'assigned_to_user_id': value.assigned_to_user_id,
217
233
  'created_by': WorkflowUserToJSON(value.created_by),
218
234
  'created_dts_begin': value.created_dts_begin,