ebay-mcp 1.17.0 → 1.18.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (178) hide show
  1. package/README.md +92 -53
  2. package/build/api/account-management/accountV2.js +347 -0
  3. package/build/api/account-management/finances.js +289 -0
  4. package/build/api/analytics-and-report/analytics.js +1 -1
  5. package/build/api/{client.js → client/ebayApiClient.js} +83 -36
  6. package/build/api/{clientTrading.js → client/tradingApiClient.js} +22 -22
  7. package/build/api/communication/feedback.js +21 -21
  8. package/build/api/communication/message.js +23 -23
  9. package/build/api/communication/negotiation.js +7 -7
  10. package/build/api/communication/notification.js +52 -52
  11. package/build/api/developer/developer.js +3 -3
  12. package/build/api/{index.js → ebaySellerApi.js} +28 -4
  13. package/build/api/listing-management/feed.js +91 -0
  14. package/build/api/listing-management/feedReportTasks.js +107 -0
  15. package/build/api/listing-management/feedRequest.js +91 -0
  16. package/build/api/listing-management/feedSchedules.js +95 -0
  17. package/build/api/listing-management/feedTasks.js +91 -0
  18. package/build/api/listing-management/items.js +22 -22
  19. package/build/api/listing-management/locations.js +4 -4
  20. package/build/api/listing-management/media.js +14 -14
  21. package/build/api/listing-management/mediaAttach.js +14 -14
  22. package/build/api/listing-management/mediaResources.js +22 -39
  23. package/build/api/listing-management/offerFormat.js +1 -1
  24. package/build/api/listing-management/offers.js +23 -23
  25. package/build/api/listing-management/stores.js +203 -0
  26. package/build/api/listing-metadata/charity.js +76 -0
  27. package/build/api/listing-metadata/metadata.js +31 -11
  28. package/build/api/listing-metadata/metadataShipping.js +117 -0
  29. package/build/api/listing-metadata/taxonomy.js +52 -7
  30. package/build/api/marketing-and-promotions/ads.js +34 -34
  31. package/build/api/marketing-and-promotions/campaigns.js +21 -21
  32. package/build/api/marketing-and-promotions/promotions.js +24 -24
  33. package/build/api/marketing-and-promotions/reports.js +7 -7
  34. package/build/api/marketing-and-promotions/shared.js +0 -3
  35. package/build/api/order-management/dispute.js +11 -9
  36. package/build/api/order-management/fulfillment.js +4 -4
  37. package/build/api/order-management/logistics.js +150 -0
  38. package/build/api/other/browseMappers.js +15 -13
  39. package/build/api/other/browseValidators.js +4 -4
  40. package/build/api/other/edelivery.js +19 -19
  41. package/build/api/other/finding.js +13 -13
  42. package/build/api/other/translation.js +2 -2
  43. package/build/api/other/vero.js +2 -2
  44. package/build/api/shared/download.js +79 -0
  45. package/build/api/shared/location.js +33 -0
  46. package/build/api/shared/request.js +69 -11
  47. package/build/api/trading/listingFormat.js +37 -30
  48. package/build/api/trading/trading.js +33 -33
  49. package/build/auth/credentialSession.js +5 -5
  50. package/build/auth/oauth.js +3 -3
  51. package/build/auth/oauthHelper.js +24 -24
  52. package/build/auth/oauthMetadata.js +4 -4
  53. package/build/auth/oauthMiddleware.js +16 -16
  54. package/build/auth/scopeUtils.js +24 -3
  55. package/build/auth/tokenVerifier.js +23 -23
  56. package/build/config/environment.js +10 -45
  57. package/build/config/oauthScopes.js +132 -0
  58. package/build/config/toolFamilies.js +4 -0
  59. package/build/index.js +5 -5
  60. package/build/mcp/httpTransport.js +32 -20
  61. package/build/mcp/runtime.js +12 -12
  62. package/build/mcp/toolGating.js +6 -12
  63. package/build/mcp/uiBridge.js +3 -3
  64. package/build/schemas/account-management/account.js +2 -52
  65. package/build/schemas/account-management/accountV2.js +294 -0
  66. package/build/schemas/account-management/finances.js +143 -0
  67. package/build/schemas/analytics/analytics.js +2 -48
  68. package/build/schemas/communication/messages.js +2 -46
  69. package/build/schemas/developer/developer.js +1 -27
  70. package/build/schemas/fulfillment/logistics.js +115 -0
  71. package/build/schemas/fulfillment/orders.js +2 -47
  72. package/build/schemas/inventory-management/feed.js +217 -0
  73. package/build/schemas/inventory-management/inventory.js +2 -50
  74. package/build/schemas/inventory-management/media.js +2 -2
  75. package/build/schemas/inventory-management/mediaDocuments.js +1 -1
  76. package/build/schemas/inventory-management/stores.js +42 -0
  77. package/build/schemas/marketing/ads.js +2 -2
  78. package/build/schemas/marketing/campaigns.js +2 -2
  79. package/build/schemas/marketing/common.js +2 -2
  80. package/build/schemas/marketing/marketing.js +0 -1
  81. package/build/schemas/marketing/promotions.js +2 -2
  82. package/build/schemas/marketing/reports.js +2 -2
  83. package/build/schemas/metadata/metadata.js +2 -90
  84. package/build/schemas/metadata/shipping.js +16 -0
  85. package/build/schemas/other/browse.js +2 -2
  86. package/build/schemas/other/finding.js +2 -2
  87. package/build/schemas/other/otherApis.js +2 -114
  88. package/build/schemas/taxonomy/categoryTree.js +8 -0
  89. package/build/schemas/taxonomy/charity.js +41 -0
  90. package/build/schemas/taxonomy/taxonomy.js +2 -69
  91. package/build/scripts/autoSetup.js +3 -3
  92. package/build/scripts/{buildUi.js → buildMcpApps.js} +13 -13
  93. package/build/scripts/devSync.js +34 -70
  94. package/build/scripts/diagnostics.js +15 -16
  95. package/build/scripts/interactiveSetup.js +25 -25
  96. package/build/scripts/scopeHelper.js +2 -2
  97. package/build/scripts/securityChecker.js +20 -20
  98. package/build/scripts/setup.js +76 -76
  99. package/build/scripts/setupShared.js +5 -30
  100. package/build/scripts/setupValidator.js +9 -9
  101. package/build/scripts/setupWizard.js +23 -23
  102. package/build/scripts/skills.js +14 -17
  103. package/build/scripts/specRefs.js +55 -0
  104. package/build/scripts/specSources.js +144 -0
  105. package/build/serverHttp.js +4 -7
  106. package/build/skills/content.js +13 -13
  107. package/build/skills/install.js +9 -9
  108. package/build/skills/registrySnapshot.js +7 -3
  109. package/build/skills/render.js +2 -2
  110. package/build/tools/categories/accountV2.js +106 -0
  111. package/build/tools/categories/charity.js +21 -0
  112. package/build/tools/categories/communication.js +1 -1
  113. package/build/tools/categories/connector.js +19 -16
  114. package/build/tools/categories/feed.js +183 -0
  115. package/build/tools/categories/finances.js +86 -0
  116. package/build/tools/categories/fulfillment.js +4 -4
  117. package/build/tools/categories/index.js +12 -2
  118. package/build/tools/categories/inventory.js +1 -1
  119. package/build/tools/categories/logistics.js +52 -0
  120. package/build/tools/categories/metadata.js +38 -1
  121. package/build/tools/categories/stores.js +64 -0
  122. package/build/tools/categories/taxonomy.js +18 -1
  123. package/build/tools/categories/tokenManagement.js +8 -8
  124. package/build/tools/contracts.js +2 -2
  125. package/build/tools/defineTool.js +27 -12
  126. package/build/tools/fileResult.js +30 -0
  127. package/build/tools/registry.js +2 -2
  128. package/build/tools/schemas.js +2 -2
  129. package/build/tools/ui/mapHelpers.js +12 -12
  130. package/build/tools/ui/maps.js +101 -97
  131. package/build/tools/ui/viewModels.js +2 -2
  132. package/build/utils/apiStatusFeed.js +12 -12
  133. package/build/utils/communication/feedback.js +3 -3
  134. package/build/utils/communication/message.js +3 -3
  135. package/build/utils/communication/negotiation.js +3 -3
  136. package/build/utils/communication/notification.js +3 -3
  137. package/build/utils/entryModule.js +33 -0
  138. package/build/utils/envFile.js +47 -0
  139. package/build/utils/envParser.js +5 -5
  140. package/build/utils/errors.js +4 -4
  141. package/build/utils/http.js +60 -41
  142. package/build/utils/localFeedFiles.js +61 -0
  143. package/build/utils/localMedia.js +18 -6
  144. package/build/utils/logRedaction.js +21 -0
  145. package/build/utils/logger.js +52 -33
  146. package/build/utils/other/compliance.js +3 -3
  147. package/build/utils/other/identity.js +3 -3
  148. package/build/utils/other/translation.js +3 -3
  149. package/build/utils/other/vero.js +3 -3
  150. package/build/utils/schemaHelpers.js +2 -2
  151. package/build/utils/tokenUtils.js +2 -2
  152. package/build/utils/trading/trading.js +1 -1
  153. package/build/utils/version.js +1 -1
  154. package/build/utils/zodIssues.js +14 -0
  155. package/package.json +9 -12
  156. package/README.de.md +0 -422
  157. package/README.es.md +0 -422
  158. package/README.fr.md +0 -422
  159. package/README.ja.md +0 -422
  160. package/README.ko.md +0 -422
  161. package/README.pt-BR.md +0 -422
  162. package/README.ru.md +0 -422
  163. package/README.zh-CN.md +0 -422
  164. package/build/schemas/index.js +0 -76
  165. package/build/schemas/marketing/jsonSchemas.js +0 -118
  166. package/build/scripts/downloadSpecs.js +0 -117
  167. package/build/scripts/updateApiStatusDoc.js +0 -71
  168. package/build/utils/effectSchema.js +0 -203
  169. package/build/utils/effectSchemaAdapter.js +0 -121
  170. package/build/utils/effectSchemaChainMethods.js +0 -146
  171. package/build/utils/effectSchemaRefinements.js +0 -104
  172. package/build/utils/effectSchemaStringMethods.js +0 -63
  173. package/build/utils/effectSchemaTypes.js +0 -47
  174. package/docs/auth/production_scopes.json +0 -111
  175. package/docs/auth/sandbox_scopes.json +0 -142
  176. /package/build/api/{clientRequestError.js → client/ebayClientRequestError.js} +0 -0
  177. /package/build/api/{rateLimitTracker.js → client/rateLimitTracker.js} +0 -0
  178. /package/build/api/{clientTradingError.js → client/tradingApiFailure.js} +0 -0
@@ -0,0 +1,117 @@
1
+ import { decodeEndpointInputEffect, requestGetEffect, } from '../../api/shared/request.js';
2
+ import { shippingMetadataInputSchema } from '../../schemas/metadata/shipping.js';
3
+ import { Effect } from 'effect';
4
+ const SHIPPING_MARKETPLACE_PATH = '/sell/metadata/v1/shipping/marketplace';
5
+ /**
6
+ * Creates the Metadata API `shipping:marketplace` endpoint methods composed into MetadataApi.
7
+ *
8
+ * @param client - Shared authenticated eBay REST client.
9
+ * @returns Endpoint Effects keyed by their eBay operationId.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const shipping = createMetadataShippingMethods(client);
14
+ * const carriers = await Effect.runPromise(
15
+ * shipping.getShippingCarriers({ marketplaceId: MarketplaceId.EBAY_US }),
16
+ * );
17
+ * ```
18
+ */
19
+ export const createMetadataShippingMethods = (client) => {
20
+ const getShippingResource = (input, resource) => Effect.gen(function* () {
21
+ const { marketplaceId, acceptLanguage } = yield* decodeEndpointInputEffect(shippingMetadataInputSchema, input);
22
+ const path = `${SHIPPING_MARKETPLACE_PATH}/${encodeURIComponent(marketplaceId)}/${resource}`;
23
+ const config = acceptLanguage === undefined
24
+ ? undefined
25
+ : { headers: { 'Accept-Language': acceptLanguage } };
26
+ return yield* requestGetEffect(client, path, undefined, config);
27
+ });
28
+ /**
29
+ * Retrieves the locations a seller can exclude from shipping on a marketplace.
30
+ *
31
+ * @param input - Marketplace ID and optional Accept-Language (fr-CA, fr-BE, nl-BE).
32
+ * @returns An Effect that succeeds with eBay's ShippingExcludeLocationResponse.
33
+ *
34
+ * @example
35
+ * ```ts
36
+ * const excluded = await Effect.runPromise(
37
+ * metadataApi.getExcludeShippingLocations({ marketplaceId: MarketplaceId.EBAY_US }),
38
+ * );
39
+ * ```
40
+ *
41
+ * @see https://developer.ebay.com/api-docs/sell/metadata/resources/shipping:marketplace/methods/getExcludeShippingLocations
42
+ */
43
+ const getExcludeShippingLocations = (input) => getShippingResource(input, 'get_exclude_shipping_locations');
44
+ /**
45
+ * Retrieves the handling times a marketplace allows for shipping after cleared payment.
46
+ *
47
+ * @param input - Marketplace ID and optional Accept-Language (fr-CA, fr-BE, nl-BE).
48
+ * @returns An Effect that succeeds with eBay's ShippingHandlingTimeResponse.
49
+ *
50
+ * @example
51
+ * ```ts
52
+ * const times = await Effect.runPromise(
53
+ * metadataApi.getHandlingTimes({ marketplaceId: MarketplaceId.EBAY_GB }),
54
+ * );
55
+ * ```
56
+ *
57
+ * @see https://developer.ebay.com/api-docs/sell/metadata/resources/shipping:marketplace/methods/getHandlingTimes
58
+ */
59
+ const getHandlingTimes = (input) => getShippingResource(input, 'get_handling_times');
60
+ /**
61
+ * Retrieves the shipping carriers supported on a marketplace, including the carrier enum
62
+ * values required when supplying shipment tracking.
63
+ *
64
+ * @param input - Marketplace ID and optional Accept-Language (fr-CA, fr-BE, nl-BE).
65
+ * @returns An Effect that succeeds with eBay's ShippingCarrierResponse.
66
+ *
67
+ * @example
68
+ * ```ts
69
+ * const carriers = await Effect.runPromise(
70
+ * metadataApi.getShippingCarriers({ marketplaceId: MarketplaceId.EBAY_US }),
71
+ * );
72
+ * ```
73
+ *
74
+ * @see https://developer.ebay.com/api-docs/sell/metadata/resources/shipping:marketplace/methods/getShippingCarriers
75
+ */
76
+ const getShippingCarriers = (input) => getShippingResource(input, 'get_shipping_carriers');
77
+ /**
78
+ * Retrieves the regions, countries, and special locations a seller can ship to.
79
+ *
80
+ * @param input - Marketplace ID and optional Accept-Language (fr-CA, fr-BE, nl-BE).
81
+ * @returns An Effect that succeeds with eBay's ShippingLocationResponse.
82
+ *
83
+ * @example
84
+ * ```ts
85
+ * const locations = await Effect.runPromise(
86
+ * metadataApi.getShippingLocations({ marketplaceId: MarketplaceId.EBAY_DE }),
87
+ * );
88
+ * ```
89
+ *
90
+ * @see https://developer.ebay.com/api-docs/sell/metadata/resources/shipping:marketplace/methods/getShippingLocations
91
+ */
92
+ const getShippingLocations = (input) => getShippingResource(input, 'get_shipping_locations');
93
+ /**
94
+ * Retrieves the shipping services available on a marketplace, with shipping times and
95
+ * package limits.
96
+ *
97
+ * @param input - Marketplace ID and optional Accept-Language (fr-CA, fr-BE, nl-BE).
98
+ * @returns An Effect that succeeds with eBay's ShippingServiceResponse.
99
+ *
100
+ * @example
101
+ * ```ts
102
+ * const services = await Effect.runPromise(
103
+ * metadataApi.getShippingServices({ marketplaceId: MarketplaceId.EBAY_CA, acceptLanguage: 'fr-CA' }),
104
+ * );
105
+ * ```
106
+ *
107
+ * @see https://developer.ebay.com/api-docs/sell/metadata/resources/shipping:marketplace/methods/getShippingServices
108
+ */
109
+ const getShippingServices = (input) => getShippingResource(input, 'get_shipping_services');
110
+ return {
111
+ getExcludeShippingLocations,
112
+ getHandlingTimes,
113
+ getShippingCarriers,
114
+ getShippingLocations,
115
+ getShippingServices,
116
+ };
117
+ };
@@ -1,6 +1,16 @@
1
- import { buildEndpointParams, requestGetEffect, requireObjectEffect, requireStringEffect, } from '../../api/shared/request.js';
1
+ import { requestDownloadEffect, } from '../../api/shared/download.js';
2
+ import { buildEndpointParams, decodeEndpointInputEffect, requestGetEffect, requireObjectEffect, requireStringEffect, } from '../../api/shared/request.js';
3
+ import { categoryTreeIdInputSchema } from '../../schemas/taxonomy/categoryTree.js';
2
4
  import { Effect } from 'effect';
3
- /** Taxonomy API - category trees, category suggestions, and compatibility metadata. */
5
+ /**
6
+ * fetchItemAspects streams a whole marketplace's aspect file before the inline-size check,
7
+ * so it gets more than the client's 30 s default; larger trees still end in a bounded failure.
8
+ */
9
+ const ITEM_ASPECTS_DOWNLOAD = { timeoutMs: 120_000 };
10
+ /**
11
+ * Taxonomy API - category trees, category suggestions, item aspects, expired-category
12
+ * mappings, and compatibility metadata.
13
+ */
4
14
  export class TaxonomyApi {
5
15
  client;
6
16
  basePath = '/commerce/taxonomy/v1';
@@ -11,7 +21,7 @@ export class TaxonomyApi {
11
21
  * Retrieves the default category tree ID for a marketplace.
12
22
  *
13
23
  * @param input - Marketplace identifier used to select the default tree.
14
- * @returns An Effect that succeeds with eBay's getDefaultCategoryTreeId response.
24
+ * @returns An Effect that succeeds with eBay's getDefaultCategoryTreeId response, or undefined on HTTP 204.
15
25
  *
16
26
  * @example
17
27
  * ```ts
@@ -88,7 +98,7 @@ export class TaxonomyApi {
88
98
  * Retrieves category suggestions for listing search text.
89
99
  *
90
100
  * @param input - Category tree identifier and query text.
91
- * @returns An Effect that succeeds with eBay's getCategorySuggestions response.
101
+ * @returns An Effect that succeeds with eBay's getCategorySuggestions response, or undefined on HTTP 204.
92
102
  *
93
103
  * @example
94
104
  * ```ts
@@ -116,7 +126,7 @@ export class TaxonomyApi {
116
126
  * Retrieves item aspects for a category.
117
127
  *
118
128
  * @param input - Category tree and category identifiers.
119
- * @returns An Effect that succeeds with eBay's getItemAspectsForCategory response.
129
+ * @returns An Effect that succeeds with eBay's getItemAspectsForCategory response, or undefined on HTTP 204.
120
130
  *
121
131
  * @example
122
132
  * ```ts
@@ -144,7 +154,7 @@ export class TaxonomyApi {
144
154
  * Retrieves compatibility property names for a category.
145
155
  *
146
156
  * @param input - Category tree and compatibility-enabled category identifiers.
147
- * @returns An Effect that succeeds with eBay's getCompatibilityProperties response.
157
+ * @returns An Effect that succeeds with eBay's getCompatibilityProperties response, or undefined on HTTP 204.
148
158
  *
149
159
  * @example
150
160
  * ```ts
@@ -172,7 +182,7 @@ export class TaxonomyApi {
172
182
  * Retrieves compatibility values for one property within a category.
173
183
  *
174
184
  * @param input - Category tree, category, and compatibility property identifiers.
175
- * @returns An Effect that succeeds with eBay's getCompatibilityPropertyValues response.
185
+ * @returns An Effect that succeeds with eBay's getCompatibilityPropertyValues response, or undefined on HTTP 204.
176
186
  *
177
187
  * @example
178
188
  * ```ts
@@ -205,4 +215,39 @@ export class TaxonomyApi {
205
215
  return yield* requestGetEffect(client, `${basePath}/category_tree/${categoryTreeId}/get_compatibility_property_values`, params);
206
216
  });
207
217
  };
218
+ /**
219
+ * Downloads the aspects of every leaf category in a category tree as eBay's gzipped JSON file.
220
+ *
221
+ * eBay documents the file as possibly over 100 MB compressed; files above
222
+ * MAX_INLINE_DOWNLOAD_BYTES (25 MiB) fail with DownloadTooLargeError, so use
223
+ * getItemAspectsForCategory for per-category lookups.
224
+ *
225
+ * @param input - Category tree identifier.
226
+ * @returns An Effect with the gzipped bytes, eBay's content type, and its file name.
227
+ *
228
+ * @example
229
+ * ```ts
230
+ * const file = await Effect.runPromise(taxonomyApi.fetchItemAspects({ categoryTreeId: '3' }));
231
+ * ```
232
+ *
233
+ * @see https://developer.ebay.com/api-docs/commerce/taxonomy/resources/category_tree/methods/fetchItemAspects
234
+ */
235
+ fetchItemAspects = (input) => this.categoryTreeResourcePath(input, 'fetch_item_aspects').pipe(Effect.flatMap((path) => requestDownloadEffect(this.client, path, ITEM_ASPECTS_DOWNLOAD)));
236
+ /**
237
+ * Retrieves the mappings of expired leaf categories to the active categories replacing them.
238
+ *
239
+ * @param input - Category tree identifier.
240
+ * @returns An Effect that succeeds with eBay's ExpiredCategories, or undefined on HTTP 204.
241
+ *
242
+ * @example
243
+ * ```ts
244
+ * const expired = await Effect.runPromise(
245
+ * taxonomyApi.getExpiredCategories({ categoryTreeId: '0' }),
246
+ * );
247
+ * ```
248
+ *
249
+ * @see https://developer.ebay.com/api-docs/commerce/taxonomy/resources/category_tree/methods/getExpiredCategories
250
+ */
251
+ getExpiredCategories = (input) => this.categoryTreeResourcePath(input, 'get_expired_categories').pipe(Effect.flatMap((path) => requestGetEffect(this.client, path)));
252
+ categoryTreeResourcePath = (input, resource) => decodeEndpointInputEffect(categoryTreeIdInputSchema, input, 'categoryTreeId').pipe(Effect.map(({ categoryTreeId }) => `${this.basePath}/category_tree/${encodeURIComponent(categoryTreeId)}/${resource}`));
208
253
  }
@@ -10,7 +10,7 @@ export const createMarketingAdsMethods = (client) => ({
10
10
  *
11
11
  * @example
12
12
  * ```ts
13
- * const response = await Effect.runPromise(marketingApi.bulkCreateAdsByInventoryReference({ campaignId: 'campaign-1', request: { ... } }));
13
+ * const createdAds = await Effect.runPromise(marketingApi.bulkCreateAdsByInventoryReference({ campaignId: 'campaign-1', request: { ... } }));
14
14
  * ```
15
15
  *
16
16
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkCreateAdsByInventoryReference
@@ -27,7 +27,7 @@ export const createMarketingAdsMethods = (client) => ({
27
27
  *
28
28
  * @example
29
29
  * ```ts
30
- * const response = await Effect.runPromise(marketingApi.bulkCreateAdsByListingId({ campaignId: 'campaign-1', request: { ... } }));
30
+ * const createdAds = await Effect.runPromise(marketingApi.bulkCreateAdsByListingId({ campaignId: 'campaign-1', request: { ... } }));
31
31
  * ```
32
32
  *
33
33
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkCreateAdsByListingId
@@ -44,7 +44,7 @@ export const createMarketingAdsMethods = (client) => ({
44
44
  *
45
45
  * @example
46
46
  * ```ts
47
- * const response = await Effect.runPromise(marketingApi.bulkDeleteAdsByInventoryReference({ campaignId: 'campaign-1', request: { ... } }));
47
+ * const deletedAds = await Effect.runPromise(marketingApi.bulkDeleteAdsByInventoryReference({ campaignId: 'campaign-1', request: { ... } }));
48
48
  * ```
49
49
  *
50
50
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkDeleteAdsByInventoryReference
@@ -61,7 +61,7 @@ export const createMarketingAdsMethods = (client) => ({
61
61
  *
62
62
  * @example
63
63
  * ```ts
64
- * const response = await Effect.runPromise(marketingApi.bulkDeleteAdsByListingId({ campaignId: 'campaign-1', request: { ... } }));
64
+ * const deletedAds = await Effect.runPromise(marketingApi.bulkDeleteAdsByListingId({ campaignId: 'campaign-1', request: { ... } }));
65
65
  * ```
66
66
  *
67
67
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkDeleteAdsByListingId
@@ -78,7 +78,7 @@ export const createMarketingAdsMethods = (client) => ({
78
78
  *
79
79
  * @example
80
80
  * ```ts
81
- * const response = await Effect.runPromise(marketingApi.bulkUpdateAdsBidByInventoryReference({ campaignId: 'campaign-1', request: { ... } }));
81
+ * const adBidUpdates = await Effect.runPromise(marketingApi.bulkUpdateAdsBidByInventoryReference({ campaignId: 'campaign-1', request: { ... } }));
82
82
  * ```
83
83
  *
84
84
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkUpdateAdsBidByInventoryReference
@@ -95,7 +95,7 @@ export const createMarketingAdsMethods = (client) => ({
95
95
  *
96
96
  * @example
97
97
  * ```ts
98
- * const response = await Effect.runPromise(marketingApi.bulkUpdateAdsBidByListingId({ campaignId: 'campaign-1', request: { ... } }));
98
+ * const adBidUpdates = await Effect.runPromise(marketingApi.bulkUpdateAdsBidByListingId({ campaignId: 'campaign-1', request: { ... } }));
99
99
  * ```
100
100
  *
101
101
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkUpdateAdsBidByListingId
@@ -112,7 +112,7 @@ export const createMarketingAdsMethods = (client) => ({
112
112
  *
113
113
  * @example
114
114
  * ```ts
115
- * const response = await Effect.runPromise(marketingApi.bulkUpdateAdsStatus({ campaignId: 'campaign-1', request: { ... } }));
115
+ * const adStatusUpdates = await Effect.runPromise(marketingApi.bulkUpdateAdsStatus({ campaignId: 'campaign-1', request: { ... } }));
116
116
  * ```
117
117
  *
118
118
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkUpdateAdsStatus
@@ -129,7 +129,7 @@ export const createMarketingAdsMethods = (client) => ({
129
129
  *
130
130
  * @example
131
131
  * ```ts
132
- * const response = await Effect.runPromise(marketingApi.bulkUpdateAdsStatusByListingId({ campaignId: 'campaign-1', request: { ... } }));
132
+ * const adStatusUpdates = await Effect.runPromise(marketingApi.bulkUpdateAdsStatusByListingId({ campaignId: 'campaign-1', request: { ... } }));
133
133
  * ```
134
134
  *
135
135
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkUpdateAdsStatusByListingId
@@ -146,7 +146,7 @@ export const createMarketingAdsMethods = (client) => ({
146
146
  *
147
147
  * @example
148
148
  * ```ts
149
- * const response = await Effect.runPromise(marketingApi.getAds({ campaignId: 'campaign-1' }));
149
+ * const ads = await Effect.runPromise(marketingApi.getAds({ campaignId: 'campaign-1' }));
150
150
  * ```
151
151
  *
152
152
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/getAds
@@ -170,7 +170,7 @@ export const createMarketingAdsMethods = (client) => ({
170
170
  *
171
171
  * @example
172
172
  * ```ts
173
- * const response = await Effect.runPromise(marketingApi.createAdByListingId({ campaignId: 'campaign-1', request: { ... } }));
173
+ * const createdAd = await Effect.runPromise(marketingApi.createAdByListingId({ campaignId: 'campaign-1', request: { ... } }));
174
174
  * ```
175
175
  *
176
176
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/createAdByListingId
@@ -187,7 +187,7 @@ export const createMarketingAdsMethods = (client) => ({
187
187
  *
188
188
  * @example
189
189
  * ```ts
190
- * const response = await Effect.runPromise(marketingApi.createAdsByInventoryReference({ campaignId: 'campaign-1', request: { ... } }));
190
+ * const createdAds = await Effect.runPromise(marketingApi.createAdsByInventoryReference({ campaignId: 'campaign-1', request: { ... } }));
191
191
  * ```
192
192
  *
193
193
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/createAdsByInventoryReference
@@ -204,7 +204,7 @@ export const createMarketingAdsMethods = (client) => ({
204
204
  *
205
205
  * @example
206
206
  * ```ts
207
- * const response = await Effect.runPromise(marketingApi.getAd({ adId: 'ad-1', campaignId: 'campaign-1' }));
207
+ * const ad = await Effect.runPromise(marketingApi.getAd({ adId: 'ad-1', campaignId: 'campaign-1' }));
208
208
  * ```
209
209
  *
210
210
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/getAd
@@ -221,7 +221,7 @@ export const createMarketingAdsMethods = (client) => ({
221
221
  *
222
222
  * @example
223
223
  * ```ts
224
- * const response = await Effect.runPromise(marketingApi.deleteAd({ adId: 'ad-1', campaignId: 'campaign-1' }));
224
+ * await Effect.runPromise(marketingApi.deleteAd({ adId: 'ad-1', campaignId: 'campaign-1' }));
225
225
  * ```
226
226
  *
227
227
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/deleteAd
@@ -238,7 +238,7 @@ export const createMarketingAdsMethods = (client) => ({
238
238
  *
239
239
  * @example
240
240
  * ```ts
241
- * const response = await Effect.runPromise(marketingApi.deleteAdsByInventoryReference({ campaignId: 'campaign-1', request: { ... } }));
241
+ * await Effect.runPromise(marketingApi.deleteAdsByInventoryReference({ campaignId: 'campaign-1', request: { ... } }));
242
242
  * ```
243
243
  *
244
244
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/deleteAdsByInventoryReference
@@ -255,7 +255,7 @@ export const createMarketingAdsMethods = (client) => ({
255
255
  *
256
256
  * @example
257
257
  * ```ts
258
- * const response = await Effect.runPromise(marketingApi.getAdsByInventoryReference({ campaignId: 'campaign-1', inventoryReferenceId: 'inventoryReference-1', inventoryReferenceType: 'inventoryReferenceType-1' }));
258
+ * const ads = await Effect.runPromise(marketingApi.getAdsByInventoryReference({ campaignId: 'campaign-1', inventoryReferenceId: 'inventoryReference-1', inventoryReferenceType: 'inventoryReferenceType-1' }));
259
259
  * ```
260
260
  *
261
261
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/getAdsByInventoryReference
@@ -282,7 +282,7 @@ export const createMarketingAdsMethods = (client) => ({
282
282
  *
283
283
  * @example
284
284
  * ```ts
285
- * const response = await Effect.runPromise(marketingApi.updateBid({ adId: 'ad-1', campaignId: 'campaign-1', request: { ... } }));
285
+ * const updatedBid = await Effect.runPromise(marketingApi.updateBid({ adId: 'ad-1', campaignId: 'campaign-1', request: { ... } }));
286
286
  * ```
287
287
  *
288
288
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/updateBid
@@ -299,7 +299,7 @@ export const createMarketingAdsMethods = (client) => ({
299
299
  *
300
300
  * @example
301
301
  * ```ts
302
- * const response = await Effect.runPromise(marketingApi.getAdGroups({ campaignId: 'campaign-1' }));
302
+ * const adGroups = await Effect.runPromise(marketingApi.getAdGroups({ campaignId: 'campaign-1' }));
303
303
  * ```
304
304
  *
305
305
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/getAdGroups
@@ -321,7 +321,7 @@ export const createMarketingAdsMethods = (client) => ({
321
321
  *
322
322
  * @example
323
323
  * ```ts
324
- * const response = await Effect.runPromise(marketingApi.createAdGroup({ campaignId: 'campaign-1', request: { ... } }));
324
+ * const createdAdGroup = await Effect.runPromise(marketingApi.createAdGroup({ campaignId: 'campaign-1', request: { ... } }));
325
325
  * ```
326
326
  *
327
327
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/createAdGroup
@@ -338,7 +338,7 @@ export const createMarketingAdsMethods = (client) => ({
338
338
  *
339
339
  * @example
340
340
  * ```ts
341
- * const response = await Effect.runPromise(marketingApi.getAdGroup({ adGroupId: 'adGroup-1', campaignId: 'campaign-1' }));
341
+ * const adGroup = await Effect.runPromise(marketingApi.getAdGroup({ adGroupId: 'adGroup-1', campaignId: 'campaign-1' }));
342
342
  * ```
343
343
  *
344
344
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/getAdGroup
@@ -355,7 +355,7 @@ export const createMarketingAdsMethods = (client) => ({
355
355
  *
356
356
  * @example
357
357
  * ```ts
358
- * const response = await Effect.runPromise(marketingApi.updateAdGroup({ adGroupId: 'adGroup-1', campaignId: 'campaign-1', request: { ... } }));
358
+ * const updatedAdGroup = await Effect.runPromise(marketingApi.updateAdGroup({ adGroupId: 'adGroup-1', campaignId: 'campaign-1', request: { ... } }));
359
359
  * ```
360
360
  *
361
361
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/updateAdGroup
@@ -372,7 +372,7 @@ export const createMarketingAdsMethods = (client) => ({
372
372
  *
373
373
  * @example
374
374
  * ```ts
375
- * const response = await Effect.runPromise(marketingApi.suggestBids({ adGroupId: 'adGroup-1', campaignId: 'campaign-1', request: { ... } }));
375
+ * const suggestedBids = await Effect.runPromise(marketingApi.suggestBids({ adGroupId: 'adGroup-1', campaignId: 'campaign-1', request: { ... } }));
376
376
  * ```
377
377
  *
378
378
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/suggestBids
@@ -389,7 +389,7 @@ export const createMarketingAdsMethods = (client) => ({
389
389
  *
390
390
  * @example
391
391
  * ```ts
392
- * const response = await Effect.runPromise(marketingApi.suggestKeywords({ adGroupId: 'adGroup-1', campaignId: 'campaign-1', request: { ... } }));
392
+ * const suggestedKeywords = await Effect.runPromise(marketingApi.suggestKeywords({ adGroupId: 'adGroup-1', campaignId: 'campaign-1', request: { ... } }));
393
393
  * ```
394
394
  *
395
395
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/suggestKeywords
@@ -406,7 +406,7 @@ export const createMarketingAdsMethods = (client) => ({
406
406
  *
407
407
  * @example
408
408
  * ```ts
409
- * const response = await Effect.runPromise(marketingApi.bulkCreateKeyword({ campaignId: 'campaign-1', request: { ... } }));
409
+ * const createdKeywords = await Effect.runPromise(marketingApi.bulkCreateKeyword({ campaignId: 'campaign-1', request: { ... } }));
410
410
  * ```
411
411
  *
412
412
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/keyword/methods/bulkCreateKeyword
@@ -423,7 +423,7 @@ export const createMarketingAdsMethods = (client) => ({
423
423
  *
424
424
  * @example
425
425
  * ```ts
426
- * const response = await Effect.runPromise(marketingApi.bulkUpdateKeyword({ campaignId: 'campaign-1', request: { ... } }));
426
+ * const updatedKeywords = await Effect.runPromise(marketingApi.bulkUpdateKeyword({ campaignId: 'campaign-1', request: { ... } }));
427
427
  * ```
428
428
  *
429
429
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/keyword/methods/bulkUpdateKeyword
@@ -440,7 +440,7 @@ export const createMarketingAdsMethods = (client) => ({
440
440
  *
441
441
  * @example
442
442
  * ```ts
443
- * const response = await Effect.runPromise(marketingApi.getKeywords({ campaignId: 'campaign-1' }));
443
+ * const keywords = await Effect.runPromise(marketingApi.getKeywords({ campaignId: 'campaign-1' }));
444
444
  * ```
445
445
  *
446
446
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/keyword/methods/getKeywords
@@ -463,7 +463,7 @@ export const createMarketingAdsMethods = (client) => ({
463
463
  *
464
464
  * @example
465
465
  * ```ts
466
- * const response = await Effect.runPromise(marketingApi.createKeyword({ campaignId: 'campaign-1', request: { ... } }));
466
+ * const createdKeyword = await Effect.runPromise(marketingApi.createKeyword({ campaignId: 'campaign-1', request: { ... } }));
467
467
  * ```
468
468
  *
469
469
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/keyword/methods/createKeyword
@@ -480,7 +480,7 @@ export const createMarketingAdsMethods = (client) => ({
480
480
  *
481
481
  * @example
482
482
  * ```ts
483
- * const response = await Effect.runPromise(marketingApi.getKeyword({ campaignId: 'campaign-1', keywordId: 'keyword-1' }));
483
+ * const keyword = await Effect.runPromise(marketingApi.getKeyword({ campaignId: 'campaign-1', keywordId: 'keyword-1' }));
484
484
  * ```
485
485
  *
486
486
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/keyword/methods/getKeyword
@@ -497,7 +497,7 @@ export const createMarketingAdsMethods = (client) => ({
497
497
  *
498
498
  * @example
499
499
  * ```ts
500
- * const response = await Effect.runPromise(marketingApi.updateKeyword({ campaignId: 'campaign-1', keywordId: 'keyword-1', request: { ... } }));
500
+ * const updatedKeyword = await Effect.runPromise(marketingApi.updateKeyword({ campaignId: 'campaign-1', keywordId: 'keyword-1', request: { ... } }));
501
501
  * ```
502
502
  *
503
503
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/keyword/methods/updateKeyword
@@ -514,7 +514,7 @@ export const createMarketingAdsMethods = (client) => ({
514
514
  *
515
515
  * @example
516
516
  * ```ts
517
- * const response = await Effect.runPromise(marketingApi.bulkCreateNegativeKeyword({ request: { ... } }));
517
+ * const createdNegativeKeywords = await Effect.runPromise(marketingApi.bulkCreateNegativeKeyword({ request: { ... } }));
518
518
  * ```
519
519
  *
520
520
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/negative_keyword/methods/bulkCreateNegativeKeyword
@@ -531,7 +531,7 @@ export const createMarketingAdsMethods = (client) => ({
531
531
  *
532
532
  * @example
533
533
  * ```ts
534
- * const response = await Effect.runPromise(marketingApi.bulkUpdateNegativeKeyword({ request: { ... } }));
534
+ * const updatedNegativeKeywords = await Effect.runPromise(marketingApi.bulkUpdateNegativeKeyword({ request: { ... } }));
535
535
  * ```
536
536
  *
537
537
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/negative_keyword/methods/bulkUpdateNegativeKeyword
@@ -548,7 +548,7 @@ export const createMarketingAdsMethods = (client) => ({
548
548
  *
549
549
  * @example
550
550
  * ```ts
551
- * const response = await Effect.runPromise(marketingApi.getNegativeKeywords());
551
+ * const negativeKeywords = await Effect.runPromise(marketingApi.getNegativeKeywords());
552
552
  * ```
553
553
  *
554
554
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/negative_keyword/methods/getNegativeKeywords
@@ -575,7 +575,7 @@ export const createMarketingAdsMethods = (client) => ({
575
575
  *
576
576
  * @example
577
577
  * ```ts
578
- * const response = await Effect.runPromise(marketingApi.createNegativeKeyword({ request: { ... } }));
578
+ * const createdNegativeKeyword = await Effect.runPromise(marketingApi.createNegativeKeyword({ request: { ... } }));
579
579
  * ```
580
580
  *
581
581
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/negative_keyword/methods/createNegativeKeyword
@@ -592,7 +592,7 @@ export const createMarketingAdsMethods = (client) => ({
592
592
  *
593
593
  * @example
594
594
  * ```ts
595
- * const response = await Effect.runPromise(marketingApi.getNegativeKeyword({ negativeKeywordId: 'negativeKeyword-1' }));
595
+ * const negativeKeyword = await Effect.runPromise(marketingApi.getNegativeKeyword({ negativeKeywordId: 'negativeKeyword-1' }));
596
596
  * ```
597
597
  *
598
598
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/negative_keyword/methods/getNegativeKeyword
@@ -609,7 +609,7 @@ export const createMarketingAdsMethods = (client) => ({
609
609
  *
610
610
  * @example
611
611
  * ```ts
612
- * const response = await Effect.runPromise(marketingApi.updateNegativeKeyword({ negativeKeywordId: 'negativeKeyword-1', request: { ... } }));
612
+ * const updatedNegativeKeyword = await Effect.runPromise(marketingApi.updateNegativeKeyword({ negativeKeywordId: 'negativeKeyword-1', request: { ... } }));
613
613
  * ```
614
614
  *
615
615
  * @see https://developer.ebay.com/api-docs/sell/marketing/resources/negative_keyword/methods/updateNegativeKeyword