ebay-api 8.5.0 → 8.6.0

package/dist/api/restful/buy/order/index.js

@@ -1,299 +1,105 @@
 import Api from '../../index.js';
-/**
- * The Order API provides interfaces that lets shoppers pay for items (for both eBay guest and eBay member buyers).
- * Client Credentials: https://api.ebay.com/oauth/api_scope/buy.order
- */
 class Order extends Api {
     get basePath() {
         return '/buy/order/v1';
     }
-    /**
-     * (Limited Release) You must be whitelisted to use this method.
-     * This method adds a coupon to an eBay proxy guest checkout session and applies it to all the eligible items in
-     * the order.
-     *
-     * @param {String} checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is
-     *     returned by the initiateCheckoutSession method.
-     * @param body The container for the fields used to apply a coupon to a checkout session.
-     */
     applyCoupon(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/checkout_session/${checkoutSessionId}/apply_coupon`, body);
     }
-    /**
-     * This method returns the details of the specified eBay member checkout session.
-     *
-     * @param {String} checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is
-     *     returned by the initiateCheckoutSession method.
-     */
     getCheckoutSession(checkoutSessionId) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.get(`/checkout_session/${checkoutSessionId}`);
     }
-    /**
-     * This method creates a eBay member checkout session, which is the first step in performing a checkout.
-     *
-     * @param body The container for the fields used by the initiateCheckoutSession method.
-     */
     initiateCheckoutSession(body) {
         return this.post(`/checkout_session/initiate`, body);
     }
-    /**
-     * This method creates the purchase order, pays for the items, and terminates the specified eBay member checkout
-     * session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     */
     placeOrder(checkoutSessionId) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/checkout_session/${checkoutSessionId}/place_order`);
     }
-    /**
-     * (Limited Release) You must be whitelisted to use this method. This method removes a coupon from an eBay member
-     * checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body CouponRequest
-     */
     removeCoupon(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/checkout_session/${checkoutSessionId}/remove_coupon`, body);
     }
-    /**
-     * This method changes the payment method information of the specified eBay member checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdatePaymentInformation
-     */
     updatePaymentInfo(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/checkout_session/${checkoutSessionId}/update_payment_info`, body);
     }
-    /**
-     * This method changes the quantity of the specified line item in an eBay member checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdateQuantity
-     */
     updateQuantity(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/checkout_session/${checkoutSessionId}/update_quantity`, body);
     }
-    /**
-     * This method changes the quantity of the specified line item in an eBay member checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdateQuantity
-     */
     checkoutSessionId(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/checkout_session/${checkoutSessionId}/update_quantity`, body);
     }
-    /**
-     * This method changes the shipping address for in an eBay member checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body ShippingAddressImpl
-     */
     updateShippingAddress(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/checkout_session/${checkoutSessionId}/update_shipping_address`, body);
     }
-    /**
-     * This method changes the shipping method for the specified line item in an eBay member checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdateShippingOption
-     */
     updateShippingOption(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/checkout_session/${checkoutSessionId}/update_shipping_option`, body);
     }
-    /**
-     * (Limited Release) You must be whitelisted to use this method. This method adds a coupon to an eBay guest
-     * checkout
-     *  session and applies it to all the eligible items in the order.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body CouponRequest
-     */
     applyGuestCoupon(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/guest_checkout_session/${checkoutSessionId}/apply_coupon`, body);
     }
-    /**
-     * This method returns the details of the specified guest checkout session. The checkoutSessionId is passed in as a
-     * URI parameter and is required.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     */
     getGuestCheckoutSession(checkoutSessionId) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.get(`/guest_checkout_session/${checkoutSessionId}`);
     }
-    /**
-     * This method creates an eBay guest checkout session, which is the first step in performing a checkout.
-     *
-     * @param body CheckoutSessionRequest
-     */
     initiateGuestCheckoutSession(body) {
         return this.post(`/guest_checkout_session/initiate`, body);
     }
-    /**
-     * This method is used only in the PayPal Smart Button eBay guest payment flow.
-     *
-     *  @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     *  @param body InitiatePaymentRequest
-     */
     initiateGuestPayment(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/guest_checkout_session/${checkoutSessionId}/initiate_payment`, body);
     }
-    /**
-     * This method creates the purchase order, pays for the items, and terminates the specified guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body GuestPlaceOrderRequest
-     */
     placeGuestOrder(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/guest_checkout_session/${checkoutSessionId}/place_order`, body);
     }
-    /**
-     * (Limited Release) You must be whitelisted to use this method. This method removes a coupon from an eBay guest
-     * checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body CouponRequest
-     */
     removeGuestCoupon(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/guest_checkout_session/${checkoutSessionId}/remove_coupon`, body);
     }
-    /**
-     * This method changes the payment method information of the specified guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdatePaymentInformation
-     */
     updateGuestPaymentInfo(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/guest_checkout_session/${checkoutSessionId}/update_payment_info`, body);
     }
-    /**
-     * This method changes the quantity of the specified line item in an eBay guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdateQuantity
-     */
     updateGuestQuantity(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/guest_checkout_session/${checkoutSessionId}/update_quantity`, body);
     }
-    /**
-     * This method changes the shipping address for the order in an eBay guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body ShippingAddressImpl
-     */
     updateGuestShippingAddress(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/guest_checkout_session/${checkoutSessionId}/update_shipping_address`, body);
     }
-    /**
-     * This method changes the shipping method for the specified line item in an eBay guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdateShippingOption
-     */
     updateGuestShippingOption(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/guest_checkout_session/${checkoutSessionId}/update_shipping_option`, body);
     }
-    /**
-     * (Limited Release) You must be whitelisted to use this method. This method adds a coupon to an eBay proxy guest
-     * checkout session and applies it to all the eligible items in the order.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body CouponRequest
-     */
     applyProxyGuestCoupon(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/proxy_guest_checkout_session/${checkoutSessionId}/apply_coupon`, body);
     }
-    /**
-     * This method returns the details of the specified eBay proxy guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     */
     getProxyGuestCheckoutSession(checkoutSessionId) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.get(`/proxy_guest_checkout_session/${checkoutSessionId}`);
     }
-    /**
-     * This method creates an eBay proxy guest checkout session, which is a payment flow that requires apps
-     * with a VSP (vault service provider), such as Braintree. The VSP handles only the methods within this flow that
-     * contain payment information.
-     *
-     * @param body CheckoutSessionRequest
-     */
     initiateProxyGuestCheckoutSession(body) {
         return this.post(`/proxy_guest_checkout_session/initiate`, body);
     }
-    /**
-     * This method creates the proxy guest purchase order, pays for the items, and terminates the specified guest
-     * checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body GuestPlaceOrderRequest
-     */
     placeProxyGuestOrder(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/proxy_guest_checkout_session/${checkoutSessionId}/place_order`, body);
     }
-    /**
-     * (Limited Release) You must be whitelisted to use this method. This method removes a coupon from an eBay proxy
-     * guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body CouponRequest
-     */
     removeProxyGuestCoupon(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/proxy_guest_checkout_session/${checkoutSessionId}/remove_coupon`, body);
     }
-    /**
-     * This method adds or changes the payment information of the specified proxy guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param authorization The oAuth2 token. Note: The eBay partner must include this header in the request.
-     * @param date The UTC timestamp of the request, which is generated and added to the request by the VSP.
-     * @param requestNonce A UUID (a 128-bit universal unique ID), which is generated and added to the request by the
-     *     VSP.
-     * @param signature The HMAC signature, which is generated and added to the request by the VSP.
-     * @param body UpdatePaymentInformation
-     */
     updateProxyGuestPaymentInfo(checkoutSessionId, authorization, date, requestNonce, signature, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/proxy_guest_checkout_session/${checkoutSessionId}/update_payment_info`, body, {
@@ -305,55 +111,22 @@ class Order extends Api {
             }
         });
     }
-    /**
-     * This method changes the quantity of the specified line item in an eBay proxy guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdateQuantity
-     */
     updateProxyGuestQuantity(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/proxy_guest_checkout_session/${checkoutSessionId}/update_quantity`, body);
     }
-    /**
-     * This method changes the shipping address for the order in an eBay proxy guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body ShippingAddressImpl
-     */
     updateProxyGuestShippingAddress(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/proxy_guest_checkout_session/${checkoutSessionId}/update_shipping_address`, body);
     }
-    /**
-     * This method changes the shipping method for the specified line item in an eBay proxy guest checkout session.
-     *
-     * @param checkoutSessionId The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the
-     *     initiateCheckoutSession method.
-     * @param body UpdateShippingOption
-     */
     updateProxyGuestShippingOption(checkoutSessionId, body) {
         checkoutSessionId = encodeURIComponent(checkoutSessionId);
         return this.post(`/proxy_guest_checkout_session/${checkoutSessionId}/update_shipping_option`, body);
     }
-    /**
-     * This method retrieves the details about a specific guest purchase order.
-     *
-     * @param purchaseOrderId The unique identifier of a purchase order made by a guest buyer, for which details are to
-     *     be retrieved.
-     */
     getGuestPurchaseOrder(purchaseOrderId) {
         purchaseOrderId = encodeURIComponent(purchaseOrderId);
         return this.get(`/guest_purchase_order/${purchaseOrderId}`);
     }
-    /**
-     * This method retrieves the details about a specific eBay member purchase order.
-     *
-     * @param purchaseOrderId The unique identifier of a purchase order made by an eBay member, for which details are
-     *     to be retrieved.
-     */
     getPurchaseOrder(purchaseOrderId) {
         purchaseOrderId = encodeURIComponent(purchaseOrderId);
         return this.get(`/purchase_order/${purchaseOrderId}`);

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

@@ -1,74 +1,20 @@
 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,31 +1,11 @@
 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: {
@@ -35,41 +15,15 @@ class Catalog extends Restful {
             }
         });
     }
-    /**
-     * 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: {
@@ -79,14 +33,6 @@ class Catalog extends Restful {
             }
         });
     }
-    /**
-     * 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: {

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

@@ -1,35 +1,14 @@
 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,28 +1,12 @@
 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: {
@@ -33,11 +17,6 @@ class Charity extends Restful {
             }
         });
     }
-    /**
-     * 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: {

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

@@ -1,15 +1,8 @@
 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,7 +1,4 @@
 import Restful from '../../index.js';
-/**
- * Retrieves the authenticated user's account profile information.
- */
 class Identity extends Restful {
     get basePath() {
         return '/commerce/identity/v1';
@@ -9,10 +6,6 @@ class Identity extends Restful {
     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/`);
     }