ultracart_rest_api_v2_typescript 4.0.122-RC → 4.0.124-RC

package/.openapi-generator/FILES

@@ -583,6 +583,7 @@ src/models/OrderFraudScore.ts
 src/models/OrderGift.ts
 src/models/OrderGiftCertificate.ts
 src/models/OrderInternal.ts
+src/models/OrderInvoiceResponse.ts
 src/models/OrderItem.ts
 src/models/OrderItemEdi.ts
 src/models/OrderItemEdiIdentification.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.122-RC
+## ultracart_rest_api_v2_typescript@4.0.124-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.122-RC --save
+npm install ultracart_rest_api_v2_typescript@4.0.124-RC --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.124-RC | 01/25/2023 | convo event for engage customer |
+| 4.0.123-RC | 01/25/2023 | order api method generateInvoice |
 | 4.0.122-RC | 01/24/2023 | auto order - cancel minimum and change balance options |
 | 4.0.121-RC | 01/23/2023 | conversation - method to fetch single engagement record |
 | 4.0.120-RC | 01/19/2023 | added skip_on_rebill field to coupon object |

package/dist/apis/OrderApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderByTokenQuery, OrderFormat, OrderFormatResponse, OrderPackingSlipResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrdersResponse } from '../models';
+import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderByTokenQuery, OrderFormat, OrderFormatResponse, OrderInvoiceResponse, OrderPackingSlipResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrdersResponse } from '../models';
 export interface AdjustOrderTotalRequest {
     orderId: string;
     desiredTotal: string;
@@ -29,6 +29,9 @@ export interface FormatRequest {
     orderId: string;
     formatOptions: OrderFormat;
 }
+export interface GenerateInvoiceRequest {
+    orderId: string;
+}
 export interface GenerateOrderTokenRequest {
     orderId: string;
 }
@@ -215,6 +218,20 @@ export interface OrderApiInterface {
      * Format order
      */
     format(requestParameters: FormatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderFormatResponse>;
+    /**
+     * The invoice PDF that is returned is base 64 encoded
+     * @summary Generate an invoice for this order.
+     * @param {string} orderId Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    generateInvoiceRaw(requestParameters: GenerateInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderInvoiceResponse>>;
+    /**
+     * The invoice PDF that is returned is base 64 encoded
+     * Generate an invoice for this order.
+     */
+    generateInvoice(requestParameters: GenerateInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderInvoiceResponse>;
     /**
      * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API.
      * @summary Generate an order token for a given order id
@@ -587,6 +604,16 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
      * Format order
      */
     format(requestParameters: FormatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderFormatResponse>;
+    /**
+     * The invoice PDF that is returned is base 64 encoded
+     * Generate an invoice for this order.
+     */
+    generateInvoiceRaw(requestParameters: GenerateInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderInvoiceResponse>>;
+    /**
+     * The invoice PDF that is returned is base 64 encoded
+     * Generate an invoice for this order.
+     */
+    generateInvoice(requestParameters: GenerateInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderInvoiceResponse>;
     /**
      * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API.
      * Generate an order token for a given order id

package/dist/apis/OrderApi.js

@@ -379,6 +379,65 @@ var OrderApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * The invoice PDF that is returned is base 64 encoded
+     * Generate an invoice for this order.
+     */
+    OrderApi.prototype.generateInvoiceRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
+                            throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling generateInvoice.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["order_read"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/order/orders/{order_id}/invoice".replace("{".concat("order_id", "}"), encodeURIComponent(String(requestParameters.orderId))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderInvoiceResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * The invoice PDF that is returned is base 64 encoded
+     * Generate an invoice for this order.
+     */
+    OrderApi.prototype.generateInvoice = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.generateInvoiceRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API.
      * Generate an order token for a given order id

package/dist/models/ConversationWebsocketMessage.d.ts

@@ -167,12 +167,13 @@ export declare const ConversationWebsocketMessageEventTypeEnum: {
     readonly Rrweb: "rrweb";
     readonly ParticipantUpdate: "participant update";
     readonly ParticipantJoin: "participant join";
-    readonly ParticipantLeft: "participant left";
+    readonly ParticipantLeave: "participant leave";
     readonly ReadMessage: "read message";
     readonly Typing: "typing";
     readonly AddCoupon: "add coupon";
     readonly AddItem: "add item";
     readonly WebchatContext: "webchat context";
+    readonly EngageCustomer: "engage customer";
 };
 export type ConversationWebsocketMessageEventTypeEnum = typeof ConversationWebsocketMessageEventTypeEnum[keyof typeof ConversationWebsocketMessageEventTypeEnum];
 /**

package/dist/models/ConversationWebsocketMessage.js

@@ -40,12 +40,13 @@ exports.ConversationWebsocketMessageEventTypeEnum = {
     Rrweb: 'rrweb',
     ParticipantUpdate: 'participant update',
     ParticipantJoin: 'participant join',
-    ParticipantLeft: 'participant left',
+    ParticipantLeave: 'participant leave',
     ReadMessage: 'read message',
     Typing: 'typing',
     AddCoupon: 'add coupon',
     AddItem: 'add item',
-    WebchatContext: 'webchat context'
+    WebchatContext: 'webchat context',
+    EngageCustomer: 'engage customer'
 };
 /**
  * @export

package/dist/models/OrderInvoiceResponse.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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.
+ */
+import { ModelError } from './ModelError';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @export
+ * @interface OrderInvoiceResponse
+ */
+export interface OrderInvoiceResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof OrderInvoiceResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof OrderInvoiceResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * pdf_base64
+     * @type {string}
+     * @memberof OrderInvoiceResponse
+     */
+    pdfBase64?: string;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof OrderInvoiceResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof OrderInvoiceResponse
+     */
+    warning?: Warning;
+}
+export declare function OrderInvoiceResponseFromJSON(json: any): OrderInvoiceResponse;
+export declare function OrderInvoiceResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderInvoiceResponse;
+export declare function OrderInvoiceResponseToJSON(value?: OrderInvoiceResponse | null): any;

package/dist/models/OrderInvoiceResponse.js

@@ -0,0 +1,53 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderInvoiceResponseToJSON = exports.OrderInvoiceResponseFromJSONTyped = exports.OrderInvoiceResponseFromJSON = void 0;
+var runtime_1 = require("../runtime");
+var ModelError_1 = require("./ModelError");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+function OrderInvoiceResponseFromJSON(json) {
+    return OrderInvoiceResponseFromJSONTyped(json, false);
+}
+exports.OrderInvoiceResponseFromJSON = OrderInvoiceResponseFromJSON;
+function OrderInvoiceResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
+        'pdfBase64': !(0, runtime_1.exists)(json, 'pdfBase64') ? undefined : json['pdfBase64'],
+        'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
+        'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
+    };
+}
+exports.OrderInvoiceResponseFromJSONTyped = OrderInvoiceResponseFromJSONTyped;
+function OrderInvoiceResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'pdfBase64': value.pdfBase64,
+        'success': value.success,
+        'warning': (0, Warning_1.WarningToJSON)(value.warning),
+    };
+}
+exports.OrderInvoiceResponseToJSON = OrderInvoiceResponseToJSON;

package/dist/models/index.d.ts

@@ -558,6 +558,7 @@ export * from './OrderFraudScore';
 export * from './OrderGift';
 export * from './OrderGiftCertificate';
 export * from './OrderInternal';
+export * from './OrderInvoiceResponse';
 export * from './OrderItem';
 export * from './OrderItemEdi';
 export * from './OrderItemEdiIdentification';

package/dist/models/index.js

@@ -576,6 +576,7 @@ __exportStar(require("./OrderFraudScore"), exports);
 __exportStar(require("./OrderGift"), exports);
 __exportStar(require("./OrderGiftCertificate"), exports);
 __exportStar(require("./OrderInternal"), exports);
+__exportStar(require("./OrderInvoiceResponse"), exports);
 __exportStar(require("./OrderItem"), exports);
 __exportStar(require("./OrderItemEdi"), exports);
 __exportStar(require("./OrderItemEdiIdentification"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.0.122-RC",
+  "version": "4.0.124-RC",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/OrderApi.ts

@@ -42,6 +42,9 @@ import {
     OrderFormatResponse,
     OrderFormatResponseFromJSON,
     OrderFormatResponseToJSON,
+    OrderInvoiceResponse,
+    OrderInvoiceResponseFromJSON,
+    OrderInvoiceResponseToJSON,
     OrderPackingSlipResponse,
     OrderPackingSlipResponseFromJSON,
     OrderPackingSlipResponseToJSON,
@@ -100,6 +103,10 @@ export interface FormatRequest {
     formatOptions: OrderFormat;
 }
 
+export interface GenerateInvoiceRequest {
+    orderId: string;
+}
+
 export interface GenerateOrderTokenRequest {
     orderId: string;
 }
@@ -314,6 +321,22 @@ export interface OrderApiInterface {
      */
     format(requestParameters: FormatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderFormatResponse>;
 
+    /**
+     * The invoice PDF that is returned is base 64 encoded 
+     * @summary Generate an invoice for this order.
+     * @param {string} orderId Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    generateInvoiceRaw(requestParameters: GenerateInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderInvoiceResponse>>;
+
+    /**
+     * The invoice PDF that is returned is base 64 encoded 
+     * Generate an invoice for this order.
+     */
+    generateInvoice(requestParameters: GenerateInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderInvoiceResponse>;
+
     /**
      * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API. 
      * @summary Generate an order token for a given order id
@@ -895,6 +918,47 @@ export class OrderApi extends runtime.BaseAPI implements OrderApiInterface {
         return await response.value();
     }
 
+    /**
+     * The invoice PDF that is returned is base 64 encoded 
+     * Generate an invoice for this order.
+     */
+    async generateInvoiceRaw(requestParameters: GenerateInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderInvoiceResponse>> {
+        if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
+            throw new runtime.RequiredError('orderId','Required parameter requestParameters.orderId was null or undefined when calling generateInvoice.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["order_read"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/order/orders/{order_id}/invoice`.replace(`{${"order_id"}}`, encodeURIComponent(String(requestParameters.orderId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrderInvoiceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * The invoice PDF that is returned is base 64 encoded 
+     * Generate an invoice for this order.
+     */
+    async generateInvoice(requestParameters: GenerateInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderInvoiceResponse> {
+        const response = await this.generateInvoiceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API. 
      * Generate an order token for a given order id

package/src/models/ConversationWebsocketMessage.ts

@@ -229,12 +229,13 @@ export const ConversationWebsocketMessageEventTypeEnum = {
     Rrweb: 'rrweb',
     ParticipantUpdate: 'participant update',
     ParticipantJoin: 'participant join',
-    ParticipantLeft: 'participant left',
+    ParticipantLeave: 'participant leave',
     ReadMessage: 'read message',
     Typing: 'typing',
     AddCoupon: 'add coupon',
     AddItem: 'add item',
-    WebchatContext: 'webchat context'
+    WebchatContext: 'webchat context',
+    EngageCustomer: 'engage customer'
 } as const;
 export type ConversationWebsocketMessageEventTypeEnum = typeof ConversationWebsocketMessageEventTypeEnum[keyof typeof ConversationWebsocketMessageEventTypeEnum];
 

package/src/models/OrderInvoiceResponse.ts

@@ -0,0 +1,107 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    ModelError,
+    ModelErrorFromJSON,
+    ModelErrorFromJSONTyped,
+    ModelErrorToJSON,
+} from './ModelError';
+import {
+    ResponseMetadata,
+    ResponseMetadataFromJSON,
+    ResponseMetadataFromJSONTyped,
+    ResponseMetadataToJSON,
+} from './ResponseMetadata';
+import {
+    Warning,
+    WarningFromJSON,
+    WarningFromJSONTyped,
+    WarningToJSON,
+} from './Warning';
+
+/**
+ * 
+ * @export
+ * @interface OrderInvoiceResponse
+ */
+export interface OrderInvoiceResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof OrderInvoiceResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof OrderInvoiceResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * pdf_base64
+     * @type {string}
+     * @memberof OrderInvoiceResponse
+     */
+    pdfBase64?: string;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof OrderInvoiceResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof OrderInvoiceResponse
+     */
+    warning?: Warning;
+}
+
+export function OrderInvoiceResponseFromJSON(json: any): OrderInvoiceResponse {
+    return OrderInvoiceResponseFromJSONTyped(json, false);
+}
+
+export function OrderInvoiceResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderInvoiceResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
+        'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
+        'pdfBase64': !exists(json, 'pdfBase64') ? undefined : json['pdfBase64'],
+        'success': !exists(json, 'success') ? undefined : json['success'],
+        'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
+    };
+}
+
+export function OrderInvoiceResponseToJSON(value?: OrderInvoiceResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'error': ModelErrorToJSON(value.error),
+        'metadata': ResponseMetadataToJSON(value.metadata),
+        'pdfBase64': value.pdfBase64,
+        'success': value.success,
+        'warning': WarningToJSON(value.warning),
+    };
+}
+

package/src/models/index.ts

@@ -560,6 +560,7 @@ export * from './OrderFraudScore';
 export * from './OrderGift';
 export * from './OrderGiftCertificate';
 export * from './OrderInternal';
+export * from './OrderInvoiceResponse';
 export * from './OrderItem';
 export * from './OrderItemEdi';
 export * from './OrderItemEdiIdentification';