ebay-mcp 1.13.2 → 1.14.0

package/build/api/communication/message.js

@@ -1,5 +1,5 @@
-import { assertRequiredString, buildPaginatedQueryParams, getPathWithContextError, getWithContextError, } from './shared.js';
-import { withApiError } from '../../api/shared/request.js';
+import { buildEndpointParams, optionalNonNegativeNumberEffect, optionalPositiveNumberEffect, optionalStringEffect, requestGetEffect, requestPostEffect, requireObjectEffect, requireStringEffect, } from '../../api/shared/request.js';
+import { Effect } from 'effect';
 /**
  * Message API - Buyer-seller messaging
  * Based on: docs/sell-apps/communication/commerce_message_v1_oas3.json
@@ -11,94 +11,147 @@ export class MessageApi {
         this.client = client;
     }
     /**
-     * Bulk update conversation
-     * Endpoint: POST /bulk_update_conversation
-     * @throws Error if required parameters are missing or invalid
-     */
-    async bulkUpdateConversation(updateData) {
-        if (!updateData || typeof updateData !== 'object') {
-            throw new Error('updateData is required and must be an object');
-        }
-        return await withApiError('Failed to bulk update conversation', () => this.client.post(`${this.basePath}/bulk_update_conversation`, updateData));
-    }
-    /**
-     * Get conversations
-     * Endpoint: GET /conversation
-     * @param filter API filter expression.
-     * @param limit Maximum number of records to return.
-     * @param offset Zero-based pagination offset.
-     * @throws Error if the request fails
-     */
-    async getConversations(filter, limit, offset) {
-        const conversationPath = `${this.basePath}/conversation`;
-        const queryParams = this.buildConversationQueryParams(filter, limit, offset);
-        return await getWithContextError(this.client, conversationPath, queryParams, 'Failed to get conversations');
-    }
-    /**
-     * Build query params used by conversation listing endpoints.
+     * Updates multiple conversations in one request.
      *
-     * @param filter API filter expression.
-     * @param limit Maximum number of records to return.
-     * @param offset Zero-based pagination offset.
-     * @returns Validated conversation query params.
-     */
-    buildConversationQueryParams(filter, limit, offset) {
-        return buildPaginatedQueryParams(filter, limit, offset);
-    }
-    /**
-     * Get a specific conversation
-     * Endpoint: GET /conversation/{conversation_id}
-     * @param conversationId Conversation identifier.
-     * @throws Error if required parameters are missing or invalid
-     */
-    async getConversation(conversationId) {
-        assertRequiredString(conversationId, 'conversationId');
-        return await getPathWithContextError(this.client, `${this.basePath}/conversation/${conversationId}`, 'Failed to get conversation');
-    }
-    /**
-     * Send a message
-     * Endpoint: POST /send_message
-     * @throws Error if required parameters are missing or invalid
+     * @param updateData - Generated BulkUpdateConversationsRequest body.
+     * @returns An Effect that succeeds with eBay's generated bulk update response.
+     *
+     * @example
+     * ```ts
+     * const result = await Effect.runPromise(
+     *   messageApi.bulkUpdateConversation({ conversations: [{ conversationId: 'c1' }] }),
+     * );
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/commerce/message/resources/bulk_update_conversation/methods/bulkUpdateConversation
      */
-    async sendMessage(messageData) {
-        if (!messageData || typeof messageData !== 'object') {
-            throw new Error('messageData is required and must be an object');
-        }
-        return await withApiError('Failed to send message', () => this.client.post(`${this.basePath}/send_message`, messageData));
-    }
+    bulkUpdateConversation = (updateData) => {
+        const client = this.client;
+        const path = `${this.basePath}/bulk_update_conversation`;
+        return Effect.gen(function* () {
+            const body = yield* requireObjectEffect(updateData, 'updateData');
+            return yield* requestPostEffect(client, path, body);
+        });
+    };
     /**
-     * Update a conversation
-     * Endpoint: POST /update_conversation
-     * @throws Error if required parameters are missing or invalid
+     * Retrieves buyer-seller conversations.
+     *
+     * @param input - Required conversation type plus optional filters and pagination.
+     * @returns An Effect that succeeds with eBay's generated conversation collection response.
+     *
+     * @example
+     * ```ts
+     * const conversations = await Effect.runPromise(
+     *   messageApi.getConversations({ conversationType: 'FROM_MEMBERS', limit: 25 }),
+     * );
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/commerce/message/resources/conversation/methods/getConversations
      */
-    async updateConversation(updateData) {
-        if (!updateData || typeof updateData !== 'object') {
-            throw new Error('updateData is required and must be an object');
-        }
-        return await withApiError('Failed to update conversation', () => this.client.post(`${this.basePath}/update_conversation`, updateData));
-    }
+    getConversations = (input) => {
+        const client = this.client;
+        const path = `${this.basePath}/conversation`;
+        return Effect.gen(function* () {
+            const request = yield* requireObjectEffect(input, 'input');
+            const conversationType = yield* requireStringEffect(request.conversationType, 'conversationType');
+            const conversationStatus = yield* optionalStringEffect(request.conversationStatus, 'conversationStatus');
+            const endTime = yield* optionalStringEffect(request.endTime, 'endTime');
+            const limit = yield* optionalPositiveNumberEffect(request.limit, 'limit');
+            const offset = yield* optionalNonNegativeNumberEffect(request.offset, 'offset');
+            const otherPartyUsername = yield* optionalStringEffect(request.otherPartyUsername, 'otherPartyUsername');
+            const referenceId = yield* optionalStringEffect(request.referenceId, 'referenceId');
+            const referenceType = yield* optionalStringEffect(request.referenceType, 'referenceType');
+            const startTime = yield* optionalStringEffect(request.startTime, 'startTime');
+            const params = buildEndpointParams({
+                conversationType: { wireName: 'conversation_type', value: conversationType },
+                conversationStatus: { wireName: 'conversation_status', value: conversationStatus },
+                endTime: { wireName: 'end_time', value: endTime },
+                limit: { wireName: 'limit', value: limit },
+                offset: { wireName: 'offset', value: offset },
+                otherPartyUsername: { wireName: 'other_party_username', value: otherPartyUsername },
+                referenceId: { wireName: 'reference_id', value: referenceId },
+                referenceType: { wireName: 'reference_type', value: referenceType },
+                startTime: { wireName: 'start_time', value: startTime },
+            });
+            return yield* requestGetEffect(client, path, params);
+        });
+    };
     /**
-     * Search for messages
-     * @deprecated Use getConversations() instead
+     * Retrieves messages in a specific conversation.
+     *
+     * @param input - Conversation path ID plus required type and optional pagination.
+     * @returns An Effect that succeeds with eBay's generated conversation message response.
+     *
+     * @example
+     * ```ts
+     * const conversation = await Effect.runPromise(
+     *   messageApi.getConversation({ conversationId: 'c1', conversationType: 'FROM_MEMBERS' }),
+     * );
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/commerce/message/resources/conversation/methods/getConversation
      */
-    async searchMessages(filter, limit, offset) {
-        return await this.getConversations(filter, limit, offset);
-    }
+    getConversation = (input) => {
+        const client = this.client;
+        const basePath = this.basePath;
+        return Effect.gen(function* () {
+            const request = yield* requireObjectEffect(input, 'input');
+            const conversationId = yield* requireStringEffect(request.conversationId, 'conversationId');
+            const conversationType = yield* requireStringEffect(request.conversationType, 'conversationType');
+            const limit = yield* optionalPositiveNumberEffect(request.limit, 'limit');
+            const offset = yield* optionalNonNegativeNumberEffect(request.offset, 'offset');
+            const params = buildEndpointParams({
+                conversationType: { wireName: 'conversation_type', value: conversationType },
+                limit: { wireName: 'limit', value: limit },
+                offset: { wireName: 'offset', value: offset },
+            });
+            return yield* requestGetEffect(client, `${basePath}/conversation/${conversationId}`, params);
+        });
+    };
     /**
-     * Get a specific message
-     * @deprecated Use getConversation() instead
+     * Sends a message to another eBay user.
+     *
+     * @param messageData - Generated SendMessageRequest body.
+     * @returns An Effect that succeeds with eBay's generated SendMessageResponse.
+     *
+     * @example
+     * ```ts
+     * const sent = await Effect.runPromise(
+     *   messageApi.sendMessage({ messageText: 'Hello', otherPartyUsername: 'buyer_123' }),
+     * );
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/commerce/message/resources/send_message/methods/sendMessage
      */
-    async getMessage(messageId) {
-        return await this.getConversation(messageId);
-    }
+    sendMessage = (messageData) => {
+        const client = this.client;
+        const path = `${this.basePath}/send_message`;
+        return Effect.gen(function* () {
+            const body = yield* requireObjectEffect(messageData, 'messageData');
+            return yield* requestPostEffect(client, path, body);
+        });
+    };
     /**
-     * Reply to a message
-     * @deprecated Use sendMessage() instead
+     * Updates a conversation status.
+     *
+     * @param updateData - Generated UpdateConversationRequest body.
+     * @returns An Effect that succeeds when eBay accepts the update.
+     *
+     * @example
+     * ```ts
+     * await Effect.runPromise(
+     *   messageApi.updateConversation({ conversationId: 'c1', conversationStatus: 'READ' }),
+     * );
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/commerce/message/resources/update_conversation/methods/updateConversation
      */
-    async replyToMessage(messageId, messageContent) {
-        return await this.sendMessage({
-            conversation_id: messageId,
-            message_content: messageContent,
+    updateConversation = (updateData) => {
+        const client = this.client;
+        const path = `${this.basePath}/update_conversation`;
+        return Effect.gen(function* () {
+            const body = yield* requireObjectEffect(updateData, 'updateData');
+            return yield* requestPostEffect(client, path, body);
         });
-    }
+    };
 }

package/build/api/communication/negotiation.js

@@ -1,67 +1,79 @@
-import { assertRequiredString, buildPaginatedQueryParams, getPathWithContextError, getWithContextError, } from './shared.js';
-import { buildTruthyPaginatedParams } from '../shared/query-params.js';
-import { withApiError } from '../../api/shared/request.js';
+import { buildEndpointParams, optionalNonNegativeNumberEffect, optionalPositiveNumberEffect, optionalStringEffect, requestGetEffect, requestPostEffect, requireObjectEffect, } from '../../api/shared/request.js';
+import { Effect } from 'effect';
 /**
  * Negotiation API - Buyer-seller negotiations and offers
  * Based on: docs/sell-apps/communication/sell_negotiation_v1_oas3.json
  */
 export class NegotiationApi {
-    client;
     basePath = '/sell/negotiation/v1';
+    client;
     constructor(client) {
         this.client = client;
     }
     /**
-     * Find eligible items for a seller-initiated offer
-     * Endpoint: GET /find_eligible_items
-     * @param filter API filter expression.
-     * @param limit Maximum number of records to return.
-     * @param offset Zero-based pagination offset.
-     * @throws Error if the request fails
+     * Finds listings eligible for a seller-initiated offer.
+     *
+     * @param input - Optional marketplace header override plus pagination query parameters.
+     * @returns An Effect that succeeds with eBay's generated PagedEligibleItemCollection.
+     *
+     * @example
+     * ```ts
+     * const eligible = await Effect.runPromise(
+     *   negotiationApi.findEligibleItems({ marketplaceId: 'EBAY_US', limit: 10 }),
+     * );
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/negotiation/resources/offer/methods/findEligibleItems
      */
-    async findEligibleItems(filter, limit, offset) {
-        const eligibleItemsPath = `${this.basePath}/find_eligible_items`;
-        const queryParams = buildPaginatedQueryParams(filter, limit, offset);
-        return await withApiError('Failed to find eligible items', () => this.client.get(eligibleItemsPath, queryParams));
-    }
+    findEligibleItems = (input = {}) => {
+        const apiClient = this.client;
+        const path = `${this.basePath}/find_eligible_items`;
+        return Effect.gen(function* () {
+            const request = yield* requireObjectEffect(input, 'input');
+            const { marketplaceId: inputMarketplaceId, limit: inputLimit, offset: inputOffset } = request;
+            const marketplaceId = yield* optionalStringEffect(inputMarketplaceId, 'marketplaceId');
+            const limit = yield* optionalPositiveNumberEffect(inputLimit, 'limit');
+            const offset = yield* optionalNonNegativeNumberEffect(inputOffset, 'offset');
+            const params = buildEndpointParams({
+                limit: { wireName: 'limit', value: limit },
+                offset: { wireName: 'offset', value: offset },
+            });
+            const config = marketplaceId === undefined
+                ? undefined
+                : { headers: { 'X-EBAY-C-MARKETPLACE-ID': marketplaceId } };
+            return yield* requestGetEffect(apiClient, path, params, config);
+        });
+    };
     /**
-     * Send offer to interested buyers
-     * Endpoint: POST /send_offer_to_interested_buyers
-     * @throws Error if required parameters are missing or invalid
+     * Sends an offer to buyers interested in a listing.
+     *
+     * @param input - Offer body fields plus optional marketplace header override.
+     * @returns An Effect that succeeds with eBay's generated offer collection response.
+     *
+     * @example
+     * ```ts
+     * const offers = await Effect.runPromise(
+     *   negotiationApi.sendOfferToInterestedBuyers({
+     *     marketplaceId: 'EBAY_US',
+     *     message: 'Limited offer',
+     *   }),
+     * );
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/negotiation/resources/offer/methods/sendOfferToInterestedBuyers
      */
-    async sendOfferToInterestedBuyers(offerData) {
-        if (!offerData || typeof offerData !== 'object') {
-            throw new Error('offerData is required and must be an object');
-        }
-        return await withApiError('Failed to send offer to interested buyers', () => this.client.post(`${this.basePath}/send_offer_to_interested_buyers`, offerData));
-    }
-    /**
-     * Get offers to buyers (Best Offers)
-     * @param filter API filter expression.
-     * @param limit Maximum number of records to return.
-     * @param offset Zero-based pagination offset.
-     * @deprecated This method does not match any endpoint in the OpenAPI spec
-     */
-    async getOffersToBuyers(filter, limit, offset) {
-        const params = buildTruthyPaginatedParams(filter, limit, offset);
-        return await getWithContextError(this.client, `${this.basePath}/offer`, params, 'Failed to get offers to buyers');
-    }
-    /**
-     * Get offers for listing (alias for getOffersToBuyers)
-     * Endpoint: GET /offer
-     * @throws Error if the request fails
-     */
-    async getOffersForListing(filter, limit, offset) {
-        return await this.getOffersToBuyers(filter, limit, offset);
-    }
-    /**
-     * Get a specific offer
-     * Endpoint: GET /offer/{offerId}
-     * @param offerId Offer identifier.
-     * @throws Error if required parameters are missing or invalid
-     */
-    async getOffer(offerId) {
-        assertRequiredString(offerId, 'offerId');
-        return await getPathWithContextError(this.client, `${this.basePath}/offer/${offerId}`, 'Failed to get offer');
-    }
+    sendOfferToInterestedBuyers = (input) => {
+        const apiClient = this.client;
+        const path = `${this.basePath}/send_offer_to_interested_buyers`;
+        return Effect.gen(function* () {
+            const request = yield* requireObjectEffect(input, 'input');
+            const { marketplaceId, ...offerData } = request;
+            const body = yield* requireObjectEffect(offerData, 'offerData');
+            const validatedMarketplaceId = yield* optionalStringEffect(marketplaceId, 'marketplaceId');
+            const config = validatedMarketplaceId === undefined
+                ? undefined
+                : { headers: { 'X-EBAY-C-MARKETPLACE-ID': validatedMarketplaceId } };
+            return yield* requestPostEffect(apiClient, path, body, config);
+        });
+    };
 }