ultracart_rest_api_v2_typescript 3.10.121 → 3.10.122

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.122
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.122 --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.122 | 03/14/2023 | order.getOrderEdiDocuments |
57
58
  | 3.10.121 | 03/01/2023 | convo - add sentiment record to conversation obj |
58
59
  | 3.10.120 | 02/22/2023 | convo - customer initiated flag on engagement |
59
60
  | 3.10.119 | 02/20/2023 | refund reasons |
package/api.ts CHANGED
@@ -29242,6 +29242,151 @@ export interface OrderEdi {
29242
29242
  ship_to_edi_code?: string;
29243
29243
  }
29244
29244
 
29245
+ /**
29246
+ *
29247
+ * @export
29248
+ * @interface OrderEdiDocument
29249
+ */
29250
+ export interface OrderEdiDocument {
29251
+ /**
29252
+ * Direction the document flowed
29253
+ * @type {string}
29254
+ * @memberof OrderEdiDocument
29255
+ */
29256
+ direction?: OrderEdiDocument.DirectionEnum;
29257
+ /**
29258
+ * Date/time the document was created/received
29259
+ * @type {string}
29260
+ * @memberof OrderEdiDocument
29261
+ */
29262
+ doc_dts?: string;
29263
+ /**
29264
+ *
29265
+ * @type {string}
29266
+ * @memberof OrderEdiDocument
29267
+ */
29268
+ document?: string;
29269
+ /**
29270
+ *
29271
+ * @type {string}
29272
+ * @memberof OrderEdiDocument
29273
+ */
29274
+ document_type_description?: string;
29275
+ /**
29276
+ *
29277
+ * @type {number}
29278
+ * @memberof OrderEdiDocument
29279
+ */
29280
+ document_type_number?: number;
29281
+ /**
29282
+ *
29283
+ * @type {string}
29284
+ * @memberof OrderEdiDocument
29285
+ */
29286
+ external_id?: string;
29287
+ /**
29288
+ *
29289
+ * @type {string}
29290
+ * @memberof OrderEdiDocument
29291
+ */
29292
+ functional_acknowledgement?: string;
29293
+ /**
29294
+ *
29295
+ * @type {string}
29296
+ * @memberof OrderEdiDocument
29297
+ */
29298
+ functional_acknowledgement_dts?: string;
29299
+ /**
29300
+ *
29301
+ * @type {boolean}
29302
+ * @memberof OrderEdiDocument
29303
+ */
29304
+ functional_acknowledgement_pending?: boolean;
29305
+ /**
29306
+ *
29307
+ * @type {number}
29308
+ * @memberof OrderEdiDocument
29309
+ */
29310
+ group_control_number?: number;
29311
+ /**
29312
+ *
29313
+ * @type {string}
29314
+ * @memberof OrderEdiDocument
29315
+ */
29316
+ internal_id?: string;
29317
+ /**
29318
+ *
29319
+ * @type {string}
29320
+ * @memberof OrderEdiDocument
29321
+ */
29322
+ merchant_id?: string;
29323
+ /**
29324
+ *
29325
+ * @type {string}
29326
+ * @memberof OrderEdiDocument
29327
+ */
29328
+ order_id?: string;
29329
+ /**
29330
+ *
29331
+ * @type {boolean}
29332
+ * @memberof OrderEdiDocument
29333
+ */
29334
+ test_mode?: boolean;
29335
+ }
29336
+
29337
+ /**
29338
+ * @export
29339
+ * @namespace OrderEdiDocument
29340
+ */
29341
+ export namespace OrderEdiDocument {
29342
+ /**
29343
+ * @export
29344
+ * @enum {string}
29345
+ */
29346
+ export enum DirectionEnum {
29347
+ Inbound = <any> 'inbound',
29348
+ Outbound = <any> 'outbound'
29349
+ }
29350
+ }
29351
+
29352
+ /**
29353
+ *
29354
+ * @export
29355
+ * @interface OrderEdiDocumentsResponse
29356
+ */
29357
+ export interface OrderEdiDocumentsResponse {
29358
+ /**
29359
+ * edi_documents
29360
+ * @type {Array<OrderEdiDocument>}
29361
+ * @memberof OrderEdiDocumentsResponse
29362
+ */
29363
+ ediDocuments?: Array<OrderEdiDocument>;
29364
+ /**
29365
+ *
29366
+ * @type {ModelError}
29367
+ * @memberof OrderEdiDocumentsResponse
29368
+ */
29369
+ error?: ModelError;
29370
+ /**
29371
+ *
29372
+ * @type {ResponseMetadata}
29373
+ * @memberof OrderEdiDocumentsResponse
29374
+ */
29375
+ metadata?: ResponseMetadata;
29376
+ /**
29377
+ * Indicates if API call was successful
29378
+ * @type {boolean}
29379
+ * @memberof OrderEdiDocumentsResponse
29380
+ */
29381
+ success?: boolean;
29382
+ /**
29383
+ *
29384
+ * @type {Warning}
29385
+ * @memberof OrderEdiDocumentsResponse
29386
+ */
29387
+ warning?: Warning;
29388
+ }
29389
+
29245
29390
  /**
29246
29391
  *
29247
29392
  * @export
@@ -58401,6 +58546,58 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
58401
58546
  options: localVarRequestOptions,
58402
58547
  };
58403
58548
  },
58549
+ /**
58550
+ * Retrieve EDI documents associated with this order.
58551
+ * @summary Retrieve EDI documents associated with this order.
58552
+ * @param {string} order_id The order id to retrieve EDI documents for.
58553
+ * @param {*} [options] Override http request option.
58554
+ * @throws {RequiredError}
58555
+ */
58556
+ getOrderEdiDocuments(order_id: string, options: any = {}): FetchArgs {
58557
+ // verify required parameter 'order_id' is not null or undefined
58558
+ if (order_id === null || order_id === undefined) {
58559
+ throw new RequiredError('order_id','Required parameter order_id was null or undefined when calling getOrderEdiDocuments.');
58560
+ }
58561
+ const localVarPath = `/order/orders/{order_id}/edi`
58562
+ .replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
58563
+ const localVarUrlObj = url.parse(localVarPath, true);
58564
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
58565
+ const localVarHeaderParameter = {} as any;
58566
+ const localVarQueryParameter = {} as any;
58567
+
58568
+ if(configuration && configuration.apiVersion) {
58569
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
58570
+ }
58571
+
58572
+
58573
+
58574
+ // authentication ultraCartOauth required
58575
+ // oauth required
58576
+ if (configuration && configuration.accessToken) {
58577
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
58578
+ ? configuration.accessToken("ultraCartOauth", ["order_write"])
58579
+ : configuration.accessToken;
58580
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
58581
+ }
58582
+
58583
+ // authentication ultraCartSimpleApiKey required
58584
+ if (configuration && configuration.apiKey) {
58585
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
58586
+ ? configuration.apiKey("x-ultracart-simple-key")
58587
+ : configuration.apiKey;
58588
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
58589
+ }
58590
+
58591
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
58592
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
58593
+ delete localVarUrlObj.search;
58594
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
58595
+
58596
+ return {
58597
+ url: url.format(localVarUrlObj),
58598
+ options: localVarRequestOptions,
58599
+ };
58600
+ },
58404
58601
  /**
58405
58602
  * 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
58603
  * @summary Retrieve orders
@@ -59580,6 +59777,27 @@ export const OrderApiFp = function(configuration?: Configuration) {
59580
59777
  });
59581
59778
  };
59582
59779
  },
59780
+ /**
59781
+ * Retrieve EDI documents associated with this order.
59782
+ * @summary Retrieve EDI documents associated with this order.
59783
+ * @param {string} order_id The order id to retrieve EDI documents for.
59784
+ * @param {*} [options] Override http request option.
59785
+ * @throws {RequiredError}
59786
+ */
59787
+ getOrderEdiDocuments(order_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderEdiDocumentsResponse> {
59788
+ const localVarFetchArgs = OrderApiFetchParamCreator(configuration).getOrderEdiDocuments(order_id, options);
59789
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
59790
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
59791
+
59792
+ if (response.status >= 200 && response.status < 300) {
59793
+ return response.json();
59794
+
59795
+ } else {
59796
+ throw response;
59797
+ }
59798
+ });
59799
+ };
59800
+ },
59583
59801
  /**
59584
59802
  * 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
59803
  * @summary Retrieve orders
@@ -60025,6 +60243,16 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
60025
60243
  getOrderByToken(order_by_token_query: OrderByTokenQuery, _expand?: string, options?: any) {
60026
60244
  return OrderApiFp(configuration).getOrderByToken(order_by_token_query, _expand, options)(fetch, basePath);
60027
60245
  },
60246
+ /**
60247
+ * Retrieve EDI documents associated with this order.
60248
+ * @summary Retrieve EDI documents associated with this order.
60249
+ * @param {string} order_id The order id to retrieve EDI documents for.
60250
+ * @param {*} [options] Override http request option.
60251
+ * @throws {RequiredError}
60252
+ */
60253
+ getOrderEdiDocuments(order_id: string, options?: any) {
60254
+ return OrderApiFp(configuration).getOrderEdiDocuments(order_id, options)(fetch, basePath);
60255
+ },
60028
60256
  /**
60029
60257
  * 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
60258
  * @summary Retrieve orders
@@ -60338,6 +60566,16 @@ export interface OrderApiInterface {
60338
60566
  */
60339
60567
  getOrderByToken(order_by_token_query: OrderByTokenQuery, _expand?: string, options?: any): Promise<OrderResponse>;
60340
60568
 
60569
+ /**
60570
+ * Retrieve EDI documents associated with this order.
60571
+ * @summary Retrieve EDI documents associated with this order.
60572
+ * @param {string} order_id The order id to retrieve EDI documents for.
60573
+ * @param {*} [options] Override http request option.
60574
+ * @throws {RequiredError}
60575
+ * @memberof OrderApiInterface
60576
+ */
60577
+ getOrderEdiDocuments(order_id: string, options?: any): Promise<OrderEdiDocumentsResponse>;
60578
+
60341
60579
  /**
60342
60580
  * 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
60581
  * @summary Retrieve orders
@@ -60677,6 +60915,18 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
60677
60915
  return OrderApiFp(this.configuration).getOrderByToken(order_by_token_query, _expand, options)(this.fetch, this.basePath);
60678
60916
  }
60679
60917
 
60918
+ /**
60919
+ * Retrieve EDI documents associated with this order.
60920
+ * @summary Retrieve EDI documents associated with this order.
60921
+ * @param {string} order_id The order id to retrieve EDI documents for.
60922
+ * @param {*} [options] Override http request option.
60923
+ * @throws {RequiredError}
60924
+ * @memberof OrderApi
60925
+ */
60926
+ public getOrderEdiDocuments(order_id: string, options?: any) {
60927
+ return OrderApiFp(this.configuration).getOrderEdiDocuments(order_id, options)(this.fetch, this.basePath);
60928
+ }
60929
+
60680
60930
  /**
60681
60931
  * 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
60932
  * @summary Retrieve orders
package/dist/api.d.ts CHANGED
@@ -28620,6 +28620,148 @@ export interface OrderEdi {
28620
28620
  */
28621
28621
  ship_to_edi_code?: string;
28622
28622
  }
28623
+ /**
28624
+ *
28625
+ * @export
28626
+ * @interface OrderEdiDocument
28627
+ */
28628
+ export interface OrderEdiDocument {
28629
+ /**
28630
+ * Direction the document flowed
28631
+ * @type {string}
28632
+ * @memberof OrderEdiDocument
28633
+ */
28634
+ direction?: OrderEdiDocument.DirectionEnum;
28635
+ /**
28636
+ * Date/time the document was created/received
28637
+ * @type {string}
28638
+ * @memberof OrderEdiDocument
28639
+ */
28640
+ doc_dts?: string;
28641
+ /**
28642
+ *
28643
+ * @type {string}
28644
+ * @memberof OrderEdiDocument
28645
+ */
28646
+ document?: string;
28647
+ /**
28648
+ *
28649
+ * @type {string}
28650
+ * @memberof OrderEdiDocument
28651
+ */
28652
+ document_type_description?: string;
28653
+ /**
28654
+ *
28655
+ * @type {number}
28656
+ * @memberof OrderEdiDocument
28657
+ */
28658
+ document_type_number?: number;
28659
+ /**
28660
+ *
28661
+ * @type {string}
28662
+ * @memberof OrderEdiDocument
28663
+ */
28664
+ external_id?: string;
28665
+ /**
28666
+ *
28667
+ * @type {string}
28668
+ * @memberof OrderEdiDocument
28669
+ */
28670
+ functional_acknowledgement?: string;
28671
+ /**
28672
+ *
28673
+ * @type {string}
28674
+ * @memberof OrderEdiDocument
28675
+ */
28676
+ functional_acknowledgement_dts?: string;
28677
+ /**
28678
+ *
28679
+ * @type {boolean}
28680
+ * @memberof OrderEdiDocument
28681
+ */
28682
+ functional_acknowledgement_pending?: boolean;
28683
+ /**
28684
+ *
28685
+ * @type {number}
28686
+ * @memberof OrderEdiDocument
28687
+ */
28688
+ group_control_number?: number;
28689
+ /**
28690
+ *
28691
+ * @type {string}
28692
+ * @memberof OrderEdiDocument
28693
+ */
28694
+ internal_id?: string;
28695
+ /**
28696
+ *
28697
+ * @type {string}
28698
+ * @memberof OrderEdiDocument
28699
+ */
28700
+ merchant_id?: string;
28701
+ /**
28702
+ *
28703
+ * @type {string}
28704
+ * @memberof OrderEdiDocument
28705
+ */
28706
+ order_id?: string;
28707
+ /**
28708
+ *
28709
+ * @type {boolean}
28710
+ * @memberof OrderEdiDocument
28711
+ */
28712
+ test_mode?: boolean;
28713
+ }
28714
+ /**
28715
+ * @export
28716
+ * @namespace OrderEdiDocument
28717
+ */
28718
+ export declare namespace OrderEdiDocument {
28719
+ /**
28720
+ * @export
28721
+ * @enum {string}
28722
+ */
28723
+ enum DirectionEnum {
28724
+ Inbound,
28725
+ Outbound
28726
+ }
28727
+ }
28728
+ /**
28729
+ *
28730
+ * @export
28731
+ * @interface OrderEdiDocumentsResponse
28732
+ */
28733
+ export interface OrderEdiDocumentsResponse {
28734
+ /**
28735
+ * edi_documents
28736
+ * @type {Array<OrderEdiDocument>}
28737
+ * @memberof OrderEdiDocumentsResponse
28738
+ */
28739
+ ediDocuments?: Array<OrderEdiDocument>;
28740
+ /**
28741
+ *
28742
+ * @type {ModelError}
28743
+ * @memberof OrderEdiDocumentsResponse
28744
+ */
28745
+ error?: ModelError;
28746
+ /**
28747
+ *
28748
+ * @type {ResponseMetadata}
28749
+ * @memberof OrderEdiDocumentsResponse
28750
+ */
28751
+ metadata?: ResponseMetadata;
28752
+ /**
28753
+ * Indicates if API call was successful
28754
+ * @type {boolean}
28755
+ * @memberof OrderEdiDocumentsResponse
28756
+ */
28757
+ success?: boolean;
28758
+ /**
28759
+ *
28760
+ * @type {Warning}
28761
+ * @memberof OrderEdiDocumentsResponse
28762
+ */
28763
+ warning?: Warning;
28764
+ }
28623
28765
  /**
28624
28766
  *
28625
28767
  * @export
@@ -45867,6 +46009,14 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
45867
46009
  * @throws {RequiredError}
45868
46010
  */
45869
46011
  getOrderByToken(order_by_token_query: OrderByTokenQuery, _expand?: string, options?: any): FetchArgs;
46012
+ /**
46013
+ * Retrieve EDI documents associated with this order.
46014
+ * @summary Retrieve EDI documents associated with this order.
46015
+ * @param {string} order_id The order id to retrieve EDI documents for.
46016
+ * @param {*} [options] Override http request option.
46017
+ * @throws {RequiredError}
46018
+ */
46019
+ getOrderEdiDocuments(order_id: string, options?: any): FetchArgs;
45870
46020
  /**
45871
46021
  * 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
46022
  * @summary Retrieve orders
@@ -46127,6 +46277,14 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
46127
46277
  * @throws {RequiredError}
46128
46278
  */
46129
46279
  getOrderByToken(order_by_token_query: OrderByTokenQuery, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse>;
46280
+ /**
46281
+ * Retrieve EDI documents associated with this order.
46282
+ * @summary Retrieve EDI documents associated with this order.
46283
+ * @param {string} order_id The order id to retrieve EDI documents for.
46284
+ * @param {*} [options] Override http request option.
46285
+ * @throws {RequiredError}
46286
+ */
46287
+ getOrderEdiDocuments(order_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderEdiDocumentsResponse>;
46130
46288
  /**
46131
46289
  * 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
46290
  * @summary Retrieve orders
@@ -46387,6 +46545,14 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
46387
46545
  * @throws {RequiredError}
46388
46546
  */
46389
46547
  getOrderByToken(order_by_token_query: OrderByTokenQuery, _expand?: string, options?: any): Promise<OrderResponse>;
46548
+ /**
46549
+ * Retrieve EDI documents associated with this order.
46550
+ * @summary Retrieve EDI documents associated with this order.
46551
+ * @param {string} order_id The order id to retrieve EDI documents for.
46552
+ * @param {*} [options] Override http request option.
46553
+ * @throws {RequiredError}
46554
+ */
46555
+ getOrderEdiDocuments(order_id: string, options?: any): Promise<OrderEdiDocumentsResponse>;
46390
46556
  /**
46391
46557
  * 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
46558
  * @summary Retrieve orders
@@ -46661,6 +46827,15 @@ export interface OrderApiInterface {
46661
46827
  * @memberof OrderApiInterface
46662
46828
  */
46663
46829
  getOrderByToken(order_by_token_query: OrderByTokenQuery, _expand?: string, options?: any): Promise<OrderResponse>;
46830
+ /**
46831
+ * Retrieve EDI documents associated with this order.
46832
+ * @summary Retrieve EDI documents associated with this order.
46833
+ * @param {string} order_id The order id to retrieve EDI documents for.
46834
+ * @param {*} [options] Override http request option.
46835
+ * @throws {RequiredError}
46836
+ * @memberof OrderApiInterface
46837
+ */
46838
+ getOrderEdiDocuments(order_id: string, options?: any): Promise<OrderEdiDocumentsResponse>;
46664
46839
  /**
46665
46840
  * 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
46841
  * @summary Retrieve orders
@@ -46948,6 +47123,15 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
46948
47123
  * @memberof OrderApi
46949
47124
  */
46950
47125
  getOrderByToken(order_by_token_query: OrderByTokenQuery, _expand?: string, options?: any): Promise<OrderResponse>;
47126
+ /**
47127
+ * Retrieve EDI documents associated with this order.
47128
+ * @summary Retrieve EDI documents associated with this order.
47129
+ * @param {string} order_id The order id to retrieve EDI documents for.
47130
+ * @param {*} [options] Override http request option.
47131
+ * @throws {RequiredError}
47132
+ * @memberof OrderApi
47133
+ */
47134
+ getOrderEdiDocuments(order_id: string, options?: any): Promise<OrderEdiDocumentsResponse>;
46951
47135
  /**
46952
47136
  * 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
47137
  * @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(/\/+$/, "");
@@ -1012,6 +1012,22 @@ var OrderAutoOrder;
1012
1012
  StatusEnum[StatusEnum["Disabled"] = 'disabled'] = "Disabled";
1013
1013
  })(StatusEnum = OrderAutoOrder.StatusEnum || (OrderAutoOrder.StatusEnum = {}));
1014
1014
  })(OrderAutoOrder = exports.OrderAutoOrder || (exports.OrderAutoOrder = {}));
1015
+ /**
1016
+ * @export
1017
+ * @namespace OrderEdiDocument
1018
+ */
1019
+ var OrderEdiDocument;
1020
+ (function (OrderEdiDocument) {
1021
+ /**
1022
+ * @export
1023
+ * @enum {string}
1024
+ */
1025
+ var DirectionEnum;
1026
+ (function (DirectionEnum) {
1027
+ DirectionEnum[DirectionEnum["Inbound"] = 'inbound'] = "Inbound";
1028
+ DirectionEnum[DirectionEnum["Outbound"] = 'outbound'] = "Outbound";
1029
+ })(DirectionEnum = OrderEdiDocument.DirectionEnum || (OrderEdiDocument.DirectionEnum = {}));
1030
+ })(OrderEdiDocument = exports.OrderEdiDocument || (exports.OrderEdiDocument = {}));
1015
1031
  /**
1016
1032
  * @export
1017
1033
  * @namespace OrderFormat
@@ -17972,6 +17988,52 @@ var OrderApiFetchParamCreator = function (configuration) {
17972
17988
  options: localVarRequestOptions,
17973
17989
  };
17974
17990
  },
17991
+ /**
17992
+ * Retrieve EDI documents associated with this order.
17993
+ * @summary Retrieve EDI documents associated with this order.
17994
+ * @param {string} order_id The order id to retrieve EDI documents for.
17995
+ * @param {*} [options] Override http request option.
17996
+ * @throws {RequiredError}
17997
+ */
17998
+ getOrderEdiDocuments: function (order_id, options) {
17999
+ if (options === void 0) { options = {}; }
18000
+ // verify required parameter 'order_id' is not null or undefined
18001
+ if (order_id === null || order_id === undefined) {
18002
+ throw new RequiredError('order_id', 'Required parameter order_id was null or undefined when calling getOrderEdiDocuments.');
18003
+ }
18004
+ var localVarPath = "/order/orders/{order_id}/edi"
18005
+ .replace("{".concat("order_id", "}"), encodeURIComponent(String(order_id)));
18006
+ var localVarUrlObj = url.parse(localVarPath, true);
18007
+ var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
18008
+ var localVarHeaderParameter = {};
18009
+ var localVarQueryParameter = {};
18010
+ if (configuration && configuration.apiVersion) {
18011
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
18012
+ }
18013
+ // authentication ultraCartOauth required
18014
+ // oauth required
18015
+ if (configuration && configuration.accessToken) {
18016
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
18017
+ ? configuration.accessToken("ultraCartOauth", ["order_write"])
18018
+ : configuration.accessToken;
18019
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
18020
+ }
18021
+ // authentication ultraCartSimpleApiKey required
18022
+ if (configuration && configuration.apiKey) {
18023
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
18024
+ ? configuration.apiKey("x-ultracart-simple-key")
18025
+ : configuration.apiKey;
18026
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
18027
+ }
18028
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
18029
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
18030
+ delete localVarUrlObj.search;
18031
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
18032
+ return {
18033
+ url: url.format(localVarUrlObj),
18034
+ options: localVarRequestOptions,
18035
+ };
18036
+ },
17975
18037
  /**
17976
18038
  * 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
18039
  * @summary Retrieve orders
@@ -19039,6 +19101,28 @@ var OrderApiFp = function (configuration) {
19039
19101
  });
19040
19102
  };
19041
19103
  },
19104
+ /**
19105
+ * Retrieve EDI documents associated with this order.
19106
+ * @summary Retrieve EDI documents associated with this order.
19107
+ * @param {string} order_id The order id to retrieve EDI documents for.
19108
+ * @param {*} [options] Override http request option.
19109
+ * @throws {RequiredError}
19110
+ */
19111
+ getOrderEdiDocuments: function (order_id, options) {
19112
+ var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).getOrderEdiDocuments(order_id, options);
19113
+ return function (fetch, basePath) {
19114
+ if (fetch === void 0) { fetch = portableFetch; }
19115
+ if (basePath === void 0) { basePath = BASE_PATH; }
19116
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
19117
+ if (response.status >= 200 && response.status < 300) {
19118
+ return response.json();
19119
+ }
19120
+ else {
19121
+ throw response;
19122
+ }
19123
+ });
19124
+ };
19125
+ },
19042
19126
  /**
19043
19127
  * 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
19128
  * @summary Retrieve orders
@@ -19496,6 +19580,16 @@ var OrderApiFactory = function (configuration, fetch, basePath) {
19496
19580
  getOrderByToken: function (order_by_token_query, _expand, options) {
19497
19581
  return (0, exports.OrderApiFp)(configuration).getOrderByToken(order_by_token_query, _expand, options)(fetch, basePath);
19498
19582
  },
19583
+ /**
19584
+ * Retrieve EDI documents associated with this order.
19585
+ * @summary Retrieve EDI documents associated with this order.
19586
+ * @param {string} order_id The order id to retrieve EDI documents for.
19587
+ * @param {*} [options] Override http request option.
19588
+ * @throws {RequiredError}
19589
+ */
19590
+ getOrderEdiDocuments: function (order_id, options) {
19591
+ return (0, exports.OrderApiFp)(configuration).getOrderEdiDocuments(order_id, options)(fetch, basePath);
19592
+ },
19499
19593
  /**
19500
19594
  * 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
19595
  * @summary Retrieve orders
@@ -19827,6 +19921,17 @@ var OrderApi = /** @class */ (function (_super) {
19827
19921
  OrderApi.prototype.getOrderByToken = function (order_by_token_query, _expand, options) {
19828
19922
  return (0, exports.OrderApiFp)(this.configuration).getOrderByToken(order_by_token_query, _expand, options)(this.fetch, this.basePath);
19829
19923
  };
19924
+ /**
19925
+ * Retrieve EDI documents associated with this order.
19926
+ * @summary Retrieve EDI documents associated with this order.
19927
+ * @param {string} order_id The order id to retrieve EDI documents for.
19928
+ * @param {*} [options] Override http request option.
19929
+ * @throws {RequiredError}
19930
+ * @memberof OrderApi
19931
+ */
19932
+ OrderApi.prototype.getOrderEdiDocuments = function (order_id, options) {
19933
+ return (0, exports.OrderApiFp)(this.configuration).getOrderEdiDocuments(order_id, options)(this.fetch, this.basePath);
19934
+ };
19830
19935
  /**
19831
19936
  * 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
19937
  * @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.122",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [