ultracart_rest_api_v2_typescript 3.10.35 → 3.10.38

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.35
1
+ ## ultracart_rest_api_v2_typescript@3.10.38
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.35 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.38 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.10.38 | 08/12/2022 | internal code to allow merchant login as customer |
58
+ | 3.10.37 | 08/11/2022 | fix entry_dts type on gift certificate ledger |
59
+ | 3.10.36 | 08/10/2022 | conversation event refactoring |
57
60
  | 3.10.35 | 08/05/2022 | conversation adjustments for ES integration |
58
61
  | 3.10.34 | 08/05/2022 | conversations query by medium and stats fixes |
59
62
  | 3.10.33 | 08/03/2022 | conversation summary participants |
package/api.ts CHANGED
@@ -6533,6 +6533,32 @@ export namespace ConversationEventRRWeb {
6533
6533
  }
6534
6534
  }
6535
6535
 
6536
+ /**
6537
+ *
6538
+ * @export
6539
+ * @interface ConversationEventReadMessage
6540
+ */
6541
+ export interface ConversationEventReadMessage {
6542
+ /**
6543
+ *
6544
+ * @type {string}
6545
+ * @memberof ConversationEventReadMessage
6546
+ */
6547
+ conversation_message_uuid?: string;
6548
+ /**
6549
+ * Message date/time
6550
+ * @type {string}
6551
+ * @memberof ConversationEventReadMessage
6552
+ */
6553
+ message_dts?: string;
6554
+ /**
6555
+ *
6556
+ * @type {number}
6557
+ * @memberof ConversationEventReadMessage
6558
+ */
6559
+ message_epoch?: number;
6560
+ }
6561
+
6536
6562
  /**
6537
6563
  *
6538
6564
  * @export
@@ -6613,6 +6639,12 @@ export interface ConversationMessage {
6613
6639
  * @memberof ConversationMessage
6614
6640
  */
6615
6641
  message_dts?: string;
6642
+ /**
6643
+ * Message epoch milliseconds
6644
+ * @type {number}
6645
+ * @memberof ConversationMessage
6646
+ */
6647
+ message_epoch?: number;
6616
6648
  /**
6617
6649
  *
6618
6650
  * @type {Array<ConversationMessageTransportStatus>}
@@ -6661,11 +6693,35 @@ export interface ConversationMessageTransportStatus {
6661
6693
  */
6662
6694
  conversation_participant_arn?: string;
6663
6695
  /**
6664
- *
6696
+ * The status of the message transport
6665
6697
  * @type {string}
6666
6698
  * @memberof ConversationMessageTransportStatus
6667
6699
  */
6668
- status?: string;
6700
+ status?: ConversationMessageTransportStatus.StatusEnum;
6701
+ }
6702
+
6703
+ /**
6704
+ * @export
6705
+ * @namespace ConversationMessageTransportStatus
6706
+ */
6707
+ export namespace ConversationMessageTransportStatus {
6708
+ /**
6709
+ * @export
6710
+ * @enum {string}
6711
+ */
6712
+ export enum StatusEnum {
6713
+ Accepted = <any> 'accepted',
6714
+ Scheduled = <any> 'scheduled',
6715
+ Queued = <any> 'queued',
6716
+ Sending = <any> 'sending',
6717
+ Sent = <any> 'sent',
6718
+ Read = <any> 'read',
6719
+ TWILIOCREDENTIALSMISSING = <any> 'TWILIO_CREDENTIALS_MISSING',
6720
+ SENTTOTWILIO = <any> 'SENT_TO_TWILIO',
6721
+ TWILIOERROR = <any> 'TWILIO_ERROR',
6722
+ SENTTOPINPOINT = <any> 'SENT_TO_PINPOINT',
6723
+ PINPOINTERROR = <any> 'PINPOINT_ERROR'
6724
+ }
6669
6725
  }
6670
6726
 
6671
6727
  /**
@@ -6774,6 +6830,12 @@ export interface ConversationParticipant {
6774
6830
  * @memberof ConversationParticipant
6775
6831
  */
6776
6832
  status?: string;
6833
+ /**
6834
+ *
6835
+ * @type {number}
6836
+ * @memberof ConversationParticipant
6837
+ */
6838
+ unread_messages?: number;
6777
6839
  }
6778
6840
 
6779
6841
  /**
@@ -7261,6 +7323,12 @@ export interface ConversationWebsocketMessage {
7261
7323
  * @memberof ConversationWebsocketMessage
7262
7324
  */
7263
7325
  event_queue_status_update?: ConversationWebchatQueueStatus;
7326
+ /**
7327
+ *
7328
+ * @type {ConversationEventReadMessage}
7329
+ * @memberof ConversationWebsocketMessage
7330
+ */
7331
+ event_read_message?: ConversationEventReadMessage;
7264
7332
  /**
7265
7333
  *
7266
7334
  * @type {ConversationEventRRWeb}
@@ -7317,7 +7385,8 @@ export namespace ConversationWebsocketMessage {
7317
7385
  UpdatedMessage = <any> 'updated message',
7318
7386
  QueueStatusUpdate = <any> 'queue status update',
7319
7387
  Rrweb = <any> 'rrweb',
7320
- ParticipantUpdate = <any> 'participant update'
7388
+ ParticipantUpdate = <any> 'participant update',
7389
+ ReadMessage = <any> 'read message'
7321
7390
  }
7322
7391
  /**
7323
7392
  * @export
@@ -8827,6 +8896,12 @@ export interface CouponMultipleAmountsOffItems {
8827
8896
  * @interface CouponNoDiscount
8828
8897
  */
8829
8898
  export interface CouponNoDiscount {
8899
+ /**
8900
+ * This property does nothing but is included in this object to ensure the object is generated by our sdk builders.
8901
+ * @type {boolean}
8902
+ * @memberof CouponNoDiscount
8903
+ */
8904
+ ignore_this_property?: boolean;
8830
8905
  }
8831
8906
 
