ultracart_rest_api_v2_typescript 4.0.34-RC → 4.0.37-RC

package/.openapi-generator/FILES

@@ -7,6 +7,7 @@ src/apis/AutoOrderApi.ts
 src/apis/ChannelPartnerApi.ts
 src/apis/ChargebackApi.ts
 src/apis/CheckoutApi.ts
+src/apis/ConversationApi.ts
 src/apis/CouponApi.ts
 src/apis/CustomerApi.ts
 src/apis/FulfillmentApi.ts
@@ -138,6 +139,15 @@ src/models/CheckoutSetupBrowserKeyRequest.ts
 src/models/CheckoutSetupBrowserKeyResponse.ts
 src/models/CheckoutStateProvinceResponse.ts
 src/models/CityStateZip.ts
+src/models/Conversation.ts
+src/models/ConversationAgentAuthResponse.ts
+src/models/ConversationMessage.ts
+src/models/ConversationMessageTransportStatus.ts
+src/models/ConversationParticipant.ts
+src/models/ConversationStartRequest.ts
+src/models/ConversationStartResponse.ts
+src/models/ConversationSummary.ts
+src/models/ConversationsResponse.ts
 src/models/CountriesResponse.ts
 src/models/Country.ts
 src/models/Coupon.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.34-RC
+## ultracart_rest_api_v2_typescript@4.0.37-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.34-RC --save
+npm install ultracart_rest_api_v2_typescript@4.0.37-RC --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.37-RC | 07/20/2022 | conversation participant name added |
+| 4.0.36-RC | 07/18/2022 | twilio dev |
+| 4.0.35-RC | 07/14/2022 | Add channel storefront_oid to the customer activity record |
 | 4.0.34-RC | 07/11/2022 | Customer API - mergeCustomer method |
 | 4.0.33-RC | 07/05/2022 | docs update |
 | 4.0.32-RC | 06/24/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |

package/dist/apis/ConversationApi.d.ts

@@ -0,0 +1,213 @@
+/**
+ * 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 * as runtime from '../runtime';
+import { Conversation, ConversationAgentAuthResponse, ConversationStartRequest, ConversationStartResponse, ConversationsResponse } from '../models';
+export interface GetConversationRequest {
+    conversationUuid: string;
+}
+export interface GetConversationMultimediaUploadUrlRequest {
+    extension: string;
+}
+export interface GetConversationsRequest {
+    limit?: number;
+    offset?: number;
+}
+export interface JoinConversationRequest {
+    conversationUuid: string;
+}
+export interface LeaveConversationRequest {
+    conversationUuid: string;
+}
+export interface StartConversationRequest {
+    startRequest: ConversationStartRequest;
+}
+/**
+ * ConversationApi - interface
+ *
+ * @export
+ * @interface ConversationApiInterface
+ */
+export interface ConversationApiInterface {
+    /**
+     * Retrieve a JWT to authorize an agent to make a websocket connection.
+     * @summary Get agent websocket authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getAgentWebsocketAuthorizationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentAuthResponse>>;
+    /**
+     * Retrieve a JWT to authorize an agent to make a websocket connection.
+     * Get agent websocket authorization
+     */
+    getAgentWebsocketAuthorization(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentAuthResponse>;
+    /**
+     * Retrieve a conversation including the participants and messages
+     * @summary Retrieve a conversation
+     * @param {string} conversationUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationRaw(requestParameters: GetConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Conversation>>;
+    /**
+     * Retrieve a conversation including the participants and messages
+     * Retrieve a conversation
+     */
+    getConversation(requestParameters: GetConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Conversation>;
+    /**
+     * Get a presigned conersation multimedia upload URL
+     * @summary Get a presigned conersation multimedia upload URL
+     * @param {string} extension
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationMultimediaUploadUrlRaw(requestParameters: GetConversationMultimediaUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Get a presigned conersation multimedia upload URL
+     * Get a presigned conersation multimedia upload URL
+     */
+    getConversationMultimediaUploadUrl(requestParameters: GetConversationMultimediaUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
+     * @summary Retrieve a list of conversation summaries newest to oldest
+     * @param {number} [limit] The maximum number of records to return on this one API call. (Max 200)
+     * @param {number} [offset] Pagination of the record set.  Offset is a zero based index.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationsRaw(requestParameters: GetConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationsResponse>>;
+    /**
+     * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
+     * Retrieve a list of conversation summaries newest to oldest
+     */
+    getConversations(requestParameters: GetConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationsResponse>;
+    /**
+     * Join a conversation
+     * @summary Join a conversation
+     * @param {string} conversationUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    joinConversationRaw(requestParameters: JoinConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Join a conversation
+     * Join a conversation
+     */
+    joinConversation(requestParameters: JoinConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Leave a conversation
+     * @summary Leave a conversation
+     * @param {string} conversationUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    leaveConversationRaw(requestParameters: LeaveConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Leave a conversation
+     * Leave a conversation
+     */
+    leaveConversation(requestParameters: LeaveConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Start a new conversation
+     * @summary Start a conversation
+     * @param {ConversationStartRequest} startRequest Start request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    startConversationRaw(requestParameters: StartConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationStartResponse>>;
+    /**
+     * Start a new conversation
+     * Start a conversation
+     */
+    startConversation(requestParameters: StartConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationStartResponse>;
+}
+/**
+ *
+ */
+export declare class ConversationApi extends runtime.BaseAPI implements ConversationApiInterface {
+    /**
+     * Retrieve a JWT to authorize an agent to make a websocket connection.
+     * Get agent websocket authorization
+     */
+    getAgentWebsocketAuthorizationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentAuthResponse>>;
+    /**
+     * Retrieve a JWT to authorize an agent to make a websocket connection.
+     * Get agent websocket authorization
+     */
+    getAgentWebsocketAuthorization(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentAuthResponse>;
+    /**
+     * Retrieve a conversation including the participants and messages
+     * Retrieve a conversation
+     */
+    getConversationRaw(requestParameters: GetConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Conversation>>;
+    /**
+     * Retrieve a conversation including the participants and messages
+     * Retrieve a conversation
+     */
+    getConversation(requestParameters: GetConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Conversation>;
+    /**
+     * Get a presigned conersation multimedia upload URL
+     * Get a presigned conersation multimedia upload URL
+     */
+    getConversationMultimediaUploadUrlRaw(requestParameters: GetConversationMultimediaUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Get a presigned conersation multimedia upload URL
+     * Get a presigned conersation multimedia upload URL
+     */
+    getConversationMultimediaUploadUrl(requestParameters: GetConversationMultimediaUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
+     * Retrieve a list of conversation summaries newest to oldest
+     */
+    getConversationsRaw(requestParameters: GetConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationsResponse>>;
+    /**
+     * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
+     * Retrieve a list of conversation summaries newest to oldest
+     */
+    getConversations(requestParameters?: GetConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationsResponse>;
+    /**
+     * Join a conversation
+     * Join a conversation
+     */
+    joinConversationRaw(requestParameters: JoinConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Join a conversation
+     * Join a conversation
+     */
+    joinConversation(requestParameters: JoinConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Leave a conversation
+     * Leave a conversation
+     */
+    leaveConversationRaw(requestParameters: LeaveConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Leave a conversation
+     * Leave a conversation
+     */
+    leaveConversation(requestParameters: LeaveConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Start a new conversation
+     * Start a conversation
+     */
+    startConversationRaw(requestParameters: StartConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationStartResponse>>;
+    /**
+     * Start a new conversation
+     * Start a conversation
+     */
+    startConversation(requestParameters: StartConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationStartResponse>;
+}