ultracart_rest_api_v2_typescript 4.0.63-RC → 4.0.65-RC
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +4 -0
- package/README.md +4 -2
- package/dist/apis/ConversationApi.d.ts +57 -1
- package/dist/apis/ConversationApi.js +122 -0
- package/dist/apis/ItemApi.d.ts +160 -1
- package/dist/apis/ItemApi.js +334 -0
- package/dist/models/ConversationMessagesResponse.d.ts +55 -0
- package/dist/models/ConversationMessagesResponse.js +54 -0
- package/dist/models/ItemDigitalItem.d.ts +25 -0
- package/dist/models/ItemDigitalItem.js +9 -0
- package/dist/models/ItemDigitalItemPdfMeta.d.ts +87 -0
- package/dist/models/ItemDigitalItemPdfMeta.js +62 -0
- package/dist/models/ItemDigitalItemResponse.d.ts +55 -0
- package/dist/models/ItemDigitalItemResponse.js +54 -0
- package/dist/models/ItemDigitalItemsResponse.d.ts +55 -0
- package/dist/models/ItemDigitalItemsResponse.js +54 -0
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.js +4 -0
- package/package.json +1 -1
- package/src/apis/ConversationApi.ts +133 -0
- package/src/apis/ItemApi.ts +391 -0
- package/src/models/ConversationMessagesResponse.ts +113 -0
- package/src/models/ItemDigitalItem.ts +39 -0
- package/src/models/ItemDigitalItemPdfMeta.ts +136 -0
- package/src/models/ItemDigitalItemResponse.ts +113 -0
- package/src/models/ItemDigitalItemsResponse.ts +113 -0
- package/src/models/index.ts +4 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -149,6 +149,7 @@ src/models/ConversationEventReadMessage.ts
|
|
|
149
149
|
src/models/ConversationEventTyping.ts
|
|
150
150
|
src/models/ConversationMessage.ts
|
|
151
151
|
src/models/ConversationMessageTransportStatus.ts
|
|
152
|
+
src/models/ConversationMessagesResponse.ts
|
|
152
153
|
src/models/ConversationMultimediaUploadUrl.ts
|
|
153
154
|
src/models/ConversationMultimediaUploadUrlResponse.ts
|
|
154
155
|
src/models/ConversationParticipant.ts
|
|
@@ -429,6 +430,9 @@ src/models/ItemContentMultimedia.ts
|
|
|
429
430
|
src/models/ItemContentMultimediaThumbnail.ts
|
|
430
431
|
src/models/ItemDigitalDelivery.ts
|
|
431
432
|
src/models/ItemDigitalItem.ts
|
|
433
|
+
src/models/ItemDigitalItemPdfMeta.ts
|
|
434
|
+
src/models/ItemDigitalItemResponse.ts
|
|
435
|
+
src/models/ItemDigitalItemsResponse.ts
|
|
432
436
|
src/models/ItemEbay.ts
|
|
433
437
|
src/models/ItemEbayCategorySpecific.ts
|
|
434
438
|
src/models/ItemEbayMarketListing.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@4.0.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@4.0.65-RC
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install ultracart_rest_api_v2_typescript@4.0.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@4.0.65-RC --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 4.0.65-RC | 09/22/2022 | testing digital file mgmt calls |
|
|
58
|
+
| 4.0.64-RC | 09/19/2022 | conversations pagination |
|
|
57
59
|
| 4.0.63-RC | 09/13/2022 | storefront comms - postcard tracking |
|
|
58
60
|
| 4.0.62-RC | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
|
|
59
61
|
| 4.0.61-RC | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |
|
|
@@ -10,9 +10,15 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { ConversationAgentAuthResponse, ConversationMultimediaUploadUrlResponse, ConversationResponse, ConversationStartRequest, ConversationStartResponse, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
|
|
13
|
+
import { ConversationAgentAuthResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationResponse, ConversationStartRequest, ConversationStartResponse, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
|
|
14
14
|
export interface GetConversationRequest {
|
|
15
15
|
conversationUuid: string;
|
|
16
|
+
limit?: number;
|
|
17
|
+
}
|
|
18
|
+
export interface GetConversationMessagesRequest {
|
|
19
|
+
conversationUuid: string;
|
|
20
|
+
since: number;
|
|
21
|
+
limit?: number;
|
|
16
22
|
}
|
|
17
23
|
export interface GetConversationMultimediaUploadUrlRequest {
|
|
18
24
|
extension: string;
|
|
@@ -42,6 +48,19 @@ export interface UpdateConversationWebchatQueueStatusRequest {
|
|
|
42
48
|
* @interface ConversationApiInterface
|
|
43
49
|
*/
|
|
44
50
|
export interface ConversationApiInterface {
|
|
51
|
+
/**
|
|
52
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
53
|
+
* @summary Agent keep alive
|
|
54
|
+
* @param {*} [options] Override http request option.
|
|
55
|
+
* @throws {RequiredError}
|
|
56
|
+
* @memberof ConversationApiInterface
|
|
57
|
+
*/
|
|
58
|
+
getAgentKeepAliveRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
59
|
+
/**
|
|
60
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
61
|
+
* Agent keep alive
|
|
62
|
+
*/
|
|
63
|
+
getAgentKeepAlive(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
45
64
|
/**
|
|
46
65
|
* Retrieve a JWT to authorize an agent to make a websocket connection.
|
|
47
66
|
* @summary Get agent websocket authorization
|
|
@@ -59,6 +78,7 @@ export interface ConversationApiInterface {
|
|
|
59
78
|
* Retrieve a conversation including the participants and messages
|
|
60
79
|
* @summary Retrieve a conversation
|
|
61
80
|
* @param {string} conversationUuid
|
|
81
|
+
* @param {number} [limit]
|
|
62
82
|
* @param {*} [options] Override http request option.
|
|
63
83
|
* @throws {RequiredError}
|
|
64
84
|
* @memberof ConversationApiInterface
|
|
@@ -69,6 +89,22 @@ export interface ConversationApiInterface {
|
|
|
69
89
|
* Retrieve a conversation
|
|
70
90
|
*/
|
|
71
91
|
getConversation(requestParameters: GetConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationResponse>;
|
|
92
|
+
/**
|
|
93
|
+
* Retrieve conversation messages since a particular time
|
|
94
|
+
* @summary Retrieve conversation messages
|
|
95
|
+
* @param {string} conversationUuid
|
|
96
|
+
* @param {number} since
|
|
97
|
+
* @param {number} [limit]
|
|
98
|
+
* @param {*} [options] Override http request option.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
* @memberof ConversationApiInterface
|
|
101
|
+
*/
|
|
102
|
+
getConversationMessagesRaw(requestParameters: GetConversationMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationMessagesResponse>>;
|
|
103
|
+
/**
|
|
104
|
+
* Retrieve conversation messages since a particular time
|
|
105
|
+
* Retrieve conversation messages
|
|
106
|
+
*/
|
|
107
|
+
getConversationMessages(requestParameters: GetConversationMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationMessagesResponse>;
|
|
72
108
|
/**
|
|
73
109
|
* Get a presigned conersation multimedia upload URL
|
|
74
110
|
* @summary Get a presigned conersation multimedia upload URL
|
|
@@ -174,6 +210,16 @@ export interface ConversationApiInterface {
|
|
|
174
210
|
*
|
|
175
211
|
*/
|
|
176
212
|
export declare class ConversationApi extends runtime.BaseAPI implements ConversationApiInterface {
|
|
213
|
+
/**
|
|
214
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
215
|
+
* Agent keep alive
|
|
216
|
+
*/
|
|
217
|
+
getAgentKeepAliveRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
218
|
+
/**
|
|
219
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
220
|
+
* Agent keep alive
|
|
221
|
+
*/
|
|
222
|
+
getAgentKeepAlive(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
177
223
|
/**
|
|
178
224
|
* Retrieve a JWT to authorize an agent to make a websocket connection.
|
|
179
225
|
* Get agent websocket authorization
|
|
@@ -194,6 +240,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
|
|
|
194
240
|
* Retrieve a conversation
|
|
195
241
|
*/
|
|
196
242
|
getConversation(requestParameters: GetConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationResponse>;
|
|
243
|
+
/**
|
|
244
|
+
* Retrieve conversation messages since a particular time
|
|
245
|
+
* Retrieve conversation messages
|
|
246
|
+
*/
|
|
247
|
+
getConversationMessagesRaw(requestParameters: GetConversationMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationMessagesResponse>>;
|
|
248
|
+
/**
|
|
249
|
+
* Retrieve conversation messages since a particular time
|
|
250
|
+
* Retrieve conversation messages
|
|
251
|
+
*/
|
|
252
|
+
getConversationMessages(requestParameters: GetConversationMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationMessagesResponse>;
|
|
197
253
|
/**
|
|
198
254
|
* Get a presigned conersation multimedia upload URL
|
|
199
255
|
* Get a presigned conersation multimedia upload URL
|
|
@@ -75,6 +75,60 @@ var ConversationApi = /** @class */ (function (_super) {
|
|
|
75
75
|
function ConversationApi() {
|
|
76
76
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
77
77
|
}
|
|
78
|
+
/**
|
|
79
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
80
|
+
* Agent keep alive
|
|
81
|
+
*/
|
|
82
|
+
ConversationApi.prototype.getAgentKeepAliveRaw = function (initOverrides) {
|
|
83
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
84
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
85
|
+
return __generator(this, function (_c) {
|
|
86
|
+
switch (_c.label) {
|
|
87
|
+
case 0:
|
|
88
|
+
queryParameters = {};
|
|
89
|
+
headerParameters = {};
|
|
90
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
91
|
+
// oauth required
|
|
92
|
+
_a = headerParameters;
|
|
93
|
+
_b = "Authorization";
|
|
94
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_write"])];
|
|
95
|
+
case 1:
|
|
96
|
+
// oauth required
|
|
97
|
+
_a[_b] = _c.sent();
|
|
98
|
+
_c.label = 2;
|
|
99
|
+
case 2:
|
|
100
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
101
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
102
|
+
}
|
|
103
|
+
return [4 /*yield*/, this.request({
|
|
104
|
+
path: "/conversation/agent/keepalive",
|
|
105
|
+
method: 'GET',
|
|
106
|
+
headers: headerParameters,
|
|
107
|
+
query: queryParameters,
|
|
108
|
+
}, initOverrides)];
|
|
109
|
+
case 3:
|
|
110
|
+
response = _c.sent();
|
|
111
|
+
return [2 /*return*/, new runtime.VoidApiResponse(response)];
|
|
112
|
+
}
|
|
113
|
+
});
|
|
114
|
+
});
|
|
115
|
+
};
|
|
116
|
+
/**
|
|
117
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
118
|
+
* Agent keep alive
|
|
119
|
+
*/
|
|
120
|
+
ConversationApi.prototype.getAgentKeepAlive = function (initOverrides) {
|
|
121
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
122
|
+
return __generator(this, function (_a) {
|
|
123
|
+
switch (_a.label) {
|
|
124
|
+
case 0: return [4 /*yield*/, this.getAgentKeepAliveRaw(initOverrides)];
|
|
125
|
+
case 1:
|
|
126
|
+
_a.sent();
|
|
127
|
+
return [2 /*return*/];
|
|
128
|
+
}
|
|
129
|
+
});
|
|
130
|
+
});
|
|
131
|
+
};
|
|
78
132
|
/**
|
|
79
133
|
* Retrieve a JWT to authorize an agent to make a websocket connection.
|
|
80
134
|
* Get agent websocket authorization
|
|
@@ -145,6 +199,9 @@ var ConversationApi = /** @class */ (function (_super) {
|
|
|
145
199
|
throw new runtime.RequiredError('conversationUuid', 'Required parameter requestParameters.conversationUuid was null or undefined when calling getConversation.');
|
|
146
200
|
}
|
|
147
201
|
queryParameters = {};
|
|
202
|
+
if (requestParameters.limit !== undefined) {
|
|
203
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
204
|
+
}
|
|
148
205
|
headerParameters = {};
|
|
149
206
|
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
150
207
|
// oauth required
|
|
@@ -190,6 +247,71 @@ var ConversationApi = /** @class */ (function (_super) {
|
|
|
190
247
|
});
|
|
191
248
|
});
|
|
192
249
|
};
|
|
250
|
+
/**
|
|
251
|
+
* Retrieve conversation messages since a particular time
|
|
252
|
+
* Retrieve conversation messages
|
|
253
|
+
*/
|
|
254
|
+
ConversationApi.prototype.getConversationMessagesRaw = function (requestParameters, initOverrides) {
|
|
255
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
256
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
257
|
+
return __generator(this, function (_c) {
|
|
258
|
+
switch (_c.label) {
|
|
259
|
+
case 0:
|
|
260
|
+
if (requestParameters.conversationUuid === null || requestParameters.conversationUuid === undefined) {
|
|
261
|
+
throw new runtime.RequiredError('conversationUuid', 'Required parameter requestParameters.conversationUuid was null or undefined when calling getConversationMessages.');
|
|
262
|
+
}
|
|
263
|
+
if (requestParameters.since === null || requestParameters.since === undefined) {
|
|
264
|
+
throw new runtime.RequiredError('since', 'Required parameter requestParameters.since was null or undefined when calling getConversationMessages.');
|
|
265
|
+
}
|
|
266
|
+
queryParameters = {};
|
|
267
|
+
if (requestParameters.limit !== undefined) {
|
|
268
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
269
|
+
}
|
|
270
|
+
headerParameters = {};
|
|
271
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
272
|
+
// oauth required
|
|
273
|
+
_a = headerParameters;
|
|
274
|
+
_b = "Authorization";
|
|
275
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_read"])];
|
|
276
|
+
case 1:
|
|
277
|
+
// oauth required
|
|
278
|
+
_a[_b] = _c.sent();
|
|
279
|
+
_c.label = 2;
|
|
280
|
+
case 2:
|
|
281
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
282
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
283
|
+
}
|
|
284
|
+
return [4 /*yield*/, this.request({
|
|
285
|
+
path: "/conversation/conversations/{conversation_uuid}/messages/{since}".replace("{".concat("conversation_uuid", "}"), encodeURIComponent(String(requestParameters.conversationUuid))).replace("{".concat("since", "}"), encodeURIComponent(String(requestParameters.since))),
|
|
286
|
+
method: 'GET',
|
|
287
|
+
headers: headerParameters,
|
|
288
|
+
query: queryParameters,
|
|
289
|
+
}, initOverrides)];
|
|
290
|
+
case 3:
|
|
291
|
+
response = _c.sent();
|
|
292
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationMessagesResponseFromJSON)(jsonValue); })];
|
|
293
|
+
}
|
|
294
|
+
});
|
|
295
|
+
});
|
|
296
|
+
};
|
|
297
|
+
/**
|
|
298
|
+
* Retrieve conversation messages since a particular time
|
|
299
|
+
* Retrieve conversation messages
|
|
300
|
+
*/
|
|
301
|
+
ConversationApi.prototype.getConversationMessages = function (requestParameters, initOverrides) {
|
|
302
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
303
|
+
var response;
|
|
304
|
+
return __generator(this, function (_a) {
|
|
305
|
+
switch (_a.label) {
|
|
306
|
+
case 0: return [4 /*yield*/, this.getConversationMessagesRaw(requestParameters, initOverrides)];
|
|
307
|
+
case 1:
|
|
308
|
+
response = _a.sent();
|
|
309
|
+
return [4 /*yield*/, response.value()];
|
|
310
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
311
|
+
}
|
|
312
|
+
});
|
|
313
|
+
});
|
|
314
|
+
};
|
|
193
315
|
/**
|
|
194
316
|
* Get a presigned conersation multimedia upload URL
|
|
195
317
|
* Get a presigned conersation multimedia upload URL
|
package/dist/apis/ItemApi.d.ts
CHANGED
|
@@ -10,10 +10,30 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { Item, ItemResponse, ItemsRequest, ItemsResponse, PricingTiersResponse, TempMultimediaResponse } from '../models';
|
|
13
|
+
import { Item, ItemDigitalItem, ItemDigitalItemResponse, ItemDigitalItemsResponse, ItemResponse, ItemsRequest, ItemsResponse, PricingTiersResponse, TempMultimediaResponse } from '../models';
|
|
14
|
+
export interface DeleteDigitalItemRequest {
|
|
15
|
+
digitalItemOid: number;
|
|
16
|
+
}
|
|
14
17
|
export interface DeleteItemRequest {
|
|
15
18
|
merchantItemOid: number;
|
|
16
19
|
}
|
|
20
|
+
export interface GetDigitalItemRequest {
|
|
21
|
+
digitalItemOid: number;
|
|
22
|
+
limit?: number;
|
|
23
|
+
offset?: number;
|
|
24
|
+
since?: string;
|
|
25
|
+
sort?: string;
|
|
26
|
+
expand?: string;
|
|
27
|
+
placeholders?: boolean;
|
|
28
|
+
}
|
|
29
|
+
export interface GetDigitalItemsRequest {
|
|
30
|
+
limit?: number;
|
|
31
|
+
offset?: number;
|
|
32
|
+
since?: string;
|
|
33
|
+
sort?: string;
|
|
34
|
+
expand?: string;
|
|
35
|
+
placeholders?: boolean;
|
|
36
|
+
}
|
|
17
37
|
export interface GetItemRequest {
|
|
18
38
|
merchantItemOid: number;
|
|
19
39
|
expand?: string;
|
|
@@ -37,11 +57,18 @@ export interface GetItemsRequest {
|
|
|
37
57
|
export interface GetPricingTiersRequest {
|
|
38
58
|
expand?: string;
|
|
39
59
|
}
|
|
60
|
+
export interface InsertDigitalItemRequest {
|
|
61
|
+
digitalItem: ItemDigitalItem;
|
|
62
|
+
}
|
|
40
63
|
export interface InsertItemRequest {
|
|
41
64
|
item: Item;
|
|
42
65
|
expand?: string;
|
|
43
66
|
placeholders?: boolean;
|
|
44
67
|
}
|
|
68
|
+
export interface UpdateDigitalItemRequest {
|
|
69
|
+
digitalItemOid: number;
|
|
70
|
+
digitalItem: ItemDigitalItem;
|
|
71
|
+
}
|
|
45
72
|
export interface UpdateItemRequest {
|
|
46
73
|
merchantItemOid: number;
|
|
47
74
|
item: Item;
|
|
@@ -64,6 +91,20 @@ export interface UploadTemporaryMultimediaRequest {
|
|
|
64
91
|
* @interface ItemApiInterface
|
|
65
92
|
*/
|
|
66
93
|
export interface ItemApiInterface {
|
|
94
|
+
/**
|
|
95
|
+
* Delete a digital item on the UltraCart account.
|
|
96
|
+
* @summary Delete a digital item, which is a file within the digital library, not an actual merchant item
|
|
97
|
+
* @param {number} digitalItemOid The digital item oid to delete.
|
|
98
|
+
* @param {*} [options] Override http request option.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
* @memberof ItemApiInterface
|
|
101
|
+
*/
|
|
102
|
+
deleteDigitalItemRaw(requestParameters: DeleteDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
103
|
+
/**
|
|
104
|
+
* Delete a digital item on the UltraCart account.
|
|
105
|
+
* Delete a digital item, which is a file within the digital library, not an actual merchant item
|
|
106
|
+
*/
|
|
107
|
+
deleteDigitalItem(requestParameters: DeleteDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
67
108
|
/**
|
|
68
109
|
* Delete an item on the UltraCart account.
|
|
69
110
|
* @summary Delete an item
|
|
@@ -78,6 +119,45 @@ export interface ItemApiInterface {
|
|
|
78
119
|
* Delete an item
|
|
79
120
|
*/
|
|
80
121
|
deleteItem(requestParameters: DeleteItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
122
|
+
/**
|
|
123
|
+
* Retrieves a digital item (file information) from the account. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
|
|
124
|
+
* @summary Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
|
|
125
|
+
* @param {number} digitalItemOid The digital item oid to retrieve.
|
|
126
|
+
* @param {number} [limit] The maximum number of records to return on this one API call. (Default 100, Max 2000)
|
|
127
|
+
* @param {number} [offset] Pagination of the record set. Offset is a zero based index.
|
|
128
|
+
* @param {string} [since] Fetch items that have been created/modified since this date/time.
|
|
129
|
+
* @param {string} [sort] The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
130
|
+
* @param {string} [expand] The object expansion to perform on the result. See documentation for examples
|
|
131
|
+
* @param {boolean} [placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
132
|
+
* @param {*} [options] Override http request option.
|
|
133
|
+
* @throws {RequiredError}
|
|
134
|
+
* @memberof ItemApiInterface
|
|
135
|
+
*/
|
|
136
|
+
getDigitalItemRaw(requestParameters: GetDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemDigitalItemResponse>>;
|
|
137
|
+
/**
|
|
138
|
+
* Retrieves a digital item (file information) from the account. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
|
|
139
|
+
* Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
|
|
140
|
+
*/
|
|
141
|
+
getDigitalItem(requestParameters: GetDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemResponse>;
|
|
142
|
+
/**
|
|
143
|
+
* Retrieves a group of digital items (file information) from the account. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
144
|
+
* @summary Retrieve digital items from the digital library which are digital files that may be attached to normal items
|
|
145
|
+
* @param {number} [limit] The maximum number of records to return on this one API call. (Default 100, Max 2000)
|
|
146
|
+
* @param {number} [offset] Pagination of the record set. Offset is a zero based index.
|
|
147
|
+
* @param {string} [since] Fetch items that have been created/modified since this date/time.
|
|
148
|
+
* @param {string} [sort] The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
149
|
+
* @param {string} [expand] The object expansion to perform on the result. See documentation for examples
|
|
150
|
+
* @param {boolean} [placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
151
|
+
* @param {*} [options] Override http request option.
|
|
152
|
+
* @throws {RequiredError}
|
|
153
|
+
* @memberof ItemApiInterface
|
|
154
|
+
*/
|
|
155
|
+
getDigitalItemsRaw(requestParameters: GetDigitalItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemDigitalItemsResponse>>;
|
|
156
|
+
/**
|
|
157
|
+
* Retrieves a group of digital items (file information) from the account. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
158
|
+
* Retrieve digital items from the digital library which are digital files that may be attached to normal items
|
|
159
|
+
*/
|
|
160
|
+
getDigitalItems(requestParameters: GetDigitalItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
|
|
81
161
|
/**
|
|
82
162
|
* Retrieves a single item using the specified item oid.
|
|
83
163
|
* @summary Retrieve an item
|
|
@@ -145,6 +225,20 @@ export interface ItemApiInterface {
|
|
|
145
225
|
* Retrieve pricing tiers
|
|
146
226
|
*/
|
|
147
227
|
getPricingTiers(requestParameters: GetPricingTiersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PricingTiersResponse>;
|
|
228
|
+
/**
|
|
229
|
+
* Create a file within the digital library. This does not create an item, but makes this digital file available and selectable as part (or all) of an item.
|
|
230
|
+
* @summary Create a file within the digital library
|
|
231
|
+
* @param {ItemDigitalItem} digitalItem Digital item to create
|
|
232
|
+
* @param {*} [options] Override http request option.
|
|
233
|
+
* @throws {RequiredError}
|
|
234
|
+
* @memberof ItemApiInterface
|
|
235
|
+
*/
|
|
236
|
+
insertDigitalItemRaw(requestParameters: InsertDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemDigitalItemResponse>>;
|
|
237
|
+
/**
|
|
238
|
+
* Create a file within the digital library. This does not create an item, but makes this digital file available and selectable as part (or all) of an item.
|
|
239
|
+
* Create a file within the digital library
|
|
240
|
+
*/
|
|
241
|
+
insertDigitalItem(requestParameters: InsertDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemResponse>;
|
|
148
242
|
/**
|
|
149
243
|
* Create a new item on the UltraCart account.
|
|
150
244
|
* @summary Create an item
|
|
@@ -161,6 +255,21 @@ export interface ItemApiInterface {
|
|
|
161
255
|
* Create an item
|
|
162
256
|
*/
|
|
163
257
|
insertItem(requestParameters: InsertItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemResponse>;
|
|
258
|
+
/**
|
|
259
|
+
* 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.
|
|
260
|
+
* @summary Updates a file within the digital library
|
|
261
|
+
* @param {number} digitalItemOid The digital item oid to update.
|
|
262
|
+
* @param {ItemDigitalItem} digitalItem Digital item to update
|
|
263
|
+
* @param {*} [options] Override http request option.
|
|
264
|
+
* @throws {RequiredError}
|
|
265
|
+
* @memberof ItemApiInterface
|
|
266
|
+
*/
|
|
267
|
+
updateDigitalItemRaw(requestParameters: UpdateDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemDigitalItemResponse>>;
|
|
268
|
+
/**
|
|
269
|
+
* 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.
|
|
270
|
+
* Updates a file within the digital library
|
|
271
|
+
*/
|
|
272
|
+
updateDigitalItem(requestParameters: UpdateDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemResponse>;
|
|
164
273
|
/**
|
|
165
274
|
* Update a new item on the UltraCart account.
|
|
166
275
|
* @summary Update an item
|
|
@@ -214,6 +323,16 @@ export interface ItemApiInterface {
|
|
|
214
323
|
*
|
|
215
324
|
*/
|
|
216
325
|
export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface {
|
|
326
|
+
/**
|
|
327
|
+
* Delete a digital item on the UltraCart account.
|
|
328
|
+
* Delete a digital item, which is a file within the digital library, not an actual merchant item
|
|
329
|
+
*/
|
|
330
|
+
deleteDigitalItemRaw(requestParameters: DeleteDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
331
|
+
/**
|
|
332
|
+
* Delete a digital item on the UltraCart account.
|
|
333
|
+
* Delete a digital item, which is a file within the digital library, not an actual merchant item
|
|
334
|
+
*/
|
|
335
|
+
deleteDigitalItem(requestParameters: DeleteDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
217
336
|
/**
|
|
218
337
|
* Delete an item on the UltraCart account.
|
|
219
338
|
* Delete an item
|
|
@@ -224,6 +343,26 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
224
343
|
* Delete an item
|
|
225
344
|
*/
|
|
226
345
|
deleteItem(requestParameters: DeleteItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
346
|
+
/**
|
|
347
|
+
* Retrieves a digital item (file information) from the account. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
|
|
348
|
+
* Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
|
|
349
|
+
*/
|
|
350
|
+
getDigitalItemRaw(requestParameters: GetDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemDigitalItemResponse>>;
|
|
351
|
+
/**
|
|
352
|
+
* Retrieves a digital item (file information) from the account. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
|
|
353
|
+
* Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
|
|
354
|
+
*/
|
|
355
|
+
getDigitalItem(requestParameters: GetDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemResponse>;
|
|
356
|
+
/**
|
|
357
|
+
* Retrieves a group of digital items (file information) from the account. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
358
|
+
* Retrieve digital items from the digital library which are digital files that may be attached to normal items
|
|
359
|
+
*/
|
|
360
|
+
getDigitalItemsRaw(requestParameters: GetDigitalItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemDigitalItemsResponse>>;
|
|
361
|
+
/**
|
|
362
|
+
* Retrieves a group of digital items (file information) from the account. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
363
|
+
* Retrieve digital items from the digital library which are digital files that may be attached to normal items
|
|
364
|
+
*/
|
|
365
|
+
getDigitalItems(requestParameters?: GetDigitalItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
|
|
227
366
|
/**
|
|
228
367
|
* Retrieves a single item using the specified item oid.
|
|
229
368
|
* Retrieve an item
|
|
@@ -264,6 +403,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
264
403
|
* Retrieve pricing tiers
|
|
265
404
|
*/
|
|
266
405
|
getPricingTiers(requestParameters?: GetPricingTiersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PricingTiersResponse>;
|
|
406
|
+
/**
|
|
407
|
+
* Create a file within the digital library. This does not create an item, but makes this digital file available and selectable as part (or all) of an item.
|
|
408
|
+
* Create a file within the digital library
|
|
409
|
+
*/
|
|
410
|
+
insertDigitalItemRaw(requestParameters: InsertDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemDigitalItemResponse>>;
|
|
411
|
+
/**
|
|
412
|
+
* Create a file within the digital library. This does not create an item, but makes this digital file available and selectable as part (or all) of an item.
|
|
413
|
+
* Create a file within the digital library
|
|
414
|
+
*/
|
|
415
|
+
insertDigitalItem(requestParameters: InsertDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemResponse>;
|
|
267
416
|
/**
|
|
268
417
|
* Create a new item on the UltraCart account.
|
|
269
418
|
* Create an item
|
|
@@ -274,6 +423,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
274
423
|
* Create an item
|
|
275
424
|
*/
|
|
276
425
|
insertItem(requestParameters: InsertItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemResponse>;
|
|
426
|
+
/**
|
|
427
|
+
* 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.
|
|
428
|
+
* Updates a file within the digital library
|
|
429
|
+
*/
|
|
430
|
+
updateDigitalItemRaw(requestParameters: UpdateDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemDigitalItemResponse>>;
|
|
431
|
+
/**
|
|
432
|
+
* 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.
|
|
433
|
+
* Updates a file within the digital library
|
|
434
|
+
*/
|
|
435
|
+
updateDigitalItem(requestParameters: UpdateDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemResponse>;
|
|
277
436
|
/**
|
|
278
437
|
* Update a new item on the UltraCart account.
|
|
279
438
|
* Update an item
|