ultracart_rest_api_v2_typescript 3.10.121 → 3.10.123

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.121
1
+ ## ultracart_rest_api_v2_typescript@3.10.123
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.121 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.123 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.10.123 | 03/21/2023 | order api - new stage named Hold |
58
+ | 3.10.122 | 03/14/2023 | order.getOrderEdiDocuments |
57
59
  | 3.10.121 | 03/01/2023 | convo - add sentiment record to conversation obj |
58
60
  | 3.10.120 | 02/22/2023 | convo - customer initiated flag on engagement |
59
61
  | 3.10.119 | 02/20/2023 | refund reasons |
package/api.ts CHANGED
@@ -28465,7 +28465,8 @@ export namespace Order {
28465
28465
  LeastCostRouting = <any> 'Least Cost Routing',
28466
28466
  Unknown = <any> 'Unknown',
28467
28467
  PreOrdered = <any> 'Pre-ordered',
28468
- AdvancedOrderRouting = <any> 'Advanced Order Routing'
28468
+ AdvancedOrderRouting = <any> 'Advanced Order Routing',
28469
+ Hold = <any> 'Hold'
28469
28470
  }
28470
28471
  }
28471
28472
 
@@ -29242,6 +29243,151 @@ export interface OrderEdi {
29242
29243
  ship_to_edi_code?: string;
29243
29244
  }
29244
29245
 
29246
+ /**
29247
+ *
29248
+ * @export
29249
+ * @interface OrderEdiDocument
29250
+ */
29251
+ export interface OrderEdiDocument {
29252
+ /**
29253
+ * Direction the document flowed
29254
+ * @type {string}
29255
+ * @memberof OrderEdiDocument
29256
+ */
29257
+ direction?: OrderEdiDocument.DirectionEnum;
29258
+ /**
29259
+ * Date/time the document was created/received
29260
+ * @type {string}
29261
+ * @memberof OrderEdiDocument
29262
+ */
29263
+ doc_dts?: string;
29264
+ /**
29265
+ *
29266
+ * @type {string}
29267
+ * @memberof OrderEdiDocument
29268
+ */
29269
+ document?: string;
29270
+ /**
29271
+ *
29272
+ * @type {string}
29273
+ * @memberof OrderEdiDocument
29274
+ */
29275
+ document_type_description?: string;
29276
+ /**
29277
+ *
29278
+ * @type {number}
29279
+ * @memberof OrderEdiDocument
29280
+ */
29281
+ document_type_number?: number;
29282
+ /**
29283
+ *
29284
+ * @type {string}
29285
+ * @memberof OrderEdiDocument
29286
+ */
29287
+ external_id?: string;
29288
+ /**
29289
+ *
29290
+ * @type {string}
29291
+ * @memberof OrderEdiDocument
29292
+ */
29293
+ functional_acknowledgement?: string;
29294
+ /**
29295
+ *
29296
+ * @type {string}
29297
+ * @memberof OrderEdiDocument
29298
+ */
29299
+ functional_acknowledgement_dts?: string;
29300
+ /**
29301
+ *
29302
+ * @type {boolean}
29303
+ * @memberof OrderEdiDocument
29304
+ */
29305
+ functional_acknowledgement_pending?: boolean;
29306
+ /**
29307
+ *
29308
+ * @type {number}
29309
+ * @memberof OrderEdiDocument
29310
+ */
29311
+ group_control_number?: number;
29312
+ /**
29313
+ *
29314
+ * @type {string}
29315
+ * @memberof OrderEdiDocument
29316
+ */
29317
+ internal_id?: string;
29318
+ /**
29319
+ *
29320
+ * @type {string}
29321
+ * @memberof OrderEdiDocument
29322
+ */
29323
+ merchant_id?: string;
29324
+ /**
29325
+ *
29326
+ * @type {string}
29327
+ * @memberof OrderEdiDocument
29328
+ */
29329
+ order_id?: string;
29330
+ /**
29331
+ *
29332
+ * @type {boolean}
29333
+ * @memberof OrderEdiDocument
29334
+ */
29335
+ test_mode?: boolean;
29336
+ }
29337
+
29338
+ /**
29339
+ * @export
29340
+ * @namespace OrderEdiDocument
29341
+ */
29342
+ export namespace OrderEdiDocument {
29343
+ /**
29344
+ * @export
29345
+ * @enum {string}
29346
+ */
29347
+ export enum DirectionEnum {
29348
+ Inbound = <any> 'inbound',
29349
+ Outbound = <any> 'outbound'
29350
+ }
29351
+ }
29352
+
29353
+ /**
29354
+ *
29355
+ * @export
29356
+ * @interface OrderEdiDocumentsResponse
29357
+ */
29358
+ export interface OrderEdiDocumentsResponse {
29359
+ /**
29360
+ * edi_documents
29361
+ * @type {Array<OrderEdiDocument>}
29362
+ * @memberof OrderEdiDocumentsResponse
29363
+ */
29364
+ ediDocuments?: Array<OrderEdiDocument>;
29365
+ /**
29366
+ *
29367
+ * @type {ModelError}
29368
+ * @memberof OrderEdiDocumentsResponse
29369
+ */
29370
+ error?: ModelError;
29371
+ /**
29372
+ *
29373
+ * @type {ResponseMetadata}
29374
+ * @memberof OrderEdiDocumentsResponse
29375
+ */
29376
+ metadata?: ResponseMetadata;
29377
+ /**
29378
+ * Indicates if API call was successful
29379
+ * @type {boolean}
29380
+ * @memberof OrderEdiDocumentsResponse
29381
+ */
29382
+ success?: boolean;
29383
+ /**
29384
+ *
29385
+ * @type {Warning}
29386
+ * @memberof OrderEdiDocumentsResponse
29387
+ */
29388
+ warning?: Warning;
29389
+ }
29390
+
29245
29391
  /**
29246
29392
  *
29247
29393
  * @export
@@ -58401,6 +58547,58 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
58401
58547
  options: localVarRequestOptions,
58402
58548
  };
58403
58549
  },
58550
+ /**
58551
+ * Retrieve EDI documents associated with this order.
58552
+ * @summary Retrieve EDI documents associated with this order.
58553
+ * @param {string} order_id The order id to retrieve EDI documents for.
58554
+ * @param {*} [options] Override http request option.
58555
+ * @throws {RequiredError}
58556
+ */
58557
+ getOrderEdiDocuments(order_id: string, options: any = {}): FetchArgs {
58558
+ // verify required parameter 'order_id' is not null or undefined
58559
+ if (order_id === null || order_id === undefined) {
58560
+ throw new RequiredError('order_id','Required parameter order_id was null or undefined when calling getOrderEdiDocuments.');
58561
+ }
58562
+ const localVarPath = `/order/orders/{order_id}/edi`
58563
+ .replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
58564
+ const localVarUrlObj = url.parse(localVarPath, true);
58565
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
58566
+ const localVarHeaderParameter = {} as any;
58567
+ const localVarQueryParameter = {} as any;
58568
+
58569
+ if(configuration && configuration.apiVersion) {
58570
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
58571
+ }
58572
+
58573
+
58574
+
58575
+ // authentication ultraCartOauth required
58576
+ // oauth required
58577
+ if (configuration && configuration.accessToken) {
58578
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
58579
+ ? configuration.accessToken("ultraCartOauth", ["order_write"])
58580
+ : configuration.accessToken;
58581
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
58582
+ }
58583
+
58584
+ // authentication ultraCartSimpleApiKey required
58585
+ if (configuration && configuration.apiKey) {
58586
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
58587
+ ? configuration.apiKey("x-ultracart-simple-key")
58588
+ : configuration.apiKey;
58589
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
58590
+ }
58591
+
58592
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
58593
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
58594
+ delete localVarUrlObj.search;
58595
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
58596
+
58597
+ return {
58598
+ url: url.format(localVarUrlObj),
58599
+ options: localVarRequestOptions,
58600
+ };
58601
+ },
58404
58602
  /**
58405
58603
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
58406
58604
  * @summary Retrieve orders
@@ -59580,6 +59778,27 @@ export const OrderApiFp = function(configuration?: Configuration) {
59580
59778
  });
59581
59779
  };
59582
59780
  },
59781
+ /**
59782
+ * Retrieve EDI documents associated with this order.
59783
+ * @summary Retrieve EDI documents associated with this order.
59784
+ * @param {string} order_id The order id to retrieve EDI documents for.
59785
+ * @param {*} [options] Override http request option.
59786
+ * @throws {RequiredError}
59787
+ */
59788
+ getOrderEdiDocuments(order_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderEdiDocumentsResponse> {
59789
+ const localVarFetchArgs = OrderApiFetchParamCreator(configuration).getOrderEdiDocuments(order_id, options);
59790
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
59791
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
59792
+
59793
+ if (response.status >= 200 && response.status < 300) {
59794
+ return response.json();
59795
+
59796
+ } else {
59797
+ throw response;
59798
+ }
59799
+ });
59800
+ };
59801
+ },
59583
59802
  /**
59584
59803
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
59585
59804
  * @summary Retrieve orders
@@ -60025,6 +60244,16 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
60025
60244
  getOrderByToken(order_by_token_query: OrderByTokenQuery, _expand?: string, options?: any) {
60026
60245
  return OrderApiFp(configuration).getOrderByToken(order_by_token_query, _expand, options)(fetch, basePath);
60027
60246
  },
60247
+ /**
60248
+ * Retrieve EDI documents associated with this order.
60249
+ * @summary Retrieve EDI documents associated with this order.
60250
+ * @param {string} order_id The order id to retrieve EDI documents for.
60251
+ * @param {*} [options] Override http request option.
60252
+ * @throws {RequiredError}
60253
+ */
60254
+ getOrderEdiDocuments(order_id: string, options?: any) {
60255
+ return OrderApiFp(configuration).getOrderEdiDocuments(order_id, options)(fetch, basePath);
60256
+ },
60028
60257
  /**
60029
60258
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
60030
60259
  * @summary Retrieve orders
@@ -60338,6 +60567,16 @@ export interface OrderApiInterface {
60338
60567
  */
