ebay-mcp 1.4.3

package/build/types/sell-apps/communication/commerceFeedbackV1BetaOas3.js

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export {};

package/build/types/sell-apps/communication/commerceMessageV1Oas3.d.ts

@@ -0,0 +1,590 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    '/bulk_update_conversation': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description This method can be used to update the <b>conversationStatus</b> of up to 10 conversations.<br><br>The <b>conversationId</b>, existing <b>conversationType</b>, and updated <b>conversationStatus</b> for each conversation to modify are required in the <b>conversations</b> array.<br><br><div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;"><span class="autonumber"><span><b><span style="color: #dd1e31;" class="mcFormatColor">Important!</span></b></span></span> Though it cannot be updated, the <b>conversationType</b> field is required for each conversation being updated.</p></div><br>If the updates were successful, the <b>conversationId</b> of each conversation will be returned with an associated <b>updateStatus</b> value of <code>SUCCESSFUL</code>. */
+        post: operations['bulkUpdateConversation'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/conversation/{conversation_id}': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description This method can be used to retrieve messages within a specific conversation.<br><br>The <b>conversation_id</b> of the conversation for which to retrieve messages is required as path parameters, and the and <b>conversation_type</b> of the conversation is required as a query parameter. */
+        get: operations['getConversation'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/conversation': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description This method can be used to retrieve one or more conversations associated with a user.<br><br>The <b>conversation_type</b> query parameter is required when using this method to specify if the retrieved conversations are from eBay or from members.<br><br>The result set can also optionally be filtered by conversation status, reference, username, and/or time range. The <b>limit</b> and <b>offset</b> path parameters can be used to paginate the result set and control how many conversations are returned in the response. */
+        get: operations['getConversations'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/send_message': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description This method can be used to start a conversation with another user or send a message in an existing conversation with another user based on the information provided in the request.<br><br>To send a message, one of the <b>conversationId</b> or <b>otherPartyUsername</b> request fields are required. The <b>conversationId</b> must be used when sending a message in an existing conversation and specifies the conversation for which to send the message. For a new conversation, the <b>otherPartyUsername</b> field must be used to send the message to a specific user. In addition, the <b>messageText</b> field is required as it contains the body text of the message.<br><br>Optionally, media (such as images or documents) can be attached to the message using the <b>messageMedia</b> container. The <b>reference</b> container can also be used to associate a message with a listing. */
+        post: operations['sendMessage'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/update_conversation': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description This method can be used to update the <b>conversationStatus</b> or the <b>read</b> status of a specified conversation.<br><br><span class="tablenote"><b>Note:</b> Only one of these statuses can be updated at a time using this method. If both fields are included, only the <b>read</b> status of the specified conversation will be updated and the <b>conversationStatus</b> field will be ignored.</span><br>The <b>conversationId</b> of the conversation to modify, as well as the existing <b>conversationType</b> of the specified conversation are required as part of the request payload.<br><br><div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;"><span class="autonumber"><span><b><span style="color: #dd1e31;" class="mcFormatColor">Important!</span></b></span></span> Though it cannot be updated, the existing <b>conversationType</b> of the specified conversation to be updated is required in the request payload. If this value is not provided, an error will occur.</p></div><br>To update a conversation's status (for example, updating an <code>ACTIVE</code> conversation to <code>ARCHIVE</code>), include the <b>conversationStatus</b> field in the request with the updated value. To update a conversation's read status (for example, updating an <code>UNREAD</code> conversation to <code>READ</code>), include the <b>read</b> boolean in the request with the updated value. */
+        post: operations['updateConversation'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /** @description This type specifies the conversations to be updated. */
+        BulkConversation: {
+            /** @description This field indicates the unique identifier of the conversation that is to be updated.<br><br>Use the <a href="/api-docs/commerce/message/resources/conversation/methods/getConversations" target="_blank">getConversations</a> method to retrieve conversation ID values. */
+            conversationId?: string;
+            /** @description This field indicates the status for which to update the associated conversation.<br><br><b>Valid values:</b><ul><li><code>ACTIVE</code></li><li><code>ARCHIVE</code></li><li><code>DELETE</code></li><li><code>READ</code></li><li><code>UNREAD</code></li></ul> */
+            conversationStatus?: string;
+            /** @description This field specifies the existing type of the conversation that is to be updated.<br><br><div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;"><span class="autonumber"><span><b><span style="color: #dd1e31;" class="mcFormatColor">Important!</span></b></span></span> This value <b>cannot</b> be updated using this method, but is required for each conversation being updated.</p></div><br><b>Valid values:</b><ul><li><code>FROM_MEMBERS</code></li><li><code>FROM_EBAY</code></li></ul> */
+            conversationType?: string;
+        };
+        /** @description This type defines the request body of the <b>bulkUpdateConversation</b> method. */
+        BulkUpdateConversationsRequest: {
+            /** @description This array specifies the list of conversations to update and the updated <b>conversationStatus</b> for each. */
+            conversations?: components['schemas']['BulkConversation'][];
+        };
+        /** @description This type defines the response payload of the <b>bulkUpdateConversation</b> method. */
+        BulkUpdateConversationsResponse: {
+            /** @description This container returns metadata from the call, such as how many conversations were updated, how many succeeded, and how many failed. */
+            conversationsMetadata?: components['schemas']['ConversationsMetadata'];
+            /** @description This array returns a list of each conversation specified in the request, and if the requested update was successful or failed. */
+            conversationsResponse?: components['schemas']['ConversationsResponse'][];
+        };
+        /** @description This type defines the details of a conversation, such as its ID, status, type, and latest message. */
+        ConversationDetail: {
+            /** @description The unique identifier of the conversation. */
+            conversationId?: string;
+            /** @description This value indicates the current status of the conversation, such as <code>ACTIVE</code> or <code>ARCHIVE</code>. */
+            conversationStatus?: string;
+            /** @description The title of the conversation. */
+            conversationTitle?: string;
+            /** @description This value indicates the type of the conversation, such as <code>FROM_EBAY</code> or <code>FROM_MEMBERS</code>. */
+            conversationType?: string;
+            /** @description This value indicates the date, in ISO 8601 format, the conversation was created. */
+            createdDate?: string;
+            /** @description This container returns the latest message in the conversation and its details. */
+            latestMessage?: components['schemas']['MessageDetail'];
+            /** @description This value indicates the reference ID associated with the corresponding <b>referenceType</b> value.<br><br>In the case of a <code>LISTING</code> <b>referenceType</b>, this value will be the item ID value of the associated listing. */
+            referenceId?: string;
+            /** @description This value indicates the reference type, if applicable, associated with the conversation.<br><br>The reference type is used to specify what the conversation is in reference to. For example, a value of <code>LISTING</code> specifies that the conversation is associated with a specific listing. The item ID associated with this listing will then be returned in the <b>referenceId</b> field.<br><br>Currently, only <code>LISTING</code> will be returned. */
+            referenceType?: string;
+            /**
+             * Format: int32
+             * @description This value indicates the amount of unread messages in the conversation.
+             */
+            unreadCount?: number;
+        };
+        /** @description This type defines the metadata, such as successes and failures, associated with a bulk conversation status update. */
+        ConversationsMetadata: {
+            /**
+             * Format: int32
+             * @description The total amount of conversations being updated.
+             */
+            totalConversationsCount?: number;
+            /**
+             * Format: int32
+             * @description The number of conversations in which the specified update failed.
+             */
+            updateFailureCount?: number;
+            /**
+             * Format: int32
+             * @description The number of conversations in which the specified update succeeded.
+             */
+            updateSuccessCount?: number;
+        };
+        /** @description This type provides the updated information for a conversation that has been modified. */
+        ConversationsResponse: {
+            /** @description The unique identifier of the conversation. */
+            conversationId?: string;
+            /** @description The update status of the conversation, such as <code>SUCCESS</code> or <code>FAILURE</code>. */
+            updateStatus?: string;
+        };
+        /** @description This type defines the fields that can be returned in an error. */
+        Error: {
+            /** @description Identifies the type of erro. */
+            category?: string;
+            /** @description Name for the primary system where the error occurred. This is relevant for application errors. */
+            domain?: string;
+            /**
+             * Format: int32
+             * @description A unique number to identify the error.
+             */
+            errorId?: number;
+            /** @description An array of request elements most closely associated to the error. */
+            inputRefIds?: string[];
+            /** @description A more detailed explanation of the error. */
+            longMessage?: string;
+            /** @description Information on how to correct the problem, in the end user's terms and language where applicable. */
+            message?: string;
+            /** @description An array of request elements most closely associated to the error. */
+            outputRefIds?: string[];
+            /** @description An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned. */
+            parameters?: components['schemas']['ErrorParameter'][];
+            /** @description Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc. */
+            subdomain?: string;
+        };
+        ErrorParameter: {
+            /** @description The object of the error. */
+            name?: string;
+            /** @description The value of the object. */
+            value?: string;
+        };
+        /** @description This type defines the response payload of the <b>getConversations</b> method. */
+        GetAllMyConversationsResponse: {
+            /** @description This array returns the conversations that match the filter criteria.<br><br>Each conversation is returned with information such as its ID, status, title, type, and creation date, as well as the latest message in the conversation. */
+            conversations?: components['schemas']['ConversationDetail'][];
+            /** @description The URI to the current page of results. */
+            href?: string;
+            /**
+             * Format: int32
+             * @description The value of the <b>limit</b> parameter submitted in the request.
+             */
+            limit?: number;
+            /** @description The URI for the next page of results.<br><br>This value is returned if there is an additional page of results in the result set. */
+            next?: string;
+            /**
+             * Format: int32
+             * @description The value of the <b>offset</b> parameter submitted in the request.
+             */
+            offset?: number;
+            /** @description The URI for the previous page of results.<br><br>This is retuned if there is a previous page of results in the result set. */
+            prev?: string;
+            /**
+             * Format: int32
+             * @description The total number of entries returned in the result set.
+             */
+            total?: number;
+        };
+        /** @description This type defines the response payload of the <b>getConversation</b> method. */
+        GetMessagesByConversationIdResponse: {
+            /** @description The current status of the conversation, such as <code>ACTIVE</code> or <code>ARCHIVE</code>. */
+            conversationStatus?: string;
+            /** @description The title of the conversation. */
+            conversationTitle?: string;
+            /** @description The type of the conversation, such as <code>FROM_EBAY</code> or <code>FROM_MEMBERS</code>. */
+            conversationType?: string;
+            /** @description The URI to the current page of results. */
+            href?: string;
+            /**
+             * Format: int32
+             * @description The value of the <b>limit</b> parameter submitted in the request.
+             */
+            limit?: number;
+            /** @description This array returns a list of messages from the specified conversation. */
+            messages?: components['schemas']['MessageDetail'][];
+            /** @description The URI for the next page of results.<br><br>This value is only returned if there is an additional page of results in the result set. */
+            next?: string;
+            /**
+             * Format: int32
+             * @description The value of the <b>offset</b> parameter submitted in the request.
+             */
+            offset?: number;
+            /** @description The URI for the previous page of results.<br><br>This is only retuned if there is a previous page of results in the result set. */
+            prev?: string;
+            /**
+             * Format: int32
+             * @description The total number of entries returned in the result set.
+             */
+            total?: number;
+        };
+        /** @description This type defines message details for a conversation. */
+        MessageDetail: {
+            /** @description The date,  in ISO 8601 format, the message was received. */
+            createdDate?: string;
+            /** @description The message text. */
+            messageBody?: string;
+            /** @description The unique identifier of the message. */
+            messageId?: string;
+            /** @description This array returns a list, if applicable, of media attached to the message. */
+            messageMedia?: components['schemas']['MessageMedia'][];
+            /** @description This boolean indicates if the message has been viewed by the recipient.<br><br>If this boolean is returned as <code>true</code>, the message has been read. If this boolean is returned as <code>false</code>, the message has not been read. */
+            readStatus?: boolean;
+            /** @description The eBay username of the message recipient. */
+            recipientUsername?: string;
+            /** @description The eBay username of the message sender. */
+            senderUsername?: string;
+            /** @description The subject line of the message. */
+            subject?: string;
+        };
+        /** @description This type specifies the type of message media sent when sending a message. */
+        MessageMedia: {
+            /** @description The name of the media attached to the message. */
+            mediaName?: string;
+            /** @description The type of media attached to the message.<br><br><b>Valid values:</b><ul><li><code>IMAGE</code></li><li><code>PDF</code></li><li><code>DOC</code></li><li><code>TXT</code></li></ul> */
+            mediaType?: string;
+            /** @description The URL of the self-hosted media attached to the message. URLs must use the "HTTPS" protocol. */
+            mediaUrl?: string;
+        };
+        /** @description This type specifies the reference type and associated reference ID associated with a message. */
+        Reference: {
+            /** @description This value indicates the reference ID associated with the corresponding <b>referenceType</b> value.<br><br>For example, in the case of a <code>LISTING</code> reference type, this value will be the item ID value of the listing. */
+            referenceId?: string;
+            /** @description This value indicates the reference type to associate with the conversation.<br><br>The reference type is used to specify what the conversation is in reference to. For example, a value of <code>LISTING</code> specifies that the conversation is associated with a specific listing. The item ID associated with this listing will then be returned in the <b>referenceId</b> field.<br><br>Currently, only <code>LISTING</code> is supported. */
+            referenceType?: string;
+        };
+        /** @description This type defines the request payload of the <b>sendMessage</b> method. */
+        SendMessageRequest: {
+            /** @description This field specifies the unique identifier of the conversation in which to send the message.<br><br>Use the <a href="/api-docs/commerce/message/resources/conversation/methods/getConversations" target="_blank">getConversations</a> method to retrieve conversation ID values.<br><br>This field is required if sending a message in an existing conversation. */
+            conversationId?: string;
+            /** @description This boolean indicates whether a copy of the message should be emailed to the sender.<br><br>If this boolean is input as <code>true</code>, a copy of the message will be emailed to the sender. */
+            emailCopyToSender?: boolean;
+            /** @description This array lists the individual forms of media, if any, to be attached to the message.<br><br>Up to five individual forms of media may be be sent per message. If more than five are specified in this array, an error will occur and the call will fail. */
+            messageMedia?: components['schemas']['MessageMedia'][];
+            /** @description The text of the message.<br><br><b>Max length:</b> 2000 characters */
+            messageText?: string;
+            /** @description This field specifies the eBay username of the entity for which to send the message.<br><br>This field is required if starting a new conversation with another eBay user. */
+            otherPartyUsername?: string;
+            /** @description This container should be used if the new or existing conversation is related to a specific eBay listing.<br><br>For example, a <b>referenceType</b> of <code>LISTING</code> and an associated <b>referenceId</b> will specify the item ID value of the listing associated with the message. */
+            reference?: components['schemas']['Reference'];
+        };
+        /** @description This type defines the response payload of the <b>sendMessage</b> method. */
+        SendMessageResponse: {
+            /** @description The date, in ISO 8601 format, the message was sent. */
+            createdDate?: string;
+            /** @description The message text. */
+            messageBody?: string;
+            /** @description The unique identifier of the message. */
+            messageId?: string;
+            /** @description This array will be returned if the user attached one or more images or documents to the message. */
+            messageMedia?: components['schemas']['MessageMedia'][];
+            /** @description The read status of the message.<br><br>If returned as <code>true</code>, the message has been read by the recipient. */
+            readStatus?: boolean;
+            /** @description The eBay username of the recipient. */
+            recipientUserName?: string;
+            /** @description The eBay username of the sender. */
+            senderUserName?: string;
+            /** @description The subject line of the message. */
+            subject?: string;
+        };
+        /** @description This type defines the request payload of the <b>updateConversation</b> method. */
+        UpdateConversationRequest: {
+            /** @description This field specifies the unique identifier of the conversation that is to be updated.<br><br>Use the <a href="/api-docs/commerce/message/resources/conversation/methods/getConversations" target="_blank">getConversations</a> method to retrieve conversation ID values */
+            conversationId?: string;
+            /** @description This field specifies the status for which to update the specified conversation.<br><br><b>Valid values:</b><ul><li><code>ACTIVE</code></li><li><code>ARCHIVE</code></li><li><code>DELETE</code></li></ul><span class="tablenote"><b>Note:</b> This field should not be used in conjunction with the <b>read</b> field. If both fields are input in the request, only the <b>read</b> status will be updated for the specified conversation and the <b>conversationStatus</b> field will be ignored.</span> */
+            conversationStatus?: string;
+            /** @description This field specifies the existing type of the conversation being updated.<br><br><div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;"><span class="autonumber"><span><b><span style="color: #dd1e31;" class="mcFormatColor">Important!</span></b></span></span> This value <b>cannot</b> be updated using this method, but is required as part of the request payload.</p></div><br><b>Valid values:</b><ul><li><code>FROM_MEMBERS</code></li><li><code>FROM_EBAY</code></li></ul> */
+            conversationType?: string;
+            /** @description This boolean specifies the read status for which to update the conversation.<br><br>If set to <code>true</code>, the conversation will update to 'read', and if set to <code>false</code>, the conversation will update to 'unread'.<br><br><span class="tablenote"><b>Note:</b> This field should not be used in conjunction with the <b>conversationStatus</b> field. If both fields are input in the request, only the <b>read</b> status will be updated for the specified conversation and the <b>conversationStatus</b> field will be ignored.</span> */
+            read?: boolean;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    bulkUpdateConversation: {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br>For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
+                'Content-Type': string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': components['schemas']['BulkUpdateConversationsRequest'];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: Record<string, unknown>;
+                content: {
+                    'application/json': components['schemas']['BulkUpdateConversationsResponse'];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+        };
+    };
+    getConversation: {
+        parameters: {
+            query: {
+                /** @description This query parameter specifies the type of the conversation being retrieved.<br><br>This parameter is always required when using the this method.<br><br><b>Valid values:</b><ul><li><code>FROM_EBAY</code></li><li><code>FROM_MEMBERS</code></li></ul> */
+                conversation_type: string;
+                /** @description The maximum number of entries that can be returned on each page of the paginated response.<br><br>Use this parameter in conjunction with the <b>offset</b> parameter to control the pagination of the output. For example, if <b>offset</b> is set to <code>10</code> and <b>limit</b> is set to <code>10</code>, the call retrieves entries 11 through 20 from the result set.<br><br><span class="tablenote"><b>Note:</b> This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>.</span><br>If this parameter is omitted, the default value is used.<br><br><b>Default:</b> 25<br><br><b>Maximum:</b> 50 */
+                limit?: string;
+                /** @description The number of reports to skip in the result set before returning the first entry in the paginated response.<br><br>Use this parameter in conjunction with the <b>limit</b> parameter to control the pagination of the output. For example, if <b>offset</b> is set to <code>0</code> and <b>limit</b> is set to <code>10</code>, the first page of the response will contain the first 10 entries from the complete list retrieved by the call.<br><br><span class="tablenote"><b>Note:</b> This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>.</span><br>If this parameter is omitted, the default value is used.<br><br><b>Default:</b> 0 */
+                offset?: string;
+            };
+            header?: never;
+            path: {
+                /** @description This path parameters specifies the unique identifier of the conversation that is to be retrieved.<br><br>Use the <a href="/api-docs/commerce/message/resources/conversation/methods/getConversations" target="_blank">getConversations</a> method to retrieve conversation ID values. */
+                conversation_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: Record<string, unknown>;
+                content: {
+                    'application/json': components['schemas']['GetMessagesByConversationIdResponse'];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+        };
+    };
+    getConversations: {
+        parameters: {
+            query: {
+                /** @description This query parameter specifies the status of the conversations being retrieved. Only conversations in the specified status will be returned.<br><br><b>Valid values:</b><ul><li><code>ACTIVE</code></li><li><code>ARCHIVE</code></li><li><code>DELETE</code></li><li><code>READ</code></li><li><code>UNREAD</code></li></ul> */
+                conversation_status?: string;
+                /** @description This query parameter specifies the type of the conversations being retrieved. Only conversations of the specified type will be returned.<br><br>This parameter is always required when using this method.<br><br><b>Valid values:</b><ul><li><code>FROM_EBAY</code></li><li><code>FROM_MEMBERS</code></li></ul> */
+                conversation_type: string;
+                /** @description This query parameter specifies the end time (in ISO 8601 format) for which to stop retrieving conversations.<br><br>For example, if set to <code>2024-11-06T10:00:00.000Z</code>, only messages sent before this time will be retrieved.<br><br><b>Format:</b> yyyy-MM-ddThh:mm.ss.sssZ<br><br><span class="tablenote"><b>Note:</b> Currently, this parameter is only available if the <b>conversation_type</b> of the conversation is <code>FROM_MEMBERS</code>.</span> */
+                end_time?: string;
+                /** @description The maximum number of entries that can be returned on each page of the paginated response.<br><br>Use this parameter in conjunction with the <b>offset</b> parameter to control the pagination of the output. For example, if <b>offset</b> is set to <code>10</code> and <b>limit</b> is set to <code>10</code>, the call retrieves entries 11 through 20 from the result set.<br><br><span class="tablenote"><b>Note:</b> This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>.</span><br>If this parameter is omitted, the default value is used.<br><br><b>Default:</b> 25<br><br><b>Maximum:</b> 50 */
+                limit?: string;
+                /** @description The number of reports to skip in the result set before returning the first entry in the paginated response.<br><br>Use this parameter in conjunction with the <b>limit</b> parameter to control the pagination of the output. For example, if <b>offset</b> is set to <code>0</code> and <b>limit</b> is set to <code>10</code>, the first page of the response will contain the first 10 entries from the complete list retrieved by the call.<br><br><span class="tablenote"><b>Note:</b> This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>.</span><br>If this parameter is omitted, the default value is used.<br><br><b>Default:</b> 0 */
+                offset?: string;
+                /** @description This query parameter specifies the user name (login name) of an eBay user for which to retrieve conversations.<br><br>If this filter is used, only conversation(s) from the other eBay user specified through this parameter will be returned. */
+                other_party_username?: string;
+                /** @description This query parameter specifies the unique identifier of the reference (specified by the corresponding <b>reference_type</b> value) associated with the conversation. Only conversations associated with the specified reference ID will be returned.<br><br>For example, in the case of a <code>LISTING</code> reference, this value will be the item ID value of the listing.<br><br><span class="tablenote"><b>Note:</b> If this query parameter is used, the <b>reference_type</b> parameter must also be used to specify the type of reference this ID is associated with.</span> */
+                reference_id?: string;
+                /** @description This query parameter specifies the type of reference associated with a conversation.<br><br>The reference type is used to specify what the conversation is in reference to. For example, a value of <code>LISTING</code> specifies that the conversation is associated with a specific listing. The item ID associated with this listing can then be specified through the <b>reference_id</b> query parameter.<br><br>Currently, only the <code>LISTING</code> reference type is supported. */
+                reference_type?: string;
+                /** @description This query parameter specifies the start time (in ISO 8601 format) for which to start retrieving conversations.<br><br>For example, if set to <code>2024-11-06T10:00:00.000Z</code>, only messages sent after this time will be retrieved.<br><br><b>Format:</b> yyyy-MM-ddThh:mm.ss.sssZ<br><br><span class="tablenote"><b>Note:</b> Currently, this parameter is only available if the <b>conversation_type</b> of the conversation is <code>FROM_MEMBERS</code>.</span> */
+                start_time?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: Record<string, unknown>;
+                content: {
+                    'application/json': components['schemas']['GetAllMyConversationsResponse'];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+        };
+    };
+    sendMessage: {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br>For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
+                'Content-Type': string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': components['schemas']['SendMessageRequest'];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: Record<string, unknown>;
+                content: {
+                    'application/json': components['schemas']['SendMessageResponse'];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+        };
+    };
+    updateConversation: {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br>For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
+                'Content-Type': string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': components['schemas']['UpdateConversationRequest'];
+            };
+        };
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Bad Request */
+            400: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+        };
+    };
+}

package/build/types/sell-apps/communication/commerceMessageV1Oas3.js

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export {};