ebay-mcp 1.14.0 → 1.14.2

package/build/api/marketing-and-promotions/campaigns.js

@@ -0,0 +1,362 @@
+import { buildEndpointParams, requestDeleteEffect, requestGetEffect, requestPostEffect, } from '../../api/shared/request.js';
+import { MARKETING_BASE_PATH, marketplaceHeader, } from './shared.js';
+/** Marketing API — campaigns methods closed over a shared client. */
+export const createMarketingCampaignsMethods = (client) => ({
+    /**
+     * Clone campaign through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for cloneCampaign.
+     * @returns An Effect that succeeds with eBay's generated cloneCampaign response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.cloneCampaign({ campaignId: 'campaign-1', request: { ... } }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/cloneCampaign
+     */
+    cloneCampaign: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/${input.campaignId}/clone`;
+        return requestPostEffect(client, path, input.request);
+    },
+    /**
+     * Get campaigns through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for getCampaigns.
+     * @returns An Effect that succeeds with eBay's generated getCampaigns response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.getCampaigns());
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/getCampaigns
+     */
+    getCampaigns: (input = {}) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign`;
+        const params = buildEndpointParams({
+            campaignName: { wireName: 'campaign_name', value: input.campaignName },
+            campaignStatus: { wireName: 'campaign_status', value: input.campaignStatus },
+            campaignTargetingTypes: {
+                wireName: 'campaign_targeting_types',
+                value: input.campaignTargetingTypes,
+            },
+            channels: { wireName: 'channels', value: input.channels },
+            endDateRange: { wireName: 'end_date_range', value: input.endDateRange },
+            fundingStrategy: { wireName: 'funding_strategy', value: input.fundingStrategy },
+            limit: { wireName: 'limit', value: input.limit },
+            offset: { wireName: 'offset', value: input.offset },
+            startDateRange: { wireName: 'start_date_range', value: input.startDateRange },
+        });
+        return requestGetEffect(client, path, params);
+    },
+    /**
+     * Create campaign through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for createCampaign.
+     * @returns An Effect that succeeds with eBay's generated createCampaign response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.createCampaign({ request: { ... } }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/createCampaign
+     */
+    createCampaign: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign`;
+        return requestPostEffect(client, path, input.request);
+    },
+    /**
+     * Get campaign through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for getCampaign.
+     * @returns An Effect that succeeds with eBay's generated getCampaign response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.getCampaign({ campaignId: 'campaign-1' }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/getCampaign
+     */
+    getCampaign: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/${input.campaignId}`;
+        return requestGetEffect(client, path);
+    },
+    /**
+     * Delete campaign through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for deleteCampaign.
+     * @returns An Effect that succeeds with eBay's generated deleteCampaign response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.deleteCampaign({ campaignId: 'campaign-1' }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/deleteCampaign
+     */
+    deleteCampaign: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/${input.campaignId}`;
+        return requestDeleteEffect(client, path);
+    },
+    /**
+     * End campaign through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for endCampaign.
+     * @returns An Effect that succeeds with eBay's generated endCampaign response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.endCampaign({ campaignId: 'campaign-1' }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/endCampaign
+     */
+    endCampaign: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/${input.campaignId}/end`;
+        return requestPostEffect(client, path);
+    },
+    /**
+     * Find campaign by ad reference through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for findCampaignByAdReference.
+     * @returns An Effect that succeeds with eBay's generated findCampaignByAdReference response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.findCampaignByAdReference());
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/findCampaignByAdReference
+     */
+    findCampaignByAdReference: (input = {}) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/find_campaign_by_ad_reference`;
+        const params = buildEndpointParams({
+            inventoryReferenceId: {
+                wireName: 'inventory_reference_id',
+                value: input.inventoryReferenceId,
+            },
+            inventoryReferenceType: {
+                wireName: 'inventory_reference_type',
+                value: input.inventoryReferenceType,
+            },
+            listingId: { wireName: 'listing_id', value: input.listingId },
+        });
+        return requestGetEffect(client, path, params);
+    },
+    /**
+     * Get campaign by name through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for getCampaignByName.
+     * @returns An Effect that succeeds with eBay's generated getCampaignByName response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.getCampaignByName({ campaignName: 'campaignName-1' }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/getCampaignByName
+     */
+    getCampaignByName: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/get_campaign_by_name`;
+        const params = buildEndpointParams({
+            campaignName: { wireName: 'campaign_name', value: input.campaignName },
+        });
+        return requestGetEffect(client, path, params);
+    },
+    /**
+     * Launch campaign through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for launchCampaign.
+     * @returns An Effect that succeeds with eBay's generated launchCampaign response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.launchCampaign({ campaignId: 'campaign-1' }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/launchCampaign
+     */
+    launchCampaign: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/${input.campaignId}/launch`;
+        return requestPostEffect(client, path);
+    },
+    /**
+     * Pause campaign through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for pauseCampaign.
+     * @returns An Effect that succeeds with eBay's generated pauseCampaign response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.pauseCampaign({ campaignId: 'campaign-1' }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/pauseCampaign
+     */
+    pauseCampaign: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/${input.campaignId}/pause`;
+        return requestPostEffect(client, path);
+    },
+    /**
+     * Resume campaign through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for resumeCampaign.
+     * @returns An Effect that succeeds with eBay's generated resumeCampaign response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.resumeCampaign({ campaignId: 'campaign-1' }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/resumeCampaign
+     */
+    resumeCampaign: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/${input.campaignId}/resume`;
+        return requestPostEffect(client, path);
+    },
+    /**
+     * Setup quick campaign through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for setupQuickCampaign.
+     * @returns An Effect that succeeds with eBay's generated setupQuickCampaign response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.setupQuickCampaign({ request: { ... } }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/setupQuickCampaign
+     */
+    setupQuickCampaign: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/setup_quick_campaign`;
+        return requestPostEffect(client, path, input.request);
+    },
+    /**
+     * Suggest budget through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for suggestBudget.
+     * @returns An Effect that succeeds with eBay's generated suggestBudget response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.suggestBudget({ marketplaceId: 'EBAY_US' }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/suggestBudget
+     */
+    suggestBudget: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/suggest_budget`;
+        const config = marketplaceHeader(input.marketplaceId);
+        return requestGetEffect(client, path, undefined, config);
+    },
+    /**
+     * Suggest items through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for suggestItems.
+     * @returns An Effect that succeeds with eBay's generated suggestItems response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.suggestItems({ campaignId: 'campaign-1' }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/suggestItems
+     */
+    suggestItems: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/${input.campaignId}/suggest_items`;
+        const params = buildEndpointParams({
+            categoryIds: { wireName: 'category_ids', value: input.categoryIds },
+            limit: { wireName: 'limit', value: input.limit },
+            offset: { wireName: 'offset', value: input.offset },
+        });
+        return requestGetEffect(client, path, params);
+    },
+    /**
+     * Suggest max cpc through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for suggestMaxCpc.
+     * @returns An Effect that succeeds with eBay's generated suggestMaxCpc response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.suggestMaxCpc({ request: { ... } }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/suggestMaxCpc
+     */
+    suggestMaxCpc: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/suggest_max_cpc`;
+        return requestPostEffect(client, path, input.request);
+    },
+    /**
+     * Update ad rate strategy through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for updateAdRateStrategy.
+     * @returns An Effect that succeeds with eBay's generated updateAdRateStrategy response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.updateAdRateStrategy({ campaignId: 'campaign-1', request: { ... } }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/updateAdRateStrategy
+     */
+    updateAdRateStrategy: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/${input.campaignId}/update_ad_rate_strategy`;
+        return requestPostEffect(client, path, input.request);
+    },
+    /**
+     * Update bidding strategy through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for updateBiddingStrategy.
+     * @returns An Effect that succeeds with eBay's generated updateBiddingStrategy response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.updateBiddingStrategy({ campaignId: 'campaign-1', request: { ... } }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/updateBiddingStrategy
+     */
+    updateBiddingStrategy: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/${input.campaignId}/update_bidding_strategy`;
+        return requestPostEffect(client, path, input.request);
+    },
+    /**
+     * Update campaign budget through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for updateCampaignBudget.
+     * @returns An Effect that succeeds with eBay's generated updateCampaignBudget response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.updateCampaignBudget({ campaignId: 'campaign-1', request: { ... } }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/updateCampaignBudget
+     */
+    updateCampaignBudget: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/${input.campaignId}/update_campaign_budget`;
+        return requestPostEffect(client, path, input.request);
+    },
+    /**
+     * Update campaign identification through the eBay Marketing API.
+     *
+     * @param input - Path, query, header, and request body values for updateCampaignIdentification.
+     * @returns An Effect that succeeds with eBay's generated updateCampaignIdentification response DTO.
+     *
+     * @example
+     * ```ts
+     * const response = await Effect.runPromise(marketingApi.updateCampaignIdentification({ campaignId: 'campaign-1', request: { ... } }));
+     * ```
+     *
+     * @see https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/updateCampaignIdentification
+     */
+    updateCampaignIdentification: (input) => {
+        const path = `${MARKETING_BASE_PATH}/ad_campaign/${input.campaignId}/update_campaign_identification`;
+        return requestPostEffect(client, path, input.request);
+    },
+});