ebay-api 8.1.0 → 8.2.0

package/README.md

@@ -21,7 +21,7 @@ It supports `client credentials grant` and `authorization code grant` \(Auth'N'A
 
 ## Changelog
 
-* `v8.1.0` is the latest release.
+* `v8.2.0` is the latest release.
 * See [here](https://github.com/hendt/ebay-api/blob/master/CHANGELOG.md) for the full changelog.
 
 ## Implementation status
@@ -34,7 +34,7 @@ It supports `client credentials grant` and `authorization code grant` \(Auth'N'A
 | **Commerce API**   | ✔ Catalog API<br>✔ Charity API `v1.2.0`<br>✔ Identity API<br>✔ Notification API `v1.2.0`<br>✔ Taxonomy API `v1.0.0`<br>✔ Translation API `v1_beta.1.4`                                                                                                                                                                                 |
 | **Developer API**  | ✔ Analytics API                                                                                                                                                                                                                                                                                                                        |
 | **Post Order API** | ✔ Cancellation API<br>✔ Case Management API<br>✔ Inquiry API<br>✔ Return API                                                                                                                                                                                                                                                           |
-| **Sell API**       | ✔ Account API `v1.6.3`<br>✔ Analytics API `v1.3.0`<br>✔ Compliance API `v1.4.1`<br>✔ Feed API<br>✔ Finance API `v1.9.0`<br>✔ Fulfillment API `v1.19.10`<br>✔ Inventory API `v1.14.0`<br>✔ Listing API<br>✔ Logistics API<br>✔ Marketing API `v1.10.0`<br>✔ Metadata API<br>✔ Negotiation API `v1.1.0`<br>✔ Recommendation API `v1.1.0` |
+| **Sell API**       | ✔ Account API `v1.9.0`<br>✔ Analytics API `v1.3.0`<br>✔ Compliance API `v1.4.1`<br>✔ Feed API<br>✔ Finance API `v1.9.0`<br>✔ Fulfillment API `v1.19.10`<br>✔ Inventory API `v1.14.0`<br>✔ Listing API<br>✔ Logistics API<br>✔ Marketing API `v1.10.0`<br>✔ Metadata API<br>✔ Negotiation API `v1.1.0`<br>✔ Recommendation API `v1.1.0` |
 
 ### Traditional API
 

package/dist/api/restful/sell/account/index.d.ts

@@ -1,6 +1,6 @@
-import Restful from '../../index.js';
-import { FulfillmentPolicyRequest, PaymentPolicyRequest, Program, ReturnPolicyRequest, SalesTaxBase } from '../../../../types/index.js';
 import { PaymentsProgramType } from '../../../../enums/index.js';
+import { CustomPolicyCreateRequest, CustomPolicyRequest, FulfillmentPolicyRequest, InventoryLocation, InventoryLocationFull, PaymentPolicyRequest, Program, ReturnPolicyRequest, SalesTaxBase } from '../../../../types/index.js';
+import Restful from '../../index.js';
 /**
  * The <b>Account API</b> gives sellers the ability to configure their eBay seller accounts,
  * including the seller's policies (the Fulfillment Policy, Payment Policy, and Return Policy),
@@ -9,6 +9,27 @@ import { PaymentsProgramType } from '../../../../enums/index.js';
 export default class Account extends Restful {
     static id: string;
     get basePath(): string;
+    /**
+     * This method retrieves the list of custom policies specified by the <b>policy_types</b> query parameter for the selected eBay marketplace.
+     * @param policyTypes This query parameter specifies the type of custom policies to be returned.
+     */
+    getCustomPolicies(policyTypes: string): Promise<any>;
+    /**
+     * This method creates a new custom policy in which a seller specifies their terms for complying with local governmental regulations.
+     * @param body Request to create a new Custom Policy.
+     */
+    createCustomPolicy(body: CustomPolicyCreateRequest): Promise<any>;
+    /**
+     * This method retrieves the custom policy specified by the <b>custom_policy_id</b> path parameter for the selected eBay marketplace.
+     * @param customPolicyId This path parameter is the unique custom policy identifier for the policy to be returned.
+     */
+    getCustomPolicy(customPolicyId: string): Promise<any>;
+    /**
+     * This method updates an existing custom policy specified by the <b>custom_policy_id</b> path parameter for the selected marketplace.
+     * @param customPolicyId This path parameter is the unique custom policy identifier for the policy to be returned.
+     * @param body Request to update a current custom policy.
+     */
+    updateCustomPolicy(customPolicyId: string, body: CustomPolicyRequest): Promise<any>;
     /**
      * This method retrieves all the fulfillment policies configured for the marketplace you specify using the
      * marketplace_id query parameter.
@@ -210,8 +231,68 @@ export default class Account extends Restful {
      *     tax table you want to retrieve.
      */
     getSalesTaxes(countryCode: string): Promise<any>;
+    /**
+     * This method retrieves a list of subscriptions associated with the seller account.
+     * @param limit This field is for future use.
+     * @param continuationToken This field is for future use.
+     */
+    getSubscription({ limit, continuationToken }?: {
+        limit?: string;
+        continuationToken?: string;
+    }): Promise<any>;
     /**
      * his method is used by sellers onboarded for eBay managed payments, or sellers who are currently going through, or who are eligible for onboarding for eBay managed payments.
      */
     getKYC(): Promise<any>;
+    /**
+     * This method allows developers to check the seller eligibility status for eBay advertising programs.
+     * @param programTypes A comma-separated list of eBay advertising programs.
+     */
+    getAdvertisingEligibility(programTypes?: string): Promise<any>;
+    /**
+     * This call retrieves all defined details of the inventory location that is specified by the <b>merchantLocationKey</b> path parameter.
+     * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
+     */
+    getInventoryLocation(merchantLocationKey: string): Promise<any>;
+    /**
+     * <p>Use this call to create a new inventory location.
+     * @param merchantLocationKey A unique, merchant-defined key (ID) for an inventory location.
+     * @param body Inventory Location details
+     */
+    createInventoryLocation(merchantLocationKey: string, body: InventoryLocationFull): Promise<any>;
+    /**
+     * <p>This call deletes the inventory location that is specified in the <code>merchantLocationKey</code> path parameter.
+     * @param merchantLocationKey
+     */
+    deleteInventoryLocation(merchantLocationKey: string): Promise<any>;
+    /**
+     * <p>This call disables the inventory location that is specified in the <code>merchantLocationKey</code> path parameter.
+     * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
+     */
+    disableInventoryLocation(merchantLocationKey: string): Promise<any>;
+    /**
+     * <p>This call enables a disabled inventory location that is specified in the <code>merchantLocationKey</code> path parameter.
+     * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
+     */
+    enableInventoryLocation(merchantLocationKey: string): Promise<any>;
+    /**
+     * This call retrieves all defined details for every inventory location associated with the seller's account.
+     * @param limit The value passed in this query parameter sets the maximum number of records to return per page of data.
+     * @param offset Specifies the number of locations to skip in the result set before returning the first location in the paginated response.
+     */
+    getInventoryLocations({ limit, offset }?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<any>;
+    /**
+     * <p>Use this call to update non-physical location details for an existing inventory location.
+     * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
+     * @param body The inventory location details to be updated (other than the address and geo co-ordinates).
+     */
+    updateInventoryLocation(merchantLocationKey: string, body: InventoryLocation): Promise<any>;
+    /**
+     * This method retrieves all the sales tax jurisdictions for the country that you specify in the <b>countryCode</b> path parameter.
+     * @param countryCode This path parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> country code for the country whose jurisdictions you want to retrieve. eBay provides sales tax jurisdiction information for Canada and the United States.
+     */
+    getSalesTaxJurisdictions(countryCode: string): Promise<any>;
 }

package/dist/api/restful/sell/account/index.js

@@ -8,6 +8,41 @@ export default class Account extends Restful {
     get basePath() {
         return '/sell/account/v1';
     }
+    /**
+     * This method retrieves the list of custom policies specified by the <b>policy_types</b> query parameter for the selected eBay marketplace.
+     * @param policyTypes This query parameter specifies the type of custom policies to be returned.
+     */
+    getCustomPolicies(policyTypes) {
+        return this.get(`/custom_policy/`, {
+            params: {
+                policy_types: policyTypes
+            }
+        });
+    }
+    /**
+     * This method creates a new custom policy in which a seller specifies their terms for complying with local governmental regulations.
+     * @param body Request to create a new Custom Policy.
+     */
+    createCustomPolicy(body) {
+        return this.post(`/custom_policy/`, body);
+    }
+    /**
+     * This method retrieves the custom policy specified by the <b>custom_policy_id</b> path parameter for the selected eBay marketplace.
+     * @param customPolicyId This path parameter is the unique custom policy identifier for the policy to be returned.
+     */
+    getCustomPolicy(customPolicyId) {
+        customPolicyId = encodeURIComponent(customPolicyId);
+        return this.get(`/custom_policy/${customPolicyId}`);
+    }
+    /**
+     * This method updates an existing custom policy specified by the <b>custom_policy_id</b> path parameter for the selected marketplace.
+     * @param customPolicyId This path parameter is the unique custom policy identifier for the policy to be returned.
+     * @param body Request to update a current custom policy.
+     */
+    updateCustomPolicy(customPolicyId, body) {
+        customPolicyId = encodeURIComponent(customPolicyId);
+        return this.put(`/custom_policy/${customPolicyId}`, body);
+    }
     /**
      * This method retrieves all the fulfillment policies configured for the marketplace you specify using the
      * marketplace_id query parameter.
@@ -28,7 +63,7 @@ export default class Account extends Restful {
      * @param body Request to create a seller account fulfillment policy.
      */
     createFulfillmentPolicy(body) {
-        return this.post(`/fulfillment_policy`, body);
+        return this.post(`/fulfillment_policy/`, body);
     }
     /**
      * This method updates an existing fulfillment policy.
@@ -37,8 +72,8 @@ export default class Account extends Restful {
      * @param body Request to create a seller account fulfillment policy.
      */
     updateFulfillmentPolicy(fulfillmentPolicyId, body) {
-        const id = encodeURIComponent(fulfillmentPolicyId);
-        return this.put(`/fulfillment_policy/${id}`, body);
+        fulfillmentPolicyId = encodeURIComponent(fulfillmentPolicyId);
+        return this.put(`/fulfillment_policy/${fulfillmentPolicyId}`, body);
     }
     /**
      * This method deletes a fulfillment policy.
@@ -46,8 +81,8 @@ export default class Account extends Restful {
      * @param fulfillmentPolicyId This path parameter specifies the ID of the fulfillment policy to delete.
      */
     deleteFulfillmentPolicy(fulfillmentPolicyId) {
-        const id = encodeURIComponent(fulfillmentPolicyId);
-        return this.delete(`/fulfillment_policy/${id}`);
+        fulfillmentPolicyId = encodeURIComponent(fulfillmentPolicyId);
+        return this.delete(`/fulfillment_policy/${fulfillmentPolicyId}`);
     }
     /**
      * This method retrieves the complete details of a fulfillment policy.
@@ -320,11 +355,106 @@ export default class Account extends Restful {
             }
         });
     }
+    /**
+     * This method retrieves a list of subscriptions associated with the seller account.
+     * @param limit This field is for future use.
+     * @param continuationToken This field is for future use.
+     */
+    getSubscription({ limit, continuationToken } = {}) {
+        return this.get(`/subscription`, {
+            params: {
+                limit,
+                continuation_token: continuationToken
+            }
+        });
+    }
     /**
      * his method is used by sellers onboarded for eBay managed payments, or sellers who are currently going through, or who are eligible for onboarding for eBay managed payments.
      */
     getKYC() {
         return this.get(`/kyc`);
     }
+    /**
+     * This method allows developers to check the seller eligibility status for eBay advertising programs.
+     * @param programTypes A comma-separated list of eBay advertising programs.
+     */
+    getAdvertisingEligibility(programTypes) {
+        return this.get(`/advertising_eligibility`, {
+            params: {
+                program_types: programTypes
+            }
+        });
+    }
+    /**
+     * This call retrieves all defined details of the inventory location that is specified by the <b>merchantLocationKey</b> path parameter.
+     * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
+     */
+    getInventoryLocation(merchantLocationKey) {
+        merchantLocationKey = encodeURIComponent(merchantLocationKey);
+        return this.get(`/location/${merchantLocationKey}`);
+    }
+    /**
+     * <p>Use this call to create a new inventory location.
+     * @param merchantLocationKey A unique, merchant-defined key (ID) for an inventory location.
+     * @param body Inventory Location details
+     */
+    createInventoryLocation(merchantLocationKey, body) {
+        merchantLocationKey = encodeURIComponent(merchantLocationKey);
+        return this.post(`/location/${merchantLocationKey}`, body);
+    }
+    /**
+     * <p>This call deletes the inventory location that is specified in the <code>merchantLocationKey</code> path parameter.
+     * @param merchantLocationKey
+     */
+    deleteInventoryLocation(merchantLocationKey) {
+        merchantLocationKey = encodeURIComponent(merchantLocationKey);
+        return this.delete(`/location/${merchantLocationKey}`);
+    }
+    /**
+     * <p>This call disables the inventory location that is specified in the <code>merchantLocationKey</code> path parameter.
+     * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
+     */
+    disableInventoryLocation(merchantLocationKey) {
+        merchantLocationKey = encodeURIComponent(merchantLocationKey);
+        return this.post(`/location/${merchantLocationKey}/disable`);
+    }
+    /**
+     * <p>This call enables a disabled inventory location that is specified in the <code>merchantLocationKey</code> path parameter.
+     * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
+     */
+    enableInventoryLocation(merchantLocationKey) {
+        merchantLocationKey = encodeURIComponent(merchantLocationKey);
+        return this.post(`/location/${merchantLocationKey}/enable`);
+    }
+    /**
+     * This call retrieves all defined details for every inventory location associated with the seller's account.
+     * @param limit The value passed in this query parameter sets the maximum number of records to return per page of data.
+     * @param offset Specifies the number of locations to skip in the result set before returning the first location in the paginated response.
+     */
+    getInventoryLocations({ limit, offset } = {}) {
+        return this.get(`/location`, {
+            params: {
+                limit,
+                offset
+            }
+        });
+    }
+    /**
+     * <p>Use this call to update non-physical location details for an existing inventory location.
+     * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
+     * @param body The inventory location details to be updated (other than the address and geo co-ordinates).
+     */
+    updateInventoryLocation(merchantLocationKey, body) {
+        merchantLocationKey = encodeURIComponent(merchantLocationKey);
+        return this.post(`/location/${merchantLocationKey}/update_location_details`, body);
+    }
+    /**
+     * This method retrieves all the sales tax jurisdictions for the country that you specify in the <b>countryCode</b> path parameter.
+     * @param countryCode This path parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> country code for the country whose jurisdictions you want to retrieve. eBay provides sales tax jurisdiction information for Canada and the United States.
+     */
+    getSalesTaxJurisdictions(countryCode) {
+        countryCode = encodeURIComponent(countryCode);
+        return this.get(`/country/${countryCode}/sales_tax_jurisdiction`);
+    }
 }
 Account.id = 'Account';