8832
8907
  /**
@@ -10663,6 +10738,44 @@ export interface CustomerLoyaltyRedemption {
10663
10738
  remaining_balance?: number;
10664
10739
  }
10665
10740
 
10741
+ /**
10742
+ *
10743
+ * @export
10744
+ * @interface CustomerMagicLinkResponse
10745
+ */
10746
+ export interface CustomerMagicLinkResponse {
10747
+ /**
10748
+ *
10749
+ * @type {ModelError}
10750
+ * @memberof CustomerMagicLinkResponse
10751
+ */
10752
+ error?: ModelError;
10753
+ /**
10754
+ *
10755
+ * @type {ResponseMetadata}
10756
+ * @memberof CustomerMagicLinkResponse
10757
+ */
10758
+ metadata?: ResponseMetadata;
10759
+ /**
10760
+ * Indicates if API call was successful
10761
+ * @type {boolean}
10762
+ * @memberof CustomerMagicLinkResponse
10763
+ */
10764
+ success?: boolean;
10765
+ /**
10766
+ * URL
10767
+ * @type {string}
10768
+ * @memberof CustomerMagicLinkResponse
10769
+ */
10770
+ url?: string;
10771
+ /**
10772
+ *
10773
+ * @type {Warning}
10774
+ * @memberof CustomerMagicLinkResponse
10775
+ */
10776
+ warning?: Warning;
10777
+ }
10778
+
10666
10779
  /**
10667
10780
  *
10668
10781
  * @export
@@ -31604,6 +31717,118 @@ export interface StepWaiting {
31604
31717
  number_waiting?: number;
31605
31718
  }
31606
31719
 
31720
+ /**
31721
+ *
31722
+ * @export
31723
+ * @interface StoreFront
31724
+ */
31725
+ export interface StoreFront {
31726
+ /**
31727
+ *
31728
+ * @type {string}
31729
+ * @memberof StoreFront
31730
+ */
31731
+ host_alias1?: string;
31732
+ /**
31733
+ *
31734
+ * @type {string}
31735
+ * @memberof StoreFront
31736
+ */
31737
+ host_alias2?: string;
31738
+ /**
31739
+ *
31740
+ * @type {string}
31741
+ * @memberof StoreFront
31742
+ */
31743
+ host_alias3?: string;
31744
+ /**
31745
+ *
31746
+ * @type {string}
31747
+ * @memberof StoreFront
31748
+ */
31749
+ host_alias4?: string;
31750
+ /**
31751
+ *
31752
+ * @type {string}
31753
+ * @memberof StoreFront
31754
+ */
31755
+ host_alias5?: string;
31756
+ /**
31757
+ *
31758
+ * @type {string}
31759
+ * @memberof StoreFront
31760
+ */
31761
+ host_name?: string;
31762
+ /**
31763
+ *
31764
+ * @type {boolean}
31765
+ * @memberof StoreFront
31766
+ */
31767
+ locked?: boolean;
31768
+ /**
31769
+ *
31770
+ * @type {string}
31771
+ * @memberof StoreFront
31772
+ */
31773
+ merchant_id?: string;
31774
+ /**
31775
+ *
31776
+ * @type {boolean}
31777
+ * @memberof StoreFront
31778
+ */
31779
+ redirect_aliases?: boolean;
31780
+ /**
31781
+ *
31782
+ * @type {number}
31783
+ * @memberof StoreFront
31784
+ */
31785
+ storefront_oid?: number;
31786
+ /**
31787
+ *
31788
+ * @type {string}
31789
+ * @memberof StoreFront
31790
+ */
31791
+ unlock_password?: string;
31792
+ }
31793
+
31794
+ /**
31795
+ *
31796
+ * @export
31797
+ * @interface StoreFrontsResponse
31798
+ */
31799
+ export interface StoreFrontsResponse {
31800
+ /**
31801
+ *
31802
+ * @type {ModelError}
31803
+ * @memberof StoreFrontsResponse
31804
+ */
31805
+ error?: ModelError;
31806
+ /**
31807
+ *
31808
+ * @type {ResponseMetadata}
31809
+ * @memberof StoreFrontsResponse
31810
+ */
31811
+ metadata?: ResponseMetadata;
31812
+ /**
31813
+ *
31814
+ * @type {Array<StoreFront>}
31815
+ * @memberof StoreFrontsResponse
31816
+ */
31817
+ storeFronts?: Array<StoreFront>;
31818
+ /**
31819
+ * Indicates if API call was successful
31820
+ * @type {boolean}
31821
+ * @memberof StoreFrontsResponse
31822
+ */
31823
+ success?: boolean;
31824
+ /**
31825
+ *
31826
+ * @type {Warning}
31827
+ * @memberof StoreFrontsResponse
31828
+ */
31829
+ warning?: Warning;
31830
+ }
31831
+
31607
31832
  /**
31608
31833
  *
31609
31834
  * @export
@@ -43360,6 +43585,64 @@ export const CustomerApiFetchParamCreator = function (configuration?: Configurat
43360
43585
  options: localVarRequestOptions,
43361
43586
  };
43362
43587
  },
43588
+ /**
43589
+ * Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
43590
+ * @summary getMagicLink
43591
+ * @param {number} customer_profile_oid The customer_profile_oid of the customer.
43592
+ * @param {string} storefront_host_name The storefront to log into.
43593
+ * @param {*} [options] Override http request option.
43594
+ * @throws {RequiredError}
43595
+ */
43596
+ getMagicLink(customer_profile_oid: number, storefront_host_name: string, options: any = {}): FetchArgs {
43597
+ // verify required parameter 'customer_profile_oid' is not null or undefined
43598
+ if (customer_profile_oid === null || customer_profile_oid === undefined) {
43599
+ throw new RequiredError('customer_profile_oid','Required parameter customer_profile_oid was null or undefined when calling getMagicLink.');
43600
+ }
43601
+ // verify required parameter 'storefront_host_name' is not null or undefined
43602
+ if (storefront_host_name === null || storefront_host_name === undefined) {
43603
+ throw new RequiredError('storefront_host_name','Required parameter storefront_host_name was null or undefined when calling getMagicLink.');
43604
+ }
43605
+ const localVarPath = `/customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name}`
43606
+ .replace(`{${"customer_profile_oid"}}`, encodeURIComponent(String(customer_profile_oid)))
43607
+ .replace(`{${"storefront_host_name"}}`, encodeURIComponent(String(storefront_host_name)));
43608
+ const localVarUrlObj = url.parse(localVarPath, true);
43609
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
43610
+ const localVarHeaderParameter = {} as any;
43611
+ const localVarQueryParameter = {} as any;
43612
+
43613
+ if(configuration && configuration.apiVersion) {
43614
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
43615
+ }
43616
+
43617
+
43618
+
43619
+ // authentication ultraCartOauth required
43620
+ // oauth required
43621
+ if (configuration && configuration.accessToken) {
43622
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
43623
+ ? configuration.accessToken("ultraCartOauth", ["customer_write"])
43624
+ : configuration.accessToken;
43625
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
43626
+ }
43627
+
43628
+ // authentication ultraCartSimpleApiKey required
43629
+ if (configuration && configuration.apiKey) {
43630
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
43631
+ ? configuration.apiKey("x-ultracart-simple-key")
43632
+ : configuration.apiKey;
43633
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
43634
+ }
43635
+
43636
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
43637
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
43638
+ delete localVarUrlObj.search;
43639
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
43640
+
43641
+ return {
43642
+ url: url.format(localVarUrlObj),
43643
+ options: localVarRequestOptions,
43644
+ };
43645
+ },
43363
43646
  /**
43364
43647
  * Insert a customer on the UltraCart account.
43365
43648
  * @summary Insert a customer
@@ -44030,6 +44313,28 @@ export const CustomerApiFp = function(configuration?: Configuration) {
44030
44313
  });
44031
44314
  };
44032
44315
  },
44316
+ /**
44317
+ * Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
44318
+ * @summary getMagicLink
44319
+ * @param {number} customer_profile_oid The customer_profile_oid of the customer.
44320
+ * @param {string} storefront_host_name The storefront to log into.
44321
+ * @param {*} [options] Override http request option.
44322
+ * @throws {RequiredError}
44323
+ */
44324
+ getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CustomerMagicLinkResponse> {
44325
+ const localVarFetchArgs = CustomerApiFetchParamCreator(configuration).getMagicLink(customer_profile_oid, storefront_host_name, options);
44326
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
44327
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
44328
+
44329
+ if (response.status >= 200 && response.status < 300) {
44330
+ return response.json();
44331
+
44332
+ } else {
44333
+ throw response;
44334
+ }
44335
+ });
44336
+ };
44337
+ },
44033
44338
  /**
44034
44339
  * Insert a customer on the UltraCart account.
44035
44340
  * @summary Insert a customer
@@ -44329,6 +44634,17 @@ export const CustomerApiFactory = function (configuration?: Configuration, fetch
44329
44634
  getEmailVerificationToken(token_request: EmailVerifyTokenRequest, options?: any) {
44330
44635
  return CustomerApiFp(configuration).getEmailVerificationToken(token_request, options)(fetch, basePath);
44331
44636
  },
44637
+ /**
44638
+ * Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
44639
+ * @summary getMagicLink
44640
+ * @param {number} customer_profile_oid The customer_profile_oid of the customer.
44641
+ * @param {string} storefront_host_name The storefront to log into.
44642
+ * @param {*} [options] Override http request option.
44643
+ * @throws {RequiredError}
44644
+ */
44645
+ getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any) {
44646
+ return CustomerApiFp(configuration).getMagicLink(customer_profile_oid, storefront_host_name, options)(fetch, basePath);
44647
+ },
44332
44648
  /**
44333
44649
  * Insert a customer on the UltraCart account.
44334
44650
  * @summary Insert a customer
@@ -44562,6 +44878,17 @@ export interface CustomerApiInterface {
44562
44878
  */
