ebay-mcp 1.4.3
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.
- package/LICENSE +201 -0
- package/README.md +586 -0
- package/build/api/account-management/account.d.ts +216 -0
- package/build/api/account-management/account.js +305 -0
- package/build/api/analytics-and-report/analytics.d.ts +33 -0
- package/build/api/analytics-and-report/analytics.js +102 -0
- package/build/api/client.d.ts +89 -0
- package/build/api/client.js +343 -0
- package/build/api/communication/feedback.d.ts +45 -0
- package/build/api/communication/feedback.js +119 -0
- package/build/api/communication/message.d.ts +55 -0
- package/build/api/communication/message.js +131 -0
- package/build/api/communication/negotiation.d.ts +39 -0
- package/build/api/communication/negotiation.js +97 -0
- package/build/api/communication/notification.d.ts +128 -0
- package/build/api/communication/notification.js +373 -0
- package/build/api/index.d.ts +96 -0
- package/build/api/index.js +121 -0
- package/build/api/listing-management/inventory.d.ts +216 -0
- package/build/api/listing-management/inventory.js +633 -0
- package/build/api/listing-metadata/metadata.d.ts +154 -0
- package/build/api/listing-metadata/metadata.js +485 -0
- package/build/api/listing-metadata/taxonomy.d.ts +38 -0
- package/build/api/listing-metadata/taxonomy.js +58 -0
- package/build/api/marketing-and-promotions/marketing.d.ts +395 -0
- package/build/api/marketing-and-promotions/marketing.js +565 -0
- package/build/api/marketing-and-promotions/recommendation.d.ts +20 -0
- package/build/api/marketing-and-promotions/recommendation.js +32 -0
- package/build/api/order-management/dispute.d.ts +65 -0
- package/build/api/order-management/dispute.js +69 -0
- package/build/api/order-management/fulfillment.d.ts +80 -0
- package/build/api/order-management/fulfillment.js +89 -0
- package/build/api/other/compliance.d.ts +26 -0
- package/build/api/other/compliance.js +47 -0
- package/build/api/other/edelivery.d.ts +153 -0
- package/build/api/other/edelivery.js +219 -0
- package/build/api/other/identity.d.ts +17 -0
- package/build/api/other/identity.js +24 -0
- package/build/api/other/translation.d.ts +14 -0
- package/build/api/other/translation.js +22 -0
- package/build/api/other/vero.d.ts +30 -0
- package/build/api/other/vero.js +48 -0
- package/build/auth/oauth-metadata.d.ts +46 -0
- package/build/auth/oauth-metadata.js +59 -0
- package/build/auth/oauth-middleware.d.ts +35 -0
- package/build/auth/oauth-middleware.js +99 -0
- package/build/auth/oauth-types.d.ts +66 -0
- package/build/auth/oauth-types.js +4 -0
- package/build/auth/oauth.d.ts +93 -0
- package/build/auth/oauth.js +383 -0
- package/build/auth/scope-utils.d.ts +70 -0
- package/build/auth/scope-utils.js +304 -0
- package/build/auth/token-verifier.d.ts +57 -0
- package/build/auth/token-verifier.js +172 -0
- package/build/config/environment.d.ts +61 -0
- package/build/config/environment.js +260 -0
- package/build/index.d.ts +1 -0
- package/build/index.js +98 -0
- package/build/schemas/account-management/account.d.ts +5324 -0
- package/build/schemas/account-management/account.js +366 -0
- package/build/schemas/analytics/analytics.d.ts +167 -0
- package/build/schemas/analytics/analytics.js +191 -0
- package/build/schemas/communication/messages.d.ts +1872 -0
- package/build/schemas/communication/messages.js +348 -0
- package/build/schemas/fulfillment/orders.d.ts +4655 -0
- package/build/schemas/fulfillment/orders.js +317 -0
- package/build/schemas/index.d.ts +2100 -0
- package/build/schemas/index.js +68 -0
- package/build/schemas/inventory-management/inventory.d.ts +6419 -0
- package/build/schemas/inventory-management/inventory.js +450 -0
- package/build/schemas/marketing/marketing.d.ts +14181 -0
- package/build/schemas/marketing/marketing.js +1088 -0
- package/build/schemas/metadata/metadata.d.ts +5259 -0
- package/build/schemas/metadata/metadata.js +614 -0
- package/build/schemas/other/other-apis.d.ts +257 -0
- package/build/schemas/other/other-apis.js +372 -0
- package/build/schemas/taxonomy/taxonomy.d.ts +215 -0
- package/build/schemas/taxonomy/taxonomy.js +571 -0
- package/build/scripts/auto-setup.d.ts +12 -0
- package/build/scripts/auto-setup.js +277 -0
- package/build/scripts/diagnostics.d.ts +8 -0
- package/build/scripts/diagnostics.js +299 -0
- package/build/scripts/download-specs.d.ts +1 -0
- package/build/scripts/download-specs.js +116 -0
- package/build/scripts/interactive-setup.d.ts +21 -0
- package/build/scripts/interactive-setup.js +723 -0
- package/build/server-http.d.ts +11 -0
- package/build/server-http.js +361 -0
- package/build/tools/definitions/account-with-schemas.d.ts +39 -0
- package/build/tools/definitions/account-with-schemas.js +170 -0
- package/build/tools/definitions/account.d.ts +12 -0
- package/build/tools/definitions/account.js +428 -0
- package/build/tools/definitions/analytics.d.ts +25 -0
- package/build/tools/definitions/analytics.js +66 -0
- package/build/tools/definitions/communication.d.ts +12 -0
- package/build/tools/definitions/communication.js +151 -0
- package/build/tools/definitions/fulfillment.d.ts +12 -0
- package/build/tools/definitions/fulfillment.js +326 -0
- package/build/tools/definitions/index.d.ts +25 -0
- package/build/tools/definitions/index.js +37 -0
- package/build/tools/definitions/inventory.d.ts +12 -0
- package/build/tools/definitions/inventory.js +429 -0
- package/build/tools/definitions/marketing.d.ts +12 -0
- package/build/tools/definitions/marketing.js +1095 -0
- package/build/tools/definitions/metadata.d.ts +12 -0
- package/build/tools/definitions/metadata.js +188 -0
- package/build/tools/definitions/other.d.ts +13 -0
- package/build/tools/definitions/other.js +309 -0
- package/build/tools/definitions/taxonomy.d.ts +25 -0
- package/build/tools/definitions/taxonomy.js +64 -0
- package/build/tools/definitions/token-management.d.ts +35 -0
- package/build/tools/definitions/token-management.js +103 -0
- package/build/tools/index.d.ts +11 -0
- package/build/tools/index.js +1003 -0
- package/build/tools/schemas.d.ts +14764 -0
- package/build/tools/schemas.js +667 -0
- package/build/tools/tool-definitions.d.ts +35 -0
- package/build/tools/tool-definitions.js +3534 -0
- package/build/types/application-settings/developerAnalyticsV1BetaOas3.d.ts +197 -0
- package/build/types/application-settings/developerAnalyticsV1BetaOas3.js +5 -0
- package/build/types/application-settings/developerClientRegistrationV1Oas3.d.ts +155 -0
- package/build/types/application-settings/developerClientRegistrationV1Oas3.js +5 -0
- package/build/types/application-settings/developerKeyManagementV1Oas3.d.ts +246 -0
- package/build/types/application-settings/developerKeyManagementV1Oas3.js +5 -0
- package/build/types/ebay-enums.d.ts +1204 -0
- package/build/types/ebay-enums.js +1330 -0
- package/build/types/ebay.d.ts +143 -0
- package/build/types/ebay.js +123 -0
- package/build/types/index.d.ts +6 -0
- package/build/types/index.js +10 -0
- package/build/types/sell-apps/account-management/sellAccountV1Oas3.d.ts +2579 -0
- package/build/types/sell-apps/account-management/sellAccountV1Oas3.js +5 -0
- package/build/types/sell-apps/analytics-and-report/sellAnalyticsV1Oas3.d.ts +446 -0
- package/build/types/sell-apps/analytics-and-report/sellAnalyticsV1Oas3.js +5 -0
- package/build/types/sell-apps/communication/commerceFeedbackV1BetaOas3.d.ts +705 -0
- package/build/types/sell-apps/communication/commerceFeedbackV1BetaOas3.js +5 -0
- package/build/types/sell-apps/communication/commerceMessageV1Oas3.d.ts +590 -0
- package/build/types/sell-apps/communication/commerceMessageV1Oas3.js +5 -0
- package/build/types/sell-apps/communication/commerceNotificationV1Oas3.d.ts +1276 -0
- package/build/types/sell-apps/communication/commerceNotificationV1Oas3.js +5 -0
- package/build/types/sell-apps/communication/sellNegotiationV1Oas3.d.ts +277 -0
- package/build/types/sell-apps/communication/sellNegotiationV1Oas3.js +5 -0
- package/build/types/sell-apps/listing-management/sellInventoryV1Oas3.d.ts +3133 -0
- package/build/types/sell-apps/listing-management/sellInventoryV1Oas3.js +5 -0
- package/build/types/sell-apps/listing-metadata/sellMetadataV1Oas3.d.ts +2289 -0
- package/build/types/sell-apps/listing-metadata/sellMetadataV1Oas3.js +5 -0
- package/build/types/sell-apps/markeitng-and-promotions/sellMarketingV1Oas3.d.ts +6650 -0
- package/build/types/sell-apps/markeitng-and-promotions/sellMarketingV1Oas3.js +5 -0
- package/build/types/sell-apps/markeitng-and-promotions/sellRecommendationV1Oas3.d.ts +172 -0
- package/build/types/sell-apps/markeitng-and-promotions/sellRecommendationV1Oas3.js +5 -0
- package/build/types/sell-apps/order-management/sellFulfillmentV1Oas3.d.ts +1869 -0
- package/build/types/sell-apps/order-management/sellFulfillmentV1Oas3.js +5 -0
- package/build/types/sell-apps/other-apis/commerceIdentityV1Oas3.d.ts +178 -0
- package/build/types/sell-apps/other-apis/commerceIdentityV1Oas3.js +5 -0
- package/build/types/sell-apps/other-apis/commerceTranslationV1BetaOas3.d.ts +128 -0
- package/build/types/sell-apps/other-apis/commerceTranslationV1BetaOas3.js +5 -0
- package/build/types/sell-apps/other-apis/commerceVeroV1Oas3.d.ts +417 -0
- package/build/types/sell-apps/other-apis/commerceVeroV1Oas3.js +5 -0
- package/build/types/sell-apps/other-apis/sellComplianceV1Oas3.d.ts +273 -0
- package/build/types/sell-apps/other-apis/sellComplianceV1Oas3.js +5 -0
- package/build/types/sell-apps/other-apis/sellEdeliveryInternationalShippingOas3.d.ts +2537 -0
- package/build/types/sell-apps/other-apis/sellEdeliveryInternationalShippingOas3.js +5 -0
- package/build/types/sell-apps/other-apis/sellMarketingV1Oas3.d.ts +6650 -0
- package/build/types/sell-apps/other-apis/sellMarketingV1Oas3.js +5 -0
- package/build/types/sell-apps/other-apis/sellRecommendationV1Oas3.d.ts +172 -0
- package/build/types/sell-apps/other-apis/sellRecommendationV1Oas3.js +5 -0
- package/build/utils/account-management/account.d.ts +1094 -0
- package/build/utils/account-management/account.js +831 -0
- package/build/utils/communication/feedback.d.ts +152 -0
- package/build/utils/communication/feedback.js +216 -0
- package/build/utils/communication/message.d.ts +174 -0
- package/build/utils/communication/message.js +242 -0
- package/build/utils/communication/negotiation.d.ts +123 -0
- package/build/utils/communication/negotiation.js +150 -0
- package/build/utils/communication/notification.d.ts +370 -0
- package/build/utils/communication/notification.js +369 -0
- package/build/utils/date-converter.d.ts +59 -0
- package/build/utils/date-converter.js +160 -0
- package/build/utils/llm-client-detector.d.ts +54 -0
- package/build/utils/llm-client-detector.js +318 -0
- package/build/utils/oauth-helper.d.ts +37 -0
- package/build/utils/oauth-helper.js +315 -0
- package/build/utils/order-management/dispute.d.ts +346 -0
- package/build/utils/order-management/dispute.js +369 -0
- package/build/utils/order-management/fulfillment.d.ts +200 -0
- package/build/utils/order-management/fulfillment.js +205 -0
- package/build/utils/other/compliance.d.ts +49 -0
- package/build/utils/other/compliance.js +76 -0
- package/build/utils/other/edelivery.d.ts +310 -0
- package/build/utils/other/edelivery.js +241 -0
- package/build/utils/other/identity.d.ts +13 -0
- package/build/utils/other/identity.js +13 -0
- package/build/utils/other/translation.d.ts +28 -0
- package/build/utils/other/translation.js +41 -0
- package/build/utils/other/vero.d.ts +61 -0
- package/build/utils/other/vero.js +90 -0
- package/build/utils/scope-helper.d.ts +49 -0
- package/build/utils/scope-helper.js +207 -0
- package/build/utils/security-checker.d.ts +46 -0
- package/build/utils/security-checker.js +248 -0
- package/build/utils/setup-validator.d.ts +25 -0
- package/build/utils/setup-validator.js +305 -0
- package/build/utils/token-utils.d.ts +40 -0
- package/build/utils/token-utils.js +40 -0
- package/package.json +115 -0
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Taxonomy API - Category trees and hierarchies
|
|
3
|
+
* Based on: eBay Commerce Taxonomy API
|
|
4
|
+
*/
|
|
5
|
+
export class TaxonomyApi {
|
|
6
|
+
client;
|
|
7
|
+
basePath = '/commerce/taxonomy/v1';
|
|
8
|
+
constructor(client) {
|
|
9
|
+
this.client = client;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Get the default category tree ID for a marketplace
|
|
13
|
+
*/
|
|
14
|
+
async getDefaultCategoryTreeId(marketplaceId) {
|
|
15
|
+
return await this.client.get(`${this.basePath}/get_default_category_tree_id`, {
|
|
16
|
+
marketplace_id: marketplaceId,
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Get category tree
|
|
21
|
+
*/
|
|
22
|
+
async getCategoryTree(categoryTreeId) {
|
|
23
|
+
return await this.client.get(`${this.basePath}/category_tree/${categoryTreeId}`);
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Get category subtree
|
|
27
|
+
*/
|
|
28
|
+
async getCategorySubtree(categoryTreeId, categoryId) {
|
|
29
|
+
return await this.client.get(`${this.basePath}/category_tree/${categoryTreeId}/get_category_subtree`, { category_id: categoryId });
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Get category suggestions
|
|
33
|
+
*/
|
|
34
|
+
async getCategorySuggestions(categoryTreeId, query) {
|
|
35
|
+
return await this.client.get(`${this.basePath}/category_tree/${categoryTreeId}/get_category_suggestions`, { q: query });
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Get item aspects for category
|
|
39
|
+
*/
|
|
40
|
+
async getItemAspectsForCategory(categoryTreeId, categoryId) {
|
|
41
|
+
return await this.client.get(`${this.basePath}/category_tree/${categoryTreeId}/get_item_aspects_for_category`, { category_id: categoryId });
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Get compatibility properties
|
|
45
|
+
*/
|
|
46
|
+
async getCompatibilityProperties(categoryTreeId, categoryId) {
|
|
47
|
+
return await this.client.get(`${this.basePath}/category_tree/${categoryTreeId}/get_compatibility_properties`, { category_id: categoryId });
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Get compatibility property values
|
|
51
|
+
*/
|
|
52
|
+
async getCompatibilityPropertyValues(categoryTreeId, categoryId, compatibilityProperty) {
|
|
53
|
+
return await this.client.get(`${this.basePath}/category_tree/${categoryTreeId}/get_compatibility_property_values`, {
|
|
54
|
+
category_id: categoryId,
|
|
55
|
+
compatibility_property: compatibilityProperty,
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
}
|
|
@@ -0,0 +1,395 @@
|
|
|
1
|
+
import type { EbayApiClient } from '../../api/client.js';
|
|
2
|
+
import type { components } from '../../types/sell-apps/markeitng-and-promotions/sellMarketingV1Oas3.js';
|
|
3
|
+
type AdGroupRequest = components['schemas']['CreateAdGroupRequest'];
|
|
4
|
+
type BulkCreateAdRequest = components['schemas']['BulkCreateAdRequest'];
|
|
5
|
+
type BulkCreateAdsByInventoryReferenceRequest = components['schemas']['BulkCreateAdsByInventoryReferenceRequest'];
|
|
6
|
+
type BulkCreateKeywordsRequest = components['schemas']['BulkCreateKeywordRequest'];
|
|
7
|
+
type BulkDeleteAdRequest = components['schemas']['BulkDeleteAdRequest'];
|
|
8
|
+
type BulkDeleteKeywordsRequest = components['schemas']['BulkDeleteAdRequest'];
|
|
9
|
+
type BulkUpdateAdStatusByListingIdRequest = components['schemas']['BulkUpdateAdStatusByListingIdRequest'];
|
|
10
|
+
type BulkUpdateAdStatusRequest = components['schemas']['BulkUpdateAdStatusRequest'];
|
|
11
|
+
type BulkUpdateKeywordBidsRequest = components['schemas']['BulkUpdateKeywordRequest'];
|
|
12
|
+
type CloneCampaignRequest = components['schemas']['CloneCampaignRequest'];
|
|
13
|
+
type CreateAdRequest = components['schemas']['CreateAdRequest'];
|
|
14
|
+
type CreateAdsByInventoryReferenceRequest = components['schemas']['CreateAdsByInventoryReferenceRequest'];
|
|
15
|
+
type CreateCampaignRequest = components['schemas']['CreateCampaignRequest'];
|
|
16
|
+
type CreateKeywordRequest = components['schemas']['CreateKeywordRequest'];
|
|
17
|
+
type CreateNegativeKeywordRequest = components['schemas']['CreateNegativeKeywordRequest'];
|
|
18
|
+
type CreateReportTask = components['schemas']['CreateReportTask'];
|
|
19
|
+
type ItemPromotion = components['schemas']['ItemPromotion'];
|
|
20
|
+
type UpdateBidPercentageRequest = components['schemas']['UpdateBidPercentageRequest'];
|
|
21
|
+
type UpdateCampaignIdentificationRequest = components['schemas']['UpdateCampaignIdentificationRequest'];
|
|
22
|
+
type Ad = components['schemas']['Ad'];
|
|
23
|
+
type AdGroup = components['schemas']['AdGroup'];
|
|
24
|
+
type AdGroupPagedCollection = components['schemas']['AdGroupPagedCollectionResponse'];
|
|
25
|
+
type AdPagedCollectionResponse = components['schemas']['AdPagedCollectionResponse'];
|
|
26
|
+
type AdReferences = components['schemas']['AdReferences'];
|
|
27
|
+
type Ads = components['schemas']['Ads'];
|
|
28
|
+
type BaseResponse = components['schemas']['BaseResponse'];
|
|
29
|
+
type BulkAdResponse = components['schemas']['BulkAdResponse'];
|
|
30
|
+
type BulkAdUpdateResponse = components['schemas']['BulkAdUpdateResponse'];
|
|
31
|
+
type BulkAdUpdateStatusByListingIdResponse = components['schemas']['BulkAdUpdateStatusByListingIdResponse'];
|
|
32
|
+
type BulkAdUpdateStatusResponse = components['schemas']['BulkAdUpdateStatusResponse'];
|
|
33
|
+
type BulkCreateAdsByInventoryReferenceResponse = components['schemas']['BulkCreateAdsByInventoryReferenceResponse'];
|
|
34
|
+
type BulkCreateKeywordsResponse = components['schemas']['BulkCreateKeywordResponse'];
|
|
35
|
+
type BulkDeleteAdResponse = components['schemas']['BulkDeleteAdResponse'];
|
|
36
|
+
type BulkDeleteAdsByInventoryReferenceResponse = components['schemas']['BulkDeleteAdsByInventoryReferenceResponse'];
|
|
37
|
+
type BulkUpdateAdsByInventoryReferenceResponse = components['schemas']['BulkUpdateAdsByInventoryReferenceResponse'];
|
|
38
|
+
type BulkUpdateKeywordBidsResponse = components['schemas']['BulkUpdateKeywordResponse'];
|
|
39
|
+
type Campaign = components['schemas']['Campaign'];
|
|
40
|
+
type CampaignPagedCollectionResponse = components['schemas']['CampaignPagedCollectionResponse'];
|
|
41
|
+
type Keyword = components['schemas']['Keyword'];
|
|
42
|
+
type KeywordPagedCollection = components['schemas']['KeywordPagedCollectionResponse'];
|
|
43
|
+
type NegativeKeyword = components['schemas']['NegativeKeyword'];
|
|
44
|
+
type NegativeKeywordPagedCollection = components['schemas']['NegativeKeywordPagedCollectionResponse'];
|
|
45
|
+
type PromotionsReportPagedCollection = components['schemas']['PromotionsReportPagedCollection'];
|
|
46
|
+
type ReportMetadata = components['schemas']['ReportMetadata'];
|
|
47
|
+
type ReportMetadatas = components['schemas']['ReportMetadatas'];
|
|
48
|
+
type ReportTask = components['schemas']['ReportTask'];
|
|
49
|
+
type ReportTaskPagedCollection = components['schemas']['ReportTaskPagedCollection'];
|
|
50
|
+
type SuggestedBids = components['schemas']['SuggestedBids'];
|
|
51
|
+
type SuggestedKeywords = components['schemas']['SuggestedKeywords'];
|
|
52
|
+
type SummaryReportResponse = components['schemas']['SummaryReportResponse'];
|
|
53
|
+
type BulkCreateNegativeKeywordRequest = components['schemas']['BulkCreateNegativeKeywordRequest'];
|
|
54
|
+
type BulkCreateNegativeKeywordResponse = components['schemas']['BulkCreateNegativeKeywordResponse'];
|
|
55
|
+
type BulkUpdateNegativeKeywordRequest = components['schemas']['BulkUpdateNegativeKeywordRequest'];
|
|
56
|
+
type BulkUpdateNegativeKeywordResponse = components['schemas']['BulkUpdateNegativeKeywordResponse'];
|
|
57
|
+
type NegativeKeywordRequest = components['schemas']['UpdateNegativeKeywordRequest'];
|
|
58
|
+
type BulkDeleteAdsByInventoryReferenceRequest = Record<string, unknown>;
|
|
59
|
+
type CreateAdGroupRequest = AdGroupRequest;
|
|
60
|
+
type UpdateKeywordByKeywordIdRequest = Record<string, unknown>;
|
|
61
|
+
type SuggestKeywordsRequest = Record<string, unknown>;
|
|
62
|
+
type UpdateBidRequest = Record<string, unknown>;
|
|
63
|
+
type ItemPromotionRequest = Record<string, unknown>;
|
|
64
|
+
type ItemPromotionResponse = Record<string, unknown>;
|
|
65
|
+
type ItemPromotionsPagedCollection = Record<string, unknown>;
|
|
66
|
+
type TargetingRequest = Record<string, unknown>;
|
|
67
|
+
type TargetingResponse = Record<string, unknown>;
|
|
68
|
+
type BulkDeleteKeywordsResponse = Record<string, unknown>;
|
|
69
|
+
type CreateKeywordResponse = Record<string, unknown>;
|
|
70
|
+
type BulkDeleteNegativeKeywordRequest = Record<string, unknown>;
|
|
71
|
+
type BulkDeleteNegativeKeywordResponse = Record<string, unknown>;
|
|
72
|
+
type Report = Record<string, unknown>;
|
|
73
|
+
type BulkUpdateKeywordRequest = BulkUpdateKeywordBidsRequest;
|
|
74
|
+
/**
|
|
75
|
+
* Marketing API - Marketing campaigns and promotions
|
|
76
|
+
* Based on: docs/sell-apps/marketing-and-promotions/sell_marketing_v1_oas3.json
|
|
77
|
+
*/
|
|
78
|
+
export declare class MarketingApi {
|
|
79
|
+
private client;
|
|
80
|
+
private readonly basePath;
|
|
81
|
+
constructor(client: EbayApiClient);
|
|
82
|
+
/**
|
|
83
|
+
* Get campaigns
|
|
84
|
+
*/
|
|
85
|
+
getCampaigns(campaignStatus?: string, marketplaceId?: string, limit?: number): Promise<CampaignPagedCollectionResponse>;
|
|
86
|
+
/**
|
|
87
|
+
* Get a specific campaign
|
|
88
|
+
*/
|
|
89
|
+
getCampaign(campaignId: string): Promise<Campaign>;
|
|
90
|
+
/**
|
|
91
|
+
* Create a campaign
|
|
92
|
+
*/
|
|
93
|
+
createCampaign(campaign: CreateCampaignRequest): Promise<BaseResponse>;
|
|
94
|
+
/**
|
|
95
|
+
* Get promotions
|
|
96
|
+
*/
|
|
97
|
+
getPromotions(marketplaceId?: string, limit?: number): Promise<ItemPromotionsPagedCollection>;
|
|
98
|
+
/**
|
|
99
|
+
* Create a promotion (item promotion)
|
|
100
|
+
*/
|
|
101
|
+
createPromotion(promotion: ItemPromotion): Promise<BaseResponse>;
|
|
102
|
+
/**
|
|
103
|
+
* Get ads for a campaign
|
|
104
|
+
*/
|
|
105
|
+
getAds(campaignId: string, adGroupIds?: string, adStatus?: string, limit?: number, listingIds?: string, offset?: number): Promise<AdPagedCollectionResponse>;
|
|
106
|
+
/**
|
|
107
|
+
* Create an ad for a campaign
|
|
108
|
+
*/
|
|
109
|
+
createAd(campaignId: string, ad: CreateAdRequest): Promise<BaseResponse>;
|
|
110
|
+
/**
|
|
111
|
+
* Create ads by inventory reference for a campaign
|
|
112
|
+
*/
|
|
113
|
+
createAdsByInventoryReference(campaignId: string, ads: CreateAdsByInventoryReferenceRequest): Promise<AdReferences>;
|
|
114
|
+
/**
|
|
115
|
+
* Get a specific ad for a campaign
|
|
116
|
+
*/
|
|
117
|
+
getAd(campaignId: string, adId: string): Promise<Ad>;
|
|
118
|
+
/**
|
|
119
|
+
* Delete a specific ad from a campaign
|
|
120
|
+
*/
|
|
121
|
+
deleteAd(campaignId: string, adId: string): Promise<void>;
|
|
122
|
+
/**
|
|
123
|
+
* Clone an ad for a campaign
|
|
124
|
+
*/
|
|
125
|
+
cloneAd(campaignId: string, adId: string, ad: CreateAdRequest): Promise<BaseResponse>;
|
|
126
|
+
/**
|
|
127
|
+
* Get ads by inventory reference for a campaign
|
|
128
|
+
*/
|
|
129
|
+
getAdsByInventoryReference(campaignId: string, inventoryReferenceId: string, inventoryReferenceType: string): Promise<Ads>;
|
|
130
|
+
/**
|
|
131
|
+
* Get ads by listing ID for a campaign
|
|
132
|
+
*/
|
|
133
|
+
getAdsByListingId(campaignId: string, listingId: string): Promise<Ads>;
|
|
134
|
+
/**
|
|
135
|
+
* Update the bid for an ad in a campaign
|
|
136
|
+
*/
|
|
137
|
+
updateBid(campaignId: string, adId: string, bid: UpdateBidPercentageRequest): Promise<void>;
|
|
138
|
+
/**
|
|
139
|
+
* Clone a campaign
|
|
140
|
+
*/
|
|
141
|
+
cloneCampaign(campaignId: string, campaign: CloneCampaignRequest): Promise<BaseResponse>;
|
|
142
|
+
/**
|
|
143
|
+
* End a campaign
|
|
144
|
+
*/
|
|
145
|
+
endCampaign(campaignId: string): Promise<void>;
|
|
146
|
+
/**
|
|
147
|
+
* Get campaign by name
|
|
148
|
+
*/
|
|
149
|
+
getCampaignByName(campaignName: string): Promise<Campaign>;
|
|
150
|
+
/**
|
|
151
|
+
* Bulk create ads by inventory reference
|
|
152
|
+
*/
|
|
153
|
+
bulkCreateAdsByInventoryReference(campaignId: string, body: BulkCreateAdsByInventoryReferenceRequest): Promise<BulkCreateAdsByInventoryReferenceResponse>;
|
|
154
|
+
/**
|
|
155
|
+
* Bulk create ads by listing id
|
|
156
|
+
*/
|
|
157
|
+
bulkCreateAdsByListingId(campaignId: string, body: BulkCreateAdRequest): Promise<BulkAdResponse>;
|
|
158
|
+
/**
|
|
159
|
+
* Bulk delete ads by inventory reference
|
|
160
|
+
*/
|
|
161
|
+
bulkDeleteAdsByInventoryReference(campaignId: string, body: BulkDeleteAdsByInventoryReferenceRequest): Promise<BulkDeleteAdsByInventoryReferenceResponse>;
|
|
162
|
+
/**
|
|
163
|
+
* Bulk delete ads by listing id
|
|
164
|
+
*/
|
|
165
|
+
bulkDeleteAdsByListingId(campaignId: string, body: BulkDeleteAdRequest): Promise<BulkDeleteAdResponse>;
|
|
166
|
+
/**
|
|
167
|
+
* Bulk update ads bid by inventory reference
|
|
168
|
+
*/
|
|
169
|
+
bulkUpdateAdsBidByInventoryReference(campaignId: string, body: BulkCreateAdsByInventoryReferenceRequest): Promise<BulkUpdateAdsByInventoryReferenceResponse>;
|
|
170
|
+
/**
|
|
171
|
+
* Bulk update ads bid by listing id
|
|
172
|
+
*/
|
|
173
|
+
bulkUpdateAdsBidByListingId(campaignId: string, body: BulkCreateAdRequest): Promise<BulkAdUpdateResponse>;
|
|
174
|
+
/**
|
|
175
|
+
* Bulk update ads status
|
|
176
|
+
*/
|
|
177
|
+
bulkUpdateAdsStatus(campaignId: string, body: BulkUpdateAdStatusRequest): Promise<BulkAdUpdateStatusResponse>;
|
|
178
|
+
/**
|
|
179
|
+
* Bulk update ads status by listing id
|
|
180
|
+
*/
|
|
181
|
+
bulkUpdateAdsStatusByListingId(campaignId: string, body: BulkUpdateAdStatusByListingIdRequest): Promise<BulkAdUpdateStatusByListingIdResponse>;
|
|
182
|
+
/**
|
|
183
|
+
* Pause a campaign
|
|
184
|
+
*/
|
|
185
|
+
pauseCampaign(campaignId: string): Promise<void>;
|
|
186
|
+
/**
|
|
187
|
+
* Resume a campaign
|
|
188
|
+
*/
|
|
189
|
+
resumeCampaign(campaignId: string): Promise<void>;
|
|
190
|
+
/**
|
|
191
|
+
* Update campaign identification
|
|
192
|
+
*/
|
|
193
|
+
updateCampaignIdentification(campaignId: string, body: UpdateCampaignIdentificationRequest): Promise<void>;
|
|
194
|
+
/**
|
|
195
|
+
* Create an ad group
|
|
196
|
+
*/
|
|
197
|
+
createAdGroup(campaignId: string, body: AdGroupRequest): Promise<BaseResponse>;
|
|
198
|
+
/**
|
|
199
|
+
* Clone an ad group
|
|
200
|
+
*/
|
|
201
|
+
cloneAdGroup(campaignId: string, adGroupId: string, body: CreateAdGroupRequest): Promise<BaseResponse>;
|
|
202
|
+
/**
|
|
203
|
+
* Get ad groups
|
|
204
|
+
*/
|
|
205
|
+
getAdGroups(campaignId: string, adGroupStatus?: string, limit?: number, offset?: number): Promise<AdGroupPagedCollection>;
|
|
206
|
+
/**
|
|
207
|
+
* Get an ad group
|
|
208
|
+
*/
|
|
209
|
+
getAdGroup(campaignId: string, adGroupId: string): Promise<AdGroup>;
|
|
210
|
+
/**
|
|
211
|
+
* Suggest bids for an ad group
|
|
212
|
+
*/
|
|
213
|
+
suggestBids(campaignId: string, adGroupId: string): Promise<SuggestedBids>;
|
|
214
|
+
/**
|
|
215
|
+
* Update ad group bids
|
|
216
|
+
*/
|
|
217
|
+
updateAdGroupBids(campaignId: string, adGroupId: string, body: UpdateKeywordByKeywordIdRequest): Promise<void>;
|
|
218
|
+
/**
|
|
219
|
+
* Update ad group keywords
|
|
220
|
+
*/
|
|
221
|
+
updateAdGroupKeywords(campaignId: string, adGroupId: string, body: BulkUpdateKeywordRequest): Promise<void>;
|
|
222
|
+
/**
|
|
223
|
+
* Suggest keywords
|
|
224
|
+
*/
|
|
225
|
+
suggestKeywords(campaignId: string, adGroupId: string, body: SuggestKeywordsRequest): Promise<SuggestedKeywords>;
|
|
226
|
+
/**
|
|
227
|
+
* Get keywords
|
|
228
|
+
*/
|
|
229
|
+
getKeywords(campaignId: string, adGroupId: string, keywordStatus?: string, limit?: number, offset?: number): Promise<KeywordPagedCollection>;
|
|
230
|
+
/**
|
|
231
|
+
* Bulk create keywords
|
|
232
|
+
*/
|
|
233
|
+
bulkCreateKeywords(campaignId: string, adGroupId: string, body: BulkCreateKeywordsRequest): Promise<BulkCreateKeywordsResponse>;
|
|
234
|
+
/**
|
|
235
|
+
* Bulk delete keywords
|
|
236
|
+
*/
|
|
237
|
+
bulkDeleteKeywords(campaignId: string, adGroupId: string, body: BulkDeleteKeywordsRequest): Promise<BulkDeleteKeywordsResponse>;
|
|
238
|
+
/**
|
|
239
|
+
* Bulk update keyword bids
|
|
240
|
+
*/
|
|
241
|
+
bulkUpdateKeywordBids(campaignId: string, adGroupId: string, body: BulkUpdateKeywordBidsRequest): Promise<BulkUpdateKeywordBidsResponse>;
|
|
242
|
+
/**
|
|
243
|
+
* Create a keyword
|
|
244
|
+
*/
|
|
245
|
+
createKeyword(campaignId: string, adGroupId: string, body: CreateKeywordRequest): Promise<CreateKeywordResponse>;
|
|
246
|
+
/**
|
|
247
|
+
* Get a keyword
|
|
248
|
+
*/
|
|
249
|
+
getKeyword(campaignId: string, adGroupId: string, keywordId: string): Promise<Keyword>;
|
|
250
|
+
/**
|
|
251
|
+
* Delete a keyword
|
|
252
|
+
*/
|
|
253
|
+
deleteKeyword(campaignId: string, adGroupId: string, keywordId: string): Promise<void>;
|
|
254
|
+
/**
|
|
255
|
+
* Update a keyword's bid
|
|
256
|
+
*/
|
|
257
|
+
updateKeywordBid(campaignId: string, adGroupId: string, keywordId: string, body: UpdateBidRequest): Promise<void>;
|
|
258
|
+
/**
|
|
259
|
+
* Get ad report
|
|
260
|
+
*/
|
|
261
|
+
getAdReport(dimension: string, metric: string, startDate: string, endDate: string, sort?: string, listingIds?: string, marketplaceId?: string): Promise<Report>;
|
|
262
|
+
/**
|
|
263
|
+
* Get ad report metadata
|
|
264
|
+
*/
|
|
265
|
+
getAdReportMetadata(): Promise<ReportMetadatas>;
|
|
266
|
+
/**
|
|
267
|
+
* Get ad report metadata for a report type
|
|
268
|
+
*/
|
|
269
|
+
getAdReportMetadataForReportType(reportType: string): Promise<ReportMetadata>;
|
|
270
|
+
/**
|
|
271
|
+
* Create a report task
|
|
272
|
+
*/
|
|
273
|
+
createReportTask(body: CreateReportTask): Promise<void>;
|
|
274
|
+
/**
|
|
275
|
+
* Get report tasks
|
|
276
|
+
*/
|
|
277
|
+
getReportTasks(reportTaskStatuses?: string, limit?: number, offset?: number): Promise<ReportTaskPagedCollection>;
|
|
278
|
+
/**
|
|
279
|
+
* Get a report task
|
|
280
|
+
*/
|
|
281
|
+
getReportTask(reportTaskId: string): Promise<ReportTask>;
|
|
282
|
+
/**
|
|
283
|
+
* Get an item promotion
|
|
284
|
+
*/
|
|
285
|
+
getItemPromotion(promotionId: string): Promise<ItemPromotionResponse>;
|
|
286
|
+
/**
|
|
287
|
+
* Delete an item promotion
|
|
288
|
+
*/
|
|
289
|
+
deleteItemPromotion(promotionId: string): Promise<void>;
|
|
290
|
+
/**
|
|
291
|
+
* Pause an item promotion
|
|
292
|
+
*/
|
|
293
|
+
pauseItemPromotion(promotionId: string): Promise<void>;
|
|
294
|
+
/**
|
|
295
|
+
* Resume an item promotion
|
|
296
|
+
*/
|
|
297
|
+
resumeItemPromotion(promotionId: string): Promise<void>;
|
|
298
|
+
/**
|
|
299
|
+
* Update an item promotion
|
|
300
|
+
*/
|
|
301
|
+
updateItemPromotion(promotionId: string, body: ItemPromotionRequest): Promise<BaseResponse>;
|
|
302
|
+
/**
|
|
303
|
+
* Get a promotion report
|
|
304
|
+
*/
|
|
305
|
+
getPromotionReport(marketplaceId: string, promotionStatus?: string, limit?: number, offset?: number): Promise<PromotionsReportPagedCollection>;
|
|
306
|
+
/**
|
|
307
|
+
* Get a promotion summary report
|
|
308
|
+
*/
|
|
309
|
+
getPromotionSummaryReport(marketplaceId: string): Promise<SummaryReportResponse>;
|
|
310
|
+
/**
|
|
311
|
+
* Get promotion summary (alias for getPromotionSummaryReport)
|
|
312
|
+
*/
|
|
313
|
+
getPromotionSummary(marketplaceId: string): Promise<SummaryReportResponse>;
|
|
314
|
+
/**
|
|
315
|
+
* Get promotion reports (alias for getPromotionReport)
|
|
316
|
+
*/
|
|
317
|
+
getPromotionReports(marketplaceId: string, promotionStatus?: string, limit?: number, offset?: number): Promise<PromotionsReportPagedCollection>;
|
|
318
|
+
/**
|
|
319
|
+
* Get targeting for a campaign
|
|
320
|
+
*/
|
|
321
|
+
getTargeting(campaignId: string): Promise<TargetingResponse>;
|
|
322
|
+
/**
|
|
323
|
+
* Create targeting for a campaign
|
|
324
|
+
*/
|
|
325
|
+
createTargeting(campaignId: string, body: TargetingRequest): Promise<void>;
|
|
326
|
+
/**
|
|
327
|
+
* Update targeting for a campaign
|
|
328
|
+
*/
|
|
329
|
+
updateTargeting(campaignId: string, body: TargetingRequest): Promise<void>;
|
|
330
|
+
/**
|
|
331
|
+
* Get negative keywords for a campaign
|
|
332
|
+
*/
|
|
333
|
+
getNegativeKeywords(campaignId: string, limit?: number, offset?: number): Promise<NegativeKeywordPagedCollection>;
|
|
334
|
+
/**
|
|
335
|
+
* Create a negative keyword for a campaign
|
|
336
|
+
*/
|
|
337
|
+
createNegativeKeyword(campaignId: string, body: CreateNegativeKeywordRequest): Promise<BaseResponse>;
|
|
338
|
+
/**
|
|
339
|
+
* Bulk create negative keywords for a campaign
|
|
340
|
+
*/
|
|
341
|
+
bulkCreateNegativeKeywords(campaignId: string, body: BulkCreateNegativeKeywordRequest): Promise<BulkCreateNegativeKeywordResponse>;
|
|
342
|
+
/**
|
|
343
|
+
* Bulk delete negative keywords for a campaign
|
|
344
|
+
*/
|
|
345
|
+
bulkDeleteNegativeKeywords(campaignId: string, body: BulkDeleteNegativeKeywordRequest): Promise<BulkDeleteNegativeKeywordResponse>;
|
|
346
|
+
/**
|
|
347
|
+
* Bulk update negative keywords for a campaign
|
|
348
|
+
*/
|
|
349
|
+
bulkUpdateNegativeKeywords(campaignId: string, body: BulkUpdateNegativeKeywordRequest): Promise<BulkUpdateNegativeKeywordResponse>;
|
|
350
|
+
/**
|
|
351
|
+
* Get a negative keyword for a campaign
|
|
352
|
+
*/
|
|
353
|
+
getNegativeKeyword(campaignId: string, negativeKeywordId: string): Promise<NegativeKeyword>;
|
|
354
|
+
/**
|
|
355
|
+
* Delete a negative keyword for a campaign
|
|
356
|
+
*/
|
|
357
|
+
deleteNegativeKeyword(campaignId: string, negativeKeywordId: string): Promise<void>;
|
|
358
|
+
/**
|
|
359
|
+
* Update a negative keyword for a campaign
|
|
360
|
+
*/
|
|
361
|
+
updateNegativeKeyword(campaignId: string, negativeKeywordId: string, body: NegativeKeywordRequest): Promise<BaseResponse>;
|
|
362
|
+
/**
|
|
363
|
+
* Get negative keywords for an ad group
|
|
364
|
+
*/
|
|
365
|
+
getNegativeKeywordsForAdGroup(adGroupId: string, limit?: number, offset?: number): Promise<NegativeKeywordPagedCollection>;
|
|
366
|
+
/**
|
|
367
|
+
* Create a negative keyword for an ad group
|
|
368
|
+
*/
|
|
369
|
+
createNegativeKeywordForAdGroup(adGroupId: string, body: CreateNegativeKeywordRequest): Promise<BaseResponse>;
|
|
370
|
+
/**
|
|
371
|
+
* Bulk create negative keywords for an ad group
|
|
372
|
+
*/
|
|
373
|
+
bulkCreateNegativeKeywordsForAdGroup(adGroupId: string, body: BulkCreateNegativeKeywordRequest): Promise<BulkCreateNegativeKeywordResponse>;
|
|
374
|
+
/**
|
|
375
|
+
* Bulk delete negative keywords for an ad group
|
|
376
|
+
*/
|
|
377
|
+
bulkDeleteNegativeKeywordsForAdGroup(adGroupId: string, body: BulkDeleteNegativeKeywordRequest): Promise<BulkDeleteNegativeKeywordResponse>;
|
|
378
|
+
/**
|
|
379
|
+
* Bulk update negative keywords for an ad group
|
|
380
|
+
*/
|
|
381
|
+
bulkUpdateNegativeKeywordsForAdGroup(adGroupId: string, body: BulkUpdateNegativeKeywordRequest): Promise<BulkUpdateNegativeKeywordResponse>;
|
|
382
|
+
/**
|
|
383
|
+
* Get a negative keyword for an ad group
|
|
384
|
+
*/
|
|
385
|
+
getNegativeKeywordForAdGroup(adGroupId: string, negativeKeywordId: string): Promise<NegativeKeyword>;
|
|
386
|
+
/**
|
|
387
|
+
* Delete a negative keyword for an ad group
|
|
388
|
+
*/
|
|
389
|
+
deleteNegativeKeywordForAdGroup(adGroupId: string, negativeKeywordId: string): Promise<void>;
|
|
390
|
+
/**
|
|
391
|
+
* Update a negative keyword for an ad group
|
|
392
|
+
*/
|
|
393
|
+
updateNegativeKeywordForAdGroup(adGroupId: string, negativeKeywordId: string, body: NegativeKeywordRequest): Promise<BaseResponse>;
|
|
394
|
+
}
|
|
395
|
+
export {};
|