ultracart_rest_api_v2_typescript 3.10.145 → 3.10.146

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.145
1
+ ## ultracart_rest_api_v2_typescript@3.10.146
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.145 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.146 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.10.146 | 06/20/2023 | auto order - establishAutoOrderByReferenceOrderId method added |
57
58
  | 3.10.145 | 06/20/2023 | coupon add allowed values for usable_by and new OncePerNewCustomerForItem flag |
58
59
  | 3.10.144 | 06/15/2023 | add pickup_dts to order.shipping object |
59
60
  | 3.10.143 | 06/14/2023 | dw bi: add request_dts on the execute queries request and report data set objects |
package/api.ts CHANGED
@@ -40877,6 +40877,63 @@ export class AffiliateApi extends BaseAPI implements AffiliateApiInterface {
40877
40877
  */
40878
40878
  export const AutoOrderApiFetchParamCreator = function (configuration?: Configuration) {
40879
40879
  return {
40880
+ /**
40881
+ * Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.
40882
+ * @summary Establish an auto order by referencing a regular order id
40883
+ * @param {string} reference_order_id The order id to attach this auto order to
40884
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
40885
+ * @param {*} [options] Override http request option.
40886
+ * @throws {RequiredError}
40887
+ */
40888
+ establishAutoOrderByReferenceOrderId(reference_order_id: string, _expand?: string, options: any = {}): FetchArgs {
40889
+ // verify required parameter 'reference_order_id' is not null or undefined
40890
+ if (reference_order_id === null || reference_order_id === undefined) {
40891
+ throw new RequiredError('reference_order_id','Required parameter reference_order_id was null or undefined when calling establishAutoOrderByReferenceOrderId.');
40892
+ }
40893
+ const localVarPath = `/auto_order/auto_orders/reference_order_id/{reference_order_id}`
40894
+ .replace(`{${"reference_order_id"}}`, encodeURIComponent(String(reference_order_id)));
40895
+ const localVarUrlObj = url.parse(localVarPath, true);
40896
+ const localVarRequestOptions = Object.assign({ method: 'POST' }, options);
40897
+ const localVarHeaderParameter = {} as any;
40898
+ const localVarQueryParameter = {} as any;
40899
+
40900
+ if(configuration && configuration.apiVersion) {
40901
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
40902
+ }
40903
+
40904
+
40905
+
40906
+ // authentication ultraCartOauth required
40907
+ // oauth required
40908
+ if (configuration && configuration.accessToken) {
40909
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
40910
+ ? configuration.accessToken("ultraCartOauth", ["auto_order_write"])
40911
+ : configuration.accessToken;
40912
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
40913
+ }
40914
+
40915
+ // authentication ultraCartSimpleApiKey required
40916
+ if (configuration && configuration.apiKey) {
40917
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
40918
+ ? configuration.apiKey("x-ultracart-simple-key")
40919
+ : configuration.apiKey;
40920
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
40921
+ }
40922
+
40923
+ if (_expand !== undefined) {
40924
+ localVarQueryParameter['_expand'] = _expand;
40925
+ }
40926
+
40927
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
40928
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
40929
+ delete localVarUrlObj.search;
40930
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
40931
+
40932
+ return {
40933
+ url: url.format(localVarUrlObj),
40934
+ options: localVarRequestOptions,
40935
+ };
40936
+ },
40880
40937
  /**
40881
40938
  * Retrieves a single auto order using the specified auto order oid.
40882
40939
  * @summary Retrieve an auto order by oid
@@ -41489,6 +41546,28 @@ export const AutoOrderApiFetchParamCreator = function (configuration?: Configura
41489
41546
  */
41490
41547
  export const AutoOrderApiFp = function(configuration?: Configuration) {
41491
41548
  return {
41549
+ /**
41550
+ * Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.
41551
+ * @summary Establish an auto order by referencing a regular order id
41552
+ * @param {string} reference_order_id The order id to attach this auto order to
41553
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
41554
+ * @param {*} [options] Override http request option.
41555
+ * @throws {RequiredError}
41556
+ */
41557
+ establishAutoOrderByReferenceOrderId(reference_order_id: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AutoOrderResponse> {
41558
+ const localVarFetchArgs = AutoOrderApiFetchParamCreator(configuration).establishAutoOrderByReferenceOrderId(reference_order_id, _expand, options);
41559
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
41560
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
41561
+
41562
+ if (response.status >= 200 && response.status < 300) {
41563
+ return response.json();
41564
+
41565
+ } else {
41566
+ throw response;
41567
+ }
41568
+ });
41569
+ };
41570
+ },
41492
41571
  /**
41493
41572
  * Retrieves a single auto order using the specified auto order oid.
41494
41573
  * @summary Retrieve an auto order by oid
@@ -41701,6 +41780,17 @@ export const AutoOrderApiFp = function(configuration?: Configuration) {
41701
41780
  */
41702
41781
  export const AutoOrderApiFactory = function (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) {
41703
41782
  return {
41783
+ /**
41784
+ * Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.
41785
+ * @summary Establish an auto order by referencing a regular order id
41786
+ * @param {string} reference_order_id The order id to attach this auto order to
41787
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
41788
+ * @param {*} [options] Override http request option.
41789
+ * @throws {RequiredError}
41790
+ */
41791
+ establishAutoOrderByReferenceOrderId(reference_order_id: string, _expand?: string, options?: any) {
41792
+ return AutoOrderApiFp(configuration).establishAutoOrderByReferenceOrderId(reference_order_id, _expand, options)(fetch, basePath);
41793
+ },
41704
41794
  /**
41705
41795
  * Retrieves a single auto order using the specified auto order oid.
41706
41796
  * @summary Retrieve an auto order by oid
@@ -41825,6 +41915,17 @@ export const AutoOrderApiFactory = function (configuration?: Configuration, fetc
41825
41915
  * @interface AutoOrderApi
41826
41916
  */
41827
41917
  export interface AutoOrderApiInterface {
41918
+ /**
41919
+ * Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.
41920
+ * @summary Establish an auto order by referencing a regular order id
41921
+ * @param {string} reference_order_id The order id to attach this auto order to
41922
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
41923
+ * @param {*} [options] Override http request option.
41924
+ * @throws {RequiredError}
41925
+ * @memberof AutoOrderApiInterface
41926
+ */
41927
+ establishAutoOrderByReferenceOrderId(reference_order_id: string, _expand?: string, options?: any): Promise<AutoOrderResponse>;
41928
+
41828
41929
  /**
41829
41930
  * Retrieves a single auto order using the specified auto order oid.
41830
41931
  * @summary Retrieve an auto order by oid
@@ -41949,6 +42050,19 @@ export interface AutoOrderApiInterface {
41949
42050
  * @extends {BaseAPI}
41950
42051
  */
41951
42052
  export class AutoOrderApi extends BaseAPI implements AutoOrderApiInterface {
42053
+ /**
42054
+ * Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.
42055
+ * @summary Establish an auto order by referencing a regular order id
42056
+ * @param {string} reference_order_id The order id to attach this auto order to
42057
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
42058
+ * @param {*} [options] Override http request option.
42059
+ * @throws {RequiredError}
42060
+ * @memberof AutoOrderApi
42061
+ */
42062
+ public establishAutoOrderByReferenceOrderId(reference_order_id: string, _expand?: string, options?: any) {
42063
+ return AutoOrderApiFp(this.configuration).establishAutoOrderByReferenceOrderId(reference_order_id, _expand, options)(this.fetch, this.basePath);
42064
+ }
42065
+
41952
42066
  /**
41953
42067
  * Retrieves a single auto order using the specified auto order oid.
41954
42068
  * @summary Retrieve an auto order by oid
package/dist/api.d.ts CHANGED
@@ -39845,6 +39845,15 @@ export declare class AffiliateApi extends BaseAPI implements AffiliateApiInterfa
39845
39845
  * @export
39846
39846
  */
39847
39847
  export declare const AutoOrderApiFetchParamCreator: (configuration?: Configuration) => {
39848
+ /**
39849
+ * Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.
39850
+ * @summary Establish an auto order by referencing a regular order id
39851
+ * @param {string} reference_order_id The order id to attach this auto order to
39852
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
39853
+ * @param {*} [options] Override http request option.
39854
+ * @throws {RequiredError}
39855
+ */
39856
+ establishAutoOrderByReferenceOrderId(reference_order_id: string, _expand?: string, options?: any): FetchArgs;
39848
39857
  /**
39849
39858
  * Retrieves a single auto order using the specified auto order oid.
39850
39859
  * @summary Retrieve an auto order by oid
@@ -39950,6 +39959,15 @@ export declare const AutoOrderApiFetchParamCreator: (configuration?: Configurati
39950
39959
  * @export
39951
39960
  */
39952
39961
  export declare const AutoOrderApiFp: (configuration?: Configuration) => {
39962
+ /**
39963
+ * Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.
39964
+ * @summary Establish an auto order by referencing a regular order id
39965
+ * @param {string} reference_order_id The order id to attach this auto order to
39966
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
39967
+ * @param {*} [options] Override http request option.
39968
+ * @throws {RequiredError}
39969
+ */
39970
+ establishAutoOrderByReferenceOrderId(reference_order_id: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AutoOrderResponse>;
39953
39971
  /**
39954
39972
  * Retrieves a single auto order using the specified auto order oid.
39955
39973
  * @summary Retrieve an auto order by oid
@@ -40055,6 +40073,15 @@ export declare const AutoOrderApiFp: (configuration?: Configuration) => {
40055
40073
  * @export
40056
40074
  */
40057
40075
  export declare const AutoOrderApiFactory: (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) => {
40076
+ /**
40077
+ * Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.
40078
+ * @summary Establish an auto order by referencing a regular order id
40079
+ * @param {string} reference_order_id The order id to attach this auto order to
40080
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
40081
+ * @param {*} [options] Override http request option.
40082
+ * @throws {RequiredError}
40083
+ */
40084
+ establishAutoOrderByReferenceOrderId(reference_order_id: string, _expand?: string, options?: any): Promise<AutoOrderResponse>;
40058
40085
  /**
40059
40086
  * Retrieves a single auto order using the specified auto order oid.
40060
40087
  * @summary Retrieve an auto order by oid
@@ -40161,6 +40188,16 @@ export declare const AutoOrderApiFactory: (configuration?: Configuration, fetch?
40161
40188
  * @interface AutoOrderApi
40162
40189
  */
40163
40190
  export interface AutoOrderApiInterface {
40191
+ /**
40192
+ * Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.
40193
+ * @summary Establish an auto order by referencing a regular order id
40194
+ * @param {string} reference_order_id The order id to attach this auto order to
40195
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
40196
+ * @param {*} [options] Override http request option.
40197
+ * @throws {RequiredError}
40198
+ * @memberof AutoOrderApiInterface
40199
+ */
40200
+ establishAutoOrderByReferenceOrderId(reference_order_id: string, _expand?: string, options?: any): Promise<AutoOrderResponse>;
40164
40201
  /**
40165
40202
  * Retrieves a single auto order using the specified auto order oid.
40166
40203
  * @summary Retrieve an auto order by oid
@@ -40276,6 +40313,16 @@ export interface AutoOrderApiInterface {
40276
40313
  * @extends {BaseAPI}
40277
40314
  */
40278
40315
  export declare class AutoOrderApi extends BaseAPI implements AutoOrderApiInterface {
40316
+ /**
40317
+ * Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.
40318
+ * @summary Establish an auto order by referencing a regular order id
40319
+ * @param {string} reference_order_id The order id to attach this auto order to
40320
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
40321
+ * @param {*} [options] Override http request option.
40322
+ * @throws {RequiredError}
40323
+ * @memberof AutoOrderApi
40324
+ */
40325
+ establishAutoOrderByReferenceOrderId(reference_order_id: string, _expand?: string, options?: any): Promise<AutoOrderResponse>;
40279
40326
  /**
40280
40327
  * Retrieves a single auto order using the specified auto order oid.
40281
40328
  * @summary Retrieve an auto order by oid
package/dist/api.js CHANGED
@@ -1828,6 +1828,56 @@ exports.AffiliateApi = AffiliateApi;
1828
1828
  */
1829
1829
  var AutoOrderApiFetchParamCreator = function (configuration) {
1830
1830
  return {
1831
+ /**
1832
+ * Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.
1833
+ * @summary Establish an auto order by referencing a regular order id
1834
+ * @param {string} reference_order_id The order id to attach this auto order to
1835
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
1836
+ * @param {*} [options] Override http request option.
1837
+ * @throws {RequiredError}
1838
+ */
1839
+ establishAutoOrderByReferenceOrderId: function (reference_order_id, _expand, options) {
1840
+ if (options === void 0) { options = {}; }
1841
+ // verify required parameter 'reference_order_id' is not null or undefined
1842
+ if (reference_order_id === null || reference_order_id === undefined) {
1843
+ throw new RequiredError('reference_order_id', 'Required parameter reference_order_id was null or undefined when calling establishAutoOrderByReferenceOrderId.');
1844
+ }
1845
+ var localVarPath = "/auto_order/auto_orders/reference_order_id/{reference_order_id}"
1846
+ .replace("{".concat("reference_order_id", "}"), encodeURIComponent(String(reference_order_id)));
1847
+ var localVarUrlObj = url.parse(localVarPath, true);
1848
+ var localVarRequestOptions = Object.assign({ method: 'POST' }, options);
1849
+ var localVarHeaderParameter = {};
1850
+ var localVarQueryParameter = {};
1851
+ if (configuration && configuration.apiVersion) {
1852
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
1853
+ }
1854
+ // authentication ultraCartOauth required
1855
+ // oauth required
1856
+ if (configuration && configuration.accessToken) {
1857
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
1858
+ ? configuration.accessToken("ultraCartOauth", ["auto_order_write"])
1859
+ : configuration.accessToken;
1860
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
1861
+ }
1862
+ // authentication ultraCartSimpleApiKey required
1863
+ if (configuration && configuration.apiKey) {
1864
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
1865
+ ? configuration.apiKey("x-ultracart-simple-key")
1866
+ : configuration.apiKey;
1867
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
1868
+ }
1869
+ if (_expand !== undefined) {
1870
+ localVarQueryParameter['_expand'] = _expand;
1871
+ }
1872
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
1873
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
1874
+ delete localVarUrlObj.search;
1875
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
1876
+ return {
1877
+ url: url.format(localVarUrlObj),
1878
+ options: localVarRequestOptions,
1879
+ };
1880
+ },
1831
1881
  /**
1832
1882
  * Retrieves a single auto order using the specified auto order oid.
1833
1883
  * @summary Retrieve an auto order by oid
@@ -2353,6 +2403,29 @@ exports.AutoOrderApiFetchParamCreator = AutoOrderApiFetchParamCreator;
2353
2403
  */
2354
2404
  var AutoOrderApiFp = function (configuration) {
2355
2405
  return {
2406
+ /**
2407
+ * Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.
2408
+ * @summary Establish an auto order by referencing a regular order id
2409
+ * @param {string} reference_order_id The order id to attach this auto order to
2410
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
2411
+ * @param {*} [options] Override http request option.
2412
+ * @throws {RequiredError}
2413
+ */
2414
+ establishAutoOrderByReferenceOrderId: function (reference_order_id, _expand, options) {
2415
+ var localVarFetchArgs = (0, exports.AutoOrderApiFetchParamCreator)(configuration).establishAutoOrderByReferenceOrderId(reference_order_id, _expand, options);
2416
+ return function (fetch, basePath) {
2417
+ if (fetch === void 0) { fetch = portableFetch; }
2418
+ if (basePath === void 0) { basePath = BASE_PATH; }
2419
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
2420
+ if (response.status >= 200 && response.status < 300) {
2421
+ return response.json();
2422
+ }
2423
+ else {
2424
+ throw response;
2425
+ }
2426
+ });
2427
+ };
2428
+ },
2356
2429
  /**
2357
2430
  * Retrieves a single auto order using the specified auto order oid.
2358
2431
  * @summary Retrieve an auto order by oid
@@ -2573,6 +2646,17 @@ exports.AutoOrderApiFp = AutoOrderApiFp;
2573
2646
  */
2574
2647
  var AutoOrderApiFactory = function (configuration, fetch, basePath) {
2575
2648
  return {
2649
+ /**
2650
+ * Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.
2651
+ * @summary Establish an auto order by referencing a regular order id
2652
+ * @param {string} reference_order_id The order id to attach this auto order to
2653
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
2654
+ * @param {*} [options] Override http request option.
2655
+ * @throws {RequiredError}
2656
+ */
2657
+ establishAutoOrderByReferenceOrderId: function (reference_order_id, _expand, options) {
2658
+ return (0, exports.AutoOrderApiFp)(configuration).establishAutoOrderByReferenceOrderId(reference_order_id, _expand, options)(fetch, basePath);
2659
+ },
2576
2660
  /**
2577
2661
  * Retrieves a single auto order using the specified auto order oid.
2578
2662
  * @summary Retrieve an auto order by oid
@@ -2702,6 +2786,18 @@ var AutoOrderApi = /** @class */ (function (_super) {
2702
2786
  function AutoOrderApi() {
2703
2787
  return _super !== null && _super.apply(this, arguments) || this;
2704
2788
  }
2789
+ /**
2790
+ * Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.
2791
+ * @summary Establish an auto order by referencing a regular order id
2792
+ * @param {string} reference_order_id The order id to attach this auto order to
2793
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
2794
+ * @param {*} [options] Override http request option.
2795
+ * @throws {RequiredError}
2796
+ * @memberof AutoOrderApi
2797
+ */
2798
+ AutoOrderApi.prototype.establishAutoOrderByReferenceOrderId = function (reference_order_id, _expand, options) {
2799
+ return (0, exports.AutoOrderApiFp)(this.configuration).establishAutoOrderByReferenceOrderId(reference_order_id, _expand, options)(this.fetch, this.basePath);
2800
+ };
2705
2801
  /**
2706
2802
  * Retrieves a single auto order using the specified auto order oid.
2707
2803
  * @summary Retrieve an auto order by oid
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.145",
3
+ "version": "3.10.146",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [