ultracart_rest_api_v2_typescript 4.1.83 → 4.1.85
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 +5 -3
- package/README.md +4 -2
- package/dist/apis/ItemApi.d.ts +171 -92
- package/dist/apis/ItemApi.js +342 -162
- package/dist/apis/OrderApi.d.ts +52 -0
- package/dist/apis/OrderApi.js +117 -0
- package/dist/models/Item.d.ts +7 -0
- package/dist/models/Item.js +3 -0
- package/dist/models/ItemGatedCode.d.ts +49 -0
- package/dist/models/ItemGatedCode.js +56 -0
- package/dist/models/ItemGatedCodeResponse.d.ts +59 -0
- package/dist/models/ItemGatedCodeResponse.js +62 -0
- package/dist/models/ItemGatedCodesRequest.d.ts +32 -0
- package/dist/models/ItemGatedCodesRequest.js +51 -0
- package/dist/models/ItemGatedCodesResponse.d.ts +59 -0
- package/dist/models/ItemGatedCodesResponse.js +62 -0
- package/dist/models/ItemGenerateGatedCodesRequest.d.ts +43 -0
- package/dist/models/ItemGenerateGatedCodesRequest.js +54 -0
- package/dist/models/OrderQuery.d.ts +1 -0
- package/dist/models/OrderQuery.js +2 -1
- package/dist/models/Warning.d.ts +6 -0
- package/dist/models/Warning.js +2 -0
- package/dist/models/index.d.ts +5 -3
- package/dist/models/index.js +5 -3
- package/package.json +1 -1
- package/src/apis/ItemApi.ts +417 -226
- package/src/apis/OrderApi.ts +121 -0
- package/src/models/Item.ts +14 -0
- package/src/models/ItemGatedCode.ts +91 -0
- package/src/models/{ItemShippingDistributionCenterResponse.ts → ItemGatedCodeResponse.ts} +22 -22
- package/src/models/ItemGatedCodesRequest.ts +74 -0
- package/src/models/ItemGatedCodesResponse.ts +124 -0
- package/src/models/ItemGenerateGatedCodesRequest.ts +83 -0
- package/src/models/OrderQuery.ts +2 -1
- package/src/models/Warning.ts +8 -0
- package/src/models/index.ts +5 -3
- package/dist/models/ItemInventoryUpdate.d.ts +0 -43
- package/dist/models/ItemInventoryUpdateRequest.d.ts +0 -32
- package/dist/models/ItemShippingDistributionCenterResponse.d.ts +0 -59
- package/src/models/ItemInventoryUpdate.ts +0 -83
- package/src/models/ItemInventoryUpdateRequest.ts +0 -74
package/.openapi-generator/FILES
CHANGED
|
@@ -664,6 +664,11 @@ src/models/ItemEbayMarketPlaceAnalysis.ts
|
|
|
664
664
|
src/models/ItemEmailNotifications.ts
|
|
665
665
|
src/models/ItemEnrollment123.ts
|
|
666
666
|
src/models/ItemFulfillmentAddon.ts
|
|
667
|
+
src/models/ItemGatedCode.ts
|
|
668
|
+
src/models/ItemGatedCodeResponse.ts
|
|
669
|
+
src/models/ItemGatedCodesRequest.ts
|
|
670
|
+
src/models/ItemGatedCodesResponse.ts
|
|
671
|
+
src/models/ItemGenerateGatedCodesRequest.ts
|
|
667
672
|
src/models/ItemGiftCertificate.ts
|
|
668
673
|
src/models/ItemGoogleProductSearch.ts
|
|
669
674
|
src/models/ItemIdentifiers.ts
|
|
@@ -673,8 +678,6 @@ src/models/ItemInternal.ts
|
|
|
673
678
|
src/models/ItemInventorySnapshot.ts
|
|
674
679
|
src/models/ItemInventorySnapshotDistributionCenter.ts
|
|
675
680
|
src/models/ItemInventorySnapshotResponse.ts
|
|
676
|
-
src/models/ItemInventoryUpdate.ts
|
|
677
|
-
src/models/ItemInventoryUpdateRequest.ts
|
|
678
681
|
src/models/ItemKitComponent.ts
|
|
679
682
|
src/models/ItemKitDefinition.ts
|
|
680
683
|
src/models/ItemOption.ts
|
|
@@ -706,7 +709,6 @@ src/models/ItemShippingCase.ts
|
|
|
706
709
|
src/models/ItemShippingDestinationMarkup.ts
|
|
707
710
|
src/models/ItemShippingDestinationRestriction.ts
|
|
708
711
|
src/models/ItemShippingDistributionCenter.ts
|
|
709
|
-
src/models/ItemShippingDistributionCenterResponse.ts
|
|
710
712
|
src/models/ItemShippingMethod.ts
|
|
711
713
|
src/models/ItemShippingPackageRequirement.ts
|
|
712
714
|
src/models/ItemTag.ts
|
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.85
|
|
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.
|
|
9
|
+
npm install ultracart_rest_api_v2_typescript@4.1.85 --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.85 | 05/05/2026 | improved warning object for customer insertCustomer and updateCustomer |
|
|
89
|
+
| 4.1.84 | 05/04/2026 | Order API - add hold stage to allowed values on order query request |
|
|
88
90
|
| 4.1.83 | 04/29/2026 | AO support for item appending on cancel request, order payment method test routing on hold release |
|
|
89
91
|
| 4.1.82 | 04/27/2026 | converation - agent status and availability |
|
|
90
92
|
| 4.1.81 | 04/27/2026 | conversations - agent status and availability |
|
package/dist/apis/ItemApi.d.ts
CHANGED
|
@@ -10,10 +10,17 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { Item, ItemContentAttribute, ItemDigitalItem, ItemDigitalItemResponse, ItemDigitalItemsResponse,
|
|
13
|
+
import { BaseResponse, Item, ItemContentAttribute, ItemDigitalItem, ItemDigitalItemResponse, ItemDigitalItemsResponse, ItemGatedCode, ItemGatedCodeResponse, ItemGatedCodesRequest, ItemGatedCodesResponse, ItemGenerateGatedCodesRequest, ItemInventorySnapshotResponse, ItemResponse, ItemReview, ItemReviewResponse, ItemReviewsResponse, ItemsRequest, ItemsResponse, PricingTiersResponse, TempMultimediaResponse } from '../models';
|
|
14
|
+
export interface DeleteAllGatedCodesRequest {
|
|
15
|
+
merchantItemOid: number;
|
|
16
|
+
}
|
|
14
17
|
export interface DeleteDigitalItemRequest {
|
|
15
18
|
digitalItemOid: number;
|
|
16
19
|
}
|
|
20
|
+
export interface DeleteGatedCodeRequest {
|
|
21
|
+
merchantItemOid: number;
|
|
22
|
+
merchantItemGatedCodeOid: number;
|
|
23
|
+
}
|
|
17
24
|
export interface DeleteItemRequest {
|
|
18
25
|
merchantItemOid: number;
|
|
19
26
|
}
|
|
@@ -21,6 +28,10 @@ export interface DeleteReviewRequest {
|
|
|
21
28
|
reviewOid: number;
|
|
22
29
|
merchantItemOid: number;
|
|
23
30
|
}
|
|
31
|
+
export interface GenerateGatedCodesRequest {
|
|
32
|
+
merchantItemOid: number;
|
|
33
|
+
generateRequest: ItemGenerateGatedCodesRequest;
|
|
34
|
+
}
|
|
24
35
|
export interface GetDigitalItemRequest {
|
|
25
36
|
digitalItemOid: number;
|
|
26
37
|
}
|
|
@@ -35,6 +46,9 @@ export interface GetDigitalItemsRequest {
|
|
|
35
46
|
export interface GetDigitalItemsByExternalIdRequest {
|
|
36
47
|
externalId: string;
|
|
37
48
|
}
|
|
49
|
+
export interface GetGatedCodesRequest {
|
|
50
|
+
merchantItemOid: number;
|
|
51
|
+
}
|
|
38
52
|
export interface GetItemRequest {
|
|
39
53
|
merchantItemOid: number;
|
|
40
54
|
expand?: string;
|
|
@@ -45,12 +59,6 @@ export interface GetItemByMerchantItemIdRequest {
|
|
|
45
59
|
expand?: string;
|
|
46
60
|
placeholders?: boolean;
|
|
47
61
|
}
|
|
48
|
-
export interface GetItemShippingDistributionCenterByCodeRequest {
|
|
49
|
-
merchantItemOid: number;
|
|
50
|
-
distributionCenterCode: string;
|
|
51
|
-
expand?: string;
|
|
52
|
-
placeholders?: boolean;
|
|
53
|
-
}
|
|
54
62
|
export interface GetItemsRequest {
|
|
55
63
|
parentCategoryId?: number;
|
|
56
64
|
parentCategoryPath?: string;
|
|
@@ -82,6 +90,10 @@ export interface GetUnassociatedDigitalItemsRequest {
|
|
|
82
90
|
export interface InsertDigitalItemRequest {
|
|
83
91
|
digitalItem: ItemDigitalItem;
|
|
84
92
|
}
|
|
93
|
+
export interface InsertGatedCodeRequest {
|
|
94
|
+
merchantItemOid: number;
|
|
95
|
+
gatedCode: ItemGatedCode;
|
|
96
|
+
}
|
|
85
97
|
export interface InsertItemRequest {
|
|
86
98
|
item: Item;
|
|
87
99
|
expand?: string;
|
|
@@ -95,6 +107,10 @@ export interface InsertUpdateItemContentAttributeRequest {
|
|
|
95
107
|
merchantItemOid: number;
|
|
96
108
|
itemAttribute: ItemContentAttribute;
|
|
97
109
|
}
|
|
110
|
+
export interface ReplaceGatedCodesRequest {
|
|
111
|
+
merchantItemOid: number;
|
|
112
|
+
gatedCodesRequest: ItemGatedCodesRequest;
|
|
113
|
+
}
|
|
98
114
|
export interface UpdateDigitalItemRequest {
|
|
99
115
|
digitalItemOid: number;
|
|
100
116
|
digitalItem: ItemDigitalItem;
|
|
@@ -105,14 +121,6 @@ export interface UpdateItemRequest {
|
|
|
105
121
|
expand?: string;
|
|
106
122
|
placeholders?: boolean;
|
|
107
123
|
}
|
|
108
|
-
export interface UpdateItemInventoriesRequest {
|
|
109
|
-
itemInventoryUpdateRequest: ItemInventoryUpdateRequest;
|
|
110
|
-
}
|
|
111
|
-
export interface UpdateItemShippingDistributionCenterByCodeRequest {
|
|
112
|
-
merchantItemOid: number;
|
|
113
|
-
distributionCenterCode: string;
|
|
114
|
-
itemShippingDistributionCenter: ItemShippingDistributionCenter;
|
|
115
|
-
}
|
|
116
124
|
export interface UpdateItemsRequest {
|
|
117
125
|
itemsRequest: ItemsRequest;
|
|
118
126
|
expand?: string;
|
|
@@ -134,6 +142,20 @@ export interface UploadTemporaryMultimediaRequest {
|
|
|
134
142
|
* @interface ItemApiInterface
|
|
135
143
|
*/
|
|
136
144
|
export interface ItemApiInterface {
|
|
145
|
+
/**
|
|
146
|
+
* Removes every gated access code currently configured for the item.
|
|
147
|
+
* @summary Delete all gated access codes for an item
|
|
148
|
+
* @param {number} merchantItemOid The item oid.
|
|
149
|
+
* @param {*} [options] Override http request option.
|
|
150
|
+
* @throws {RequiredError}
|
|
151
|
+
* @memberof ItemApiInterface
|
|
152
|
+
*/
|
|
153
|
+
deleteAllGatedCodesRaw(requestParameters: DeleteAllGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BaseResponse>>;
|
|
154
|
+
/**
|
|
155
|
+
* Removes every gated access code currently configured for the item.
|
|
156
|
+
* Delete all gated access codes for an item
|
|
157
|
+
*/
|
|
158
|
+
deleteAllGatedCodes(requestParameters: DeleteAllGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BaseResponse>;
|
|
137
159
|
/**
|
|
138
160
|
* Delete a digital item on the UltraCart account.
|
|
139
161
|
* @summary Delete a digital item, which is a file within the digital library, not an actual merchant item
|
|
@@ -148,6 +170,21 @@ export interface ItemApiInterface {
|
|
|
148
170
|
* Delete a digital item, which is a file within the digital library, not an actual merchant item
|
|
149
171
|
*/
|
|
150
172
|
deleteDigitalItem(requestParameters: DeleteDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
173
|
+
/**
|
|
174
|
+
* Delete a specific gated access code by its OID.
|
|
175
|
+
* @summary Delete a gated access code by OID
|
|
176
|
+
* @param {number} merchantItemOid The item oid.
|
|
177
|
+
* @param {number} merchantItemGatedCodeOid The gated code oid.
|
|
178
|
+
* @param {*} [options] Override http request option.
|
|
179
|
+
* @throws {RequiredError}
|
|
180
|
+
* @memberof ItemApiInterface
|
|
181
|
+
*/
|
|
182
|
+
deleteGatedCodeRaw(requestParameters: DeleteGatedCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BaseResponse>>;
|
|
183
|
+
/**
|
|
184
|
+
* Delete a specific gated access code by its OID.
|
|
185
|
+
* Delete a gated access code by OID
|
|
186
|
+
*/
|
|
187
|
+
deleteGatedCode(requestParameters: DeleteGatedCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BaseResponse>;
|
|
151
188
|
/**
|
|
152
189
|
* Delete an item on the UltraCart account.
|
|
153
190
|
* @summary Delete an item
|
|
@@ -177,6 +214,21 @@ export interface ItemApiInterface {
|
|
|
177
214
|
* Delete a review
|
|
178
215
|
*/
|
|
179
216
|
deleteReview(requestParameters: DeleteReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
217
|
+
/**
|
|
218
|
+
* Returns randomly generated codes using a profanity-safe charset (vowel-free, 0/1 removed). Codes are NOT persisted; submit them via PUT or POST to commit.
|
|
219
|
+
* @summary Generate a batch of gated access codes
|
|
220
|
+
* @param {number} merchantItemOid The item oid.
|
|
221
|
+
* @param {ItemGenerateGatedCodesRequest} generateRequest Generate request.
|
|
222
|
+
* @param {*} [options] Override http request option.
|
|
223
|
+
* @throws {RequiredError}
|
|
224
|
+
* @memberof ItemApiInterface
|
|
225
|
+
*/
|
|
226
|
+
generateGatedCodesRaw(requestParameters: GenerateGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemGatedCodesResponse>>;
|
|
227
|
+
/**
|
|
228
|
+
* Returns randomly generated codes using a profanity-safe charset (vowel-free, 0/1 removed). Codes are NOT persisted; submit them via PUT or POST to commit.
|
|
229
|
+
* Generate a batch of gated access codes
|
|
230
|
+
*/
|
|
231
|
+
generateGatedCodes(requestParameters: GenerateGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemGatedCodesResponse>;
|
|
180
232
|
/**
|
|
181
233
|
* 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.
|
|
182
234
|
* @summary Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
|
|
@@ -224,6 +276,20 @@ export interface ItemApiInterface {
|
|
|
224
276
|
* Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
|
|
225
277
|
*/
|
|
226
278
|
getDigitalItemsByExternalId(requestParameters: GetDigitalItemsByExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
|
|
279
|
+
/**
|
|
280
|
+
* Retrieve all unredeemed gated access codes configured for an item.
|
|
281
|
+
* @summary Get gated access codes for an item
|
|
282
|
+
* @param {number} merchantItemOid The item oid.
|
|
283
|
+
* @param {*} [options] Override http request option.
|
|
284
|
+
* @throws {RequiredError}
|
|
285
|
+
* @memberof ItemApiInterface
|
|
286
|
+
*/
|
|
287
|
+
getGatedCodesRaw(requestParameters: GetGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemGatedCodesResponse>>;
|
|
288
|
+
/**
|
|
289
|
+
* Retrieve all unredeemed gated access codes configured for an item.
|
|
290
|
+
* Get gated access codes for an item
|
|
291
|
+
*/
|
|
292
|
+
getGatedCodes(requestParameters: GetGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemGatedCodesResponse>;
|
|
227
293
|
/**
|
|
228
294
|
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
229
295
|
* @summary Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
@@ -269,23 +335,6 @@ export interface ItemApiInterface {
|
|
|
269
335
|
* Retrieve an item by item id
|
|
270
336
|
*/
|
|
271
337
|
getItemByMerchantItemId(requestParameters: GetItemByMerchantItemIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemResponse>;
|
|
272
|
-
/**
|
|
273
|
-
* Retrieve an item shipping distribution center.
|
|
274
|
-
* @summary Retrieve an item shipping distribution center
|
|
275
|
-
* @param {number} merchantItemOid The item oid to retrieve.
|
|
276
|
-
* @param {string} distributionCenterCode
|
|
277
|
-
* @param {string} [expand] The object expansion to perform on the result. See documentation for examples
|
|
278
|
-
* @param {boolean} [placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
279
|
-
* @param {*} [options] Override http request option.
|
|
280
|
-
* @throws {RequiredError}
|
|
281
|
-
* @memberof ItemApiInterface
|
|
282
|
-
*/
|
|
283
|
-
getItemShippingDistributionCenterByCodeRaw(requestParameters: GetItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemShippingDistributionCenterResponse>>;
|
|
284
|
-
/**
|
|
285
|
-
* Retrieve an item shipping distribution center.
|
|
286
|
-
* Retrieve an item shipping distribution center
|
|
287
|
-
*/
|
|
288
|
-
getItemShippingDistributionCenterByCode(requestParameters: GetItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemShippingDistributionCenterResponse>;
|
|
289
338
|
/**
|
|
290
339
|
* Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
291
340
|
* @summary Retrieve items
|
|
@@ -383,6 +432,21 @@ export interface ItemApiInterface {
|
|
|
383
432
|
* Create a file within the digital library
|
|
384
433
|
*/
|
|
385
434
|
insertDigitalItem(requestParameters: InsertDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemResponse>;
|
|
435
|
+
/**
|
|
436
|
+
* Insert a single gated access code; the server assigns the OID and created_dts.
|
|
437
|
+
* @summary Add a single gated access code to an item
|
|
438
|
+
* @param {number} merchantItemOid The item oid.
|
|
439
|
+
* @param {ItemGatedCode} gatedCode Gated code to insert.
|
|
440
|
+
* @param {*} [options] Override http request option.
|
|
441
|
+
* @throws {RequiredError}
|
|
442
|
+
* @memberof ItemApiInterface
|
|
443
|
+
*/
|
|
444
|
+
insertGatedCodeRaw(requestParameters: InsertGatedCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemGatedCodeResponse>>;
|
|
445
|
+
/**
|
|
446
|
+
* Insert a single gated access code; the server assigns the OID and created_dts.
|
|
447
|
+
* Add a single gated access code to an item
|
|
448
|
+
*/
|
|
449
|
+
insertGatedCode(requestParameters: InsertGatedCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemGatedCodeResponse>;
|
|
386
450
|
/**
|
|
387
451
|
* Create a new item on the UltraCart account.
|
|
388
452
|
* @summary Create an item
|
|
@@ -429,6 +493,21 @@ export interface ItemApiInterface {
|
|
|
429
493
|
* Upsert an item content attribute
|
|
430
494
|
*/
|
|
431
495
|
insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
496
|
+
/**
|
|
497
|
+
* Existing codes not present in the request body are deleted. New codes are inserted. Unchanged codes preserve their OID and created_dts.
|
|
498
|
+
* @summary Replace the full list of gated access codes for an item
|
|
499
|
+
* @param {number} merchantItemOid The item oid.
|
|
500
|
+
* @param {ItemGatedCodesRequest} gatedCodesRequest Codes to replace the existing list with.
|
|
501
|
+
* @param {*} [options] Override http request option.
|
|
502
|
+
* @throws {RequiredError}
|
|
503
|
+
* @memberof ItemApiInterface
|
|
504
|
+
*/
|
|
505
|
+
replaceGatedCodesRaw(requestParameters: ReplaceGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemGatedCodesResponse>>;
|
|
506
|
+
/**
|
|
507
|
+
* Existing codes not present in the request body are deleted. New codes are inserted. Unchanged codes preserve their OID and created_dts.
|
|
508
|
+
* Replace the full list of gated access codes for an item
|
|
509
|
+
*/
|
|
510
|
+
replaceGatedCodes(requestParameters: ReplaceGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemGatedCodesResponse>;
|
|
432
511
|
/**
|
|
433
512
|
* 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.
|
|
434
513
|
* @summary Updates a file within the digital library
|
|
@@ -461,36 +540,6 @@ export interface ItemApiInterface {
|
|
|
461
540
|
* Update an item
|
|
462
541
|
*/
|
|
463
542
|
updateItem(requestParameters: UpdateItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemResponse>;
|
|
464
|
-
/**
|
|
465
|
-
* Update item inventories for a distribution center
|
|
466
|
-
* @summary Update item inventories for a distribution center
|
|
467
|
-
* @param {ItemInventoryUpdateRequest} itemInventoryUpdateRequest Item inventory updates
|
|
468
|
-
* @param {*} [options] Override http request option.
|
|
469
|
-
* @throws {RequiredError}
|
|
470
|
-
* @memberof ItemApiInterface
|
|
471
|
-
*/
|
|
472
|
-
updateItemInventoriesRaw(requestParameters: UpdateItemInventoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
473
|
-
/**
|
|
474
|
-
* Update item inventories for a distribution center
|
|
475
|
-
* Update item inventories for a distribution center
|
|
476
|
-
*/
|
|
477
|
-
updateItemInventories(requestParameters: UpdateItemInventoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
478
|
-
/**
|
|
479
|
-
* Update an item shipping distribution center
|
|
480
|
-
* @summary Update an item shipping distribution center
|
|
481
|
-
* @param {number} merchantItemOid The item oid to update.
|
|
482
|
-
* @param {string} distributionCenterCode
|
|
483
|
-
* @param {ItemShippingDistributionCenter} itemShippingDistributionCenter Item shipping distribution center
|
|
484
|
-
* @param {*} [options] Override http request option.
|
|
485
|
-
* @throws {RequiredError}
|
|
486
|
-
* @memberof ItemApiInterface
|
|
487
|
-
*/
|
|
488
|
-
updateItemShippingDistributionCenterByCodeRaw(requestParameters: UpdateItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
489
|
-
/**
|
|
490
|
-
* Update an item shipping distribution center
|
|
491
|
-
* Update an item shipping distribution center
|
|
492
|
-
*/
|
|
493
|
-
updateItemShippingDistributionCenterByCode(requestParameters: UpdateItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
494
543
|
/**
|
|
495
544
|
* Update multiple item on the UltraCart account.
|
|
496
545
|
* @summary Update multiple items
|
|
@@ -543,6 +592,16 @@ export interface ItemApiInterface {
|
|
|
543
592
|
*
|
|
544
593
|
*/
|
|
545
594
|
export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface {
|
|
595
|
+
/**
|
|
596
|
+
* Removes every gated access code currently configured for the item.
|
|
597
|
+
* Delete all gated access codes for an item
|
|
598
|
+
*/
|
|
599
|
+
deleteAllGatedCodesRaw(requestParameters: DeleteAllGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BaseResponse>>;
|
|
600
|
+
/**
|
|
601
|
+
* Removes every gated access code currently configured for the item.
|
|
602
|
+
* Delete all gated access codes for an item
|
|
603
|
+
*/
|
|
604
|
+
deleteAllGatedCodes(requestParameters: DeleteAllGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BaseResponse>;
|
|
546
605
|
/**
|
|
547
606
|
* Delete a digital item on the UltraCart account.
|
|
548
607
|
* Delete a digital item, which is a file within the digital library, not an actual merchant item
|
|
@@ -553,6 +612,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
553
612
|
* Delete a digital item, which is a file within the digital library, not an actual merchant item
|
|
554
613
|
*/
|
|
555
614
|
deleteDigitalItem(requestParameters: DeleteDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
615
|
+
/**
|
|
616
|
+
* Delete a specific gated access code by its OID.
|
|
617
|
+
* Delete a gated access code by OID
|
|
618
|
+
*/
|
|
619
|
+
deleteGatedCodeRaw(requestParameters: DeleteGatedCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BaseResponse>>;
|
|
620
|
+
/**
|
|
621
|
+
* Delete a specific gated access code by its OID.
|
|
622
|
+
* Delete a gated access code by OID
|
|
623
|
+
*/
|
|
624
|
+
deleteGatedCode(requestParameters: DeleteGatedCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BaseResponse>;
|
|
556
625
|
/**
|
|
557
626
|
* Delete an item on the UltraCart account.
|
|
558
627
|
* Delete an item
|
|
@@ -573,6 +642,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
573
642
|
* Delete a review
|
|
574
643
|
*/
|
|
575
644
|
deleteReview(requestParameters: DeleteReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
645
|
+
/**
|
|
646
|
+
* Returns randomly generated codes using a profanity-safe charset (vowel-free, 0/1 removed). Codes are NOT persisted; submit them via PUT or POST to commit.
|
|
647
|
+
* Generate a batch of gated access codes
|
|
648
|
+
*/
|
|
649
|
+
generateGatedCodesRaw(requestParameters: GenerateGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemGatedCodesResponse>>;
|
|
650
|
+
/**
|
|
651
|
+
* Returns randomly generated codes using a profanity-safe charset (vowel-free, 0/1 removed). Codes are NOT persisted; submit them via PUT or POST to commit.
|
|
652
|
+
* Generate a batch of gated access codes
|
|
653
|
+
*/
|
|
654
|
+
generateGatedCodes(requestParameters: GenerateGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemGatedCodesResponse>;
|
|
576
655
|
/**
|
|
577
656
|
* 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.
|
|
578
657
|
* Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
|
|
@@ -603,6 +682,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
603
682
|
* Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
|
|
604
683
|
*/
|
|
605
684
|
getDigitalItemsByExternalId(requestParameters: GetDigitalItemsByExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
|
|
685
|
+
/**
|
|
686
|
+
* Retrieve all unredeemed gated access codes configured for an item.
|
|
687
|
+
* Get gated access codes for an item
|
|
688
|
+
*/
|
|
689
|
+
getGatedCodesRaw(requestParameters: GetGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemGatedCodesResponse>>;
|
|
690
|
+
/**
|
|
691
|
+
* Retrieve all unredeemed gated access codes configured for an item.
|
|
692
|
+
* Get gated access codes for an item
|
|
693
|
+
*/
|
|
694
|
+
getGatedCodes(requestParameters: GetGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemGatedCodesResponse>;
|
|
606
695
|
/**
|
|
607
696
|
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
608
697
|
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
@@ -633,16 +722,6 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
633
722
|
* Retrieve an item by item id
|
|
634
723
|
*/
|
|
635
724
|
getItemByMerchantItemId(requestParameters: GetItemByMerchantItemIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemResponse>;
|
|
636
|
-
/**
|
|
637
|
-
* Retrieve an item shipping distribution center.
|
|
638
|
-
* Retrieve an item shipping distribution center
|
|
639
|
-
*/
|
|
640
|
-
getItemShippingDistributionCenterByCodeRaw(requestParameters: GetItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemShippingDistributionCenterResponse>>;
|
|
641
|
-
/**
|
|
642
|
-
* Retrieve an item shipping distribution center.
|
|
643
|
-
* Retrieve an item shipping distribution center
|
|
644
|
-
*/
|
|
645
|
-
getItemShippingDistributionCenterByCode(requestParameters: GetItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemShippingDistributionCenterResponse>;
|
|
646
725
|
/**
|
|
647
726
|
* Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
648
727
|
* Retrieve items
|
|
@@ -703,6 +782,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
703
782
|
* Create a file within the digital library
|
|
704
783
|
*/
|
|
705
784
|
insertDigitalItem(requestParameters: InsertDigitalItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemResponse>;
|
|
785
|
+
/**
|
|
786
|
+
* Insert a single gated access code; the server assigns the OID and created_dts.
|
|
787
|
+
* Add a single gated access code to an item
|
|
788
|
+
*/
|
|
789
|
+
insertGatedCodeRaw(requestParameters: InsertGatedCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemGatedCodeResponse>>;
|
|
790
|
+
/**
|
|
791
|
+
* Insert a single gated access code; the server assigns the OID and created_dts.
|
|
792
|
+
* Add a single gated access code to an item
|
|
793
|
+
*/
|
|
794
|
+
insertGatedCode(requestParameters: InsertGatedCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemGatedCodeResponse>;
|
|
706
795
|
/**
|
|
707
796
|
* Create a new item on the UltraCart account.
|
|
708
797
|
* Create an item
|
|
@@ -733,6 +822,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
733
822
|
* Upsert an item content attribute
|
|
734
823
|
*/
|
|
735
824
|
insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
825
|
+
/**
|
|
826
|
+
* Existing codes not present in the request body are deleted. New codes are inserted. Unchanged codes preserve their OID and created_dts.
|
|
827
|
+
* Replace the full list of gated access codes for an item
|
|
828
|
+
*/
|
|
829
|
+
replaceGatedCodesRaw(requestParameters: ReplaceGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemGatedCodesResponse>>;
|
|
830
|
+
/**
|
|
831
|
+
* Existing codes not present in the request body are deleted. New codes are inserted. Unchanged codes preserve their OID and created_dts.
|
|
832
|
+
* Replace the full list of gated access codes for an item
|
|
833
|
+
*/
|
|
834
|
+
replaceGatedCodes(requestParameters: ReplaceGatedCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemGatedCodesResponse>;
|
|
736
835
|
/**
|
|
737
836
|
* 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.
|
|
738
837
|
* Updates a file within the digital library
|
|
@@ -753,26 +852,6 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
753
852
|
* Update an item
|
|
754
853
|
*/
|
|
755
854
|
updateItem(requestParameters: UpdateItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemResponse>;
|
|
756
|
-
/**
|
|
757
|
-
* Update item inventories for a distribution center
|
|
758
|
-
* Update item inventories for a distribution center
|
|
759
|
-
*/
|
|
760
|
-
updateItemInventoriesRaw(requestParameters: UpdateItemInventoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
761
|
-
/**
|
|
762
|
-
* Update item inventories for a distribution center
|
|
763
|
-
* Update item inventories for a distribution center
|
|
764
|
-
*/
|
|
765
|
-
updateItemInventories(requestParameters: UpdateItemInventoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
766
|
-
/**
|
|
767
|
-
* Update an item shipping distribution center
|
|
768
|
-
* Update an item shipping distribution center
|
|
769
|
-
*/
|
|
770
|
-
updateItemShippingDistributionCenterByCodeRaw(requestParameters: UpdateItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
771
|
-
/**
|
|
772
|
-
* Update an item shipping distribution center
|
|
773
|
-
* Update an item shipping distribution center
|
|
774
|
-
*/
|
|
775
|
-
updateItemShippingDistributionCenterByCode(requestParameters: UpdateItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
776
855
|
/**
|
|
777
856
|
* Update multiple item on the UltraCart account.
|
|
778
857
|
* Update multiple items
|