60339
60568
  getOrderByToken(order_by_token_query: OrderByTokenQuery, _expand?: string, options?: any): Promise<OrderResponse>;
60340
60569
 
60570
+ /**
60571
+ * Retrieve EDI documents associated with this order.
60572
+ * @summary Retrieve EDI documents associated with this order.
60573
+ * @param {string} order_id The order id to retrieve EDI documents for.
60574
+ * @param {*} [options] Override http request option.
60575
+ * @throws {RequiredError}
60576
+ * @memberof OrderApiInterface
60577
+ */
60578
+ getOrderEdiDocuments(order_id: string, options?: any): Promise<OrderEdiDocumentsResponse>;
60579
+
60341
60580
  /**
60342
60581
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
60343
60582
  * @summary Retrieve orders
@@ -60677,6 +60916,18 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
60677
60916
  return OrderApiFp(this.configuration).getOrderByToken(order_by_token_query, _expand, options)(this.fetch, this.basePath);
60678
60917
  }
60679
60918
 
60919
+ /**
60920
+ * Retrieve EDI documents associated with this order.
60921
+ * @summary Retrieve EDI documents associated with this order.
60922
+ * @param {string} order_id The order id to retrieve EDI documents for.
60923
+ * @param {*} [options] Override http request option.
60924
+ * @throws {RequiredError}
60925
+ * @memberof OrderApi
60926
+ */
60927
+ public getOrderEdiDocuments(order_id: string, options?: any) {
60928
+ return OrderApiFp(this.configuration).getOrderEdiDocuments(order_id, options)(this.fetch, this.basePath);
60929
+ }
60930
+
60680
60931
  /**
60681
60932
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
60682
60933
  * @summary Retrieve orders
package/dist/api.d.ts CHANGED
@@ -27858,7 +27858,8 @@ export declare namespace Order {
27858
27858
  LeastCostRouting,
27859
27859
  Unknown,
27860
27860
  PreOrdered,
27861
- AdvancedOrderRouting
27861
+ AdvancedOrderRouting,
27862
+ Hold
27862
27863
  }
27863
27864
  }
27864
27865
  /**
@@ -28620,6 +28621,148 @@ export interface OrderEdi {
28620
28621
  */
28621
28622
  ship_to_edi_code?: string;
28622
28623
  }
28624
+ /**
28625
+ *
28626
+ * @export
28627
+ * @interface OrderEdiDocument
28628
+ */
28629
+ export interface OrderEdiDocument {
28630
+ /**
28631
+ * Direction the document flowed
28632
+ * @type {string}
28633
+ * @memberof OrderEdiDocument
28634
+ */
28635
+ direction?: OrderEdiDocument.DirectionEnum;
28636
+ /**
28637
+ * Date/time the document was created/received
28638
+ * @type {string}
28639
+ * @memberof OrderEdiDocument
28640
+ */
28641
+ doc_dts?: string;
28642
+ /**
28643
+ *
28644
+ * @type {string}
28645
+ * @memberof OrderEdiDocument
28646
+ */
28647
+ document?: string;
28648
+ /**
28649
+ *
28650
+ * @type {string}
28651
+ * @memberof OrderEdiDocument
28652
+ */
28653
+ document_type_description?: string;
28654
+ /**
28655
+ *
28656
+ * @type {number}
28657
+ * @memberof OrderEdiDocument
28658
+ */
28659
+ document_type_number?: number;
28660
+ /**
28661
+ *
28662
+ * @type {string}
28663
+ * @memberof OrderEdiDocument
28664
+ */
28665
+ external_id?: string;
28666
+ /**
28667
+ *
28668
+ * @type {string}
28669
+ * @memberof OrderEdiDocument
28670
+ */
28671
+ functional_acknowledgement?: string;
28672
+ /**
28673
+ *
28674
+ * @type {string}
28675
+ * @memberof OrderEdiDocument
28676
+ */
28677
+ functional_acknowledgement_dts?: string;
28678
+ /**
28679
+ *
28680
+ * @type {boolean}
28681
+ * @memberof OrderEdiDocument
28682
+ */
28683
+ functional_acknowledgement_pending?: boolean;
28684
+ /**
28685
+ *
28686
+ * @type {number}
28687
+ * @memberof OrderEdiDocument
28688
+ */
28689
+ group_control_number?: number;
28690
+ /**
28691
+ *
28692
+ * @type {string}
28693
+ * @memberof OrderEdiDocument
28694
+ */
28695
+ internal_id?: string;
28696
+ /**
28697
+ *
28698
+ * @type {string}
28699
+ * @memberof OrderEdiDocument
28700
+ */
28701
+ merchant_id?: string;
28702
+ /**
28703
+ *
28704
+ * @type {string}
28705
+ * @memberof OrderEdiDocument
28706
+ */
28707
+ order_id?: string;
28708
+ /**
28709
+ *
28710
+ * @type {boolean}
28711
+ * @memberof OrderEdiDocument
28712
+ */
28713
+ test_mode?: boolean;
28714
+ }
28715
+ /**
28716
+ * @export
28717
+ * @namespace OrderEdiDocument
28718
+ */
28719
+ export declare namespace OrderEdiDocument {
28720
+ /**
28721
+ * @export
28722
+ * @enum {string}
28723
+ */
28724
+ enum DirectionEnum {
28725
+ Inbound,
28726
+ Outbound
28727
+ }
28728
+ }
28729
+ /**
28730
+ *
28731
+ * @export
28732
+ * @interface OrderEdiDocumentsResponse
28733
+ */
28734
+ export interface OrderEdiDocumentsResponse {
28735
+ /**
28736
+ * edi_documents
28737
+ * @type {Array<OrderEdiDocument>}
28738
+ * @memberof OrderEdiDocumentsResponse
28739
+ */
28740
+ ediDocuments?: Array<OrderEdiDocument>;
28741
+ /**
28742
+ *
28743
+ * @type {ModelError}
28744
+ * @memberof OrderEdiDocumentsResponse
28745
+ */
28746
+ error?: ModelError;
28747
+ /**
28748
+ *
28749
+ * @type {ResponseMetadata}
28750
+ * @memberof OrderEdiDocumentsResponse
28751
+ */
28752
+ metadata?: ResponseMetadata;
28753
+ /**
28754
+ * Indicates if API call was successful
28755
+ * @type {boolean}
28756
+ * @memberof OrderEdiDocumentsResponse
28757
+ */
28758
+ success?: boolean;
28759
+ /**
28760
+ *
28761
+ * @type {Warning}
28762
+ * @memberof OrderEdiDocumentsResponse
28763
+ */
28764
+ warning?: Warning;
28765
+ }
28623
28766
  /**
28624
28767
  *
28625
28768
  * @export
@@ -45867,6 +46010,14 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
45867
46010
  * @throws {RequiredError}
45868
46011
  */
45869
46012
  getOrderByToken(order_by_token_query: OrderByTokenQuery, _expand?: string, options?: any): FetchArgs;
46013
+ /**
46014
+ * Retrieve EDI documents associated with this order.
46015
+ * @summary Retrieve EDI documents associated with this order.
46016
+ * @param {string} order_id The order id to retrieve EDI documents for.
46017
+ * @param {*} [options] Override http request option.
46018
+ * @throws {RequiredError}
46019
+ */
46020
+ getOrderEdiDocuments(order_id: string, options?: any): FetchArgs;
45870
46021
  /**
45871
46022
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
45872
46023
  * @summary Retrieve orders
@@ -46127,6 +46278,14 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
46127
46278
  * @throws {RequiredError}
46128
46279
  */
46129
46280
  getOrderByToken(order_by_token_query: OrderByTokenQuery, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse>;
46281
+ /**
46282
+ * Retrieve EDI documents associated with this order.
46283
+ * @summary Retrieve EDI documents associated with this order.
46284
+ * @param {string} order_id The order id to retrieve EDI documents for.
46285
+ * @param {*} [options] Override http request option.
46286
+ * @throws {RequiredError}
46287
+ */
46288
+ getOrderEdiDocuments(order_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderEdiDocumentsResponse>;
46130
46289
  /**
46131
46290
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
46132
46291
  * @summary Retrieve orders
@@ -46387,6 +46546,14 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
46387
46546
  * @throws {RequiredError}
46388
46547
  */
46389
46548
  getOrderByToken(order_by_token_query: OrderByTokenQuery, _expand?: string, options?: any): Promise<OrderResponse>;
46549
+ /**
46550
+ * Retrieve EDI documents associated with this order.
46551
+ * @summary Retrieve EDI documents associated with this order.
46552
+ * @param {string} order_id The order id to retrieve EDI documents for.
46553
+ * @param {*} [options] Override http request option.
46554
+ * @throws {RequiredError}
46555
+ */
46556
+ getOrderEdiDocuments(order_id: string, options?: any): Promise<OrderEdiDocumentsResponse>;
46390
46557
  /**
46391
46558
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
46392
46559
  * @summary Retrieve orders
@@ -46661,6 +46828,15 @@ export interface OrderApiInterface {
46661
46828
  * @memberof OrderApiInterface
46662
46829
  */
46663
46830
  getOrderByToken(order_by_token_query: OrderByTokenQuery, _expand?: string, options?: any): Promise<OrderResponse>;
46831
+ /**
46832
+ * Retrieve EDI documents associated with this order.
46833
+ * @summary Retrieve EDI documents associated with this order.
46834
+ * @param {string} order_id The order id to retrieve EDI documents for.
46835
+ * @param {*} [options] Override http request option.
46836
+ * @throws {RequiredError}
46837
+ * @memberof OrderApiInterface
46838
+ */
46839
+ getOrderEdiDocuments(order_id: string, options?: any): Promise<OrderEdiDocumentsResponse>;
46664
46840
  /**
46665
46841
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
46666
46842
  * @summary Retrieve orders
@@ -46948,6 +47124,15 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
46948
47124
  * @memberof OrderApi
46949
47125
  */
46950
47126
  getOrderByToken(order_by_token_query: OrderByTokenQuery, _expand?: string, options?: any): Promise<OrderResponse>;
47127
+ /**
47128
+ * Retrieve EDI documents associated with this order.
47129
+ * @summary Retrieve EDI documents associated with this order.
47130
+ * @param {string} order_id The order id to retrieve EDI documents for.
47131
+ * @param {*} [options] Override http request option.
47132
+ * @throws {RequiredError}
47133
+ * @memberof OrderApi
47134
+ */
47135
+ getOrderEdiDocuments(order_id: string, options?: any): Promise<OrderEdiDocumentsResponse>;
46951
47136
  /**
46952
47137
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
46953
47138
  * @summary Retrieve orders
package/dist/api.js CHANGED
@@ -28,9 +28,9 @@ var __extends = (this && this.__extends) || (function () {
28
28
  };
29
29
  })();
30
30
  Object.defineProperty(exports, "__esModule", { value: true });
31
- exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.ConversationWebsocketMessage = exports.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationSummary = exports.ConversationSentiment = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationEventRRWeb = exports.ConversationEngagementEquationFunction = exports.ConversationEngagement = exports.ConversationAgentProfile = exports.Conversation = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
32
- exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.PointOfSaleReader = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = void 0;
33
- exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = void 0;
31
+ exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderEdiDocument = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.ConversationWebsocketMessage = exports.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationSummary = exports.ConversationSentiment = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationEventRRWeb = exports.ConversationEngagementEquationFunction = exports.ConversationEngagement = exports.ConversationAgentProfile = exports.Conversation = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
32
+ exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.PointOfSaleReader = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = void 0;
33
+ exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = void 0;
34
34
  var url = require("url");
35
35
  var portableFetch = require("portable-fetch");
36
36
  var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
@@ -973,6 +973,7 @@ var Order;
973
973
  CurrentStageEnum[CurrentStageEnum["Unknown"] = 'Unknown'] = "Unknown";
974
974
  CurrentStageEnum[CurrentStageEnum["PreOrdered"] = 'Pre-ordered'] = "PreOrdered";
975
975
  CurrentStageEnum[CurrentStageEnum["AdvancedOrderRouting"] = 'Advanced Order Routing'] = "AdvancedOrderRouting";
976
+ CurrentStageEnum[CurrentStageEnum["Hold"] = 'Hold'] = "Hold";
976
977
  })(CurrentStageEnum = Order.CurrentStageEnum || (Order.CurrentStageEnum = {}));
977
978
  })(Order = exports.Order || (exports.Order = {}));
978
979
  /**
@@ -1012,6 +1013,22 @@ var OrderAutoOrder;
1012
1013
  StatusEnum[StatusEnum["Disabled"] = 'disabled'] = "Disabled";
1013
1014
  })(StatusEnum = OrderAutoOrder.StatusEnum || (OrderAutoOrder.StatusEnum = {}));
1014
1015
  })(OrderAutoOrder = exports.OrderAutoOrder || (exports.OrderAutoOrder = {}));
1016
+ /**
1017
+ * @export
1018
+ * @namespace OrderEdiDocument
1019
+ */
1020
+ var OrderEdiDocument;
1021
+ (function (OrderEdiDocument) {
1022
+ /**
1023
+ * @export
1024
+ * @enum {string}
1025
+ */
1026
+ var DirectionEnum;
1027
+ (function (DirectionEnum) {
1028
+ DirectionEnum[DirectionEnum["Inbound"] = 'inbound'] = "Inbound";
1029
+ DirectionEnum[DirectionEnum["Outbound"] = 'outbound'] = "Outbound";
1030
+ })(DirectionEnum = OrderEdiDocument.DirectionEnum || (OrderEdiDocument.DirectionEnum = {}));
1031
+ })(OrderEdiDocument = exports.OrderEdiDocument || (exports.OrderEdiDocument = {}));
1015
1032
  /**
1016
1033
  * @export
1017
1034
  * @namespace OrderFormat
@@ -17972,6 +17989,52 @@ var OrderApiFetchParamCreator = function (configuration) {
17972
17989
  options: localVarRequestOptions,
17973
17990
  };
17974
17991
  },
17992
+ /**
17993
+ * Retrieve EDI documents associated with this order.
17994
+ * @summary Retrieve EDI documents associated with this order.
17995
+ * @param {string} order_id The order id to retrieve EDI documents for.
17996
+ * @param {*} [options] Override http request option.
17997
+ * @throws {RequiredError}
17998
+ */
17999
+ getOrderEdiDocuments: function (order_id, options) {
18000
+ if (options === void 0) { options = {}; }
18001
+ // verify required parameter 'order_id' is not null or undefined
18002
+ if (order_id === null || order_id === undefined) {
18003
+ throw new RequiredError('order_id', 'Required parameter order_id was null or undefined when calling getOrderEdiDocuments.');
18004
+ }
18005
+ var localVarPath = "/order/orders/{order_id}/edi"
18006
+ .replace("{".concat("order_id", "}"), encodeURIComponent(String(order_id)));
18007
+ var localVarUrlObj = url.parse(localVarPath, true);
18008
+ var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
18009
+ var localVarHeaderParameter = {};
18010
+ var localVarQueryParameter = {};
18011
+ if (configuration && configuration.apiVersion) {
18012
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
18013
+ }
18014
+ // authentication ultraCartOauth required
18015
+ // oauth required
18016
+ if (configuration && configuration.accessToken) {
18017
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
18018
+ ? configuration.accessToken("ultraCartOauth", ["order_write"])
18019
+ : configuration.accessToken;
18020
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
18021
+ }
18022
+ // authentication ultraCartSimpleApiKey required
18023
+ if (configuration && configuration.apiKey) {
18024
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
18025
+ ? configuration.apiKey("x-ultracart-simple-key")
18026
+ : configuration.apiKey;
18027
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
18028
+ }
18029
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
18030
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
18031
+ delete localVarUrlObj.search;
18032
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
18033
+ return {
18034
+ url: url.format(localVarUrlObj),
18035
+ options: localVarRequestOptions,
18036
+ };
18037
+ },
17975
18038
  /**
17976
18039
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
17977
18040
  * @summary Retrieve orders
@@ -19039,6 +19102,28 @@ var OrderApiFp = function (configuration) {
19039
19102
  });
19040
19103
  };
19041
19104
  },
19105
+ /**
19106
+ * Retrieve EDI documents associated with this order.
19107
+ * @summary Retrieve EDI documents associated with this order.
19108
+ * @param {string} order_id The order id to retrieve EDI documents for.
19109
+ * @param {*} [options] Override http request option.
19110
+ * @throws {RequiredError}
19111
+ */
19112
+ getOrderEdiDocuments: function (order_id, options) {
19113
+ var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).getOrderEdiDocuments(order_id, options);
19114
+ return function (fetch, basePath) {
19115
+ if (fetch === void 0) { fetch = portableFetch; }
19116
+ if (basePath === void 0) { basePath = BASE_PATH; }
19117
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
19118
+ if (response.status >= 200 && response.status < 300) {
19119
+ return response.json();
19120
+ }
19121
+ else {
19122
+ throw response;
19123
+ }
19124
+ });
19125
+ };
19126
+ },
19042
19127
  /**
19043
19128
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
19044
19129
  * @summary Retrieve orders
@@ -19496,6 +19581,16 @@ var OrderApiFactory = function (configuration, fetch, basePath) {
19496
19581
  getOrderByToken: function (order_by_token_query, _expand, options) {
19497
19582
  return (0, exports.OrderApiFp)(configuration).getOrderByToken(order_by_token_query, _expand, options)(fetch, basePath);
19498
19583
  },
19584
+ /**
19585
+ * Retrieve EDI documents associated with this order.
19586
+ * @summary Retrieve EDI documents associated with this order.
19587
+ * @param {string} order_id The order id to retrieve EDI documents for.
19588
+ * @param {*} [options] Override http request option.
19589
+ * @throws {RequiredError}
19590
+ */
19591
+ getOrderEdiDocuments: function (order_id, options) {
19592
+ return (0, exports.OrderApiFp)(configuration).getOrderEdiDocuments(order_id, options)(fetch, basePath);
19593
+ },
19499
19594
  /**
19500
19595
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
19501
19596
  * @summary Retrieve orders
@@ -19827,6 +19922,17 @@ var OrderApi = /** @class */ (function (_super) {
19827
19922
  OrderApi.prototype.getOrderByToken = function (order_by_token_query, _expand, options) {
19828
19923
  return (0, exports.OrderApiFp)(this.configuration).getOrderByToken(order_by_token_query, _expand, options)(this.fetch, this.basePath);
19829
19924
  };
19925
+ /**
19926
+ * Retrieve EDI documents associated with this order.
19927
+ * @summary Retrieve EDI documents associated with this order.
19928
+ * @param {string} order_id The order id to retrieve EDI documents for.
19929
+ * @param {*} [options] Override http request option.
19930
+ * @throws {RequiredError}
19931
+ * @memberof OrderApi
19932
+ */
19933
+ OrderApi.prototype.getOrderEdiDocuments = function (order_id, options) {
19934
+ return (0, exports.OrderApiFp)(this.configuration).getOrderEdiDocuments(order_id, options)(this.fetch, this.basePath);
19935
+ };
19830
19936
  /**
19831
19937
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
19832
19938
  * @summary Retrieve orders
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.121",
3
+ "version": "3.10.123",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [