ebay-api 8.5.1 → 8.6.1

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

@@ -4,19 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_js_1 = __importDefault(require("../../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),
- * opt in and out of eBay seller programs, configure sales tax tables, and get account information.
- */
 class Account extends index_js_1.default {
     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: {
@@ -24,36 +15,17 @@ class Account extends index_js_1.default {
             }
         });
     }
-    /**
-     * 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.
-     *
-     * @param marketplaceId This query parameter specifies the eBay marketplace of the policies you want to retrieve.
-     */
     getFulfillmentPolicies(marketplaceId) {
         return this.get(`/fulfillment_policy`, {
             params: {
@@ -61,49 +33,20 @@ class Account extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method creates a new fulfillment policy where the policy encapsulates seller's terms for fulfilling item
-     * purchases.
-     *
-     * @param body Request to create a seller account fulfillment policy.
-     */
     createFulfillmentPolicy(body) {
         return this.post(`/fulfillment_policy/`, body);
     }
-    /**
-     * This method updates an existing fulfillment policy.
-     *
-     * @param fulfillmentPolicyId This path parameter specifies the ID of the fulfillment policy you want to update.
-     * @param body Request to create a seller account fulfillment policy.
-     */
     updateFulfillmentPolicy(fulfillmentPolicyId, body) {
         fulfillmentPolicyId = encodeURIComponent(fulfillmentPolicyId);
         return this.put(`/fulfillment_policy/${fulfillmentPolicyId}`, body);
     }
-    /**
-     * This method deletes a fulfillment policy.
-     *
-     * @param fulfillmentPolicyId This path parameter specifies the ID of the fulfillment policy to delete.
-     */
     deleteFulfillmentPolicy(fulfillmentPolicyId) {
         fulfillmentPolicyId = encodeURIComponent(fulfillmentPolicyId);
         return this.delete(`/fulfillment_policy/${fulfillmentPolicyId}`);
     }
-    /**
-     * This method retrieves the complete details of a fulfillment policy.
-     * Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId path parameter.
-     *
-     * @param fulfillmentPolicyId This path parameter specifies the ID of the fulfillment policy you want to retrieve.
-     */
     getFulfillmentPolicy(fulfillmentPolicyId) {
         return this.get(`/fulfillment_policy/${fulfillmentPolicyId}`);
     }
-    /**
-     * This method retrieves the complete details for a single fulfillment policy.
-     *
-     * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
-     * @param name This query parameter specifies the user-defined name of the fulfillment policy you want to retrieve.
-     */
     getFulfillmentPolicyByName(marketplaceId, name) {
         return this.get(`/fulfillment_policy/get_by_policy_name`, {
             params: {
@@ -112,12 +55,6 @@ class Account extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method retrieves all the payment policies configured for the marketplace you specify using the
-     * marketplace_id query parameter.
-     *
-     * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
-     */
     getPaymentPolicies(marketplaceId) {
         return this.get(`/payment_policy`, {
             params: {
@@ -125,49 +62,21 @@ class Account extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve
-     * using the paymentPolicyId path parameter.
-     *
-     * @param paymentPolicyId This path parameter specifies the ID of the payment policy you want to retrieve.
-     */
     getPaymentPolicy(paymentPolicyId) {
         paymentPolicyId = encodeURIComponent(paymentPolicyId);
         return this.get(`/payment_policy/${paymentPolicyId}`);
     }
-    /**
-     * This method creates a new payment policy where the policy encapsulates seller's terms for purchase payments.
-     *
-     * @param body Payment policy request
-     */
     createPaymentPolicy(body) {
         return this.post(`/payment_policy`, body);
     }
-    /**
-     * This method updates an existing payment policy.
-     *
-     * @param paymentPolicyId This path parameter specifies the ID of the payment policy you want to update.
-     * @param body Payment policy request
-     */
     updatePaymentPolicy(paymentPolicyId, body) {
         paymentPolicyId = encodeURIComponent(paymentPolicyId);
         return this.put(`/payment_policy/${paymentPolicyId}`, body);
     }
-    /**
-     * This method updates an existing payment policy.
-     *
-     * @param paymentPolicyId This path parameter specifies the ID of the payment policy you want to delete.
-     */
     deletePaymentPolicy(paymentPolicyId) {
         paymentPolicyId = encodeURIComponent(paymentPolicyId);
         return this.delete(`/payment_policy/${paymentPolicyId}`);
     }
-    /**
-     * This method retrieves the complete details of a single payment policy.
-     *
-     * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
-     * @param name This query parameter specifies the user-defined name of the payment policy you want to retrieve.
-     */
     getPaymentPolicyByName(marketplaceId, name) {
         return this.get(`/payment_policy/get_by_policy_name`, {
             params: {
@@ -176,65 +85,28 @@ class Account extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method returns whether or not the user is opted-in to the payment program.
-     *
-     * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
-     * @param paymentsProgramType This path parameter specifies the payments program whose status is returned by the
-     *     call.
-     */
     getPaymentsProgram(marketplaceId, paymentsProgramType) {
         marketplaceId = encodeURIComponent(marketplaceId);
         const type = encodeURIComponent(paymentsProgramType);
         return this.get(`/payments_program/${marketplaceId}/${type}`);
     }
-    /**
-     * This method retrieves a seller's onboarding status of eBay managed payments for a specified marketplace.
-     *
-     * @param marketplaceId This query parameter specifies the eBay marketplace of the policy you want to retrieve.
-     * @param paymentsProgramType This path parameter specifies the payments program whose status is returned by the
-     *     call.
-     */
     getPaymentsProgramOnboarding(marketplaceId, paymentsProgramType) {
         marketplaceId = encodeURIComponent(marketplaceId);
         const type = encodeURIComponent(paymentsProgramType);
         return this.get(`/payments_program/${marketplaceId}/${type}/onboarding`);
     }
-    /**
-     * This method retrieves the seller's current set of privileges.
-     */
     getPrivileges() {
         return this.get(`/privilege`);
     }
-    /**
-     * This method gets a list of the seller programs that the seller has opted-in to.
-     */
     getOptedInPrograms() {
         return this.get(`/program/get_opted_in_programs`);
     }
-    /**
-     * This method opts the seller in to an eBay seller program.
-     *
-     * @param body Program being opted-in to.
-     */
     optInToProgram(body) {
         return this.post(`/program/opt_in`, body);
     }
-    /**
-     * This method opts the seller out of a seller program to which you have previously opted-in to.
-     *
-     * @param body Program being opted-out of.
-     */
     optOutOfProgram(body) {
         return this.post(`/program/opt_out`, body);
     }
-    /**
-     * This method retrieves a seller's shipping rate tables for the country specified in the country_code query
-     * parameter.
-     *
-     * @param countryCode This query parameter specifies the two-letter ISO 3166-1 Alpha-2 code of country for which
-     *     you want shipping-rate table information.
-     */
     getRateTables(countryCode) {
         return this.get(`/rate_table`, {
             params: {
@@ -242,13 +114,6 @@ class Account extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method retrieves all the return policies configured for the marketplace you specify using the
-     * marketplace_id query parameter.
-     *
-     * @param marketplaceId This query parameter specifies the ID of the eBay marketplace of the policy you want to
-     *     retrieve.
-     */
     getReturnPolicies(marketplaceId) {
         return this.get(`/return_policy`, {
             params: {
@@ -256,49 +121,21 @@ class Account extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter.
-     *
-     * @param returnPolicyId This path parameter specifies the of the return policy you want to retrieve.
-     */
     getReturnPolicy(returnPolicyId) {
         returnPolicyId = encodeURIComponent(returnPolicyId);
         return this.get(`/return_policy/${returnPolicyId}`);
     }
-    /**
-     * This method creates a new return policy where the policy encapsulates seller's terms for returning items.
-     *
-     * @param body Return policy request
-     */
     createReturnPolicy(body) {
         return this.post(`/return_policy`, body);
     }
-    /**
-     * This method creates a new return policy where the policy encapsulates seller's terms for returning items.
-     *
-     *  @param returnPolicyId This path parameter specifies the ID of the return policy you want to update.
-     * @param body Return policy request
-     */
     updateReturnPolicy(returnPolicyId, body) {
         returnPolicyId = encodeURIComponent(returnPolicyId);
         return this.put(`/return_policy/${returnPolicyId}`, body);
     }
-    /**
-     * This method deletes a return policy.
-     *
-     * @param returnPolicyId This path parameter specifies the ID of the return policy you want to delete.
-     */
     deleteReturnPolicy(returnPolicyId) {
         returnPolicyId = encodeURIComponent(returnPolicyId);
         return this.delete(`/return_policy/${returnPolicyId}`);
     }
-    /**
-     * This method retrieves the complete details of a single return policy.
-     *
-     * @param marketplaceId This query parameter specifies the ID of the eBay marketplace of the policy you want to
-     *     retrieve.
-     * @param name This query parameter specifies the user-defined name of the return policy you want to retrieve.
-     */
     getReturnPolicyByName(marketplaceId, name) {
         return this.get(`/return_policy/get_by_policy_name`, {
             params: {
@@ -307,52 +144,21 @@ class Account extends index_js_1.default {
             }
         });
     }
-    /**
-     * This call gets the current tax table entry for a specific tax jurisdiction.
-     *
-     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country whose
-     *     tax table you want to retrieve.
-     * @param jurisdictionId This path parameter specifies the ID of the sales tax jurisdiction for the tax table entry
-     *     you want to retrieve.
-     */
     getSalesTax(countryCode, jurisdictionId) {
         countryCode = encodeURIComponent(countryCode);
         jurisdictionId = encodeURIComponent(jurisdictionId);
         return this.get(`/sales_tax/${countryCode}/${jurisdictionId}`);
     }
-    /**
-     * This method creates or updates a sales tax table entry for a jurisdiction.
-     *
-     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country for
-     *     which you want to create tax table entry.
-     * @param jurisdictionId This path parameter specifies the ID of the sales-tax jurisdiction for the table entry you
-     *     want to create.
-     * @param body A container that describes the how the sales tax is calculated.
-     */
     createOrReplaceSalesTax(countryCode, jurisdictionId, body) {
         countryCode = encodeURIComponent(countryCode);
         jurisdictionId = encodeURIComponent(jurisdictionId);
         return this.put(`/sales_tax/${countryCode}/${jurisdictionId}`, body);
     }
-    /**
-     * This call deletes a tax table entry for a jurisdiction.
-     *
-     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country for
-     *     which you want to create tax table entry.
-     * @param jurisdictionId This path parameter specifies the ID of the sales-tax jurisdiction for the table entry you
-     *     want to delete.
-     */
     deleteSalesTax(countryCode, jurisdictionId) {
         countryCode = encodeURIComponent(countryCode);
         jurisdictionId = encodeURIComponent(jurisdictionId);
         return this.delete(`/sales_tax/${countryCode}/${jurisdictionId}`);
     }
-    /**
-     * Use this call to retrieve a sales tax table that the seller established for a specific country.
-     *
-     * @param countryCode This path parameter specifies the two-letter ISO 3166-1 Alpha-2 code for the country whose
-     *     tax table you want to retrieve.
-     */
     getSalesTaxes(countryCode) {
         return this.get(`/sales_tax`, {
             params: {
@@ -360,11 +166,6 @@ class Account extends index_js_1.default {
             }
         });
     }
-    /**
-     * 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: {
@@ -373,16 +174,9 @@ class Account extends index_js_1.default {
             }
         });
     }
-    /**
-     * 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: {
@@ -390,52 +184,26 @@ class Account extends index_js_1.default {
             }
         });
     }
-    /**
-     * 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: {
@@ -444,19 +212,10 @@ class Account extends index_js_1.default {
             }
         });
     }
-    /**
-     * <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`);

package/lib/api/restful/sell/analytics/index.d.ts

@@ -1,42 +1,16 @@
 import { Metric } from '../../../../enums/index.js';
 import { operations } from '../../../../types/restful/specs/sell_analytics_v1_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
-/**
- * The Analytics API provides information about a seller's business performance.
- */
 export default class Analytics extends Restful implements OpenApi<operations> {
     static id: string;
     get basePath(): string;
-    /**
-     * This call retrieves all the profiles for the associated seller.
-     */
     findSellerStandardsProfiles(): Promise<any>;
-    /**
-     * This call retrieves seller's profiles based on a program or cycle.
-     *
-     * @param program Specifies the program of the requested profile.
-     * @param cycle Specifies the cycle of the requested profile.
-     */
     getSellerStandardsProfile(program: string, cycle: string): Promise<any>;
-    /**
-     * This call returns a report that details the user-traffic a seller's listings receives.
-     *
-     * @param dimension Specifies the basis of the report data.
-     * @param filter Limits the report data returned.
-     * @param metric Specifies a comma separated list of the metrics you want included in the report.
-     * @param sort Specifies a single metric to be sorted and whether you want to sort in ascending or descending order.
-     */
     getTrafficReport({ dimension, filter, metric, sort }?: {
         dimension?: string;
         filter?: string;
         metric?: Metric | `${Metric}`;
         sort?: string;
     }): Promise<any>;
-    /**
-     * Use this method to retrieve a seller's performance and rating for the customer service metric.
-     *
-     * @param customerServiceMetricType Use this path parameter to specify the type of customer service metrics and benchmark data you want returned for the seller.
-     * @param evaluationType Use this query parameter to specify the Marketplace ID to evaluate for the customer service metrics and benchmark data.
-     */
     getCustomerServiceMetric(customerServiceMetricType: string, evaluationType: string): Promise<any>;
 }

package/lib/api/restful/sell/analytics/index.js

@@ -4,38 +4,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_js_1 = __importDefault(require("../../index.js"));
-/**
- * The Analytics API provides information about a seller's business performance.
- */
 class Analytics extends index_js_1.default {
     get basePath() {
         return '/sell/analytics/v1';
     }
-    /**
-     * This call retrieves all the profiles for the associated seller.
-     */
     findSellerStandardsProfiles() {
         return this.get(`/seller_standards_profile`);
     }
-    /**
-     * This call retrieves seller's profiles based on a program or cycle.
-     *
-     * @param program Specifies the program of the requested profile.
-     * @param cycle Specifies the cycle of the requested profile.
-     */
     getSellerStandardsProfile(program, cycle) {
         program = encodeURIComponent(program);
         cycle = encodeURIComponent(cycle);
         return this.get(`/seller_standards_profile/${program}/${cycle}`);
     }
-    /**
-     * This call returns a report that details the user-traffic a seller's listings receives.
-     *
-     * @param dimension Specifies the basis of the report data.
-     * @param filter Limits the report data returned.
-     * @param metric Specifies a comma separated list of the metrics you want included in the report.
-     * @param sort Specifies a single metric to be sorted and whether you want to sort in ascending or descending order.
-     */
     getTrafficReport({ dimension, filter, metric, sort } = {}) {
         return this.get(`/traffic_report`, {
             params: {
@@ -46,12 +26,6 @@ class Analytics extends index_js_1.default {
             }
         });
     }
-    /**
-     * Use this method to retrieve a seller's performance and rating for the customer service metric.
-     *
-     * @param customerServiceMetricType Use this path parameter to specify the type of customer service metrics and benchmark data you want returned for the seller.
-     * @param evaluationType Use this query parameter to specify the Marketplace ID to evaluate for the customer service metrics and benchmark data.
-     */
     getCustomerServiceMetric(customerServiceMetricType, evaluationType) {
         return this.get(`/customer_service_metric/${customerServiceMetricType}/${evaluationType}`);
     }

package/lib/api/restful/sell/compliance/index.d.ts

@@ -1,38 +1,15 @@
 import { SuppressViolationRequest } from '../../../../types/index.js';
 import { operations } from '../../../../types/restful/specs/sell_compliance_v1_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
-/**
- * Service for providing the compliance violations of seller account/listings
- */
 export default class Compliance extends Restful implements OpenApi<operations> {
     static id: string;
     get basePath(): string;
-    /**
-     * This call returns listing violation counts for a seller.
-     *
-     * @param complianceType A user passes in one or more compliance type values through this query parameter.
-     */
     getListingViolationsSummary(complianceType?: string): Promise<any>;
-    /**
-     * This call returns specific listing violations for five different compliance types.
-     *
-     * @param complianceType A user passes in one or more compliance type values through this query parameter.
-     * @param offset The first policy violation to return based on its position in the collection of listing
-     *     violations.
-     * @param listingId
-     * @param limit This query parameter is used if the user wants to set a limit on the number of listing violations
-     *     that are returned in the current result set.
-     */
     getListingViolations({ complianceType, offset, listingId, limit }?: {
         complianceType?: string;
         offset?: number;
         listingId?: string;
         limit?: number;
     }): Promise<any>;
-    /**
-     * This call suppresses a listing violation for a specific listing. Only listing violations in the AT_RISK state (returned in the violations.complianceState field of the getListingViolations call) can be suppressed.
-     *
-     * @param body  SuppressViolationRequest
-     */
     suppressViolation(body: SuppressViolationRequest): Promise<any>;
 }

package/lib/api/restful/sell/compliance/index.js

@@ -4,18 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_js_1 = __importDefault(require("../../index.js"));
-/**
- * Service for providing the compliance violations of seller account/listings
- */
 class Compliance extends index_js_1.default {
     get basePath() {
         return '/sell/compliance/v1';
     }
-    /**
-     * This call returns listing violation counts for a seller.
-     *
-     * @param complianceType A user passes in one or more compliance type values through this query parameter.
-     */
     getListingViolationsSummary(complianceType) {
         return this.get(`/listing_violation_summary`, {
             params: {
@@ -23,16 +15,6 @@ class Compliance extends index_js_1.default {
             }
         });
     }
-    /**
-     * This call returns specific listing violations for five different compliance types.
-     *
-     * @param complianceType A user passes in one or more compliance type values through this query parameter.
-     * @param offset The first policy violation to return based on its position in the collection of listing
-     *     violations.
-     * @param listingId
-     * @param limit This query parameter is used if the user wants to set a limit on the number of listing violations
-     *     that are returned in the current result set.
-     */
     getListingViolations({ complianceType, offset, listingId, limit } = {}) {
         return this.get(`/listing_violation`, {
             params: {
@@ -43,11 +25,6 @@ class Compliance extends index_js_1.default {
             }
         });
     }
-    /**
-     * This call suppresses a listing violation for a specific listing. Only listing violations in the AT_RISK state (returned in the violations.complianceState field of the getListingViolations call) can be suppressed.
-     *
-     * @param body  SuppressViolationRequest
-     */
     suppressViolation(body) {
         return this.post(`/suppress_listing_violation`, body);
     }