44563
44879
  getEmailVerificationToken(token_request: EmailVerifyTokenRequest, options?: any): Promise<EmailVerifyTokenResponse>;
44564
44880
 
44881
+ /**
44882
+ * Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
44883
+ * @summary getMagicLink
44884
+ * @param {number} customer_profile_oid The customer_profile_oid of the customer.
44885
+ * @param {string} storefront_host_name The storefront to log into.
44886
+ * @param {*} [options] Override http request option.
44887
+ * @throws {RequiredError}
44888
+ * @memberof CustomerApiInterface
44889
+ */
44890
+ getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any): Promise<CustomerMagicLinkResponse>;
44891
+
44565
44892
  /**
44566
44893
  * Insert a customer on the UltraCart account.
44567
44894
  * @summary Insert a customer
@@ -44819,6 +45146,19 @@ export class CustomerApi extends BaseAPI implements CustomerApiInterface {
44819
45146
  return CustomerApiFp(this.configuration).getEmailVerificationToken(token_request, options)(this.fetch, this.basePath);
44820
45147
  }
44821
45148
 
45149
+ /**
45150
+ * Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
45151
+ * @summary getMagicLink
45152
+ * @param {number} customer_profile_oid The customer_profile_oid of the customer.
45153
+ * @param {string} storefront_host_name The storefront to log into.
45154
+ * @param {*} [options] Override http request option.
45155
+ * @throws {RequiredError}
45156
+ * @memberof CustomerApi
45157
+ */
45158
+ public getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any) {
45159
+ return CustomerApiFp(this.configuration).getMagicLink(customer_profile_oid, storefront_host_name, options)(this.fetch, this.basePath);
45160
+ }
45161
+
44822
45162
  /**
44823
45163
  * Insert a customer on the UltraCart account.
44824
45164
  * @summary Insert a customer
@@ -58739,6 +59079,60 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
58739
59079
  options: localVarRequestOptions,
58740
59080
  };
58741
59081
  },
59082
+ /**
59083
+ *
59084
+ * @summary Get storefronts (internal use only for security reasons)
59085
+ * @param {*} [options] Override http request option.
59086
+ * @throws {RequiredError}
59087
+ */
59088
+ getStoreFronts(options: any = {}): FetchArgs {
59089
+ const localVarPath = `/storefront/`;
59090
+ const localVarUrlObj = url.parse(localVarPath, true);
59091
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
59092
+ const localVarHeaderParameter = {} as any;
59093
+ const localVarQueryParameter = {} as any;
59094
+
59095
+ if(configuration && configuration.apiVersion) {
59096
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
59097
+ }
59098
+
59099
+
59100
+
59101
+ // authentication ultraCartBrowserApiKey required
59102
+ if (configuration && configuration.apiKey) {
59103
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
59104
+ ? configuration.apiKey("x-ultracart-browser-key")
59105
+ : configuration.apiKey;
59106
+ localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
59107
+ }
59108
+
59109
+ // authentication ultraCartOauth required
59110
+ // oauth required
59111
+ if (configuration && configuration.accessToken) {
59112
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
59113
+ ? configuration.accessToken("ultraCartOauth", ["ultrabooks_write", "auto_order_write", "coupon_read", "affiliate_read", "coupon_write", "channel_partner_read", "tax_read", "conversation_write", "fulfillment_write", "tax_write", "gift_certificate_write", "channel_partner_write", "item_read", "fulfillment_read", "webhook_write", "chargeback_write", "user_write", "gift_certificate_read", "checkout_write", "storefront_read", "webhook_read", "item_write", "auto_order_read", "customer_read", "user_read", "configuration_read", "customer_write", "order_read", "conversation_read", "affiliate_write", "storefront_write", "ultrabooks_read", "order_write", "chargeback_read", "integration_log_write", "configuration_write", "checkout_read", "integration_log_read"])
59114
+ : configuration.accessToken;
59115
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
59116
+ }
59117
+
59118
+ // authentication ultraCartSimpleApiKey required
59119
+ if (configuration && configuration.apiKey) {
59120
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
59121
+ ? configuration.apiKey("x-ultracart-simple-key")
59122
+ : configuration.apiKey;
59123
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
59124
+ }
59125
+
59126
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
59127
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
59128
+ delete localVarUrlObj.search;
59129
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
59130
+
59131
+ return {
59132
+ url: url.format(localVarUrlObj),
59133
+ options: localVarRequestOptions,
59134
+ };
59135
+ },
58742
59136
  /**
58743
59137
  *
58744
59138
  * @summary Get thumbnail parameters
@@ -65296,6 +65690,26 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
65296
65690
  });
65297
65691
  };
65298
65692
  },
65693
+ /**
65694
+ *
65695
+ * @summary Get storefronts (internal use only for security reasons)
65696
+ * @param {*} [options] Override http request option.
65697
+ * @throws {RequiredError}
65698
+ */
65699
+ getStoreFronts(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<StoreFrontsResponse> {
65700
+ const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).getStoreFronts(options);
65701
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
65702
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
65703
+
65704
+ if (response.status >= 200 && response.status < 300) {
65705
+ return response.json();
65706
+
65707
+ } else {
65708
+ throw response;
65709
+ }
65710
+ });
65711
+ };
65712
+ },
65299
65713
  /**
65300
65714
  *
65301
65715
  * @summary Get thumbnail parameters
@@ -67803,6 +68217,15 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
67803
68217
  getStoreFrontPricingTiers(_expand?: string, options?: any) {
67804
68218
  return StorefrontApiFp(configuration).getStoreFrontPricingTiers(_expand, options)(fetch, basePath);
67805
68219
  },
68220
+ /**
68221
+ *
68222
+ * @summary Get storefronts (internal use only for security reasons)
68223
+ * @param {*} [options] Override http request option.
68224
+ * @throws {RequiredError}
68225
+ */
68226
+ getStoreFronts(options?: any) {
68227
+ return StorefrontApiFp(configuration).getStoreFronts(options)(fetch, basePath);
68228
+ },
67806
68229
  /**
67807
68230
  *
67808
68231
  * @summary Get thumbnail parameters
@@ -69628,6 +70051,15 @@ export interface StorefrontApiInterface {
69628
70051
  */
