ebay-api 8.5.1 → 8.6.1
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/README.md +2 -2
- package/dist/api/apiFactory.d.ts +0 -3
- package/dist/api/apiFactory.js +0 -4
- package/dist/api/base.d.ts +0 -3
- package/dist/api/base.js +0 -3
- package/dist/api/digitalSignature.d.ts +0 -33
- package/dist/api/digitalSignature.js +1 -41
- package/dist/api/index.d.ts +0 -3
- package/dist/api/index.js +0 -3
- package/dist/api/restful/buy/browse/index.d.ts +0 -66
- package/dist/api/restful/buy/browse/index.js +0 -73
- package/dist/api/restful/buy/deal/index.d.ts +0 -32
- package/dist/api/restful/buy/deal/index.js +0 -32
- package/dist/api/restful/buy/feed/index.d.ts +0 -33
- package/dist/api/restful/buy/feed/index.js +0 -33
- package/dist/api/restful/buy/marketing/index.d.ts +0 -18
- package/dist/api/restful/buy/marketing/index.js +0 -22
- package/dist/api/restful/buy/marketplaceInsights/index.d.ts +0 -21
- package/dist/api/restful/buy/marketplaceInsights/index.js +0 -21
- package/dist/api/restful/buy/offer/index.d.ts +0 -15
- package/dist/api/restful/buy/offer/index.js +0 -15
- package/dist/api/restful/buy/order/index.d.ts +0 -227
- package/dist/api/restful/buy/order/index.js +0 -227
- package/dist/api/restful/commerce/catalog/index.d.ts +0 -54
- package/dist/api/restful/commerce/catalog/index.js +0 -54
- package/dist/api/restful/commerce/charity/index.d.ts +0 -21
- package/dist/api/restful/commerce/charity/index.js +0 -21
- package/dist/api/restful/commerce/identity/index.d.ts +0 -7
- package/dist/api/restful/commerce/identity/index.js +0 -7
- package/dist/api/restful/commerce/notification/index.d.ts +0 -93
- package/dist/api/restful/commerce/notification/index.js +0 -93
- package/dist/api/restful/commerce/taxonomy/index.d.ts +0 -64
- package/dist/api/restful/commerce/taxonomy/index.js +0 -64
- package/dist/api/restful/commerce/translation/index.d.ts +0 -8
- package/dist/api/restful/commerce/translation/index.js +0 -8
- package/dist/api/restful/developer/analytics/index.d.ts +0 -15
- package/dist/api/restful/developer/analytics/index.js +0 -15
- package/dist/api/restful/developer/keyManagement/index.d.ts +0 -15
- package/dist/api/restful/developer/keyManagement/index.js +0 -15
- package/dist/api/restful/index.d.ts +0 -16
- package/dist/api/restful/index.js +1 -23
- package/dist/api/restful/postOrder/cancellation/index.d.ts +0 -43
- package/dist/api/restful/postOrder/cancellation/index.js +1 -46
- package/dist/api/restful/postOrder/case/index.d.ts +0 -46
- package/dist/api/restful/postOrder/case/index.js +0 -46
- package/dist/api/restful/postOrder/inquiry/index.d.ts +0 -64
- package/dist/api/restful/postOrder/inquiry/index.js +0 -64
- package/dist/api/restful/postOrder/return/index.d.ts +0 -190
- package/dist/api/restful/postOrder/return/index.js +0 -190
- package/dist/api/restful/sell/account/index.d.ts +0 -241
- package/dist/api/restful/sell/account/index.js +0 -241
- package/dist/api/restful/sell/analytics/index.d.ts +0 -26
- package/dist/api/restful/sell/analytics/index.js +0 -26
- package/dist/api/restful/sell/compliance/index.d.ts +0 -23
- package/dist/api/restful/sell/compliance/index.js +0 -23
- package/dist/api/restful/sell/feed/index.d.ts +0 -135
- package/dist/api/restful/sell/feed/index.js +0 -135
- package/dist/api/restful/sell/finances/index.d.ts +0 -51
- package/dist/api/restful/sell/finances/index.js +0 -51
- package/dist/api/restful/sell/fulfillment/index.d.ts +0 -108
- package/dist/api/restful/sell/fulfillment/index.js +0 -108
- package/dist/api/restful/sell/inventory/index.d.ts +0 -197
- package/dist/api/restful/sell/inventory/index.js +0 -197
- package/dist/api/restful/sell/listing/index.d.ts +0 -8
- package/dist/api/restful/sell/listing/index.js +0 -8
- package/dist/api/restful/sell/logistics/index.d.ts +0 -33
- package/dist/api/restful/sell/logistics/index.js +0 -33
- package/dist/api/restful/sell/marketing/index.d.ts +16 -495
- package/dist/api/restful/sell/marketing/index.js +48 -494
- package/dist/api/restful/sell/metadata/index.d.ts +0 -65
- package/dist/api/restful/sell/metadata/index.js +0 -65
- package/dist/api/restful/sell/negotiation/index.d.ts +0 -14
- package/dist/api/restful/sell/negotiation/index.js +0 -14
- package/dist/api/restful/sell/recommendation/index.d.ts +0 -15
- package/dist/api/restful/sell/recommendation/index.js +0 -15
- package/dist/api/traditional/XMLRequest.d.ts +0 -44
- package/dist/api/traditional/XMLRequest.js +0 -46
- package/dist/api/traditional/clientAlerts/index.js +0 -1
- package/dist/api/traditional/index.d.ts +0 -3
- package/dist/api/traditional/index.js +0 -5
- package/dist/api/traditional/shopping/index.js +0 -1
- package/dist/auth/authNAuth.d.ts +0 -5
- package/dist/auth/authNAuth.js +0 -5
- package/dist/auth/index.d.ts +0 -3
- package/dist/auth/index.js +0 -3
- package/dist/auth/oAuth2.d.ts +0 -52
- package/dist/auth/oAuth2.js +0 -53
- package/dist/eBayApi.d.ts +0 -11
- package/dist/eBayApi.js +0 -14
- package/dist/ebay-api.min.mjs +1 -1
- package/dist/enums/restfulEnums.d.ts +0 -5
- package/dist/enums/restfulEnums.js +0 -5
- package/dist/errors/index.d.ts +0 -19
- package/dist/errors/index.js +1 -21
- package/dist/types/restful/specs/buy_browse_v1_oas3.d.ts +0 -697
- package/dist/types/restful/specs/buy_browse_v1_oas3.js +0 -4
- package/dist/types/restful/specs/buy_deal_v1_oas3.d.ts +0 -189
- package/dist/types/restful/specs/buy_deal_v1_oas3.js +0 -4
- package/dist/types/restful/specs/buy_feed_v1_beta_oas3.d.ts +0 -229
- package/dist/types/restful/specs/buy_feed_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/buy_marketing_v1_beta_oas3.d.ts +0 -101
- package/dist/types/restful/specs/buy_marketing_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.d.ts +0 -150
- package/dist/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/buy_offer_v1_beta_oas3.d.ts +0 -62
- package/dist/types/restful/specs/buy_offer_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/buy_order_v1_beta_oas3.d.ts +0 -600
- package/dist/types/restful/specs/buy_order_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/cancellation_oas3.d.ts +0 -29
- package/dist/types/restful/specs/cancellation_oas3.js +0 -4
- package/dist/types/restful/specs/case_oas3.d.ts +0 -31
- package/dist/types/restful/specs/case_oas3.js +0 -4
- package/dist/types/restful/specs/commerce_catalog_v1_beta_oas3.d.ts +0 -331
- package/dist/types/restful/specs/commerce_catalog_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/commerce_charity_v1_oas3.d.ts +0 -85
- package/dist/types/restful/specs/commerce_charity_v1_oas3.js +0 -4
- package/dist/types/restful/specs/commerce_identity_v1_oas3.d.ts +0 -63
- package/dist/types/restful/specs/commerce_identity_v1_oas3.js +0 -4
- package/dist/types/restful/specs/commerce_notification_v1_oas3.d.ts +0 -236
- package/dist/types/restful/specs/commerce_notification_v1_oas3.js +0 -4
- package/dist/types/restful/specs/commerce_taxonomy_v1_oas3.d.ts +0 -219
- package/dist/types/restful/specs/commerce_taxonomy_v1_oas3.js +0 -4
- package/dist/types/restful/specs/commerce_translation_v1_beta_oas3.d.ts +0 -36
- package/dist/types/restful/specs/commerce_translation_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/developer_analytics_v1_beta_oas3.d.ts +0 -57
- package/dist/types/restful/specs/developer_analytics_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/developer_key_management_v1_oas3.d.ts +0 -60
- package/dist/types/restful/specs/developer_key_management_v1_oas3.js +0 -4
- package/dist/types/restful/specs/inquiry_oas3.d.ts +0 -45
- package/dist/types/restful/specs/inquiry_oas3.js +0 -4
- package/dist/types/restful/specs/return_oas3.d.ts +0 -130
- package/dist/types/restful/specs/return_oas3.js +0 -4
- package/dist/types/restful/specs/sell_account_v1_oas3.d.ts +0 -751
- package/dist/types/restful/specs/sell_account_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_analytics_v1_oas3.d.ts +0 -130
- package/dist/types/restful/specs/sell_analytics_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_compliance_v1_oas3.d.ts +0 -102
- package/dist/types/restful/specs/sell_compliance_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_feed_v1_oas3.d.ts +0 -461
- package/dist/types/restful/specs/sell_feed_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_finances_v1_oas3.d.ts +0 -255
- package/dist/types/restful/specs/sell_finances_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_fulfillment_v1_oas3.d.ts +0 -595
- package/dist/types/restful/specs/sell_fulfillment_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_inventory_v1_oas3.d.ts +0 -844
- package/dist/types/restful/specs/sell_inventory_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_listing_v1_beta_oas3.d.ts +0 -57
- package/dist/types/restful/specs/sell_listing_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/sell_logistics_v1_oas3.d.ts +0 -173
- package/dist/types/restful/specs/sell_logistics_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_marketing_v1_oas3.d.ts +454 -1411
- package/dist/types/restful/specs/sell_marketing_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_metadata_v1_oas3.d.ts +0 -147
- package/dist/types/restful/specs/sell_metadata_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_negotiation_v1_oas3.d.ts +0 -94
- package/dist/types/restful/specs/sell_negotiation_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_recommendation_v1_oas3.d.ts +0 -60
- package/dist/types/restful/specs/sell_recommendation_v1_oas3.js +0 -4
- package/dist/types/restfulTypes.d.ts +3 -0
- package/lib/api/apiFactory.d.ts +0 -3
- package/lib/api/apiFactory.js +0 -4
- package/lib/api/base.d.ts +0 -3
- package/lib/api/base.js +0 -3
- package/lib/api/digitalSignature.d.ts +0 -33
- package/lib/api/digitalSignature.js +1 -41
- package/lib/api/index.d.ts +0 -3
- package/lib/api/index.js +0 -3
- package/lib/api/restful/buy/browse/index.d.ts +0 -66
- package/lib/api/restful/buy/browse/index.js +0 -73
- package/lib/api/restful/buy/deal/index.d.ts +0 -32
- package/lib/api/restful/buy/deal/index.js +0 -32
- package/lib/api/restful/buy/feed/index.d.ts +0 -33
- package/lib/api/restful/buy/feed/index.js +0 -33
- package/lib/api/restful/buy/marketing/index.d.ts +0 -18
- package/lib/api/restful/buy/marketing/index.js +0 -22
- package/lib/api/restful/buy/marketplaceInsights/index.d.ts +0 -21
- package/lib/api/restful/buy/marketplaceInsights/index.js +0 -21
- package/lib/api/restful/buy/offer/index.d.ts +0 -15
- package/lib/api/restful/buy/offer/index.js +0 -15
- package/lib/api/restful/buy/order/index.d.ts +0 -227
- package/lib/api/restful/buy/order/index.js +0 -227
- package/lib/api/restful/commerce/catalog/index.d.ts +0 -54
- package/lib/api/restful/commerce/catalog/index.js +0 -54
- package/lib/api/restful/commerce/charity/index.d.ts +0 -21
- package/lib/api/restful/commerce/charity/index.js +0 -21
- package/lib/api/restful/commerce/identity/index.d.ts +0 -7
- package/lib/api/restful/commerce/identity/index.js +0 -7
- package/lib/api/restful/commerce/notification/index.d.ts +0 -93
- package/lib/api/restful/commerce/notification/index.js +0 -93
- package/lib/api/restful/commerce/taxonomy/index.d.ts +0 -64
- package/lib/api/restful/commerce/taxonomy/index.js +0 -64
- package/lib/api/restful/commerce/translation/index.d.ts +0 -8
- package/lib/api/restful/commerce/translation/index.js +0 -8
- package/lib/api/restful/developer/analytics/index.d.ts +0 -15
- package/lib/api/restful/developer/analytics/index.js +0 -15
- package/lib/api/restful/developer/keyManagement/index.d.ts +0 -15
- package/lib/api/restful/developer/keyManagement/index.js +0 -15
- package/lib/api/restful/index.d.ts +0 -16
- package/lib/api/restful/index.js +1 -23
- package/lib/api/restful/postOrder/cancellation/index.d.ts +0 -43
- package/lib/api/restful/postOrder/cancellation/index.js +1 -46
- package/lib/api/restful/postOrder/case/index.d.ts +0 -46
- package/lib/api/restful/postOrder/case/index.js +0 -46
- package/lib/api/restful/postOrder/inquiry/index.d.ts +0 -64
- package/lib/api/restful/postOrder/inquiry/index.js +0 -64
- package/lib/api/restful/postOrder/return/index.d.ts +0 -190
- package/lib/api/restful/postOrder/return/index.js +0 -190
- package/lib/api/restful/sell/account/index.d.ts +0 -241
- package/lib/api/restful/sell/account/index.js +0 -241
- package/lib/api/restful/sell/analytics/index.d.ts +0 -26
- package/lib/api/restful/sell/analytics/index.js +0 -26
- package/lib/api/restful/sell/compliance/index.d.ts +0 -23
- package/lib/api/restful/sell/compliance/index.js +0 -23
- package/lib/api/restful/sell/feed/index.d.ts +0 -135
- package/lib/api/restful/sell/feed/index.js +0 -135
- package/lib/api/restful/sell/finances/index.d.ts +0 -51
- package/lib/api/restful/sell/finances/index.js +0 -51
- package/lib/api/restful/sell/fulfillment/index.d.ts +0 -108
- package/lib/api/restful/sell/fulfillment/index.js +0 -108
- package/lib/api/restful/sell/inventory/index.d.ts +0 -197
- package/lib/api/restful/sell/inventory/index.js +0 -197
- package/lib/api/restful/sell/listing/index.d.ts +0 -8
- package/lib/api/restful/sell/listing/index.js +0 -8
- package/lib/api/restful/sell/logistics/index.d.ts +0 -33
- package/lib/api/restful/sell/logistics/index.js +0 -33
- package/lib/api/restful/sell/marketing/index.d.ts +16 -495
- package/lib/api/restful/sell/marketing/index.js +48 -494
- package/lib/api/restful/sell/metadata/index.d.ts +0 -65
- package/lib/api/restful/sell/metadata/index.js +0 -65
- package/lib/api/restful/sell/negotiation/index.d.ts +0 -14
- package/lib/api/restful/sell/negotiation/index.js +0 -14
- package/lib/api/restful/sell/recommendation/index.d.ts +0 -15
- package/lib/api/restful/sell/recommendation/index.js +0 -15
- package/lib/api/traditional/XMLRequest.d.ts +0 -44
- package/lib/api/traditional/XMLRequest.js +0 -46
- package/lib/api/traditional/clientAlerts/index.js +0 -1
- package/lib/api/traditional/index.d.ts +0 -3
- package/lib/api/traditional/index.js +0 -5
- package/lib/api/traditional/shopping/index.js +0 -1
- package/lib/auth/authNAuth.d.ts +0 -5
- package/lib/auth/authNAuth.js +0 -5
- package/lib/auth/index.d.ts +0 -3
- package/lib/auth/index.js +0 -3
- package/lib/auth/oAuth2.d.ts +0 -52
- package/lib/auth/oAuth2.js +0 -53
- package/lib/eBayApi.d.ts +0 -11
- package/lib/eBayApi.js +0 -14
- package/lib/ebay-api.min.js +1 -1
- package/lib/enums/restfulEnums.d.ts +0 -5
- package/lib/enums/restfulEnums.js +0 -5
- package/lib/errors/index.d.ts +0 -19
- package/lib/errors/index.js +1 -21
- package/lib/types/restful/specs/buy_browse_v1_oas3.d.ts +0 -697
- package/lib/types/restful/specs/buy_browse_v1_oas3.js +0 -4
- package/lib/types/restful/specs/buy_deal_v1_oas3.d.ts +0 -189
- package/lib/types/restful/specs/buy_deal_v1_oas3.js +0 -4
- package/lib/types/restful/specs/buy_feed_v1_beta_oas3.d.ts +0 -229
- package/lib/types/restful/specs/buy_feed_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/buy_marketing_v1_beta_oas3.d.ts +0 -101
- package/lib/types/restful/specs/buy_marketing_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.d.ts +0 -150
- package/lib/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/buy_offer_v1_beta_oas3.d.ts +0 -62
- package/lib/types/restful/specs/buy_offer_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/buy_order_v1_beta_oas3.d.ts +0 -600
- package/lib/types/restful/specs/buy_order_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/cancellation_oas3.d.ts +0 -29
- package/lib/types/restful/specs/cancellation_oas3.js +0 -4
- package/lib/types/restful/specs/case_oas3.d.ts +0 -31
- package/lib/types/restful/specs/case_oas3.js +0 -4
- package/lib/types/restful/specs/commerce_catalog_v1_beta_oas3.d.ts +0 -331
- package/lib/types/restful/specs/commerce_catalog_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/commerce_charity_v1_oas3.d.ts +0 -85
- package/lib/types/restful/specs/commerce_charity_v1_oas3.js +0 -4
- package/lib/types/restful/specs/commerce_identity_v1_oas3.d.ts +0 -63
- package/lib/types/restful/specs/commerce_identity_v1_oas3.js +0 -4
- package/lib/types/restful/specs/commerce_notification_v1_oas3.d.ts +0 -236
- package/lib/types/restful/specs/commerce_notification_v1_oas3.js +0 -4
- package/lib/types/restful/specs/commerce_taxonomy_v1_oas3.d.ts +0 -219
- package/lib/types/restful/specs/commerce_taxonomy_v1_oas3.js +0 -4
- package/lib/types/restful/specs/commerce_translation_v1_beta_oas3.d.ts +0 -36
- package/lib/types/restful/specs/commerce_translation_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/developer_analytics_v1_beta_oas3.d.ts +0 -57
- package/lib/types/restful/specs/developer_analytics_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/developer_key_management_v1_oas3.d.ts +0 -60
- package/lib/types/restful/specs/developer_key_management_v1_oas3.js +0 -4
- package/lib/types/restful/specs/inquiry_oas3.d.ts +0 -45
- package/lib/types/restful/specs/inquiry_oas3.js +0 -4
- package/lib/types/restful/specs/return_oas3.d.ts +0 -130
- package/lib/types/restful/specs/return_oas3.js +0 -4
- package/lib/types/restful/specs/sell_account_v1_oas3.d.ts +0 -751
- package/lib/types/restful/specs/sell_account_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_analytics_v1_oas3.d.ts +0 -130
- package/lib/types/restful/specs/sell_analytics_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_compliance_v1_oas3.d.ts +0 -102
- package/lib/types/restful/specs/sell_compliance_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_feed_v1_oas3.d.ts +0 -461
- package/lib/types/restful/specs/sell_feed_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_finances_v1_oas3.d.ts +0 -255
- package/lib/types/restful/specs/sell_finances_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_fulfillment_v1_oas3.d.ts +0 -595
- package/lib/types/restful/specs/sell_fulfillment_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_inventory_v1_oas3.d.ts +0 -844
- package/lib/types/restful/specs/sell_inventory_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_listing_v1_beta_oas3.d.ts +0 -57
- package/lib/types/restful/specs/sell_listing_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/sell_logistics_v1_oas3.d.ts +0 -173
- package/lib/types/restful/specs/sell_logistics_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_marketing_v1_oas3.d.ts +454 -1411
- package/lib/types/restful/specs/sell_marketing_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_metadata_v1_oas3.d.ts +0 -147
- package/lib/types/restful/specs/sell_metadata_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_negotiation_v1_oas3.d.ts +0 -94
- package/lib/types/restful/specs/sell_negotiation_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_recommendation_v1_oas3.d.ts +0 -60
- package/lib/types/restful/specs/sell_recommendation_v1_oas3.js +0 -4
- package/lib/types/restfulTypes.d.ts +3 -0
- package/package.json +2 -2
|
@@ -1,237 +1,42 @@
|
|
|
1
|
-
import { BulkCreateAdRequest, BulkCreateAdsByInventoryReferenceRequest, BulkCreateKeywordRequest, BulkCreateNegativeKeywordRequest, BulkDeleteAdRequest, BulkDeleteAdsByInventoryReferenceRequest, BulkUpdateAdStatusByListingIdRequest, BulkUpdateAdStatusRequest, BulkUpdateKeywordRequest, BulkUpdateNegativeKeywordRequest, CloneCampaignRequest, CreateAdGroupRequest, CreateAdRequest, CreateAdsByInventoryReferenceRequest, CreateCampaignRequest, CreateKeywordRequest, CreateNegativeKeywordRequest, CreateReportTask, ItemPriceMarkdown, ItemPromotion, TargetedBidRequest, TargetedKeywordRequest, UpdateAdGroupRequest, UpdateAdrateStrategyRequest, UpdateBidPercentageRequest, UpdateCampaignBudgetRequest, UpdateCampaignIdentificationRequest, UpdateKeywordRequest, UpdateNegativeKeywordRequest } from '../../../../types/index.js';
|
|
1
|
+
import { BulkCreateAdRequest, BulkCreateAdsByInventoryReferenceRequest, BulkCreateKeywordRequest, BulkCreateNegativeKeywordRequest, BulkDeleteAdRequest, BulkDeleteAdsByInventoryReferenceRequest, BulkUpdateAdStatusByListingIdRequest, BulkUpdateAdStatusRequest, BulkUpdateKeywordRequest, BulkUpdateNegativeKeywordRequest, CloneCampaignRequest, CreateAdGroupRequest, CreateAdRequest, CreateAdsByInventoryReferenceRequest, CreateCampaignRequest, CreateEmailCampaignRequest, CreateKeywordRequest, CreateNegativeKeywordRequest, CreateReportTask, ItemPriceMarkdown, ItemPromotion, QuickSetupRequest, TargetedBidRequest, TargetedKeywordRequest, UpdateAdGroupRequest, UpdateAdrateStrategyRequest, UpdateBidPercentageRequest, UpdateCampaignBudgetRequest, UpdateCampaignIdentificationRequest, UpdateCampaignRequest, UpdateKeywordRequest, UpdateNegativeKeywordRequest } from '../../../../types/index.js';
|
|
2
2
|
import { operations } from '../../../../types/restful/specs/sell_marketing_v1_oas3.js';
|
|
3
3
|
import Restful, { OpenApi } from '../../index.js';
|
|
4
|
-
/**
|
|
5
|
-
* <p>The <i>Marketing API </i> offers two platforms that sellers can use to promote and advertise their products:
|
|
6
|
-
* </p> <ul><li><b>Promoted Listings</b> is an eBay ad service that lets sellers set up <i>ad campaigns </i>
|
|
7
|
-
* for the products they want to promote. eBay displays the ads in search results and in other
|
|
8
|
-
* marketing modules as <b>SPONSORED</b> listings.
|
|
9
|
-
*/
|
|
10
4
|
export default class Marketing extends Restful implements OpenApi<operations> {
|
|
11
5
|
static id: string;
|
|
12
6
|
get basePath(): string;
|
|
13
|
-
/**
|
|
14
|
-
* This method creates an ad for each inventory reference ID specified in the request and associates the newly
|
|
15
|
-
* created ads with the specified campaign.
|
|
16
|
-
*
|
|
17
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created.
|
|
18
|
-
* @param body This type defines the fields for the bulkCreateAdsByInventoryReference request.
|
|
19
|
-
*/
|
|
20
7
|
bulkCreateAdsByInventoryReference(campaignId: string, body: BulkCreateAdsByInventoryReferenceRequest): Promise<any>;
|
|
21
|
-
/**
|
|
22
|
-
* This method creates an ad for each listing ID specified in the request and associates the newly created ads with
|
|
23
|
-
* the specified campaign.
|
|
24
|
-
*
|
|
25
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
26
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
27
|
-
* @param body The container for the bulk request to create ads for eBay listing IDs. eBay listing IDs are
|
|
28
|
-
* generated when the listing is created on eBay.
|
|
29
|
-
*/
|
|
30
8
|
bulkCreateAdsByListingId(campaignId: string, body: BulkCreateAdRequest): Promise<any>;
|
|
31
|
-
/**
|
|
32
|
-
* This method deletes a set of ads, as specified by a list of inventory reference IDs, from the specified
|
|
33
|
-
* campaign.
|
|
34
|
-
*
|
|
35
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
36
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
37
|
-
* @param body This type defines the fields for a bulkDeleteAdsByInventoryReference request.
|
|
38
|
-
*/
|
|
39
9
|
bulkDeleteAdsByInventoryReference(campaignId: string, body: BulkDeleteAdsByInventoryReferenceRequest): Promise<any>;
|
|
40
|
-
/**
|
|
41
|
-
* This method deletes a set of ads, as specified by a list of listing IDs, from the specified campaign.
|
|
42
|
-
*
|
|
43
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
44
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
45
|
-
* @param body This type defines the fields for the bulkDeleteAdsByListingId request.
|
|
46
|
-
*/
|
|
47
10
|
bulkDeleteAdsByListingId(campaignId: string, body: BulkDeleteAdRequest): Promise<any>;
|
|
48
|
-
/**
|
|
49
|
-
* This method replaces an ad bid based on a list of inventory references IDs associated with the specified
|
|
50
|
-
* campaign.
|
|
51
|
-
*
|
|
52
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created.
|
|
53
|
-
* @param body This type defines the fields for the BulkCreateAdsByInventoryReference request.
|
|
54
|
-
*/
|
|
55
11
|
bulkUpdateAdsBidByInventoryReference(campaignId: string, body: BulkCreateAdsByInventoryReferenceRequest): Promise<any>;
|
|
56
|
-
/**
|
|
57
|
-
* This method replaces an ad bid based on a supplied list of listing IDs that are associated with the specified
|
|
58
|
-
* campaign.
|
|
59
|
-
*
|
|
60
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
61
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
62
|
-
* @param body Container for the bulk request to update ads.
|
|
63
|
-
*/
|
|
64
12
|
bulkUpdateAdsBidByListingId(campaignId: string, body: BulkCreateAdRequest): Promise<any>;
|
|
65
|
-
/**
|
|
66
|
-
* This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program.
|
|
67
|
-
*
|
|
68
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
69
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
70
|
-
* @param body The bulk request to update the ads.
|
|
71
|
-
*/
|
|
72
13
|
bulkUpdateAdsStatus(campaignId: string, body: BulkUpdateAdStatusRequest): Promise<any>;
|
|
73
|
-
/**
|
|
74
|
-
* This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program.
|
|
75
|
-
*
|
|
76
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
77
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
78
|
-
* @param body The bulk request to update ads.
|
|
79
|
-
*/
|
|
80
14
|
bulkUpdateAdsStatusByListingId(campaignId: string, body: BulkUpdateAdStatusByListingIdRequest): Promise<any>;
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
*
|
|
84
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
85
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
86
|
-
* @param limit Specifies the maximum number of ads to return on a page in the paginated response. Default: 10
|
|
87
|
-
* Maximum: 500
|
|
88
|
-
* @param listingIds A comma separated list of eBay listing IDs. The response includes only active ads (ads
|
|
89
|
-
* associated with a RUNNING campaign).
|
|
90
|
-
* @param offset Specifies the number of ads to skip in the result set before returning the first ad in the
|
|
91
|
-
* paginated response.
|
|
92
|
-
*/
|
|
15
|
+
launchCampaign(campaignId: string): Promise<any>;
|
|
16
|
+
setupQuickCampaign(body: QuickSetupRequest): Promise<any>;
|
|
93
17
|
getAds(campaignId: string, { limit, listingIds, offset }?: {
|
|
94
18
|
limit?: number;
|
|
95
19
|
listingIds?: number;
|
|
96
20
|
offset?: number;
|
|
97
21
|
}): Promise<any>;
|
|
98
|
-
/**
|
|
99
|
-
* This method creates an ad for the specified listing ID, sets the bid percentage for that specific item, and
|
|
100
|
-
* associates the ad with the specified campaign.
|
|
101
|
-
*
|
|
102
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
103
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
104
|
-
* @param body This type defines the fields for the createAd request.
|
|
105
|
-
*/
|
|
106
22
|
createAdByListingId(campaignId: string, body: CreateAdRequest): Promise<any>;
|
|
107
|
-
/**
|
|
108
|
-
* This method creates an ad for the specified inventory reference ID, sets the bid percentage for that specific
|
|
109
|
-
* item, and associates the ad with the specified campaign.
|
|
110
|
-
*
|
|
111
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
112
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
113
|
-
* @param body This type defines the fields for the createAdsByInventoryReference request.
|
|
114
|
-
*/
|
|
115
23
|
createAdsByInventoryReference(campaignId: string, body: CreateAdsByInventoryReferenceRequest): Promise<any>;
|
|
116
|
-
/**
|
|
117
|
-
* This method retrieves the specified ad from the specified campaign.
|
|
118
|
-
*
|
|
119
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
120
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
121
|
-
* @param adId Identifier of an ad. This ID was generated when the ad was created.
|
|
122
|
-
*/
|
|
123
24
|
getAd(campaignId: string, adId: string): Promise<any>;
|
|
124
|
-
/**
|
|
125
|
-
* This method retrieves the specified ad from the specified campaign.
|
|
126
|
-
*
|
|
127
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created.
|
|
128
|
-
* @param adId Identifier of an ad. This ID was generated when the ad was created.
|
|
129
|
-
*/
|
|
130
25
|
deleteAd(campaignId: string, adId: string): Promise<any>;
|
|
131
|
-
/**
|
|
132
|
-
* This method deletes ads using a list of seller inventory reference IDs that are associated with the specified
|
|
133
|
-
* campaign ID.
|
|
134
|
-
*
|
|
135
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
136
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
137
|
-
*/
|
|
138
26
|
deleteAdsByInventoryReference(campaignId: string): Promise<any>;
|
|
139
|
-
/**
|
|
140
|
-
* This method retrieves ads from the specified campaign using the seller's inventory reference ID and inventory
|
|
141
|
-
* reference type.
|
|
142
|
-
*
|
|
143
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
144
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
145
|
-
* @param inventoryReferenceId The inventory reference ID associated with the ad you want returned.
|
|
146
|
-
* @param inventoryReferenceType The type of the inventory reference ID. Set this value to either INVENTORY_ITEM (a
|
|
147
|
-
* single listing) or INVENTORY_ITEM_GROUP (a multi-variation listing).
|
|
148
|
-
*/
|
|
149
27
|
getAdsByInventoryReference(campaignId: string, inventoryReferenceId: string, inventoryReferenceType: string): Promise<any>;
|
|
150
|
-
/**
|
|
151
|
-
* This method updates the bid for the specified ad in the specified campaign. In the request, supply the
|
|
152
|
-
* campaign_id and ad_id as a URI parameters.
|
|
153
|
-
*
|
|
154
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
155
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
156
|
-
* @param adId A unique eBay-assigned ID for an ad that's generated when an ad is created.
|
|
157
|
-
* @param body This type defines the fields for the updateBid request.
|
|
158
|
-
*/
|
|
159
28
|
updateBid(campaignId: string, adId: string, body: UpdateBidPercentageRequest): Promise<any>;
|
|
160
|
-
/**
|
|
161
|
-
*
|
|
162
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
163
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
164
|
-
* @param adGroupStatus A comma-separated list of ad group statuses.
|
|
165
|
-
* @param limit The number of results, from the current result set, to be returned in a single page.
|
|
166
|
-
* @param offset The number of results that will be skipped in the result set.
|
|
167
|
-
*/
|
|
168
29
|
getAdGroups(campaignId: string, { adGroupStatus, limit, offset }?: {
|
|
169
30
|
adGroupStatus?: string;
|
|
170
31
|
limit?: number;
|
|
171
32
|
offset?: number;
|
|
172
33
|
}): Promise<any>;
|
|
173
|
-
/**
|
|
174
|
-
*
|
|
175
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
176
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
177
|
-
* @param body This type defines the fields for the <b>createAdGroup</b> request.
|
|
178
|
-
*/
|
|
179
34
|
createAdGroup(campaignId: string, body: CreateAdGroupRequest): Promise<any>;
|
|
180
|
-
/**
|
|
181
|
-
*
|
|
182
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
183
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
184
|
-
* @param adGroupId The ID of the ad group that shall be retrieved.
|
|
185
|
-
*/
|
|
186
35
|
getAdGroup(campaignId: string, adGroupId: string): Promise<any>;
|
|
187
|
-
/**
|
|
188
|
-
*
|
|
189
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
190
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
191
|
-
* @param adGroupId The ID of the ad group that shall be retrieved.
|
|
192
|
-
* @param body This type defines the fields for the <b>UpdateAdGroup</b> request.
|
|
193
|
-
*/
|
|
194
36
|
updateAdGroup(campaignId: string, adGroupId: string, body: UpdateAdGroupRequest): Promise<any>;
|
|
195
|
-
/**
|
|
196
|
-
*
|
|
197
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
198
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
199
|
-
* @param adGroupId The ID of the ad group that shall be retrieved.
|
|
200
|
-
* @param body The data requested to retrieve the suggested bids.
|
|
201
|
-
*/
|
|
202
37
|
suggestBids(campaignId: string, adGroupId: string, body: TargetedBidRequest): Promise<any>;
|
|
203
|
-
/**
|
|
204
|
-
*
|
|
205
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
206
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
207
|
-
* @param adGroupId The ID of the ad group that shall be retrieved.
|
|
208
|
-
* @param body The required data to retrieve suggested keywords.
|
|
209
|
-
*/
|
|
210
38
|
suggestKeywords(campaignId: string, adGroupId: string, body: TargetedKeywordRequest): Promise<any>;
|
|
211
|
-
/**
|
|
212
|
-
* This method clones (makes a copy of) the specified campaign.
|
|
213
|
-
*
|
|
214
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
215
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
216
|
-
* @param body This type defines the fields for a clone campaign request.
|
|
217
|
-
*/
|
|
218
39
|
cloneCampaign(campaignId: string, body: CloneCampaignRequest): Promise<any>;
|
|
219
|
-
/**
|
|
220
|
-
* This method retrieves the details for all the campaigns of a seller, including the campaign's the selection
|
|
221
|
-
* rules.
|
|
222
|
-
*
|
|
223
|
-
* @param campaignName Specifies the campaign name. The results are filtered to include only the campaign by the
|
|
224
|
-
* specified name.
|
|
225
|
-
* @param campaignStatus Specifies the campaign status. The results are filtered to include only campaigns that are
|
|
226
|
-
* in the specified states.
|
|
227
|
-
* @param endDateRange Specifies the range of a campaign's end date. The results are filtered to include only
|
|
228
|
-
* campaigns with an end date that is within specified range.
|
|
229
|
-
* @param limit Specifies the maximum number of campaigns to return on a page in the paginated response. Default:
|
|
230
|
-
* 10 Maximum: 500
|
|
231
|
-
* @param offset Specifies the number of campaigns to skip in the result set before returning the first report in
|
|
232
|
-
* the paginated response.
|
|
233
|
-
* @param startDateRange Specifies the range of a campaign's start date in which to filter the results.
|
|
234
|
-
*/
|
|
235
40
|
getCampaigns({ campaignName, campaignStatus, endDateRange, limit, offset, startDateRange }?: {
|
|
236
41
|
campaignName?: string;
|
|
237
42
|
campaignStatus?: string;
|
|
@@ -240,171 +45,39 @@ export default class Marketing extends Restful implements OpenApi<operations> {
|
|
|
240
45
|
offset?: number;
|
|
241
46
|
startDateRange?: string;
|
|
242
47
|
}): Promise<any>;
|
|
243
|
-
/**
|
|
244
|
-
* This method retrieves the details of a single campaign, as specified with the campaign_id query parameter.
|
|
245
|
-
*
|
|
246
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
247
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
248
|
-
*/
|
|
249
48
|
getCampaign(campaignId: string): Promise<any>;
|
|
250
|
-
/**
|
|
251
|
-
* This method creates a Promoted Listings ad campaign.
|
|
252
|
-
*
|
|
253
|
-
* @param body his type defines the fields for the create campaign request.
|
|
254
|
-
*/
|
|
255
49
|
createCampaign(body: CreateCampaignRequest): Promise<any>;
|
|
256
|
-
/**
|
|
257
|
-
* This method deletes the campaign specified by the campaign_id query parameter.
|
|
258
|
-
*
|
|
259
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
260
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
261
|
-
*/
|
|
262
50
|
deleteCampaign(campaignId: string): Promise<any>;
|
|
263
|
-
/**
|
|
264
|
-
* This method ends an active (RUNNINGM) or paused campaign. Specify the campaign you want to end by supplying its
|
|
265
|
-
* campaign ID in a query parameter.
|
|
266
|
-
*
|
|
267
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
268
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
269
|
-
*/
|
|
270
51
|
endCampaign(campaignId: string): Promise<any>;
|
|
271
|
-
/**
|
|
272
|
-
* This method retrieves the campaign containing the listing that is specified using either an eBay listing ID or
|
|
273
|
-
* an inventory reference ID and inventory reference type.
|
|
274
|
-
*
|
|
275
|
-
* @param inventoryReferenceId The seller's inventory reference ID of the listing to be used to find the campaign
|
|
276
|
-
* in which it is associated.
|
|
277
|
-
* @param inventoryReferenceType The type of the seller's inventory reference ID, which is a listing or group of
|
|
278
|
-
* items.
|
|
279
|
-
* @param listingId Identifier of the eBay listing associated with the ad.
|
|
280
|
-
*/
|
|
281
52
|
findCampaignByAdReference({ inventoryReferenceId, inventoryReferenceType, listingId }?: {
|
|
282
53
|
inventoryReferenceId?: string;
|
|
283
54
|
inventoryReferenceType?: string;
|
|
284
55
|
listingId?: string;
|
|
285
56
|
}): Promise<any>;
|
|
286
|
-
/**
|
|
287
|
-
* This method retrieves the details of a single campaign, as specified with the campaign_name query parameter.
|
|
288
|
-
*
|
|
289
|
-
* @param campaignName Name of the campaign.
|
|
290
|
-
*/
|
|
291
57
|
getCampaignByName(campaignName: string): Promise<any>;
|
|
292
|
-
/**
|
|
293
|
-
* This method pauses an active (RUNNING) campaign. You can restarted by calling resumeCampaign, as long as the
|
|
294
|
-
* campaign's end date is in the future..
|
|
295
|
-
*
|
|
296
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
297
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
298
|
-
*/
|
|
299
58
|
pauseCampaign(campaignId: string): Promise<any>;
|
|
300
|
-
/**
|
|
301
|
-
* This method resumes a paused campaign, as long as it's end date is in the future.
|
|
302
|
-
*
|
|
303
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
304
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
305
|
-
*/
|
|
306
59
|
resumeCampaign(campaignId: string): Promise<any>;
|
|
307
|
-
/**
|
|
308
|
-
*
|
|
309
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
|
|
310
|
-
* @param categoryIds Specifies the category ID that is used to limit the results.
|
|
311
|
-
* @param limit Specifies the maximum number of campaigns to return on a page in the paginated response.
|
|
312
|
-
* @param offset Specifies the number of campaigns to skip in the result set before returning the first report in the paginated response.
|
|
313
|
-
*/
|
|
314
60
|
suggestItems(campaignId: string, { categoryIds, limit, offset }?: {
|
|
315
61
|
categoryIds?: string;
|
|
316
62
|
limit?: number;
|
|
317
63
|
offset?: number;
|
|
318
64
|
}): Promise<any>;
|
|
319
|
-
/**
|
|
320
|
-
*
|
|
321
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
|
|
322
|
-
* @param body This type defines the request fields for the ad rate strategy that shall be updated.
|
|
323
|
-
*/
|
|
324
65
|
updateAdRateStrategy(campaignId: string, body: UpdateAdrateStrategyRequest): Promise<any>;
|
|
325
|
-
/**
|
|
326
|
-
*
|
|
327
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
|
|
328
|
-
* @param body This type defines the request fields for the budget details that shall be updated.
|
|
329
|
-
*/
|
|
330
66
|
updateCampaignBudget(campaignId: string, body: UpdateCampaignBudgetRequest): Promise<any>;
|
|
331
|
-
/**
|
|
332
|
-
* This method replaces the name and the start and end dates of a campaign.
|
|
333
|
-
*
|
|
334
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
335
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
336
|
-
* @param body This type defines the fields to updated the campaign name and start and end dates.
|
|
337
|
-
*/
|
|
338
67
|
updateCampaignIdentification(campaignId: string, body: UpdateCampaignIdentificationRequest): Promise<any>;
|
|
339
|
-
/**
|
|
340
|
-
*
|
|
341
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
342
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
343
|
-
* @param body A type that defines the fields for the bulk request to create keywords.
|
|
344
|
-
*/
|
|
345
68
|
bulkCreateKeyword(campaignId: string, body: BulkCreateKeywordRequest): Promise<any>;
|
|
346
|
-
/**
|
|
347
|
-
*
|
|
348
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
349
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
350
|
-
* @param body A type that defines the fields for the bulk request to update keywords.
|
|
351
|
-
*/
|
|
352
69
|
bulkUpdateKeyword(campaignId: string, body: BulkUpdateKeywordRequest): Promise<any>;
|
|
353
|
-
/**
|
|
354
|
-
*
|
|
355
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
356
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
357
|
-
* @param adGroupIds A comma-separated list of ad group IDs.
|
|
358
|
-
* @param keywordStatus A comma-separated list of keyword statuses.
|
|
359
|
-
* @param limit Specifies the maximum number of results to return on a page in the paginated response.
|
|
360
|
-
* @param offset Specifies the number of results to skip in the result set before returning the first report in the paginated response.
|
|
361
|
-
*/
|
|
362
70
|
getKeywords(campaignId: string, { adGroupIds, keywordStatus, limit, offset }?: {
|
|
363
71
|
adGroupIds?: string;
|
|
364
72
|
keywordStatus?: string;
|
|
365
73
|
limit?: number;
|
|
366
74
|
offset?: number;
|
|
367
75
|
}): Promise<any>;
|
|
368
|
-
/**
|
|
369
|
-
*
|
|
370
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
371
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
372
|
-
* @param body A type that defines the fields for the request to create a keyword.
|
|
373
|
-
*/
|
|
374
76
|
createKeyword(campaignId: string, body: CreateKeywordRequest): Promise<any>;
|
|
375
|
-
/**
|
|
376
|
-
*
|
|
377
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
378
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
379
|
-
* @param keywordId This path parameter is used to identify the keyword to retrieve.
|
|
380
|
-
*/
|
|
381
77
|
getKeyword(campaignId: string, keywordId: string): Promise<any>;
|
|
382
|
-
/**
|
|
383
|
-
*
|
|
384
|
-
* @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
|
|
385
|
-
* a seller's campaign IDs by calling getCampaigns.
|
|
386
|
-
* @param keywordId This path parameter is used to identify the keyword to retrieve.
|
|
387
|
-
* @param body A type that defines the fields for the request to update a keyword.
|
|
388
|
-
*/
|
|
389
78
|
updateKeyword(campaignId: string, keywordId: string, body: UpdateKeywordRequest): Promise<any>;
|
|
390
|
-
/**
|
|
391
|
-
*
|
|
392
|
-
* @param body A type that defines the fields for the bulk request to create negative keywords.
|
|
393
|
-
*/
|
|
394
79
|
bulkCreateNegativeKeyword(body: BulkCreateNegativeKeywordRequest): Promise<any>;
|
|
395
|
-
/**
|
|
396
|
-
*
|
|
397
|
-
* @param body A type that defines the fields for the bulk request to create negative keywords.
|
|
398
|
-
*/
|
|
399
80
|
bulkUpdateNegativeKeyword(body: BulkUpdateNegativeKeywordRequest): Promise<any>;
|
|
400
|
-
/**
|
|
401
|
-
*
|
|
402
|
-
* @param adGroupIds A comma-separated list of ad group IDs.
|
|
403
|
-
* @param campaignIds A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
|
|
404
|
-
* @param limit The number of results, from the current result set, to be returned in a single page.
|
|
405
|
-
* @param negativeKeywordStatus A comma-separated list of negative keyword statuses.
|
|
406
|
-
* @param offset The number of results that will be skipped in the result set.
|
|
407
|
-
*/
|
|
408
81
|
getNegativeKeywords({ adGroupIds, campaignIds, limit, negativeKeywordStatus, offset }?: {
|
|
409
82
|
adGroupIds?: string;
|
|
410
83
|
campaignIds?: string;
|
|
@@ -412,147 +85,28 @@ export default class Marketing extends Restful implements OpenApi<operations> {
|
|
|
412
85
|
negativeKeywordStatus?: string;
|
|
413
86
|
offset?: number;
|
|
414
87
|
}): Promise<any>;
|
|
415
|
-
/**
|
|
416
|
-
*
|
|
417
|
-
* @param body A type that defines the fields for the request to create a negative keyword.
|
|
418
|
-
*/
|
|
419
88
|
createNegativeKeyword(body: CreateNegativeKeywordRequest): Promise<any>;
|
|
420
|
-
/**
|
|
421
|
-
*
|
|
422
|
-
* @param negativeKeywordId The unique identifier for the negative keyword.
|
|
423
|
-
*/
|
|
424
89
|
getNegativeKeyword(negativeKeywordId: string): Promise<any>;
|
|
425
|
-
/**
|
|
426
|
-
*
|
|
427
|
-
* @param negativeKeywordId The unique identifier for the negative keyword.
|
|
428
|
-
* @param body A type that defines the fields for the request to update a negative keyword.
|
|
429
|
-
*/
|
|
430
90
|
updateNegativeKeyword(negativeKeywordId: string, body: UpdateNegativeKeywordRequest): Promise<any>;
|
|
431
|
-
/**
|
|
432
|
-
* This call downloads the report as specified by the report_id path parameter.
|
|
433
|
-
*
|
|
434
|
-
* @param reportId The unique ID of the Promoted Listings report you want to get. This ID is generated by eBay when
|
|
435
|
-
* you run a report task with a call to createReportTask.
|
|
436
|
-
*/
|
|
437
91
|
getReport(reportId: string): Promise<any>;
|
|
438
|
-
/**
|
|
439
|
-
* This call retrieves information that details the fields used in each of the Promoted Listings reports.
|
|
440
|
-
*/
|
|
441
92
|
getReportMetadata(): Promise<any>;
|
|
442
|
-
/**
|
|
443
|
-
* This call retrieves metadata that details the fields used by the Promoted Listings report type that's specified
|
|
444
|
-
* by the report_type path parameter.
|
|
445
|
-
*
|
|
446
|
-
* @param reportType The name of the report type whose metadata you want to get.
|
|
447
|
-
*/
|
|
448
93
|
getReportMetadataForReportType(reportType: string): Promise<any>;
|
|
449
|
-
/**
|
|
450
|
-
* This method returns information on all the existing report tasks related to a seller.
|
|
451
|
-
*
|
|
452
|
-
* @param limit Specifies the maximum number of report tasks to return on a page in the paginated response.
|
|
453
|
-
* Default: 10 Maximum: 500
|
|
454
|
-
* @param offset Specifies the number of report tasks to skip in the result set before returning the first report
|
|
455
|
-
* in the paginated response.
|
|
456
|
-
* @param reportTaskStatuses This parameter filters the returned report tasks by their status. Supply a
|
|
457
|
-
* comma-separated list of the report statuses you want returned.
|
|
458
|
-
*/
|
|
459
94
|
getReportTasks({ limit, offset, reportTaskStatuses }?: {
|
|
460
95
|
limit?: number;
|
|
461
96
|
offset?: number;
|
|
462
97
|
reportTaskStatuses?: string;
|
|
463
98
|
}): Promise<any>;
|
|
464
|
-
/**
|
|
465
|
-
* This call returns the details of a specific Promoted Listings report task, as specified by the report_task_id
|
|
466
|
-
* path parameter. T
|
|
467
|
-
*
|
|
468
|
-
* @param reportTaskId A unique eBay-assigned ID for the report task that's generated when the report task is
|
|
469
|
-
* created by a call to createReportTask.
|
|
470
|
-
*/
|
|
471
99
|
getReportTask(reportTaskId: string): Promise<any>;
|
|
472
|
-
/**
|
|
473
|
-
* This method creates a report task, which generates a Promoted Listings report based on the values specified in
|
|
474
|
-
* the call.
|
|
475
|
-
*
|
|
476
|
-
* @param body The container for the fields that define the report task.
|
|
477
|
-
*/
|
|
478
100
|
createReportTask(body: CreateReportTask): Promise<any>;
|
|
479
|
-
/**
|
|
480
|
-
* This call deletes the report task specified by the report_task_id path parameter.
|
|
481
|
-
*
|
|
482
|
-
* @param reportTaskId A unique eBay-assigned ID for the report task that's generated when the report task is
|
|
483
|
-
* created by a call to createReportTask.
|
|
484
|
-
*/
|
|
485
101
|
deleteReportTask(reportTaskId: string): Promise<any>;
|
|
486
|
-
/**
|
|
487
|
-
* This method creates an item price markdown promotion (know simply as a "markdown promotion") where a
|
|
488
|
-
* discount amount is applied directly to the items included the promotion.
|
|
489
|
-
*
|
|
490
|
-
* @param body This type defines the fields that describe an item price markdown promotion.
|
|
491
|
-
*/
|
|
492
102
|
createItemPriceMarkdownPromotion(body: ItemPriceMarkdown): Promise<any>;
|
|
493
|
-
/**
|
|
494
|
-
* This method updates the specified item price markdown promotion with the new configuration that you supply in
|
|
495
|
-
* the payload of the request.
|
|
496
|
-
*
|
|
497
|
-
* @param promotionId The ID of the promotion you want to update.
|
|
498
|
-
* @param body This type defines the fields that describe an item price markdown promotion.
|
|
499
|
-
*/
|
|
500
103
|
updateItemPriceMarkdownPromotion(promotionId: string, body: ItemPriceMarkdown): Promise<any>;
|
|
501
|
-
/**
|
|
502
|
-
* This method deletes the item price markdown promotion specified by the promotion_id path parameter.
|
|
503
|
-
*
|
|
504
|
-
* @param promotionId The ID of the promotion you want to delete.
|
|
505
|
-
*/
|
|
506
104
|
deleteItemPriceMarkdownPromotion(promotionId: string): Promise<any>;
|
|
507
|
-
/**
|
|
508
|
-
* This method returns the complete details of the item price markdown promotion that's indicated by the
|
|
509
|
-
* promotion_id path parameter.
|
|
510
|
-
*
|
|
511
|
-
* @param promotionId The ID of the promotion you want to retrieve.
|
|
512
|
-
*/
|
|
513
105
|
getItemPriceMarkdownPromotion(promotionId: string): Promise<any>;
|
|
514
|
-
/**
|
|
515
|
-
* This method creates an item promotion (known casually as a "threshold promotion") where the buyer
|
|
516
|
-
* receives a discount when they meet the buying criteria that's set for the promotion.
|
|
517
|
-
*
|
|
518
|
-
* @param body This type defines the fields that describe an item promotion.
|
|
519
|
-
*/
|
|
520
106
|
createItemPromotion(body: ItemPromotion): Promise<any>;
|
|
521
|
-
/**
|
|
522
|
-
* This method updates the specified threshold promotion with the new configuration that you supply in the request.
|
|
523
|
-
*
|
|
524
|
-
* @param promotionId The ID of the promotion you want to retrieve. The promotion ID is a unique eBay-assigned
|
|
525
|
-
* value that's generated when the promotion is created.
|
|
526
|
-
* @param body type defines the fields that describe an item promotion.
|
|
527
|
-
*/
|
|
528
107
|
updateItemPromotion(promotionId: string, body: ItemPromotion): Promise<any>;
|
|
529
|
-
/**
|
|
530
|
-
* This method deletes the threshold promotion specified by the promotion_id path parameter.
|
|
531
|
-
*
|
|
532
|
-
* @param promotionId The ID of the promotion you want to retrieve. The promotion ID is a unique eBay-assigned
|
|
533
|
-
* value that's generated when the promotion is created.
|
|
534
|
-
*/
|
|
535
108
|
deleteItemPromotion(promotionId: string): Promise<any>;
|
|
536
|
-
/**
|
|
537
|
-
* This method returns the complete details of the threshold promotion specified by the promotion_id path
|
|
538
|
-
* parameter.
|
|
539
|
-
*
|
|
540
|
-
* @param promotionId The ID of the promotion you want to retrieve. The promotion ID is a unique eBay-assigned
|
|
541
|
-
* value that's generated when the promotion is created.
|
|
542
|
-
*/
|
|
543
109
|
getItemPromotion(promotionId: string): Promise<any>;
|
|
544
|
-
/**
|
|
545
|
-
* This method returns the set of listings associated with the promotion_id specified in the path parameter.
|
|
546
|
-
*
|
|
547
|
-
* @param promotionId The ID of the promotion whose associated listings you want to retrieve.
|
|
548
|
-
* @param limit Specifies the maximum number of promotions returned on a page from the result set. Default: 200
|
|
549
|
-
* Maximum: 200
|
|
550
|
-
* @param offset Specifies the number of promotions to skip in the result set before returning the first promotion
|
|
551
|
-
* in the paginated response.
|
|
552
|
-
* @param q Reserved for future use.
|
|
553
|
-
* @param sort Specifies the order in which to sort the associated listings in the response.
|
|
554
|
-
* @param status This query parameter applies only to markdown promotions.
|
|
555
|
-
*/
|
|
556
110
|
getListingSet(promotionId: string, { limit, offset, q, sort, status }?: {
|
|
557
111
|
limit?: number;
|
|
558
112
|
offset?: number;
|
|
@@ -560,19 +114,6 @@ export default class Marketing extends Restful implements OpenApi<operations> {
|
|
|
560
114
|
sort?: string;
|
|
561
115
|
status?: string;
|
|
562
116
|
}): Promise<any>;
|
|
563
|
-
/**
|
|
564
|
-
* This method returns a list of a seller's undeleted promotions.
|
|
565
|
-
*
|
|
566
|
-
* @param marketplaceId The eBay marketplace ID of the site where the promotion is hosted.
|
|
567
|
-
* @param limit Specifies the maximum number of promotions returned on a page from the result set. Default: 200
|
|
568
|
-
* Maximum: 200
|
|
569
|
-
* @param offset Specifies the number of promotions to skip in the result set before returning the first promotion
|
|
570
|
-
* in the paginated response.
|
|
571
|
-
* @param promotionStatus Specifies the promotion state by which you want to filter the results.
|
|
572
|
-
* @param promotionType Filters the returned promotions based on the their campaign promotion type.
|
|
573
|
-
* @param q A string consisting of one or more keywords.
|
|
574
|
-
* @param sort Specifies the order for how to sort the response.
|
|
575
|
-
*/
|
|
576
117
|
getPromotions(marketplaceId: string, { limit, offset, promotionStatus, promotionType, q, sort }?: {
|
|
577
118
|
limit?: number;
|
|
578
119
|
offset?: number;
|
|
@@ -581,36 +122,8 @@ export default class Marketing extends Restful implements OpenApi<operations> {
|
|
|
581
122
|
q?: string;
|
|
582
123
|
sort?: string;
|
|
583
124
|
}): Promise<any>;
|
|
584
|
-
/**
|
|
585
|
-
* This method pauses a currently-active (RUNNING) threshold promotion and changes the state of the promotion from
|
|
586
|
-
* RUNNING to PAUSED.
|
|
587
|
-
*
|
|
588
|
-
* @param promotionId Identifier of the promotion you want to pause.
|
|
589
|
-
*/
|
|
590
125
|
pausePromotion(promotionId: string): Promise<any>;
|
|
591
|
-
/**
|
|
592
|
-
* This method restarts a threshold promotion that was previously paused and changes the state of the promotion
|
|
593
|
-
* from PAUSED to RUNNING.
|
|
594
|
-
*
|
|
595
|
-
* @param promotionId Identifier of the promotion you want to make active. The ID is a unique eBay-assigned value
|
|
596
|
-
* that's generated when the promotion is created.
|
|
597
|
-
*/
|
|
598
126
|
resumePromotion(promotionId: string): Promise<any>;
|
|
599
|
-
/**
|
|
600
|
-
* This method generates a report that lists the seller's running, paused, and ended promotions for the specified
|
|
601
|
-
* eBay marketplace.
|
|
602
|
-
*
|
|
603
|
-
* @param marketplaceId The eBay marketplace ID of the siteId for which you want the promotions report.
|
|
604
|
-
* @param limit Specifies the maximum number of promotions returned on a page from the result set. Default: 200
|
|
605
|
-
* Maximum: 200
|
|
606
|
-
* @param offset Specifies the number of promotions to skip in the result set before returning the first promotion
|
|
607
|
-
* in the paginated response.
|
|
608
|
-
* @param promotionStatus Limits the results to the promotions that are in the state specified by this query
|
|
609
|
-
* parameter.
|
|
610
|
-
* @param promotionType Filters the returned promotions in the report based on the their campaign promotion type.
|
|
611
|
-
* @param q A string consisting of one or more keywords. eBay filters the response by returning only the promotions
|
|
612
|
-
* that contain the supplied keywords in the promotion title.
|
|
613
|
-
*/
|
|
614
127
|
getPromotionReports(marketplaceId: string, { limit, offset, promotionStatus, promotionType, q }?: {
|
|
615
128
|
limit?: number;
|
|
616
129
|
offset?: number;
|
|
@@ -618,10 +131,18 @@ export default class Marketing extends Restful implements OpenApi<operations> {
|
|
|
618
131
|
promotionType?: string;
|
|
619
132
|
q?: string;
|
|
620
133
|
}): Promise<any>;
|
|
621
|
-
/**
|
|
622
|
-
* This method generates a report that summarizes the seller's promotions for the specified eBay marketplace.
|
|
623
|
-
*
|
|
624
|
-
* @param marketplaceId The eBay marketplace ID of the siteId you for which you want a promotion summary report.
|
|
625
|
-
*/
|
|
626
134
|
getPromotionSummaryReport(marketplaceId: string): Promise<any>;
|
|
135
|
+
getEmailCampaign(emailCampaignId: string): Promise<any>;
|
|
136
|
+
getEmailCampaigns({ limit, q, offset, sort }?: {
|
|
137
|
+
limit?: number;
|
|
138
|
+
q?: string;
|
|
139
|
+
offset?: number;
|
|
140
|
+
sort?: string;
|
|
141
|
+
}): Promise<any>;
|
|
142
|
+
createEmailCampaign(body: CreateEmailCampaignRequest): Promise<any>;
|
|
143
|
+
updateEmailCampaign(emailCampaignId: string, body: UpdateCampaignRequest): Promise<any>;
|
|
144
|
+
deleteEmailCampaign(emailCampaignId: string): Promise<any>;
|
|
145
|
+
getEmailPreview(emailCampaignId: string): Promise<any>;
|
|
146
|
+
getAudiences(): Promise<any>;
|
|
147
|
+
getEmailReport(startDate: string, endDate: string): Promise<any>;
|
|
627
148
|
}
|