ultracart_rest_api_v2_typescript 4.0.55-RC → 4.0.58-RC

package/.openapi-generator/FILES

@@ -461,6 +461,7 @@ src/models/ItemResponse.ts
 src/models/ItemRestriction.ts
 src/models/ItemRestrictionItem.ts
 src/models/ItemRevguard.ts
+src/models/ItemReview.ts
 src/models/ItemReviews.ts
 src/models/ItemSalesforce.ts
 src/models/ItemShipping.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.55-RC
+## ultracart_rest_api_v2_typescript@4.0.58-RC
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.0.55-RC --save
+npm install ultracart_rest_api_v2_typescript@4.0.58-RC --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.58-RC | 08/26/2022 | postcard address fields for comm sequence testing |
+| 4.0.57-RC | 08/22/2022 | exposing individual reviews within item.review object |
+| 4.0.56-RC | 08/19/2022 | order api - added cell phone fields for sms |
 | 4.0.55-RC | 08/12/2022 | internal code to allow merchant login as customer |
 | 4.0.54-RC | 08/11/2022 | fix entry_dts type on gift certificate ledger |
 | 4.0.53-RC | 08/10/2022 | conversation event refactoring |

package/dist/apis/OrderApi.d.ts

@@ -111,6 +111,7 @@ export interface RefundOrderRequest {
     autoOrderCancel?: boolean;
     manualRefund?: boolean;
     reverseAffiliateTransactions?: boolean;
+    issueStoreCredit?: boolean;
     expand?: string;
 }
 export interface ReplacementRequest {
@@ -429,6 +430,7 @@ export interface OrderApiInterface {
      * @param {boolean} [autoOrderCancel] Cancel associated auto orders
      * @param {boolean} [manualRefund] Consider a manual refund done externally
      * @param {boolean} [reverseAffiliateTransactions] Reverse affiliate transactions
+     * @param {boolean} [issueStoreCredit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
      * @param {string} [expand] The object expansion to perform on the result.  See documentation for examples
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/dist/apis/OrderApi.js

@@ -1251,6 +1251,9 @@ var OrderApi = /** @class */ (function (_super) {
                         if (requestParameters.reverseAffiliateTransactions !== undefined) {
                             queryParameters['reverse_affiliate_transactions'] = requestParameters.reverseAffiliateTransactions;
                         }
+                        if (requestParameters.issueStoreCredit !== undefined) {
+                            queryParameters['issue_store_credit'] = requestParameters.issueStoreCredit;
+                        }
                         if (requestParameters.expand !== undefined) {
                             queryParameters['_expand'] = requestParameters.expand;
                         }

package/dist/apis/StorefrontApi.js

@@ -6468,7 +6468,7 @@ var StorefrontApi = /** @class */ (function (_super) {
                             headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
                         }
                         return [4 /*yield*/, this.request({
-                                path: "/storefront/",
+                                path: "/storefront",
                                 method: 'GET',
                                 headers: headerParameters,
                                 query: queryParameters,

package/dist/models/CartMarketing.d.ts

@@ -21,6 +21,12 @@ export interface CartMarketing {
      * @memberof CartMarketing
      */
     advertising_source?: string;
+    /**
+     * True if the customer agrees to receiving marketing SMS messages
+     * @type {boolean}
+     * @memberof CartMarketing
+     */
+    cell_phone_opt_in?: boolean;
     /**
      * True if the customer agrees to receiving marketing emails
      * @type {boolean}

package/dist/models/CartMarketing.js

@@ -25,6 +25,7 @@ function CartMarketingFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'advertising_source': !(0, runtime_1.exists)(json, 'advertising_source') ? undefined : json['advertising_source'],
+        'cell_phone_opt_in': !(0, runtime_1.exists)(json, 'cell_phone_opt_in') ? undefined : json['cell_phone_opt_in'],
         'mailing_list_opt_in': !(0, runtime_1.exists)(json, 'mailing_list_opt_in') ? undefined : json['mailing_list_opt_in'],
     };
 }
@@ -38,6 +39,7 @@ function CartMarketingToJSON(value) {
     }
     return {
         'advertising_source': value.advertising_source,
+        'cell_phone_opt_in': value.cell_phone_opt_in,
         'mailing_list_opt_in': value.mailing_list_opt_in,
     };
 }

package/dist/models/ConversationParticipant.d.ts

@@ -51,6 +51,12 @@ export interface ConversationParticipant {
      * @memberof ConversationParticipant
      */
     left_dts?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationParticipant
+     */
+    profile_image_url?: string;
     /**
      *
      * @type {string}

package/dist/models/ConversationParticipant.js

@@ -30,6 +30,7 @@ function ConversationParticipantFromJSONTyped(json, ignoreDiscriminator) {
         'joined_dts': !(0, runtime_1.exists)(json, 'joined_dts') ? undefined : json['joined_dts'],
         'last_message_dts': !(0, runtime_1.exists)(json, 'last_message_dts') ? undefined : json['last_message_dts'],
         'left_dts': !(0, runtime_1.exists)(json, 'left_dts') ? undefined : json['left_dts'],
+        'profile_image_url': !(0, runtime_1.exists)(json, 'profile_image_url') ? undefined : json['profile_image_url'],
         'status': !(0, runtime_1.exists)(json, 'status') ? undefined : json['status'],
         'unread_messages': !(0, runtime_1.exists)(json, 'unread_messages') ? undefined : json['unread_messages'],
     };
@@ -49,6 +50,7 @@ function ConversationParticipantToJSON(value) {
         'joined_dts': value.joined_dts,
         'last_message_dts': value.last_message_dts,
         'left_dts': value.left_dts,
+        'profile_image_url': value.profile_image_url,
         'status': value.status,
         'unread_messages': value.unread_messages,
     };

package/dist/models/ConversationWebchatQueueStatusAgent.d.ts

@@ -16,11 +16,11 @@
  */
 export interface ConversationWebchatQueueStatusAgent {
     /**
-     *
+     * Status of the agent
      * @type {string}
      * @memberof ConversationWebchatQueueStatusAgent
      */
-    agent_status?: string;
+    agent_status?: ConversationWebchatQueueStatusAgentAgentStatusEnum;
     /**
      *
      * @type {string}
@@ -45,7 +45,22 @@ export interface ConversationWebchatQueueStatusAgent {
      * @memberof ConversationWebchatQueueStatusAgent
      */
     next_round_robin?: boolean;
+    /**
+     * Profile image URL
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusAgent
+     */
+    profile_image_url?: string;
 }
+/**
+ * @export
+ */
+export declare const ConversationWebchatQueueStatusAgentAgentStatusEnum: {
+    readonly Available: "available";
+    readonly Busy: "busy";
+    readonly Unavailable: "unavailable";
+};
+export declare type ConversationWebchatQueueStatusAgentAgentStatusEnum = typeof ConversationWebchatQueueStatusAgentAgentStatusEnum[keyof typeof ConversationWebchatQueueStatusAgentAgentStatusEnum];
 export declare function ConversationWebchatQueueStatusAgentFromJSON(json: any): ConversationWebchatQueueStatusAgent;
 export declare function ConversationWebchatQueueStatusAgentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationWebchatQueueStatusAgent;
 export declare function ConversationWebchatQueueStatusAgentToJSON(value?: ConversationWebchatQueueStatusAgent | null): any;

package/dist/models/ConversationWebchatQueueStatusAgent.js

@@ -13,8 +13,16 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConversationWebchatQueueStatusAgentToJSON = exports.ConversationWebchatQueueStatusAgentFromJSONTyped = exports.ConversationWebchatQueueStatusAgentFromJSON = void 0;
+exports.ConversationWebchatQueueStatusAgentToJSON = exports.ConversationWebchatQueueStatusAgentFromJSONTyped = exports.ConversationWebchatQueueStatusAgentFromJSON = exports.ConversationWebchatQueueStatusAgentAgentStatusEnum = void 0;
 var runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.ConversationWebchatQueueStatusAgentAgentStatusEnum = {
+    Available: 'available',
+    Busy: 'busy',
+    Unavailable: 'unavailable'
+};
 function ConversationWebchatQueueStatusAgentFromJSON(json) {
     return ConversationWebchatQueueStatusAgentFromJSONTyped(json, false);
 }
@@ -29,6 +37,7 @@ function ConversationWebchatQueueStatusAgentFromJSONTyped(json, ignoreDiscrimina
         'conversation_participant_name': !(0, runtime_1.exists)(json, 'conversation_participant_name') ? undefined : json['conversation_participant_name'],
         'last_chat_dts': !(0, runtime_1.exists)(json, 'last_chat_dts') ? undefined : json['last_chat_dts'],
         'next_round_robin': !(0, runtime_1.exists)(json, 'next_round_robin') ? undefined : json['next_round_robin'],
+        'profile_image_url': !(0, runtime_1.exists)(json, 'profile_image_url') ? undefined : json['profile_image_url'],
     };
 }
 exports.ConversationWebchatQueueStatusAgentFromJSONTyped = ConversationWebchatQueueStatusAgentFromJSONTyped;
@@ -45,6 +54,7 @@ function ConversationWebchatQueueStatusAgentToJSON(value) {
         'conversation_participant_name': value.conversation_participant_name,
         'last_chat_dts': value.last_chat_dts,
         'next_round_robin': value.next_round_robin,
+        'profile_image_url': value.profile_image_url,
     };
 }
 exports.ConversationWebchatQueueStatusAgentToJSON = ConversationWebchatQueueStatusAgentToJSON;

package/dist/models/EmailCommseqSequenceTestRequest.d.ts

@@ -15,6 +15,18 @@
  * @interface EmailCommseqSequenceTestRequest
  */
 export interface EmailCommseqSequenceTestRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    address_1?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    address_2?: string;
     /**
      *
      * @type {string}
@@ -27,12 +39,24 @@ export interface EmailCommseqSequenceTestRequest {
      * @memberof EmailCommseqSequenceTestRequest
      */
     cart_item_ids?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    city?: string;
     /**
      *
      * @type {string}
      * @memberof EmailCommseqSequenceTestRequest
      */
     esp_commseq_uuid?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    mail_card?: boolean;
     /**
      *
      * @type {string}
@@ -51,6 +75,12 @@ export interface EmailCommseqSequenceTestRequest {
      * @memberof EmailCommseqSequenceTestRequest
      */
     please_review?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    postal_code?: string;
     /**
      *
      * @type {string}
@@ -63,6 +93,12 @@ export interface EmailCommseqSequenceTestRequest {
      * @memberof EmailCommseqSequenceTestRequest
      */
     send_to_logged_in_user?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    state?: string;
 }
 export declare function EmailCommseqSequenceTestRequestFromJSON(json: any): EmailCommseqSequenceTestRequest;
 export declare function EmailCommseqSequenceTestRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailCommseqSequenceTestRequest;

package/dist/models/EmailCommseqSequenceTestRequest.js

@@ -24,14 +24,20 @@ function EmailCommseqSequenceTestRequestFromJSONTyped(json, ignoreDiscriminator)
         return json;
     }
     return {
+        'address_1': !(0, runtime_1.exists)(json, 'address_1') ? undefined : json['address_1'],
+        'address_2': !(0, runtime_1.exists)(json, 'address_2') ? undefined : json['address_2'],
         'cart_id': !(0, runtime_1.exists)(json, 'cart_id') ? undefined : json['cart_id'],
         'cart_item_ids': !(0, runtime_1.exists)(json, 'cart_item_ids') ? undefined : json['cart_item_ids'],
+        'city': !(0, runtime_1.exists)(json, 'city') ? undefined : json['city'],
         'esp_commseq_uuid': !(0, runtime_1.exists)(json, 'esp_commseq_uuid') ? undefined : json['esp_commseq_uuid'],
+        'mail_card': !(0, runtime_1.exists)(json, 'mail_card') ? undefined : json['mail_card'],
         'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
         'order_id': !(0, runtime_1.exists)(json, 'order_id') ? undefined : json['order_id'],
         'please_review': !(0, runtime_1.exists)(json, 'please_review') ? undefined : json['please_review'],
+        'postal_code': !(0, runtime_1.exists)(json, 'postal_code') ? undefined : json['postal_code'],
         'send_to_email': !(0, runtime_1.exists)(json, 'send_to_email') ? undefined : json['send_to_email'],
         'send_to_logged_in_user': !(0, runtime_1.exists)(json, 'send_to_logged_in_user') ? undefined : json['send_to_logged_in_user'],
+        'state': !(0, runtime_1.exists)(json, 'state') ? undefined : json['state'],
     };
 }
 exports.EmailCommseqSequenceTestRequestFromJSONTyped = EmailCommseqSequenceTestRequestFromJSONTyped;
@@ -43,14 +49,20 @@ function EmailCommseqSequenceTestRequestToJSON(value) {
         return null;
     }
     return {
+        'address_1': value.address_1,
+        'address_2': value.address_2,
         'cart_id': value.cart_id,
         'cart_item_ids': value.cart_item_ids,
+        'city': value.city,
         'esp_commseq_uuid': value.esp_commseq_uuid,
+        'mail_card': value.mail_card,
         'name': value.name,
         'order_id': value.order_id,
         'please_review': value.please_review,
+        'postal_code': value.postal_code,
         'send_to_email': value.send_to_email,
         'send_to_logged_in_user': value.send_to_logged_in_user,
+        'state': value.state,
     };
 }
 exports.EmailCommseqSequenceTestRequestToJSON = EmailCommseqSequenceTestRequestToJSON;

package/dist/models/ExperimentVariation.d.ts

@@ -118,6 +118,12 @@ export interface ExperimentVariation {
      * @memberof ExperimentVariation
      */
     session_count?: number;
+    /**
+     * SMS Opt Ins for this variation
+     * @type {number}
+     * @memberof ExperimentVariation
+     */
+    sms_opt_ins?: number;
     /**
      * Percentage of the traffic this variation is currently receiving
      * @type {number}

package/dist/models/ExperimentVariation.js

@@ -42,6 +42,7 @@ function ExperimentVariationFromJSONTyped(json, ignoreDiscriminator) {
         'paused': !(0, runtime_1.exists)(json, 'paused') ? undefined : json['paused'],
         'revenue': !(0, runtime_1.exists)(json, 'revenue') ? undefined : json['revenue'],
         'session_count': !(0, runtime_1.exists)(json, 'session_count') ? undefined : json['session_count'],
+        'sms_opt_ins': !(0, runtime_1.exists)(json, 'sms_opt_ins') ? undefined : json['sms_opt_ins'],
         'traffic_percentage': !(0, runtime_1.exists)(json, 'traffic_percentage') ? undefined : json['traffic_percentage'],
         'url': !(0, runtime_1.exists)(json, 'url') ? undefined : json['url'],
         'variation_name': !(0, runtime_1.exists)(json, 'variation_name') ? undefined : json['variation_name'],
@@ -75,6 +76,7 @@ function ExperimentVariationToJSON(value) {
         'paused': value.paused,
         'revenue': value.revenue,
         'session_count': value.session_count,
+        'sms_opt_ins': value.sms_opt_ins,
         'traffic_percentage': value.traffic_percentage,
         'url': value.url,
         'variation_name': value.variation_name,

package/dist/models/ExperimentVariationStat.d.ts

@@ -75,6 +75,12 @@ export interface ExperimentVariationStat {
      * @memberof ExperimentVariationStat
      */
     session_count?: number;
+    /**
+     * Total SMS opt in count for this variation
+     * @type {number}
+     * @memberof ExperimentVariationStat
+     */
+    sms_opt_in_count?: number;
     /**
      * Date/time that the statistic was created
      * @type {string}

package/dist/models/ExperimentVariationStat.js

@@ -34,6 +34,7 @@ function ExperimentVariationStatFromJSONTyped(json, ignoreDiscriminator) {
         'page_view_count': !(0, runtime_1.exists)(json, 'page_view_count') ? undefined : json['page_view_count'],
         'revenue': !(0, runtime_1.exists)(json, 'revenue') ? undefined : json['revenue'],
         'session_count': !(0, runtime_1.exists)(json, 'session_count') ? undefined : json['session_count'],
+        'sms_opt_in_count': !(0, runtime_1.exists)(json, 'sms_opt_in_count') ? undefined : json['sms_opt_in_count'],
         'stat_dts': !(0, runtime_1.exists)(json, 'stat_dts') ? undefined : json['stat_dts'],
     };
 }
@@ -56,6 +57,7 @@ function ExperimentVariationStatToJSON(value) {
         'page_view_count': value.page_view_count,
         'revenue': value.revenue,
         'session_count': value.session_count,
+        'sms_opt_in_count': value.sms_opt_in_count,
         'stat_dts': value.stat_dts,
     };
 }

package/dist/models/ItemReview.d.ts

@@ -0,0 +1,243 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ItemReview
+ */
+export interface ItemReview {
+    /**
+     * Customer profile object identifier
+     * @type {number}
+     * @memberof ItemReview
+     */
+    customer_profile_oid?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ItemReview
+     */
+    featured?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemReview
+     */
+    helperful_no_votes?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemReview
+     */
+    helpful_yes_votes?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    order_id?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemReview
+     */
+    overall?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    rating_name1?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    rating_name10?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    rating_name2?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    rating_name3?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    rating_name4?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    rating_name5?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    rating_name6?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    rating_name7?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    rating_name8?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    rating_name9?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemReview
+     */
+    rating_score1?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemReview
+     */
+    rating_score10?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemReview
+     */
+    rating_score2?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemReview
+     */
+    rating_score3?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemReview
+     */
+    rating_score4?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemReview
+     */
+    rating_score5?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemReview
+     */
+    rating_score6?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemReview
+     */
+    rating_score7?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemReview
+     */
+    rating_score8?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemReview
+     */
+    rating_score9?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemReview
+     */
+    recommend_store_to_friend?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ItemReview
+     */
+    recommend_to_friend?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    review?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemReview
+     */
+    review_oid?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    reviewed_nickname?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    reviewer_email?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    reviewer_location?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    status?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    store_feedback?: string;
+    /**
+     * Date/time of review submission
+     * @type {string}
+     * @memberof ItemReview
+     */
+    submitted_dts?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemReview
+     */
+    title?: string;
+}
+export declare function ItemReviewFromJSON(json: any): ItemReview;
+export declare function ItemReviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): ItemReview;
+export declare function ItemReviewToJSON(value?: ItemReview | null): any;