ebay-api 8.4.0 → 8.5.0

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

@@ -1,41 +1,42 @@
-import Restful from '../../index.js';
-import { Metric } from '../../../../enums/index.js';
-/**
- * The Analytics API provides information about a seller's business performance.
- */
-export default class Analytics extends Restful {
-    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;
-        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>;
-}
+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

@@ -1,60 +1,60 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": 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: {
-                dimension,
-                filter,
-                metric,
-                sort
-            }
-        });
-    }
-    /**
-     * 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}`);
-    }
-}
-exports.default = Analytics;
-Analytics.id = 'Analytics';
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": 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: {
+                dimension,
+                filter,
+                metric,
+                sort
+            }
+        });
+    }
+    /**
+     * 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}`);
+    }
+}
+Analytics.id = 'Analytics';
+exports.default = Analytics;

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

@@ -1,37 +1,38 @@
-import Restful from '../../index.js';
-import { SuppressViolationRequest } from '../../../../types/index.js';
-/**
- * Service for providing the compliance violations of seller account/listings
- */
-export default class Compliance extends Restful {
-    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>;
-}
+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

@@ -1,56 +1,56 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": 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: {
-                compliance_type: complianceType
-            }
-        });
-    }
-    /**
-     * 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: {
-                compliance_type: complianceType,
-                offset,
-                listing_id: listingId,
-                limit
-            }
-        });
-    }
-    /**
-     * 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);
-    }
-}
-exports.default = Compliance;
-Compliance.id = 'Compliance';
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": 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: {
+                compliance_type: complianceType
+            }
+        });
+    }
+    /**
+     * 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: {
+                compliance_type: complianceType,
+                offset,
+                listing_id: listingId,
+                limit
+            }
+        });
+    }
+    /**
+     * 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);
+    }
+}
+Compliance.id = 'Compliance';
+exports.default = Compliance;