ebay-api 8.4.1 → 8.5.0

package/dist/api/restful/commerce/catalog/index.d.ts

@@ -1,73 +1,74 @@
-import Restful from '../../index.js';
-import { CatalogSearchParams } from '../../../../types/index.js';
-/**
- * Use the Catalog API to search the eBay catalog for products on which to base a seller's item listing;
- */
-export default class Catalog extends Restful {
-    static id: string;
-    get basePath(): string;
-    /**
-     * Note: The three catalog change request methods in the Catalog API are deprecated, and are scheduled to be
-     * decommissioned in Q1 of 2020.
-     *
-     * @param changeRequestId The unique identifier of the change request being requested.
-     */
-    getChangeRequest(changeRequestId: string): Promise<any>;
-    /**
-     * Note: The three catalog change request methods in the Catalog API are deprecated, and are scheduled to be
-     * decommissioned in Q1 of 2020.
-     *
-     * @param filter One or more comma-separated criteria for narrowing down the collection of change requests returned
-     *     by this call.
-     * @param limit The number of change requests to return. This is the result set, a subset of the full collection of
-     *     change requests that match the filter criteria of this call.
-     * @param offset The first change request to return based on its position in the returned collection of change
-     *     requests.
-     */
-    getChangeRequests({ filter, limit, offset }?: {
-        filter?: string;
-        limit?: number;
-        offset?: number;
-    }): Promise<any>;
-    /**
-     * This call retrieves details of the catalog product identified by the eBay product identifier (ePID) specified in
-     * the request.
-     *
-     * @param epid The ePID of the product being requested.
-     */
-    getProduct(epid: string): Promise<any>;
-    /**
-     * This call searches for and retrieves summaries of one or more products in the eBay catalog that match the search
-     * criteria provided by a seller.
-     *
-     * @param params SearchCatalogParams
-     */
-    search(params?: CatalogSearchParams): Promise<any>;
-    /**
-     * This call retrieves an array of all supported aspects, aspect constraints, and aspect values for the specified
-     * catalog product and its associated or suggested categories, as well as the values currently associated with that
-     * product.
-     *
-     * @param epid The unique eBay product identifier of the catalog product that you want to update.
-     * @param acceptLanguage This request header sets the natural language that will be provided in the field values of
-     *     the response payload.
-     * @param otherApplicableCategoryIds Use only if you are also including the primary_category_id parameter in the
-     *     request.
-     * @param primaryCategoryId Use only if the seller believes this product is associated with the wrong primary
-     *     category.
-     * @param marketplaceId Use this header to specify the eBay marketplace identifier.
-     */
-    getProductMetadata(epid: string, { otherApplicableCategoryIds, primaryCategoryId }?: {
-        otherApplicableCategoryIds?: string;
-        primaryCategoryId?: string;
-    }): Promise<any>;
-    /**
-     * This call retrieves an array of all supported aspects, aspect constraints, and aspect values for the specified
-     * eBay categories.
-     *
-     * @param primaryCategoryId The unique identifier of the primary eBay category for which you will retrieve product
-     *     aspects.
-     * @param otherApplicableCategoryIds A string of comma-separated category IDs.
-     */
-    getProductMetadataForCategories(primaryCategoryId: string, otherApplicableCategoryIds?: string): Promise<any>;
-}
+import { CommerceCatalogSearchParams } from '../../../../types/index.js';
+import { operations } from '../../../../types/restful/specs/commerce_catalog_v1_beta_oas3.js';
+import Restful, { OpenApi } from '../../index.js';
+/**
+ * Use the Catalog API to search the eBay catalog for products on which to base a seller's item listing;
+ */
+export default class Catalog extends Restful implements OpenApi<Omit<operations, 'createChangeRequest'>> {
+    static id: string;
+    get basePath(): string;
+    /**
+     * Note: The three catalog change request methods in the Catalog API are deprecated, and are scheduled to be
+     * decommissioned in Q1 of 2020.
+     *
+     * @param changeRequestId The unique identifier of the change request being requested.
+     */
+    getChangeRequest(changeRequestId: string): Promise<any>;
+    /**
+     * Note: The three catalog change request methods in the Catalog API are deprecated, and are scheduled to be
+     * decommissioned in Q1 of 2020.
+     *
+     * @param filter One or more comma-separated criteria for narrowing down the collection of change requests returned
+     *     by this call.
+     * @param limit The number of change requests to return. This is the result set, a subset of the full collection of
+     *     change requests that match the filter criteria of this call.
+     * @param offset The first change request to return based on its position in the returned collection of change
+     *     requests.
+     */
+    getChangeRequests({ filter, limit, offset }?: {
+        filter?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<any>;
+    /**
+     * This call retrieves details of the catalog product identified by the eBay product identifier (ePID) specified in
+     * the request.
+     *
+     * @param epid The ePID of the product being requested.
+     */
+    getProduct(epid: string): Promise<any>;
+    /**
+     * This call searches for and retrieves summaries of one or more products in the eBay catalog that match the search
+     * criteria provided by a seller.
+     *
+     * @param params SearchCatalogParams
+     */
+    search(params?: CommerceCatalogSearchParams): Promise<any>;
+    /**
+     * This call retrieves an array of all supported aspects, aspect constraints, and aspect values for the specified
+     * catalog product and its associated or suggested categories, as well as the values currently associated with that
+     * product.
+     *
+     * @param epid The unique eBay product identifier of the catalog product that you want to update.
+     * @param acceptLanguage This request header sets the natural language that will be provided in the field values of
+     *     the response payload.
+     * @param otherApplicableCategoryIds Use only if you are also including the primary_category_id parameter in the
+     *     request.
+     * @param primaryCategoryId Use only if the seller believes this product is associated with the wrong primary
+     *     category.
+     * @param marketplaceId Use this header to specify the eBay marketplace identifier.
+     */
+    getProductMetadata(epid: string, { otherApplicableCategoryIds, primaryCategoryId }?: {
+        otherApplicableCategoryIds?: string;
+        primaryCategoryId?: string;
+    }): Promise<any>;
+    /**
+     * This call retrieves an array of all supported aspects, aspect constraints, and aspect values for the specified
+     * eBay categories.
+     *
+     * @param primaryCategoryId The unique identifier of the primary eBay category for which you will retrieve product
+     *     aspects.
+     * @param otherApplicableCategoryIds A string of comma-separated category IDs.
+     */
+    getProductMetadataForCategories(primaryCategoryId: string, otherApplicableCategoryIds?: string): Promise<any>;
+}

package/dist/api/restful/commerce/catalog/index.js

@@ -1,101 +1,100 @@
-import Restful from '../../index.js';
-/**
- * Use the Catalog API to search the eBay catalog for products on which to base a seller's item listing;
- */
-export default class Catalog extends Restful {
-    get basePath() {
-        return '/commerce/catalog/v1_beta';
-    }
-    /**
-     * Note: The three catalog change request methods in the Catalog API are deprecated, and are scheduled to be
-     * decommissioned in Q1 of 2020.
-     *
-     * @param changeRequestId The unique identifier of the change request being requested.
-     */
-    getChangeRequest(changeRequestId) {
-        return this.get(`/change_request/${changeRequestId}`);
-    }
-    /**
-     * Note: The three catalog change request methods in the Catalog API are deprecated, and are scheduled to be
-     * decommissioned in Q1 of 2020.
-     *
-     * @param filter One or more comma-separated criteria for narrowing down the collection of change requests returned
-     *     by this call.
-     * @param limit The number of change requests to return. This is the result set, a subset of the full collection of
-     *     change requests that match the filter criteria of this call.
-     * @param offset The first change request to return based on its position in the returned collection of change
-     *     requests.
-     */
-    getChangeRequests({ filter, limit, offset } = {}) {
-        return this.get(`/change_request`, {
-            params: {
-                filter,
-                limit,
-                offset
-            }
-        });
-    }
-    /**
-     * This call retrieves details of the catalog product identified by the eBay product identifier (ePID) specified in
-     * the request.
-     *
-     * @param epid The ePID of the product being requested.
-     */
-    getProduct(epid) {
-        const e = encodeURIComponent(epid);
-        return this.get(`/product/${e}`);
-    }
-    /**
-     * This call searches for and retrieves summaries of one or more products in the eBay catalog that match the search
-     * criteria provided by a seller.
-     *
-     * @param params SearchCatalogParams
-     */
-    search(params) {
-        return this.get(`/product_summary/search`, {
-            params: {
-                ...(params && params)
-            }
-        });
-    }
-    /**
-     * This call retrieves an array of all supported aspects, aspect constraints, and aspect values for the specified
-     * catalog product and its associated or suggested categories, as well as the values currently associated with that
-     * product.
-     *
-     * @param epid The unique eBay product identifier of the catalog product that you want to update.
-     * @param acceptLanguage This request header sets the natural language that will be provided in the field values of
-     *     the response payload.
-     * @param otherApplicableCategoryIds Use only if you are also including the primary_category_id parameter in the
-     *     request.
-     * @param primaryCategoryId Use only if the seller believes this product is associated with the wrong primary
-     *     category.
-     * @param marketplaceId Use this header to specify the eBay marketplace identifier.
-     */
-    getProductMetadata(epid, { otherApplicableCategoryIds, primaryCategoryId } = {}) {
-        return this.get(`/get_product_metadata`, {
-            params: {
-                epid,
-                other_applicable_category_ids: otherApplicableCategoryIds,
-                primary_category_id: primaryCategoryId
-            }
-        });
-    }
-    /**
-     * This call retrieves an array of all supported aspects, aspect constraints, and aspect values for the specified
-     * eBay categories.
-     *
-     * @param primaryCategoryId The unique identifier of the primary eBay category for which you will retrieve product
-     *     aspects.
-     * @param otherApplicableCategoryIds A string of comma-separated category IDs.
-     */
-    getProductMetadataForCategories(primaryCategoryId, otherApplicableCategoryIds) {
-        return this.get(`/get_product_metadata_for_categories`, {
-            params: {
-                primary_category_id: primaryCategoryId,
-                other_applicable_category_ids: otherApplicableCategoryIds
-            }
-        });
-    }
-}
-Catalog.id = 'Catalog';
+import Restful from '../../index.js';
+/**
+ * Use the Catalog API to search the eBay catalog for products on which to base a seller's item listing;
+ */
+class Catalog extends Restful {
+    get basePath() {
+        return '/commerce/catalog/v1_beta';
+    }
+    /**
+     * Note: The three catalog change request methods in the Catalog API are deprecated, and are scheduled to be
+     * decommissioned in Q1 of 2020.
+     *
+     * @param changeRequestId The unique identifier of the change request being requested.
+     */
+    getChangeRequest(changeRequestId) {
+        return this.get(`/change_request/${changeRequestId}`);
+    }
+    /**
+     * Note: The three catalog change request methods in the Catalog API are deprecated, and are scheduled to be
+     * decommissioned in Q1 of 2020.
+     *
+     * @param filter One or more comma-separated criteria for narrowing down the collection of change requests returned
+     *     by this call.
+     * @param limit The number of change requests to return. This is the result set, a subset of the full collection of
+     *     change requests that match the filter criteria of this call.
+     * @param offset The first change request to return based on its position in the returned collection of change
+     *     requests.
+     */
+    getChangeRequests({ filter, limit, offset } = {}) {
+        return this.get(`/change_request`, {
+            params: {
+                filter,
+                limit,
+                offset
+            }
+        });
+    }
+    /**
+     * This call retrieves details of the catalog product identified by the eBay product identifier (ePID) specified in
+     * the request.
+     *
+     * @param epid The ePID of the product being requested.
+     */
+    getProduct(epid) {
+        const e = encodeURIComponent(epid);
+        return this.get(`/product/${e}`);
+    }
+    /**
+     * This call searches for and retrieves summaries of one or more products in the eBay catalog that match the search
+     * criteria provided by a seller.
+     *
+     * @param params SearchCatalogParams
+     */
+    search(params) {
+        return this.get(`/product_summary/search`, {
+            params
+        });
+    }
+    /**
+     * This call retrieves an array of all supported aspects, aspect constraints, and aspect values for the specified
+     * catalog product and its associated or suggested categories, as well as the values currently associated with that
+     * product.
+     *
+     * @param epid The unique eBay product identifier of the catalog product that you want to update.
+     * @param acceptLanguage This request header sets the natural language that will be provided in the field values of
+     *     the response payload.
+     * @param otherApplicableCategoryIds Use only if you are also including the primary_category_id parameter in the
+     *     request.
+     * @param primaryCategoryId Use only if the seller believes this product is associated with the wrong primary
+     *     category.
+     * @param marketplaceId Use this header to specify the eBay marketplace identifier.
+     */
+    getProductMetadata(epid, { otherApplicableCategoryIds, primaryCategoryId } = {}) {
+        return this.get(`/get_product_metadata`, {
+            params: {
+                epid,
+                other_applicable_category_ids: otherApplicableCategoryIds,
+                primary_category_id: primaryCategoryId
+            }
+        });
+    }
+    /**
+     * This call retrieves an array of all supported aspects, aspect constraints, and aspect values for the specified
+     * eBay categories.
+     *
+     * @param primaryCategoryId The unique identifier of the primary eBay category for which you will retrieve product
+     *     aspects.
+     * @param otherApplicableCategoryIds A string of comma-separated category IDs.
+     */
+    getProductMetadataForCategories(primaryCategoryId, otherApplicableCategoryIds) {
+        return this.get(`/get_product_metadata_for_categories`, {
+            params: {
+                primary_category_id: primaryCategoryId,
+                other_applicable_category_ids: otherApplicableCategoryIds
+            }
+        });
+    }
+}
+Catalog.id = 'Catalog';
+export default Catalog;

package/dist/api/restful/commerce/charity/index.d.ts

@@ -1,34 +1,35 @@
-import Restful from '../../index.js';
-/**
- * The Charity API allows third-party developers to search for and access details on supported charitable organizations.
- */
-export default class Charity extends Restful {
-    static id: string;
-    get basePath(): string;
-    /**
-     * This call is used to retrieve detailed information about supported charitable organizations.
-     *
-     * @param charityOrgId The unique ID of the charitable organization.
-     */
-    getCharityOrg(charityOrgId: string): Promise<any>;
-    /**
-     * This call is used to retrieve detailed information about supported charitable organizations.
-     *
-     * @param limit The number of items, from the result set, returned in a single page. Valid Values: 1-100 Default: 20
-     * @param offset The number of items that will be skipped in the result set.
-     * @param q A query string that matches the keywords in name, mission statement, or description.
-     * @param registrationIds A comma-separated list of charitable organization registration IDs.
-     */
-    getCharityOrgs({ limit, offset, q, registrationIds }: {
-        limit?: string;
-        offset?: string;
-        q?: string;
-        registrationIds?: string;
-    }): Promise<any>;
-    /**
-     * This call allows users to retrieve the details for a specific charitable organization using its legacy charity ID, which has also been referred to as the charity number, external ID, and PayPal Giving Fund ID.
-     *
-     * @param legacyCharityOrgId The legacy ID of the charitable organization.
-     */
-    getCharityOrgByLegacyId(legacyCharityOrgId: string): Promise<any>;
-}
+import { operations } from '../../../../types/restful/specs/commerce_charity_v1_oas3.js';
+import Restful, { OpenApi } from '../../index.js';
+/**
+ * The Charity API allows third-party developers to search for and access details on supported charitable organizations.
+ */
+export default class Charity extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This call is used to retrieve detailed information about supported charitable organizations.
+     *
+     * @param charityOrgId The unique ID of the charitable organization.
+     */
+    getCharityOrg(charityOrgId: string): Promise<any>;
+    /**
+     * This call is used to retrieve detailed information about supported charitable organizations.
+     *
+     * @param limit The number of items, from the result set, returned in a single page. Valid Values: 1-100 Default: 20
+     * @param offset The number of items that will be skipped in the result set.
+     * @param q A query string that matches the keywords in name, mission statement, or description.
+     * @param registrationIds A comma-separated list of charitable organization registration IDs.
+     */
+    getCharityOrgs({ limit, offset, q, registrationIds }: {
+        limit?: string;
+        offset?: string;
+        q?: string;
+        registrationIds?: string;
+    }): Promise<any>;
+    /**
+     * This call allows users to retrieve the details for a specific charitable organization using its legacy charity ID, which has also been referred to as the charity number, external ID, and PayPal Giving Fund ID.
+     *
+     * @param legacyCharityOrgId The legacy ID of the charitable organization.
+     */
+    getCharityOrgByLegacyId(legacyCharityOrgId: string): Promise<any>;
+}

package/dist/api/restful/commerce/charity/index.js

@@ -1,49 +1,50 @@
-import Restful from '../../index.js';
-/**
- * The Charity API allows third-party developers to search for and access details on supported charitable organizations.
- */
-export default class Charity extends Restful {
-    get basePath() {
-        return '/commerce/charity/v1';
-    }
-    /**
-     * This call is used to retrieve detailed information about supported charitable organizations.
-     *
-     * @param charityOrgId The unique ID of the charitable organization.
-     */
-    getCharityOrg(charityOrgId) {
-        charityOrgId = encodeURIComponent(charityOrgId);
-        return this.get(`/charity_org/${charityOrgId}`);
-    }
-    /**
-     * This call is used to retrieve detailed information about supported charitable organizations.
-     *
-     * @param limit The number of items, from the result set, returned in a single page. Valid Values: 1-100 Default: 20
-     * @param offset The number of items that will be skipped in the result set.
-     * @param q A query string that matches the keywords in name, mission statement, or description.
-     * @param registrationIds A comma-separated list of charitable organization registration IDs.
-     */
-    getCharityOrgs({ limit, offset, q, registrationIds }) {
-        return this.get(`/charity_org`, {
-            params: {
-                limit,
-                offset,
-                q,
-                registration_ids: registrationIds
-            }
-        });
-    }
-    /**
-     * This call allows users to retrieve the details for a specific charitable organization using its legacy charity ID, which has also been referred to as the charity number, external ID, and PayPal Giving Fund ID.
-     *
-     * @param legacyCharityOrgId The legacy ID of the charitable organization.
-     */
-    getCharityOrgByLegacyId(legacyCharityOrgId) {
-        return this.get(`/charity_org/get_charity_org_by_legacy_id`, {
-            params: {
-                legacy_charity_org_id: legacyCharityOrgId
-            }
-        });
-    }
-}
-Charity.id = 'Charity';
+import Restful from '../../index.js';
+/**
+ * The Charity API allows third-party developers to search for and access details on supported charitable organizations.
+ */
+class Charity extends Restful {
+    get basePath() {
+        return '/commerce/charity/v1';
+    }
+    /**
+     * This call is used to retrieve detailed information about supported charitable organizations.
+     *
+     * @param charityOrgId The unique ID of the charitable organization.
+     */
+    getCharityOrg(charityOrgId) {
+        charityOrgId = encodeURIComponent(charityOrgId);
+        return this.get(`/charity_org/${charityOrgId}`);
+    }
+    /**
+     * This call is used to retrieve detailed information about supported charitable organizations.
+     *
+     * @param limit The number of items, from the result set, returned in a single page. Valid Values: 1-100 Default: 20
+     * @param offset The number of items that will be skipped in the result set.
+     * @param q A query string that matches the keywords in name, mission statement, or description.
+     * @param registrationIds A comma-separated list of charitable organization registration IDs.
+     */
+    getCharityOrgs({ limit, offset, q, registrationIds }) {
+        return this.get(`/charity_org`, {
+            params: {
+                limit,
+                offset,
+                q,
+                registration_ids: registrationIds
+            }
+        });
+    }
+    /**
+     * This call allows users to retrieve the details for a specific charitable organization using its legacy charity ID, which has also been referred to as the charity number, external ID, and PayPal Giving Fund ID.
+     *
+     * @param legacyCharityOrgId The legacy ID of the charitable organization.
+     */
+    getCharityOrgByLegacyId(legacyCharityOrgId) {
+        return this.get(`/charity_org/get_charity_org_by_legacy_id`, {
+            params: {
+                legacy_charity_org_id: legacyCharityOrgId
+            }
+        });
+    }
+}
+Charity.id = 'Charity';
+export default Charity;

package/dist/api/restful/commerce/identity/index.d.ts

@@ -1,14 +1,15 @@
-import Restful from '../../index.js';
-/**
- * Retrieves the authenticated user's account profile information.
- */
-export default class Identity extends Restful {
-    static id: string;
-    get basePath(): string;
-    get subdomain(): string;
-    /**
-     * This method retrieves the account profile information for an authenticated user, which requires a User access
-     * token. What is returned is controlled by the scopes.
-     */
-    getUser(): Promise<any>;
-}
+import { operations } from '../../../../types/restful/specs/commerce_identity_v1_oas3.js';
+import Restful, { OpenApi } from '../../index.js';
+/**
+ * Retrieves the authenticated user's account profile information.
+ */
+export default class Identity extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    get subdomain(): string;
+    /**
+     * This method retrieves the account profile information for an authenticated user, which requires a User access
+     * token. What is returned is controlled by the scopes.
+     */
+    getUser(): Promise<any>;
+}

package/dist/api/restful/commerce/identity/index.js

@@ -1,20 +1,21 @@
-import Restful from '../../index.js';
-/**
- * Retrieves the authenticated user's account profile information.
- */
-export default class Identity extends Restful {
-    get basePath() {
-        return '/commerce/identity/v1';
-    }
-    get subdomain() {
-        return 'apiz';
-    }
-    /**
-     * This method retrieves the account profile information for an authenticated user, which requires a User access
-     * token. What is returned is controlled by the scopes.
-     */
-    getUser() {
-        return this.get(`/user/`);
-    }
-}
-Identity.id = 'Identity';
+import Restful from '../../index.js';
+/**
+ * Retrieves the authenticated user's account profile information.
+ */
+class Identity extends Restful {
+    get basePath() {
+        return '/commerce/identity/v1';
+    }
+    get subdomain() {
+        return 'apiz';
+    }
+    /**
+     * This method retrieves the account profile information for an authenticated user, which requires a User access
+     * token. What is returned is controlled by the scopes.
+     */
+    getUser() {
+        return this.get(`/user/`);
+    }
+}
+Identity.id = 'Identity';
+export default Identity;

package/dist/api/restful/commerce/index.d.ts

@@ -1,15 +1,15 @@
-import Catalog from './catalog/index.js';
-import Charity from './charity/index.js';
-import Identity from './identity/index.js';
-import Notification from './notification/index.js';
-import Taxonomy from './taxonomy/index.js';
-import Translation from './translation/index.js';
-export type Commerce = {
-    catalog: Catalog;
-    charity: Charity;
-    identity: Identity;
-    notification: Notification;
-    taxonomy: Taxonomy;
-    translation: Translation;
-};
-export { Catalog, Charity, Identity, Notification, Taxonomy, Translation };
+import Catalog from './catalog/index.js';
+import Charity from './charity/index.js';
+import Identity from './identity/index.js';
+import Notification from './notification/index.js';
+import Taxonomy from './taxonomy/index.js';
+import Translation from './translation/index.js';
+export type Commerce = {
+    catalog: Catalog;
+    charity: Charity;
+    identity: Identity;
+    notification: Notification;
+    taxonomy: Taxonomy;
+    translation: Translation;
+};
+export { Catalog, Charity, Identity, Notification, Taxonomy, Translation };