ebay-api 9.3.1 → 9.4.0

package/dist/types/restful/specs/commerce_message_v1_oas3.d.ts

@@ -0,0 +1,465 @@
+export interface paths {
+    "/bulk_update_conversation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        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;
+        };
+        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;
+        };
+        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;
+        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;
+        post: operations["updateConversation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        BulkConversation: {
+            conversationId?: string;
+            conversationStatus?: string;
+            conversationType?: string;
+        };
+        BulkUpdateConversationsRequest: {
+            conversations?: components["schemas"]["BulkConversation"][];
+        };
+        BulkUpdateConversationsResponse: {
+            conversationsMetadata?: components["schemas"]["ConversationsMetadata"];
+            conversationsResponse?: components["schemas"]["ConversationsResponse"][];
+        };
+        ConversationDetail: {
+            conversationId?: string;
+            conversationStatus?: string;
+            conversationTitle?: string;
+            conversationType?: string;
+            createdDate?: string;
+            latestMessage?: components["schemas"]["MessageDetail"];
+            referenceId?: string;
+            referenceType?: string;
+            unreadCount?: number;
+        };
+        ConversationsMetadata: {
+            totalConversationsCount?: number;
+            updateFailureCount?: number;
+            updateSuccessCount?: number;
+        };
+        ConversationsResponse: {
+            conversationId?: string;
+            updateStatus?: string;
+        };
+        Error: {
+            category?: string;
+            domain?: string;
+            errorId?: number;
+            inputRefIds?: string[];
+            longMessage?: string;
+            message?: string;
+            outputRefIds?: string[];
+            parameters?: components["schemas"]["ErrorParameter"][];
+            subdomain?: string;
+        };
+        ErrorParameter: {
+            name?: string;
+            value?: string;
+        };
+        GetAllMyConversationsResponse: {
+            conversations?: components["schemas"]["ConversationDetail"][];
+            href?: string;
+            limit?: number;
+            next?: string;
+            offset?: number;
+            prev?: string;
+            total?: number;
+        };
+        GetMessagesByConversationIdResponse: {
+            conversationStatus?: string;
+            conversationTitle?: string;
+            conversationType?: string;
+            href?: string;
+            limit?: number;
+            messages?: components["schemas"]["MessageDetail"][];
+            next?: string;
+            offset?: number;
+            prev?: string;
+            total?: number;
+        };
+        MessageDetail: {
+            createdDate?: string;
+            messageBody?: string;
+            messageId?: string;
+            messageMedia?: components["schemas"]["MessageMedia"][];
+            readStatus?: boolean;
+            recipientUsername?: string;
+            senderUsername?: string;
+            subject?: string;
+        };
+        MessageMedia: {
+            mediaName?: string;
+            mediaType?: string;
+            mediaUrl?: string;
+        };
+        Reference: {
+            referenceId?: string;
+            referenceType?: string;
+        };
+        SendMessageRequest: {
+            conversationId?: string;
+            emailCopyToSender?: boolean;
+            messageMedia?: components["schemas"]["MessageMedia"][];
+            messageText?: string;
+            otherPartyUsername?: string;
+            reference?: components["schemas"]["Reference"];
+        };
+        SendMessageResponse: {
+            createdDate?: string;
+            messageBody?: string;
+            messageId?: string;
+            messageMedia?: components["schemas"]["MessageMedia"][];
+            readStatus?: boolean;
+            recipientUserName?: string;
+            senderUserName?: string;
+            subject?: string;
+        };
+        UpdateConversationRequest: {
+            conversationId?: string;
+            conversationStatus?: string;
+            conversationType?: string;
+            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: {
+                "Content-Type": string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["BulkUpdateConversationsRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BulkUpdateConversationsResponse"];
+                };
+            };
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    getConversation: {
+        parameters: {
+            query: {
+                conversation_type: string;
+                limit?: string;
+                offset?: string;
+            };
+            header?: never;
+            path: {
+                conversation_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetMessagesByConversationIdResponse"];
+                };
+            };
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    getConversations: {
+        parameters: {
+            query: {
+                conversation_status?: string;
+                conversation_type: string;
+                end_time?: string;
+                limit?: string;
+                offset?: string;
+                other_party_username?: string;
+                reference_id?: string;
+                reference_type?: string;
+                start_time?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetAllMyConversationsResponse"];
+                };
+            };
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    sendMessage: {
+        parameters: {
+            query?: never;
+            header: {
+                "Content-Type": string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["SendMessageRequest"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SendMessageResponse"];
+                };
+            };
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    updateConversation: {
+        parameters: {
+            query?: never;
+            header: {
+                "Content-Type": string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["UpdateConversationRequest"];
+            };
+        };
+        responses: {
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+}

package/dist/types/restful/specs/commerce_message_v1_oas3.js

@@ -0,0 +1 @@
+export {};

package/dist/types/restfulTypes.d.ts

@@ -7,6 +7,7 @@ import { operations as commerceCatalogOperations } from './restful/specs/commerc
 import { components as commerceMedia } from './restful/specs/commerce_media_v1_beta_oas3.js';
 import { components as commerceNotification } from './restful/specs/commerce_notification_v1_oas3.js';
 import { components as commerceTranslation } from './restful/specs/commerce_translation_v1_beta_oas3.js';
+import { components as commerceMessage } from './restful/specs/commerce_message_v1_oas3.js';
 import { components as sellAccountV1 } from './restful/specs/sell_account_v1_oas3.js';
 import { components as sellAccountV2 } from './restful/specs/sell_account_v2_oas3.js';
 import { components as sellCompliance } from './restful/specs/sell_compliance_v1_oas3.js';
@@ -356,6 +357,9 @@ export type TranslateRequest = commerceTranslation['schemas']['TranslateRequest'
 export type CommerceCatalogSearchParams = commerceCatalogOperations['search']['parameters']['query'];
 export type CreateVideoRequest = commerceMedia['schemas']['CreateVideoRequest'];
 export type InputStream = commerceMedia['schemas']['InputStream'];
+export type UpdateConversationRequest = commerceMessage['schemas']['UpdateConversationRequest'];
+export type BulkUpdateConversationRequest = commerceMessage['schemas']['BulkUpdateConversationsRequest'];
+export type CommerceMessageSendMessageRequest = commerceMessage['schemas']['SendMessageRequest'];
 export type AttributeNameValue = buyBrowse['schemas']['AttributeNameValue'];
 export type CompatibilityPayload = buyBrowse['schemas']['CompatibilityPayload'];
 export type AddCartItemInput = buyBrowse['schemas']['AddCartItemInput'];

package/lib/api/apiFactory.js

@@ -35,6 +35,7 @@ class ApiFactory extends index_js_1.default {
             media: this.createRestfulApi(index_js_3.Media),
             translation: this.createRestfulApi(index_js_3.Translation),
             taxonomy: this.createRestfulApi(index_js_3.Taxonomy),
+            message: this.createRestfulApi(index_js_3.Message)
         };
     }
     createDeveloperApi() {

package/lib/api/restful/commerce/index.d.ts

@@ -5,6 +5,7 @@ import Media from './media/index.js';
 import Notification from './notification/index.js';
 import Taxonomy from './taxonomy/index.js';
 import Translation from './translation/index.js';
+import Message from './message/index.js';
 export type Commerce = {
     catalog: Catalog;
     charity: Charity;
@@ -13,5 +14,6 @@ export type Commerce = {
     taxonomy: Taxonomy;
     translation: Translation;
     media: Media;
+    message: Message;
 };
-export { Catalog, Charity, Identity, Notification, Taxonomy, Translation, Media };
+export { Catalog, Charity, Identity, Notification, Taxonomy, Translation, Media, Message };

package/lib/api/restful/commerce/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Media = exports.Translation = exports.Taxonomy = exports.Notification = exports.Identity = exports.Charity = exports.Catalog = void 0;
+exports.Message = exports.Media = exports.Translation = exports.Taxonomy = exports.Notification = exports.Identity = exports.Charity = exports.Catalog = void 0;
 const index_js_1 = __importDefault(require("./catalog/index.js"));
 exports.Catalog = index_js_1.default;
 const index_js_2 = __importDefault(require("./charity/index.js"));
@@ -18,3 +18,5 @@ const index_js_6 = __importDefault(require("./taxonomy/index.js"));
 exports.Taxonomy = index_js_6.default;
 const index_js_7 = __importDefault(require("./translation/index.js"));
 exports.Translation = index_js_7.default;
+const index_js_8 = __importDefault(require("./message/index.js"));
+exports.Message = index_js_8.default;

package/lib/api/restful/commerce/message/index.d.ts

@@ -0,0 +1,26 @@
+import { operations } from '../../../../types/restful/specs/commerce_message_v1_oas3.js';
+import { BulkUpdateConversationRequest, CommerceMessageSendMessageRequest, UpdateConversationRequest } from '../../../../types/restfulTypes.js';
+import Restful, { OpenApi } from '../../index.js';
+export default class Message extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    getConversations({ limit, offset, conversationStatus, conversationType, referenceId, referenceType, startTime, endTime, otherPartyUsername }?: {
+        limit?: number;
+        offset?: number;
+        conversationStatus?: string;
+        conversationType?: string;
+        referenceId?: string;
+        referenceType?: string;
+        startTime?: string;
+        endTime?: string;
+        otherPartyUsername?: string;
+    }): Promise<any>;
+    getConversation(conversationId: string, { conversationType, limit, offset }: {
+        conversationType: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<any>;
+    updateConversation(body: UpdateConversationRequest): Promise<any>;
+    bulkUpdateConversation(body: BulkUpdateConversationRequest): Promise<any>;
+    sendMessage(body: CommerceMessageSendMessageRequest): Promise<any>;
+}

package/lib/api/restful/commerce/message/index.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = __importDefault(require("../../index.js"));
+class Message extends index_js_1.default {
+    get basePath() {
+        return '/commerce/message/v1';
+    }
+    getConversations({ limit, offset, conversationStatus, conversationType, referenceId, referenceType, startTime, endTime, otherPartyUsername } = {}) {
+        return this.get(`/conversation`, {
+            params: {
+                limit,
+                offset,
+                conversation_status: conversationStatus,
+                conversation_type: conversationType,
+                reference_id: referenceId,
+                reference_type: referenceType,
+                start_time: startTime,
+                end_time: endTime,
+                other_party_username: otherPartyUsername,
+            }
+        });
+    }
+    getConversation(conversationId, { conversationType, limit, offset }) {
+        return this.get(`/conversation/${conversationId}`, {
+            params: {
+                conversation_type: conversationType,
+                limit,
+                offset,
+            }
+        });
+    }
+    updateConversation(body) {
+        return this.post(`/update_conversation`, body);
+    }
+    bulkUpdateConversation(body) {
+        return this.post(`/bulk_update_conversation`, body);
+    }
+    sendMessage(body) {
+        return this.post(`/send_message`, body);
+    }
+    ;
+}
+Message.id = 'Message';
+exports.default = Message;