69629
70052
  getStoreFrontPricingTiers(_expand?: string, options?: any): Promise<PricingTiersResponse>;
69630
70053
 
70054
+ /**
70055
+ *
70056
+ * @summary Get storefronts (internal use only for security reasons)
70057
+ * @param {*} [options] Override http request option.
70058
+ * @throws {RequiredError}
70059
+ * @memberof StorefrontApiInterface
70060
+ */
70061
+ getStoreFronts(options?: any): Promise<StoreFrontsResponse>;
70062
+
69631
70063
  /**
69632
70064
  *
69633
70065
  * @summary Get thumbnail parameters
@@ -71655,6 +72087,17 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
71655
72087
  return StorefrontApiFp(this.configuration).getStoreFrontPricingTiers(_expand, options)(this.fetch, this.basePath);
71656
72088
  }
71657
72089
 
72090
+ /**
72091
+ *
72092
+ * @summary Get storefronts (internal use only for security reasons)
72093
+ * @param {*} [options] Override http request option.
72094
+ * @throws {RequiredError}
72095
+ * @memberof StorefrontApi
72096
+ */
72097
+ public getStoreFronts(options?: any) {
72098
+ return StorefrontApiFp(this.configuration).getStoreFronts(options)(this.fetch, this.basePath);
72099
+ }
72100
+
71658
72101
  /**
71659
72102
  *
71660
72103
  * @summary Get thumbnail parameters
package/dist/api.d.ts CHANGED
@@ -6379,6 +6379,31 @@ export declare namespace ConversationEventRRWeb {
6379
6379
  Events
6380
6380
  }
6381
6381
  }
6382
+ /**
6383
+ *
6384
+ * @export
6385
+ * @interface ConversationEventReadMessage
6386
+ */
6387
+ export interface ConversationEventReadMessage {
6388
+ /**
6389
+ *
6390
+ * @type {string}
6391
+ * @memberof ConversationEventReadMessage
6392
+ */
6393
+ conversation_message_uuid?: string;
6394
+ /**
6395
+ * Message date/time
6396
+ * @type {string}
6397
+ * @memberof ConversationEventReadMessage
6398
+ */
6399
+ message_dts?: string;
6400
+ /**
6401
+ *
6402
+ * @type {number}
6403
+ * @memberof ConversationEventReadMessage
6404
+ */
6405
+ message_epoch?: number;
6406
+ }
6382
6407
  /**
6383
6408
  *
6384
6409
  * @export
@@ -6458,6 +6483,12 @@ export interface ConversationMessage {
6458
6483
  * @memberof ConversationMessage
6459
6484
  */
6460
6485
  message_dts?: string;
6486
+ /**
6487
+ * Message epoch milliseconds
6488
+ * @type {number}
6489
+ * @memberof ConversationMessage
6490
+ */
6491
+ message_epoch?: number;
6461
6492
  /**
6462
6493
  *
6463
6494
  * @type {Array<ConversationMessageTransportStatus>}
@@ -6504,11 +6535,34 @@ export interface ConversationMessageTransportStatus {
6504
6535
  */
6505
6536
  conversation_participant_arn?: string;
6506
6537
  /**
6507
- *
6538
+ * The status of the message transport
6508
6539
  * @type {string}
6509
6540
  * @memberof ConversationMessageTransportStatus
6510
6541
  */
6511
- status?: string;
6542
+ status?: ConversationMessageTransportStatus.StatusEnum;
6543
+ }
6544
+ /**
6545
+ * @export
6546
+ * @namespace ConversationMessageTransportStatus
6547
+ */
6548
+ export declare namespace ConversationMessageTransportStatus {
6549
+ /**
6550
+ * @export
6551
+ * @enum {string}
6552
+ */
6553
+ enum StatusEnum {
6554
+ Accepted,
6555
+ Scheduled,
6556
+ Queued,
6557
+ Sending,
6558
+ Sent,
6559
+ Read,
6560
+ TWILIOCREDENTIALSMISSING,
6561
+ SENTTOTWILIO,
6562
+ TWILIOERROR,
6563
+ SENTTOPINPOINT,
6564
+ PINPOINTERROR
6565
+ }
6512
6566
  }
6513
6567
  /**
6514
6568
  *
@@ -6614,6 +6668,12 @@ export interface ConversationParticipant {
6614
6668
  * @memberof ConversationParticipant
6615
6669
  */
6616
6670
  status?: string;
6671
+ /**
6672
+ *
6673
+ * @type {number}
6674
+ * @memberof ConversationParticipant
6675
+ */
6676
+ unread_messages?: number;
6617
6677
  }
6618
6678
  /**
6619
6679
  *
@@ -7089,6 +7149,12 @@ export interface ConversationWebsocketMessage {
7089
7149
  * @memberof ConversationWebsocketMessage
7090
7150
  */
7091
7151
  event_queue_status_update?: ConversationWebchatQueueStatus;
7152
+ /**
7153
+ *
7154
+ * @type {ConversationEventReadMessage}
7155
+ * @memberof ConversationWebsocketMessage
7156
+ */
7157
+ event_read_message?: ConversationEventReadMessage;
7092
7158
  /**
7093
7159
  *
7094
7160
  * @type {ConversationEventRRWeb}
@@ -7144,7 +7210,8 @@ export declare namespace ConversationWebsocketMessage {
7144
7210
  UpdatedMessage,
7145
7211
  QueueStatusUpdate,
7146
7212
  Rrweb,
7147
- ParticipantUpdate
7213
+ ParticipantUpdate,
7214
+ ReadMessage
7148
7215
  }
7149
7216
  /**
7150
7217
  * @export
@@ -8616,6 +8683,12 @@ export interface CouponMultipleAmountsOffItems {
8616
8683
  * @interface CouponNoDiscount
8617
8684
  */
8618
8685
  export interface CouponNoDiscount {
8686
+ /**
8687
+ * This property does nothing but is included in this object to ensure the object is generated by our sdk builders.
8688
+ * @type {boolean}
8689
+ * @memberof CouponNoDiscount
8690
+ */
8691
+ ignore_this_property?: boolean;
8619
8692
  }
8620
8693
  /**
8621
8694
  *
@@ -10410,6 +10483,43 @@ export interface CustomerLoyaltyRedemption {
10410
10483
  */
10411
10484
  remaining_balance?: number;
10412
10485
  }
10486
+ /**
10487
+ *
10488
+ * @export
10489
+ * @interface CustomerMagicLinkResponse
10490
+ */
10491
+ export interface CustomerMagicLinkResponse {
10492
+ /**
10493
+ *
10494
+ * @type {ModelError}
10495
+ * @memberof CustomerMagicLinkResponse
10496
+ */
10497
+ error?: ModelError;
10498
+ /**
10499
+ *
10500
+ * @type {ResponseMetadata}
10501
+ * @memberof CustomerMagicLinkResponse
10502
+ */
10503
+ metadata?: ResponseMetadata;
10504
+ /**
10505
+ * Indicates if API call was successful
10506
+ * @type {boolean}
10507
+ * @memberof CustomerMagicLinkResponse
10508
+ */
10509
+ success?: boolean;
10510
+ /**
10511
+ * URL
10512
+ * @type {string}
10513
+ * @memberof CustomerMagicLinkResponse
10514
+ */
10515
+ url?: string;
10516
+ /**
10517
+ *
10518
+ * @type {Warning}
10519
+ * @memberof CustomerMagicLinkResponse
10520
+ */
10521
+ warning?: Warning;
10522
+ }
10413
10523
  /**
10414
10524
  *
10415
10525
  * @export
@@ -30937,6 +31047,116 @@ export interface StepWaiting {
30937
31047
  */
30938
31048
  number_waiting?: number;
30939
31049
  }
31050
+ /**
31051
+ *
31052
+ * @export
31053
+ * @interface StoreFront
31054
+ */
31055
+ export interface StoreFront {
31056
+ /**
31057
+ *
31058
+ * @type {string}
31059
+ * @memberof StoreFront
31060
+ */
31061
+ host_alias1?: string;
31062
+ /**
31063
+ *
31064
+ * @type {string}
31065
+ * @memberof StoreFront
31066
+ */
31067
+ host_alias2?: string;
31068
+ /**
31069
+ *
31070
+ * @type {string}
31071
+ * @memberof StoreFront
31072
+ */
31073
+ host_alias3?: string;
31074
+ /**
31075
+ *
31076
+ * @type {string}
31077
+ * @memberof StoreFront
31078
+ */
31079
+ host_alias4?: string;
31080
+ /**
31081
+ *
31082
+ * @type {string}
31083
+ * @memberof StoreFront
31084
+ */
31085
+ host_alias5?: string;
31086
+ /**
31087
+ *
31088
+ * @type {string}
31089
+ * @memberof StoreFront
31090
+ */
31091
+ host_name?: string;
31092
+ /**
31093
+ *
31094
+ * @type {boolean}
31095
+ * @memberof StoreFront
31096
+ */
31097
+ locked?: boolean;
31098
+ /**
31099
+ *
31100
+ * @type {string}
31101
+ * @memberof StoreFront
31102
+ */
31103
+ merchant_id?: string;
31104
+ /**
31105
+ *
31106
+ * @type {boolean}
31107
+ * @memberof StoreFront
31108
+ */
31109
+ redirect_aliases?: boolean;
31110
+ /**
31111
+ *
31112
+ * @type {number}
31113
+ * @memberof StoreFront
31114
+ */
31115
+ storefront_oid?: number;
31116
+ /**
31117
+ *
31118
+ * @type {string}
31119
+ * @memberof StoreFront
31120
+ */
31121
+ unlock_password?: string;
31122
+ }
31123
+ /**
31124
+ *
31125
+ * @export
31126
+ * @interface StoreFrontsResponse
31127
+ */
31128
+ export interface StoreFrontsResponse {
31129
+ /**
31130
+ *
31131
+ * @type {ModelError}
31132
+ * @memberof StoreFrontsResponse
31133
+ */
31134
+ error?: ModelError;
31135
+ /**
31136
+ *
31137
+ * @type {ResponseMetadata}
31138
+ * @memberof StoreFrontsResponse
31139
+ */
31140
+ metadata?: ResponseMetadata;
31141
+ /**
31142
+ *
31143
+ * @type {Array<StoreFront>}
31144
+ * @memberof StoreFrontsResponse
31145
+ */
31146
+ storeFronts?: Array<StoreFront>;
31147
+ /**
31148
+ * Indicates if API call was successful
31149
+ * @type {boolean}
31150
+ * @memberof StoreFrontsResponse
31151
+ */
31152
+ success?: boolean;
31153
+ /**
31154
+ *
31155
+ * @type {Warning}
31156
+ * @memberof StoreFrontsResponse
31157
+ */
31158
+ warning?: Warning;
31159
+ }
30940
31160
  /**
30941
31161
  *
30942
31162
  * @export
@@ -37017,6 +37237,15 @@ export declare const CustomerApiFetchParamCreator: (configuration?: Configuratio
37017
37237
  * @throws {RequiredError}
37018
37238
  */
37019
37239
  getEmailVerificationToken(token_request: EmailVerifyTokenRequest, options?: any): FetchArgs;
37240
+ /**
37241
+ * Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
37242
+ * @summary getMagicLink
37243
+ * @param {number} customer_profile_oid The customer_profile_oid of the customer.
37244
+ * @param {string} storefront_host_name The storefront to log into.
37245
+ * @param {*} [options] Override http request option.
37246
+ * @throws {RequiredError}
37247
+ */
37248
+ getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any): FetchArgs;
37020
37249
  /**
37021
37250
  * Insert a customer on the UltraCart account.
37022
37251
  * @summary Insert a customer
@@ -37211,6 +37440,15 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
37211
37440
  * @throws {RequiredError}
37212
37441
  */
37213
37442
  getEmailVerificationToken(token_request: EmailVerifyTokenRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailVerifyTokenResponse>;
37443
+ /**
37444
+ * Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
37445
+ * @summary getMagicLink
37446
+ * @param {number} customer_profile_oid The customer_profile_oid of the customer.
37447
+ * @param {string} storefront_host_name The storefront to log into.
37448
+ * @param {*} [options] Override http request option.
37449
+ * @throws {RequiredError}
37450
+ */
37451
+ getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CustomerMagicLinkResponse>;
37214
37452
  /**
37215
37453
  * Insert a customer on the UltraCart account.
37216
37454
  * @summary Insert a customer
@@ -37405,6 +37643,15 @@ export declare const CustomerApiFactory: (configuration?: Configuration, fetch?:
37405
37643
  * @throws {RequiredError}
37406
37644
  */
37407
37645
  getEmailVerificationToken(token_request: EmailVerifyTokenRequest, options?: any): Promise<EmailVerifyTokenResponse>;
37646
+ /**
37647
+ * Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
37648
+ * @summary getMagicLink
37649
+ * @param {number} customer_profile_oid The customer_profile_oid of the customer.
37650
+ * @param {string} storefront_host_name The storefront to log into.
37651
+ * @param {*} [options] Override http request option.
37652
+ * @throws {RequiredError}
37653
+ */
37654
+ getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any): Promise<CustomerMagicLinkResponse>;
37408
37655
  /**
37409
37656
  * Insert a customer on the UltraCart account.
37410
37657
  * @summary Insert a customer
@@ -37612,6 +37859,16 @@ export interface CustomerApiInterface {
37612
37859
  * @memberof CustomerApiInterface
37613
37860
  */
37614
37861
  getEmailVerificationToken(token_request: EmailVerifyTokenRequest, options?: any): Promise<EmailVerifyTokenResponse>;
37862
+ /**
37863
+ * Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
37864
+ * @summary getMagicLink
37865
+ * @param {number} customer_profile_oid The customer_profile_oid of the customer.
37866
+ * @param {string} storefront_host_name The storefront to log into.
37867
+ * @param {*} [options] Override http request option.
37868
+ * @throws {RequiredError}
37869
+ * @memberof CustomerApiInterface
37870
+ */
37871
+ getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any): Promise<CustomerMagicLinkResponse>;
37615
37872
  /**
37616
37873
  * Insert a customer on the UltraCart account.
37617
37874
  * @summary Insert a customer
@@ -37826,6 +38083,16 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
37826
38083
  * @memberof CustomerApi
37827
38084
  */
37828
38085
  getEmailVerificationToken(token_request: EmailVerifyTokenRequest, options?: any): Promise<EmailVerifyTokenResponse>;
38086
+ /**
38087
+ * Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
38088
+ * @summary getMagicLink
38089
+ * @param {number} customer_profile_oid The customer_profile_oid of the customer.
38090
+ * @param {string} storefront_host_name The storefront to log into.
38091
+ * @param {*} [options] Override http request option.
38092
+ * @throws {RequiredError}
38093
+ * @memberof CustomerApi
38094
+ */
38095
+ getMagicLink(customer_profile_oid: number, storefront_host_name: string, options?: any): Promise<CustomerMagicLinkResponse>;
37829
38096
  /**
37830
38097
  * Insert a customer on the UltraCart account.
37831
38098
  * @summary Insert a customer
@@ -41886,6 +42153,13 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
41886
42153
  * @throws {RequiredError}
41887
42154
  */
41888
42155
  getStoreFrontPricingTiers(_expand?: string, options?: any): FetchArgs;
42156
+ /**
42157
+ *
42158
+ * @summary Get storefronts (internal use only for security reasons)
42159
+ * @param {*} [options] Override http request option.
42160
+ * @throws {RequiredError}
42161
+ */
42162
+ getStoreFronts(options?: any): FetchArgs;
41889
42163
  /**
41890
42164
  *
41891
42165
  * @summary Get thumbnail parameters
@@ -43382,6 +43656,13 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
43382
43656
  * @throws {RequiredError}
43383
43657
  */
43384
43658
  getStoreFrontPricingTiers(_expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<PricingTiersResponse>;
43659
+ /**
43660
+ *
43661
+ * @summary Get storefronts (internal use only for security reasons)
43662
+ * @param {*} [options] Override http request option.
43663
+ * @throws {RequiredError}
43664
+ */
43665
+ getStoreFronts(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<StoreFrontsResponse>;
43385
43666
  /**
43386
43667
  *
43387
43668
  * @summary Get thumbnail parameters
@@ -44878,6 +45159,13 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
44878
45159
  * @throws {RequiredError}
44879
45160
  */
44880
45161
  getStoreFrontPricingTiers(_expand?: string, options?: any): Promise<PricingTiersResponse>;
45162
+ /**
45163
+ *
45164
+ * @summary Get storefronts (internal use only for security reasons)
45165
+ * @param {*} [options] Override http request option.
45166
+ * @throws {RequiredError}
45167
+ */
45168
+ getStoreFronts(options?: any): Promise<StoreFrontsResponse>;
44881
45169
  /**
44882
45170
  *
44883
45171
  * @summary Get thumbnail parameters
@@ -46476,6 +46764,14 @@ export interface StorefrontApiInterface {
46476
46764
  * @memberof StorefrontApiInterface
46477
46765
  */
46478
46766
  getStoreFrontPricingTiers(_expand?: string, options?: any): Promise<PricingTiersResponse>;
46767
+ /**
46768
+ *
46769
+ * @summary Get storefronts (internal use only for security reasons)
46770
+ * @param {*} [options] Override http request option.
46771
+ * @throws {RequiredError}
46772
+ * @memberof StorefrontApiInterface
46773
+ */
46774
+ getStoreFronts(options?: any): Promise<StoreFrontsResponse>;
46479
46775
  /**
46480
46776
  *
46481
46777
  * @summary Get thumbnail parameters
@@ -48137,6 +48433,14 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
48137
48433
  * @memberof StorefrontApi
48138
48434
  */
48139
48435
  getStoreFrontPricingTiers(_expand?: string, options?: any): Promise<PricingTiersResponse>;
48436
+ /**
48437
+ *
48438
+ * @summary Get storefronts (internal use only for security reasons)
48439
+ * @param {*} [options] Override http request option.
48440
+ * @throws {RequiredError}
48441
+ * @memberof StorefrontApi
48442
+ */
48443
+ getStoreFronts(options?: any): Promise<StoreFrontsResponse>;
48140
48444
  /**
48141
48445
  *
48142
48446
  * @summary Get thumbnail parameters
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.Weight = exports.Webhook = exports.TempMultimedia = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = 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.ConversationSummary = exports.ConversationMessage = exports.ConversationEventRRWeb = 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.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = 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 = 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 = void 0;
31
+ exports.Webhook = exports.TempMultimedia = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = 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.ConversationSummary = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationEventRRWeb = 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.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = 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 = 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 = 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(/\/+$/, "");
@@ -407,6 +407,31 @@ var ConversationMessage;
407
407
  TypeEnum[TypeEnum["Notice"] = 'notice'] = "Notice";
408
408
  })(TypeEnum = ConversationMessage.TypeEnum || (ConversationMessage.TypeEnum = {}));
409
409
  })(ConversationMessage = exports.ConversationMessage || (exports.ConversationMessage = {}));
410
+ /**
411
+ * @export
412
+ * @namespace ConversationMessageTransportStatus
413
+ */
414
+ var ConversationMessageTransportStatus;
415
+ (function (ConversationMessageTransportStatus) {
416
+ /**
417
+ * @export
418
+ * @enum {string}
419
+ */
420
+ var StatusEnum;
421
+ (function (StatusEnum) {
422
+ StatusEnum[StatusEnum["Accepted"] = 'accepted'] = "Accepted";
423
+ StatusEnum[StatusEnum["Scheduled"] = 'scheduled'] = "Scheduled";
424
+ StatusEnum[StatusEnum["Queued"] = 'queued'] = "Queued";
425
+ StatusEnum[StatusEnum["Sending"] = 'sending'] = "Sending";
426
+ StatusEnum[StatusEnum["Sent"] = 'sent'] = "Sent";
427
+ StatusEnum[StatusEnum["Read"] = 'read'] = "Read";
428
+ StatusEnum[StatusEnum["TWILIOCREDENTIALSMISSING"] = 'TWILIO_CREDENTIALS_MISSING'] = "TWILIOCREDENTIALSMISSING";
429
+ StatusEnum[StatusEnum["SENTTOTWILIO"] = 'SENT_TO_TWILIO'] = "SENTTOTWILIO";
430
+ StatusEnum[StatusEnum["TWILIOERROR"] = 'TWILIO_ERROR'] = "TWILIOERROR";
431
+ StatusEnum[StatusEnum["SENTTOPINPOINT"] = 'SENT_TO_PINPOINT'] = "SENTTOPINPOINT";
432
+ StatusEnum[StatusEnum["PINPOINTERROR"] = 'PINPOINT_ERROR'] = "PINPOINTERROR";
433
+ })(StatusEnum = ConversationMessageTransportStatus.StatusEnum || (ConversationMessageTransportStatus.StatusEnum = {}));
434
+ })(ConversationMessageTransportStatus = exports.ConversationMessageTransportStatus || (exports.ConversationMessageTransportStatus = {}));
410
435
  /**
411
436
  * @export
412
437
  * @namespace ConversationSummary
@@ -444,6 +469,7 @@ var ConversationWebsocketMessage;
444
469
  EventTypeEnum[EventTypeEnum["QueueStatusUpdate"] = 'queue status update'] = "QueueStatusUpdate";
445
470
  EventTypeEnum[EventTypeEnum["Rrweb"] = 'rrweb'] = "Rrweb";
446
471
  EventTypeEnum[EventTypeEnum["ParticipantUpdate"] = 'participant update'] = "ParticipantUpdate";
472
+ EventTypeEnum[EventTypeEnum["ReadMessage"] = 'read message'] = "ReadMessage";
447
473
  })(EventTypeEnum = ConversationWebsocketMessage.EventTypeEnum || (ConversationWebsocketMessage.EventTypeEnum = {}));
448
474
  /**
449
475
  * @export
@@ -8901,6 +8927,58 @@ var CustomerApiFetchParamCreator = function (configuration) {
8901
8927
  options: localVarRequestOptions,
8902
8928
  };
8903
8929
  },
8930
+ /**
8931
+ * Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
8932
+ * @summary getMagicLink
8933
+ * @param {number} customer_profile_oid The customer_profile_oid of the customer.
8934
+ * @param {string} storefront_host_name The storefront to log into.
8935
+ * @param {*} [options] Override http request option.
8936
+ * @throws {RequiredError}
8937
+ */
8938
+ getMagicLink: function (customer_profile_oid, storefront_host_name, options) {
8939
+ if (options === void 0) { options = {}; }
8940
+ // verify required parameter 'customer_profile_oid' is not null or undefined
8941
+ if (customer_profile_oid === null || customer_profile_oid === undefined) {
8942
+ throw new RequiredError('customer_profile_oid', 'Required parameter customer_profile_oid was null or undefined when calling getMagicLink.');
8943
+ }
8944
+ // verify required parameter 'storefront_host_name' is not null or undefined
8945
+ if (storefront_host_name === null || storefront_host_name === undefined) {
8946
+ throw new RequiredError('storefront_host_name', 'Required parameter storefront_host_name was null or undefined when calling getMagicLink.');
8947
+ }
8948
+ var localVarPath = "/customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name}"
8949
+ .replace("{".concat("customer_profile_oid", "}"), encodeURIComponent(String(customer_profile_oid)))
8950
+ .replace("{".concat("storefront_host_name", "}"), encodeURIComponent(String(storefront_host_name)));
8951
+ var localVarUrlObj = url.parse(localVarPath, true);
8952
+ var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
8953
+ var localVarHeaderParameter = {};
8954
+ var localVarQueryParameter = {};
8955
+ if (configuration && configuration.apiVersion) {
8956
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
8957
+ }
8958
+ // authentication ultraCartOauth required
8959
+ // oauth required
8960
+ if (configuration && configuration.accessToken) {
8961
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
8962
+ ? configuration.accessToken("ultraCartOauth", ["customer_write"])
8963
+ : configuration.accessToken;
8964
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
8965
+ }
8966
+ // authentication ultraCartSimpleApiKey required
8967
+ if (configuration && configuration.apiKey) {
8968
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
8969
+ ? configuration.apiKey("x-ultracart-simple-key")
8970
+ : configuration.apiKey;
8971
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
8972
+ }
8973
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
8974
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
8975
+ delete localVarUrlObj.search;
8976
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
8977
+ return {
8978
+ url: url.format(localVarUrlObj),
8979
+ options: localVarRequestOptions,
8980
+ };
8981
+ },
8904
8982
  /**
8905
8983
  * Insert a customer on the UltraCart account.
8906
8984
  * @summary Insert a customer
@@ -9537,6 +9615,29 @@ var CustomerApiFp = function (configuration) {
9537
9615
  });
9538
9616
  };
9539
9617
  },
9618
+ /**
9619
+ * Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
9620
+ * @summary getMagicLink
9621
+ * @param {number} customer_profile_oid The customer_profile_oid of the customer.
9622
+ * @param {string} storefront_host_name The storefront to log into.
9623
+ * @param {*} [options] Override http request option.
9624
+ * @throws {RequiredError}
9625
+ */
9626
+ getMagicLink: function (customer_profile_oid, storefront_host_name, options) {
9627
+ var localVarFetchArgs = (0, exports.CustomerApiFetchParamCreator)(configuration).getMagicLink(customer_profile_oid, storefront_host_name, options);
9628
+ return function (fetch, basePath) {
9629
+ if (fetch === void 0) { fetch = portableFetch; }
9630
+ if (basePath === void 0) { basePath = BASE_PATH; }
9631
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
9632
+ if (response.status >= 200 && response.status < 300) {
9633
+ return response.json();
9634
+ }
9635
+ else {
9636
+ throw response;
9637
+ }
9638
+ });
9639
+ };
9640
+ },
9540
9641
  /**
9541
9642
  * Insert a customer on the UltraCart account.
9542
9643
  * @summary Insert a customer
@@ -9842,6 +9943,17 @@ var CustomerApiFactory = function (configuration, fetch, basePath) {
9842
9943
  getEmailVerificationToken: function (token_request, options) {
9843
9944
  return (0, exports.CustomerApiFp)(configuration).getEmailVerificationToken(token_request, options)(fetch, basePath);
9844
9945
  },
9946
+ /**
9947
+ * Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
9948
+ * @summary getMagicLink
9949
+ * @param {number} customer_profile_oid The customer_profile_oid of the customer.
9950
+ * @param {string} storefront_host_name The storefront to log into.
9951
+ * @param {*} [options] Override http request option.
9952
+ * @throws {RequiredError}
9953
+ */
9954
+ getMagicLink: function (customer_profile_oid, storefront_host_name, options) {
9955
+ return (0, exports.CustomerApiFp)(configuration).getMagicLink(customer_profile_oid, storefront_host_name, options)(fetch, basePath);
9956
+ },
9845
9957
  /**
9846
9958
  * Insert a customer on the UltraCart account.
9847
9959
  * @summary Insert a customer
@@ -10092,6 +10204,18 @@ var CustomerApi = /** @class */ (function (_super) {
10092
10204
  CustomerApi.prototype.getEmailVerificationToken = function (token_request, options) {
10093
10205
  return (0, exports.CustomerApiFp)(this.configuration).getEmailVerificationToken(token_request, options)(this.fetch, this.basePath);
10094
10206
  };
10207
+ /**
10208
+ * Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
10209
+ * @summary getMagicLink
10210
+ * @param {number} customer_profile_oid The customer_profile_oid of the customer.
10211
+ * @param {string} storefront_host_name The storefront to log into.
10212
+ * @param {*} [options] Override http request option.
10213
+ * @throws {RequiredError}
10214
+ * @memberof CustomerApi
10215
+ */
10216
+ CustomerApi.prototype.getMagicLink = function (customer_profile_oid, storefront_host_name, options) {
10217
+ return (0, exports.CustomerApiFp)(this.configuration).getMagicLink(customer_profile_oid, storefront_host_name, options)(this.fetch, this.basePath);
10218
+ };
10095
10219
  /**
10096
10220
  * Insert a customer on the UltraCart account.
10097
10221
  * @summary Insert a customer
@@ -22126,6 +22250,53 @@ var StorefrontApiFetchParamCreator = function (configuration) {
22126
22250
  options: localVarRequestOptions,
22127
22251
  };
22128
22252
  },
22253
+ /**
22254
+ *
22255
+ * @summary Get storefronts (internal use only for security reasons)
22256
+ * @param {*} [options] Override http request option.
22257
+ * @throws {RequiredError}
22258
+ */
22259
+ getStoreFronts: function (options) {
22260
+ if (options === void 0) { options = {}; }
22261
+ var localVarPath = "/storefront/";
22262
+ var localVarUrlObj = url.parse(localVarPath, true);
22263
+ var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
22264
+ var localVarHeaderParameter = {};
22265
+ var localVarQueryParameter = {};
22266
+ if (configuration && configuration.apiVersion) {
22267
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
22268
+ }
22269
+ // authentication ultraCartBrowserApiKey required
22270
+ if (configuration && configuration.apiKey) {
22271
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
22272
+ ? configuration.apiKey("x-ultracart-browser-key")
22273
+ : configuration.apiKey;
22274
+ localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
22275
+ }
22276
+ // authentication ultraCartOauth required
22277
+ // oauth required
22278
+ if (configuration && configuration.accessToken) {
22279
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
22280
+ ? configuration.accessToken("ultraCartOauth", ["ultrabooks_write", "auto_order_write", "coupon_read", "affiliate_read", "coupon_write", "channel_partner_read", "tax_read", "conversation_write", "fulfillment_write", "tax_write", "gift_certificate_write", "channel_partner_write", "item_read", "fulfillment_read", "webhook_write", "chargeback_write", "user_write", "gift_certificate_read", "checkout_write", "storefront_read", "webhook_read", "item_write", "auto_order_read", "customer_read", "user_read", "configuration_read", "customer_write", "order_read", "conversation_read", "affiliate_write", "storefront_write", "ultrabooks_read", "order_write", "chargeback_read", "integration_log_write", "configuration_write", "checkout_read", "integration_log_read"])
22281
+ : configuration.accessToken;
22282
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
22283
+ }
22284
+ // authentication ultraCartSimpleApiKey required
22285
+ if (configuration && configuration.apiKey) {
22286
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
22287
+ ? configuration.apiKey("x-ultracart-simple-key")
22288
+ : configuration.apiKey;
22289
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
22290
+ }
22291
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
22292
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
22293
+ delete localVarUrlObj.search;
22294
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
22295
+ return {
22296
+ url: url.format(localVarUrlObj),
22297
+ options: localVarRequestOptions,
22298
+ };
22299
+ },
22129
22300
  /**
22130
22301
  *
22131
22302
  * @summary Get thumbnail parameters
@@ -28288,6 +28459,27 @@ var StorefrontApiFp = function (configuration) {
28288
28459
  });
28289
28460
  };
28290
28461
  },
28462
+ /**
28463
+ *
28464
+ * @summary Get storefronts (internal use only for security reasons)
28465
+ * @param {*} [options] Override http request option.
28466
+ * @throws {RequiredError}
28467
+ */
28468
+ getStoreFronts: function (options) {
28469
+ var localVarFetchArgs = (0, exports.StorefrontApiFetchParamCreator)(configuration).getStoreFronts(options);
28470
+ return function (fetch, basePath) {
28471
+ if (fetch === void 0) { fetch = portableFetch; }
28472
+ if (basePath === void 0) { basePath = BASE_PATH; }
28473
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
28474
+ if (response.status >= 200 && response.status < 300) {
28475
+ return response.json();
28476
+ }
28477
+ else {
28478
+ throw response;
28479
+ }
28480
+ });
28481
+ };
28482
+ },
28291
28483
  /**
28292
28484
  *
28293
28485
  * @summary Get thumbnail parameters
@@ -30857,6 +31049,15 @@ var StorefrontApiFactory = function (configuration, fetch, basePath) {
30857
31049
  getStoreFrontPricingTiers: function (_expand, options) {
30858
31050
  return (0, exports.StorefrontApiFp)(configuration).getStoreFrontPricingTiers(_expand, options)(fetch, basePath);
30859
31051
  },
31052
+ /**
31053
+ *
31054
+ * @summary Get storefronts (internal use only for security reasons)
31055
+ * @param {*} [options] Override http request option.
31056
+ * @throws {RequiredError}
31057
+ */
31058
+ getStoreFronts: function (options) {
31059
+ return (0, exports.StorefrontApiFp)(configuration).getStoreFronts(options)(fetch, basePath);
31060
+ },
30860
31061
  /**
30861
31062
  *
30862
31063
  * @summary Get thumbnail parameters
@@ -32788,6 +32989,16 @@ var StorefrontApi = /** @class */ (function (_super) {
32788
32989
  StorefrontApi.prototype.getStoreFrontPricingTiers = function (_expand, options) {
32789
32990
  return (0, exports.StorefrontApiFp)(this.configuration).getStoreFrontPricingTiers(_expand, options)(this.fetch, this.basePath);
32790
32991
  };
32992
+ /**
32993
+ *
32994
+ * @summary Get storefronts (internal use only for security reasons)
32995
+ * @param {*} [options] Override http request option.
32996
+ * @throws {RequiredError}
32997
+ * @memberof StorefrontApi
32998
+ */
32999
+ StorefrontApi.prototype.getStoreFronts = function (options) {
33000
+ return (0, exports.StorefrontApiFp)(this.configuration).getStoreFronts(options)(this.fetch, this.basePath);
33001
+ };
32791
33002
  /**
32792
33003
  *
32793
33004
  * @summary Get thumbnail parameters
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.35",
3
+ "version": "3.10.38",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [