ultracart_rest_api_v2_typescript 3.10.226 → 3.11.0

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@3.10.226
1
+ ## ultracart_rest_api_v2_typescript@3.11.0
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@3.10.226 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.11.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.11.0 | 02/21/2025 | ItemApi.getInventorySnapshot had bad nickname causing bad sdk method name |
58
+ | 3.10.228 | 02/20/2025 | automation fix |
59
+ | 3.10.227 | 02/20/2025 | no change, revving sdk to troubleshoot java deployment automation |
57
60
  | 3.10.226 | 02/20/2025 | no change, revving sdk to troubleshoot java deployment automation |
58
61
  | 3.10.225 | 02/18/2025 | small bug fixes for incorrect return types on several methods |
59
62
  | 3.10.224 | 02/06/2025 | added storefront_host_name to channel partner order object |
package/api.ts CHANGED
@@ -34307,6 +34307,12 @@ export interface OrderPayment {
34307
34307
  * @memberof OrderPayment
34308
34308
  */
34309
34309
  payment_status?: OrderPayment.PaymentStatusEnum;
34310
+ /**
34311
+ *
34312
+ * @type {OrderPaymentPayPal}
34313
+ * @memberof OrderPayment
34314
+ */
34315
+ paypal?: OrderPaymentPayPal;
34310
34316
  /**
34311
34317
  *
34312
34318
  * @type {OrderPaymentPurchaseOrder}
@@ -34737,6 +34743,26 @@ export interface OrderPaymentInsurance {
34737
34743
  refund_claim_id?: string;
34738
34744
  }
34739
34745
 
34746
+ /**
34747
+ *
34748
+ * @export
34749
+ * @interface OrderPaymentPayPal
34750
+ */
34751
+ export interface OrderPaymentPayPal {
34752
+ /**
34753
+ * PayPal Customer ID
34754
+ * @type {string}
34755
+ * @memberof OrderPaymentPayPal
34756
+ */
34757
+ customer_id?: string;
34758
+ /**
34759
+ * PayPal Vault ID
34760
+ * @type {string}
34761
+ * @memberof OrderPaymentPayPal
34762
+ */
34763
+ vault_id?: string;
34764
+ }
34765
+
34740
34766
  /**
34741
34767
  *
34742
34768
  * @export
@@ -69682,6 +69708,52 @@ export const ItemApiFetchParamCreator = function (configuration?: Configuration)
69682
69708
 
69683
69709
 
69684
69710
 
69711
+ // authentication ultraCartOauth required
69712
+ // oauth required
69713
+ if (configuration && configuration.accessToken) {
69714
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
69715
+ ? configuration.accessToken("ultraCartOauth", ["item_read"])
69716
+ : configuration.accessToken;
69717
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
69718
+ }
69719
+
69720
+ // authentication ultraCartSimpleApiKey required
69721
+ if (configuration && configuration.apiKey) {
69722
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
69723
+ ? configuration.apiKey("x-ultracart-simple-key")
69724
+ : configuration.apiKey;
69725
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
69726
+ }
69727
+
69728
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
69729
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
69730
+ delete localVarUrlObj.search;
69731
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
69732
+
69733
+ return {
69734
+ url: url.format(localVarUrlObj),
69735
+ options: localVarRequestOptions,
69736
+ };
69737
+ },
69738
+ /**
69739
+ * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
69740
+ * @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.
69741
+ * @param {*} [options] Override http request option.
69742
+ * @throws {RequiredError}
69743
+ */
69744
+ getInventorySnapshot(options: any = {}): FetchArgs {
69745
+ const localVarPath = `/item/items/inventory_snapshot`;
69746
+ const localVarUrlObj = url.parse(localVarPath, true);
69747
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
69748
+ const localVarHeaderParameter = {} as any;
69749
+ const localVarQueryParameter = {} as any;
69750
+
69751
+ if(configuration && configuration.apiVersion) {
69752
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
69753
+ }
69754
+
69755
+
69756
+
69685
69757
  // authentication ultraCartOauth required
69686
69758
  // oauth required
69687
69759
  if (configuration && configuration.accessToken) {
@@ -70398,52 +70470,6 @@ export const ItemApiFetchParamCreator = function (configuration?: Configuration)
70398
70470
  options: localVarRequestOptions,
70399
70471
  };
70400
70472
  },
70401
- /**
70402
- * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
70403
- * @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.
70404
- * @param {*} [options] Override http request option.
70405
- * @throws {RequiredError}
70406
- */
70407
- restItemInventorySnapshotResponse(options: any = {}): FetchArgs {
70408
- const localVarPath = `/item/items/inventory_snapshot`;
70409
- const localVarUrlObj = url.parse(localVarPath, true);
70410
- const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
70411
- const localVarHeaderParameter = {} as any;
70412
- const localVarQueryParameter = {} as any;
70413
-
70414
- if(configuration && configuration.apiVersion) {
70415
- localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
70416
- }
70417
-
70418
-
70419
-
70420
- // authentication ultraCartOauth required
70421
- // oauth required
70422
- if (configuration && configuration.accessToken) {
70423
- const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
70424
- ? configuration.accessToken("ultraCartOauth", ["item_read"])
70425
- : configuration.accessToken;
70426
- localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
70427
- }
70428
-
70429
- // authentication ultraCartSimpleApiKey required
70430
- if (configuration && configuration.apiKey) {
70431
- const localVarApiKeyValue = typeof configuration.apiKey === 'function'
70432
- ? configuration.apiKey("x-ultracart-simple-key")
70433
- : configuration.apiKey;
70434
- localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
70435
- }
70436
-
70437
- localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
70438
- // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
70439
- delete localVarUrlObj.search;
70440
- localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
70441
-
70442
- return {
70443
- url: url.format(localVarUrlObj),
70444
- options: localVarRequestOptions,
70445
- };
70446
- },
70447
70473
  /**
70448
70474
  * 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.
70449
70475
  * @summary Updates a file within the digital library
@@ -70913,6 +70939,26 @@ export const ItemApiFp = function(configuration?: Configuration) {
70913
70939
  });
70914
70940
  };
70915
70941
  },
70942
+ /**
70943
+ * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
70944
+ * @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.
70945
+ * @param {*} [options] Override http request option.
70946
+ * @throws {RequiredError}
70947
+ */
70948
+ getInventorySnapshot(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemInventorySnapshotResponse> {
70949
+ const localVarFetchArgs = ItemApiFetchParamCreator(configuration).getInventorySnapshot(options);
70950
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
70951
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
70952
+
70953
+ if (response.status >= 200 && response.status < 300) {
70954
+ return response.json();
70955
+
70956
+ } else {
70957
+ throw response;
70958
+ }
70959
+ });
70960
+ };
70961
+ },
70916
70962
  /**
70917
70963
  * Retrieves a single item using the specified item oid.
70918
70964
  * @summary Retrieve an item
@@ -71165,26 +71211,6 @@ export const ItemApiFp = function(configuration?: Configuration) {
71165
71211
  });
71166
71212
  };
71167
71213
  },
71168
- /**
71169
- * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
71170
- * @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.
71171
- * @param {*} [options] Override http request option.
71172
- * @throws {RequiredError}
71173
- */
71174
- restItemInventorySnapshotResponse(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemInventorySnapshotResponse> {
71175
- const localVarFetchArgs = ItemApiFetchParamCreator(configuration).restItemInventorySnapshotResponse(options);
71176
- return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
71177
- return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
71178
-
71179
- if (response.status >= 200 && response.status < 300) {
71180
- return response.json();
71181
-
71182
- } else {
71183
- throw response;
71184
- }
71185
- });
71186
- };
71187
- },
71188
71214
  /**
71189
71215
  * 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.
71190
71216
  * @summary Updates a file within the digital library
@@ -71374,6 +71400,15 @@ export const ItemApiFactory = function (configuration?: Configuration, fetch?: F
71374
71400
  getDigitalItemsByExternalId(external_id: string, options?: any) {
71375
71401
  return ItemApiFp(configuration).getDigitalItemsByExternalId(external_id, options)(fetch, basePath);
71376
71402
  },
71403
+ /**
71404
+ * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
71405
+ * @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.
71406
+ * @param {*} [options] Override http request option.
71407
+ * @throws {RequiredError}
71408
+ */
71409
+ getInventorySnapshot(options?: any) {
71410
+ return ItemApiFp(configuration).getInventorySnapshot(options)(fetch, basePath);
71411
+ },
71377
71412
  /**
71378
71413
  * Retrieves a single item using the specified item oid.
71379
71414
  * @summary Retrieve an item
@@ -71505,15 +71540,6 @@ export const ItemApiFactory = function (configuration?: Configuration, fetch?: F
71505
71540
  insertUpdateItemContentAttribute(item_attribute: ItemContentAttribute, merchant_item_oid: number, options?: any) {
71506
71541
  return ItemApiFp(configuration).insertUpdateItemContentAttribute(item_attribute, merchant_item_oid, options)(fetch, basePath);
71507
71542
  },
71508
- /**
71509
- * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
71510
- * @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.
71511
- * @param {*} [options] Override http request option.
71512
- * @throws {RequiredError}
71513
- */
71514
- restItemInventorySnapshotResponse(options?: any) {
71515
- return ItemApiFp(configuration).restItemInventorySnapshotResponse(options)(fetch, basePath);
71516
- },
71517
71543
  /**
71518
71544
  * 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.
71519
71545
  * @summary Updates a file within the digital library
@@ -71648,6 +71674,15 @@ export interface ItemApiInterface {
71648
71674
  */
71649
71675
  getDigitalItemsByExternalId(external_id: string, options?: any): Promise<ItemDigitalItemsResponse>;
71650
71676
 
71677
+ /**
71678
+ * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
71679
+ * @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.
71680
+ * @param {*} [options] Override http request option.
71681
+ * @throws {RequiredError}
71682
+ * @memberof ItemApiInterface
71683
+ */
71684
+ getInventorySnapshot(options?: any): Promise<ItemInventorySnapshotResponse>;
71685
+
71651
71686
  /**
71652
71687
  * Retrieves a single item using the specified item oid.
71653
71688
  * @summary Retrieve an item
@@ -71779,15 +71814,6 @@ export interface ItemApiInterface {
71779
71814
  */
71780
71815
  insertUpdateItemContentAttribute(item_attribute: ItemContentAttribute, merchant_item_oid: number, options?: any): Promise<{}>;
71781
71816
 
71782
- /**
71783
- * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
71784
- * @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.
71785
- * @param {*} [options] Override http request option.
71786
- * @throws {RequiredError}
71787
- * @memberof ItemApiInterface
71788
- */
71789
- restItemInventorySnapshotResponse(options?: any): Promise<ItemInventorySnapshotResponse>;
71790
-
71791
71817
  /**
71792
71818
  * 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.
71793
71819
  * @summary Updates a file within the digital library
@@ -71934,6 +71960,17 @@ export class ItemApi extends BaseAPI implements ItemApiInterface {
71934
71960
  return ItemApiFp(this.configuration).getDigitalItemsByExternalId(external_id, options)(this.fetch, this.basePath);
71935
71961
  }
71936
71962
 
71963
+ /**
71964
+ * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
71965
+ * @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.
71966
+ * @param {*} [options] Override http request option.
71967
+ * @throws {RequiredError}
71968
+ * @memberof ItemApi
71969
+ */
71970
+ public getInventorySnapshot(options?: any) {
71971
+ return ItemApiFp(this.configuration).getInventorySnapshot(options)(this.fetch, this.basePath);
71972
+ }
71973
+
71937
71974
  /**
71938
71975
  * Retrieves a single item using the specified item oid.
71939
71976
  * @summary Retrieve an item
@@ -72087,17 +72124,6 @@ export class ItemApi extends BaseAPI implements ItemApiInterface {
72087
72124
  return ItemApiFp(this.configuration).insertUpdateItemContentAttribute(item_attribute, merchant_item_oid, options)(this.fetch, this.basePath);
72088
72125
  }
72089
72126
 
72090
- /**
72091
- * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
72092
- * @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.
72093
- * @param {*} [options] Override http request option.
72094
- * @throws {RequiredError}
72095
- * @memberof ItemApi
72096
- */
72097
- public restItemInventorySnapshotResponse(options?: any) {
72098
- return ItemApiFp(this.configuration).restItemInventorySnapshotResponse(options)(this.fetch, this.basePath);
72099
- }
72100
-
72101
72127
  /**
72102
72128
  * 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.
72103
72129
  * @summary Updates a file within the digital library
package/dist/api.d.ts CHANGED
@@ -33589,6 +33589,12 @@ export interface OrderPayment {
33589
33589
  * @memberof OrderPayment
33590
33590
  */
33591
33591
  payment_status?: OrderPayment.PaymentStatusEnum;
33592
+ /**
33593
+ *
33594
+ * @type {OrderPaymentPayPal}
33595
+ * @memberof OrderPayment
33596
+ */
33597
+ paypal?: OrderPaymentPayPal;
33592
33598
  /**
33593
33599
  *
33594
33600
  * @type {OrderPaymentPurchaseOrder}
@@ -34008,6 +34014,25 @@ export interface OrderPaymentInsurance {
34008
34014
  */
34009
34015
  refund_claim_id?: string;
34010
34016
  }
34017
+ /**
34018
+ *
34019
+ * @export
34020
+ * @interface OrderPaymentPayPal
34021
+ */
34022
+ export interface OrderPaymentPayPal {
34023
+ /**
34024
+ * PayPal Customer ID
34025
+ * @type {string}
34026
+ * @memberof OrderPaymentPayPal
34027
+ */
34028
+ customer_id?: string;
34029
+ /**
34030
+ * PayPal Vault ID
34031
+ * @type {string}
34032
+ * @memberof OrderPaymentPayPal
34033
+ */
34034
+ vault_id?: string;
34035
+ }
34011
34036
  /**
34012
34037
  *
34013
34038
  * @export
@@ -54244,6 +54269,13 @@ export declare const ItemApiFetchParamCreator: (configuration?: Configuration) =
54244
54269
  * @throws {RequiredError}
54245
54270
  */
54246
54271
  getDigitalItemsByExternalId(external_id: string, options?: any): FetchArgs;
54272
+ /**
54273
+ * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
54274
+ * @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.
54275
+ * @param {*} [options] Override http request option.
54276
+ * @throws {RequiredError}
54277
+ */
54278
+ getInventorySnapshot(options?: any): FetchArgs;
54247
54279
  /**
54248
54280
  * Retrieves a single item using the specified item oid.
54249
54281
  * @summary Retrieve an item
@@ -54353,13 +54385,6 @@ export declare const ItemApiFetchParamCreator: (configuration?: Configuration) =
54353
54385
  * @throws {RequiredError}
54354
54386
  */
54355
54387
  insertUpdateItemContentAttribute(item_attribute: ItemContentAttribute, merchant_item_oid: number, options?: any): FetchArgs;
54356
- /**
54357
- * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
54358
- * @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.
54359
- * @param {*} [options] Override http request option.
54360
- * @throws {RequiredError}
54361
- */
54362
- restItemInventorySnapshotResponse(options?: any): FetchArgs;
54363
54388
  /**
54364
54389
  * 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.
54365
54390
  * @summary Updates a file within the digital library
@@ -54469,6 +54494,13 @@ export declare const ItemApiFp: (configuration?: Configuration) => {
54469
54494
  * @throws {RequiredError}
54470
54495
  */
54471
54496
  getDigitalItemsByExternalId(external_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemDigitalItemsResponse>;
54497
+ /**
54498
+ * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
54499
+ * @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.
54500
+ * @param {*} [options] Override http request option.
54501
+ * @throws {RequiredError}
54502
+ */
54503
+ getInventorySnapshot(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemInventorySnapshotResponse>;
54472
54504
  /**
54473
54505
  * Retrieves a single item using the specified item oid.
54474
54506
  * @summary Retrieve an item
@@ -54578,13 +54610,6 @@ export declare const ItemApiFp: (configuration?: Configuration) => {
54578
54610
  * @throws {RequiredError}
54579
54611
  */
54580
54612
  insertUpdateItemContentAttribute(item_attribute: ItemContentAttribute, merchant_item_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
54581
- /**
54582
- * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
54583
- * @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.
54584
- * @param {*} [options] Override http request option.
54585
- * @throws {RequiredError}
54586
- */
54587
- restItemInventorySnapshotResponse(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemInventorySnapshotResponse>;
54588
54613
  /**
54589
54614
  * 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.
54590
54615
  * @summary Updates a file within the digital library
@@ -54694,6 +54719,13 @@ export declare const ItemApiFactory: (configuration?: Configuration, fetch?: Fet
54694
54719
  * @throws {RequiredError}
54695
54720
  */
54696
54721
  getDigitalItemsByExternalId(external_id: string, options?: any): Promise<ItemDigitalItemsResponse>;
54722
+ /**
54723
+ * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
54724
+ * @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.
54725
+ * @param {*} [options] Override http request option.
54726
+ * @throws {RequiredError}
54727
+ */
54728
+ getInventorySnapshot(options?: any): Promise<ItemInventorySnapshotResponse>;
54697
54729
  /**
54698
54730
  * Retrieves a single item using the specified item oid.
54699
54731
  * @summary Retrieve an item
@@ -54803,13 +54835,6 @@ export declare const ItemApiFactory: (configuration?: Configuration, fetch?: Fet
54803
54835
  * @throws {RequiredError}
54804
54836
  */
54805
54837
  insertUpdateItemContentAttribute(item_attribute: ItemContentAttribute, merchant_item_oid: number, options?: any): Promise<Response>;
54806
- /**
54807
- * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
54808
- * @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.
54809
- * @param {*} [options] Override http request option.
54810
- * @throws {RequiredError}
54811
- */
54812
- restItemInventorySnapshotResponse(options?: any): Promise<ItemInventorySnapshotResponse>;
54813
54838
  /**
54814
54839
  * 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.
54815
54840
  * @summary Updates a file within the digital library
@@ -54926,6 +54951,14 @@ export interface ItemApiInterface {
54926
54951
  * @memberof ItemApiInterface
54927
54952
  */
54928
54953
  getDigitalItemsByExternalId(external_id: string, options?: any): Promise<ItemDigitalItemsResponse>;
54954
+ /**
54955
+ * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
54956
+ * @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.
54957
+ * @param {*} [options] Override http request option.
54958
+ * @throws {RequiredError}
54959
+ * @memberof ItemApiInterface
54960
+ */
54961
+ getInventorySnapshot(options?: any): Promise<ItemInventorySnapshotResponse>;
54929
54962
  /**
54930
54963
  * Retrieves a single item using the specified item oid.
54931
54964
  * @summary Retrieve an item
@@ -55046,14 +55079,6 @@ export interface ItemApiInterface {
55046
55079
  * @memberof ItemApiInterface
55047
55080
  */
55048
55081
  insertUpdateItemContentAttribute(item_attribute: ItemContentAttribute, merchant_item_oid: number, options?: any): Promise<{}>;
55049
- /**
55050
- * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
55051
- * @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.
55052
- * @param {*} [options] Override http request option.
55053
- * @throws {RequiredError}
55054
- * @memberof ItemApiInterface
55055
- */
55056
- restItemInventorySnapshotResponse(options?: any): Promise<ItemInventorySnapshotResponse>;
55057
55082
  /**
55058
55083
  * 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.
55059
55084
  * @summary Updates a file within the digital library
@@ -55176,6 +55201,14 @@ export declare class ItemApi extends BaseAPI implements ItemApiInterface {
55176
55201
  * @memberof ItemApi
55177
55202
  */
55178
55203
  getDigitalItemsByExternalId(external_id: string, options?: any): Promise<ItemDigitalItemsResponse>;
55204
+ /**
55205
+ * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
55206
+ * @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.
55207
+ * @param {*} [options] Override http request option.
55208
+ * @throws {RequiredError}
55209
+ * @memberof ItemApi
55210
+ */
55211
+ getInventorySnapshot(options?: any): Promise<ItemInventorySnapshotResponse>;
55179
55212
  /**
55180
55213
  * Retrieves a single item using the specified item oid.
55181
55214
  * @summary Retrieve an item
@@ -55296,14 +55329,6 @@ export declare class ItemApi extends BaseAPI implements ItemApiInterface {
55296
55329
  * @memberof ItemApi
55297
55330
  */
55298
55331
  insertUpdateItemContentAttribute(item_attribute: ItemContentAttribute, merchant_item_oid: number, options?: any): Promise<Response>;
55299
- /**
55300
- * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
55301
- * @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.
55302
- * @param {*} [options] Override http request option.
55303
- * @throws {RequiredError}
55304
- * @memberof ItemApi
55305
- */
55306
- restItemInventorySnapshotResponse(options?: any): Promise<ItemInventorySnapshotResponse>;
55307
55332
  /**
55308
55333
  * 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.
55309
55334
  * @summary Updates a file within the digital library
package/dist/api.js CHANGED
@@ -22594,6 +22594,46 @@ var ItemApiFetchParamCreator = function (configuration) {
22594
22594
  options: localVarRequestOptions,
22595
22595
  };
22596
22596
  },
22597
+ /**
22598
+ * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
22599
+ * @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.
22600
+ * @param {*} [options] Override http request option.
22601
+ * @throws {RequiredError}
22602
+ */
22603
+ getInventorySnapshot: function (options) {
22604
+ if (options === void 0) { options = {}; }
22605
+ var localVarPath = "/item/items/inventory_snapshot";
22606
+ var localVarUrlObj = url.parse(localVarPath, true);
22607
+ var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
22608
+ var localVarHeaderParameter = {};
22609
+ var localVarQueryParameter = {};
22610
+ if (configuration && configuration.apiVersion) {
22611
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
22612
+ }
22613
+ // authentication ultraCartOauth required
22614
+ // oauth required
22615
+ if (configuration && configuration.accessToken) {
22616
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
22617
+ ? configuration.accessToken("ultraCartOauth", ["item_read"])
22618
+ : configuration.accessToken;
22619
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
22620
+ }
22621
+ // authentication ultraCartSimpleApiKey required
22622
+ if (configuration && configuration.apiKey) {
22623
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
22624
+ ? configuration.apiKey("x-ultracart-simple-key")
22625
+ : configuration.apiKey;
22626
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
22627
+ }
22628
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
22629
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
22630
+ delete localVarUrlObj.search;
22631
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
22632
+ return {
22633
+ url: url.format(localVarUrlObj),
22634
+ options: localVarRequestOptions,
22635
+ };
22636
+ },
22597
22637
  /**
22598
22638
  * Retrieves a single item using the specified item oid.
22599
22639
  * @summary Retrieve an item
@@ -23192,46 +23232,6 @@ var ItemApiFetchParamCreator = function (configuration) {
23192
23232
  options: localVarRequestOptions,
23193
23233
  };
23194
23234
  },
23195
- /**
23196
- * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
23197
- * @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.
23198
- * @param {*} [options] Override http request option.
23199
- * @throws {RequiredError}
23200
- */
23201
- restItemInventorySnapshotResponse: function (options) {
23202
- if (options === void 0) { options = {}; }
23203
- var localVarPath = "/item/items/inventory_snapshot";
23204
- var localVarUrlObj = url.parse(localVarPath, true);
23205
- var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
23206
- var localVarHeaderParameter = {};
23207
- var localVarQueryParameter = {};
23208
- if (configuration && configuration.apiVersion) {
23209
- localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
23210
- }
23211
- // authentication ultraCartOauth required
23212
- // oauth required
23213
- if (configuration && configuration.accessToken) {
23214
- var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
23215
- ? configuration.accessToken("ultraCartOauth", ["item_read"])
23216
- : configuration.accessToken;
23217
- localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
23218
- }
23219
- // authentication ultraCartSimpleApiKey required
23220
- if (configuration && configuration.apiKey) {
23221
- var localVarApiKeyValue = typeof configuration.apiKey === 'function'
23222
- ? configuration.apiKey("x-ultracart-simple-key")
23223
- : configuration.apiKey;
23224
- localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
23225
- }
23226
- localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
23227
- // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
23228
- delete localVarUrlObj.search;
23229
- localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
23230
- return {
23231
- url: url.format(localVarUrlObj),
23232
- options: localVarRequestOptions,
23233
- };
23234
- },
23235
23235
  /**
23236
23236
  * 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.
23237
23237
  * @summary Updates a file within the digital library
@@ -23666,6 +23666,27 @@ var ItemApiFp = function (configuration) {
23666
23666
  });
23667
23667
  };
23668
23668
  },
23669
+ /**
23670
+ * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
23671
+ * @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.
23672
+ * @param {*} [options] Override http request option.
23673
+ * @throws {RequiredError}
23674
+ */
23675
+ getInventorySnapshot: function (options) {
23676
+ var localVarFetchArgs = (0, exports.ItemApiFetchParamCreator)(configuration).getInventorySnapshot(options);
23677
+ return function (fetch, basePath) {
23678
+ if (fetch === void 0) { fetch = portableFetch; }
23679
+ if (basePath === void 0) { basePath = BASE_PATH; }
23680
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
23681
+ if (response.status >= 200 && response.status < 300) {
23682
+ return response.json();
23683
+ }
23684
+ else {
23685
+ throw response;
23686
+ }
23687
+ });
23688
+ };
23689
+ },
23669
23690
  /**
23670
23691
  * Retrieves a single item using the specified item oid.
23671
23692
  * @summary Retrieve an item
@@ -23929,27 +23950,6 @@ var ItemApiFp = function (configuration) {
23929
23950
  });
23930
23951
  };
23931
23952
  },
23932
- /**
23933
- * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
23934
- * @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.
23935
- * @param {*} [options] Override http request option.
23936
- * @throws {RequiredError}
23937
- */
23938
- restItemInventorySnapshotResponse: function (options) {
23939
- var localVarFetchArgs = (0, exports.ItemApiFetchParamCreator)(configuration).restItemInventorySnapshotResponse(options);
23940
- return function (fetch, basePath) {
23941
- if (fetch === void 0) { fetch = portableFetch; }
23942
- if (basePath === void 0) { basePath = BASE_PATH; }
23943
- return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
23944
- if (response.status >= 200 && response.status < 300) {
23945
- return response.json();
23946
- }
23947
- else {
23948
- throw response;
23949
- }
23950
- });
23951
- };
23952
- },
23953
23953
  /**
23954
23954
  * 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.
23955
23955
  * @summary Updates a file within the digital library
@@ -24144,6 +24144,15 @@ var ItemApiFactory = function (configuration, fetch, basePath) {
24144
24144
  getDigitalItemsByExternalId: function (external_id, options) {
24145
24145
  return (0, exports.ItemApiFp)(configuration).getDigitalItemsByExternalId(external_id, options)(fetch, basePath);
24146
24146
  },
24147
+ /**
24148
+ * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
24149
+ * @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.
24150
+ * @param {*} [options] Override http request option.
24151
+ * @throws {RequiredError}
24152
+ */
24153
+ getInventorySnapshot: function (options) {
24154
+ return (0, exports.ItemApiFp)(configuration).getInventorySnapshot(options)(fetch, basePath);
24155
+ },
24147
24156
  /**
24148
24157
  * Retrieves a single item using the specified item oid.
24149
24158
  * @summary Retrieve an item
@@ -24275,15 +24284,6 @@ var ItemApiFactory = function (configuration, fetch, basePath) {
24275
24284
  insertUpdateItemContentAttribute: function (item_attribute, merchant_item_oid, options) {
24276
24285
  return (0, exports.ItemApiFp)(configuration).insertUpdateItemContentAttribute(item_attribute, merchant_item_oid, options)(fetch, basePath);
24277
24286
  },
24278
- /**
24279
- * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
24280
- * @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.
24281
- * @param {*} [options] Override http request option.
24282
- * @throws {RequiredError}
24283
- */
24284
- restItemInventorySnapshotResponse: function (options) {
24285
- return (0, exports.ItemApiFp)(configuration).restItemInventorySnapshotResponse(options)(fetch, basePath);
24286
- },
24287
24287
  /**
24288
24288
  * 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.
24289
24289
  * @summary Updates a file within the digital library
@@ -24429,6 +24429,16 @@ var ItemApi = /** @class */ (function (_super) {
24429
24429
  ItemApi.prototype.getDigitalItemsByExternalId = function (external_id, options) {
24430
24430
  return (0, exports.ItemApiFp)(this.configuration).getDigitalItemsByExternalId(external_id, options)(this.fetch, this.basePath);
24431
24431
  };
24432
+ /**
24433
+ * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
24434
+ * @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.
24435
+ * @param {*} [options] Override http request option.
24436
+ * @throws {RequiredError}
24437
+ * @memberof ItemApi
24438
+ */
24439
+ ItemApi.prototype.getInventorySnapshot = function (options) {
24440
+ return (0, exports.ItemApiFp)(this.configuration).getInventorySnapshot(options)(this.fetch, this.basePath);
24441
+ };
24432
24442
  /**
24433
24443
  * Retrieves a single item using the specified item oid.
24434
24444
  * @summary Retrieve an item
@@ -24571,16 +24581,6 @@ var ItemApi = /** @class */ (function (_super) {
24571
24581
  ItemApi.prototype.insertUpdateItemContentAttribute = function (item_attribute, merchant_item_oid, options) {
24572
24582
  return (0, exports.ItemApiFp)(this.configuration).insertUpdateItemContentAttribute(item_attribute, merchant_item_oid, options)(this.fetch, this.basePath);
24573
24583
  };
24574
- /**
24575
- * Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
24576
- * @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.
24577
- * @param {*} [options] Override http request option.
24578
- * @throws {RequiredError}
24579
- * @memberof ItemApi
24580
- */
24581
- ItemApi.prototype.restItemInventorySnapshotResponse = function (options) {
24582
- return (0, exports.ItemApiFp)(this.configuration).restItemInventorySnapshotResponse(options)(this.fetch, this.basePath);
24583
- };
24584
24584
  /**
24585
24585
  * 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.
24586
24586
  * @summary Updates a file within the digital library
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.226",
3
+ "version": "3.11.0",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [