ebay-mcp 1.4.3

package/build/types/sell-apps/other-apis/commerceVeroV1Oas3.d.ts

@@ -0,0 +1,417 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    '/vero_reason_code/{vero_reason_code_id}': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description <div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;"><span class="autonumber"><span><b><span style="color: #dd1e31;" class="mcFormatColor">Important!</span></b></span></span> You must be a member of the Verified Rights Owner (VeRO) Program to use this call.</p></div><br>This method is used to retrieve the details of a specific VeRO reason code, including a description of the code and the marketplace associated with the code.<br><br>The <b>vero_reason_code_id</b> of the VeRO reason code for which to retrieve details is required as a path parameter. */
+        get: operations['getVeroReasonCode'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/vero_reason_code': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description <div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;"><span class="autonumber"><span><b><span style="color: #dd1e31;" class="mcFormatColor">Important!</span></b></span></span> You must be a member of the Verified Rights Owner (VeRO) Program to use this call.</p></div><br>This method is used to retrieve the details of an array of VeRO reason codes. This information includes the descriptions of each code, as well as the marketplace associated with each code.<br><br> If the <b>X-EBAY-C-MARKETPLACE-ID</b> header is present, only VeRO reason codes for that specific site will be returned. If this header is not included, all reason codes for all sites are returned. */
+        get: operations['getVeroReasonCodes'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/vero_report': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description <div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;"><span class="autonumber"><span><b><span style="color: #dd1e31;" class="mcFormatColor">Important!</span></b></span></span> You must be a member of the Verified Rights Owner (VeRO) Program to use this call.</p></div><br>This method can be used to create a VeRO report for a listing. VeRO reports can be used to report items that your copyright, trademark, or other intellectual property rights.<br><br>The <b>itemId</b> of the item being reported must be provided in the request, as well as the <b>veroReasonCodeId</b> of the claimed infringement.<br><br>You can report one or more items at a time using this method. A maximum of 150 items can be reported using this method. */
+        post: operations['createVeroReport'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/vero_report/{vero_report_id}': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description <div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;"><span class="autonumber"><span><b><span style="color: #dd1e31;" class="mcFormatColor">Important!</span></b></span></span> You must be a member of the Verified Rights Owner (VeRO) Program to use this call.</p></div><br>This method can be used to retrieve status information about a VeRO report you have submitted to eBay for copyright, trademark, or other intellectual property rights infringement.<br><br>The <b>vero_report_id</b> path parameter is used to specify the eBay report for which to retrieve status information. */
+        get: operations['getVeroReport'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/vero_report_items': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Retrieves status for VERO infringement reports by Brand.
+         * @description <div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;"><span class="autonumber"><span><b><span style="color: #dd1e31;" class="mcFormatColor">Important!</span></b></span></span> You must be a member of the Verified Rights Owner (VeRO) Program to use this call.</p></div><br>This method can be used to retrieve status information about one or more VeRO reported items you have submitted.<br><br>Without the use of any query parameters, the default behavior of this method is to return the status of all VeRO reported items submitted by the seller during the last two years. Use the <b>itemId</b> query parameter to see a specific reported item, and use the <b>filter</b> query to retrieve the status of reported items submitted within a specific date range. Pagination is also available to limit the number of reported items that are retrieved per page of data.
+         */
+        get: operations['getVeroReportItems'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /** @description This type defines the fields that can be returned in an error. */
+        Error: {
+            /** @description Identifies the type of erro. */
+            category?: string;
+            /** @description Name for the primary system where the error occurred. This is relevant for application errors. */
+            domain?: string;
+            /**
+             * Format: int32
+             * @description A unique number to identify the error.
+             */
+            errorId?: number;
+            /** @description An array of request elements most closely associated to the error. */
+            inputRefIds?: string[];
+            /** @description A more detailed explanation of the error. */
+            longMessage?: string;
+            /** @description Information on how to correct the problem, in the end user's terms and language where applicable. */
+            message?: string;
+            /** @description An array of request elements most closely associated to the error. */
+            outputRefIds?: string[];
+            /** @description An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned. */
+            parameters?: components['schemas']['ErrorParameter'][];
+            /** @description Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc. */
+            subdomain?: string;
+        };
+        ErrorParameter: {
+            /** @description The object of the error. */
+            name?: string;
+            /** @description The value of the object. */
+            value?: string;
+        };
+        /** @description This type defines the brief and detailed description of a VeRO infringement, as well as the ID associated with the infringement. */
+        ReasonCodeDetailType: {
+            /** @description The short description of the infringement associated with the reason code. */
+            briefText?: string;
+            /** @description The long description of the infringement associated with the reason code. */
+            detailedText?: string;
+            /** @description The unique identifier of a VeRO reason code. */
+            veroReasonCodeId?: string;
+        };
+        /** @description This type defines the details of an item being reported for violating a product owner's copyright, trademark, or intellectual property rights. */
+        ReportItemDetails: {
+            /** @description The brand name of the item being reported for VeRO violation.<br><br><b>Max length:</b> 50 characters */
+            brand?: string;
+            /** @description If the VeRO Program member wants a copy of the Notice of Claimed Infringement (NOCI) document sent to their email address, this field should be included in the request and set to <code>true</code>. This same document is automatically sent to the seller of the reported item.<br><br>As this field defaults to <code>true</b>, the report will be automatically emailed if this field is omitted.<br><br><b>Default:</b> true */
+            copyEmailToRightsOwner?: boolean;
+            /** @description If the infringement type stated in the <b>VeroReasonCodeId</b> has anything to do with which country the item is being shipped to, each country that would trigger this infringement type should be specified in this comma-delimited array.<br><br>This field is required when the <b>veroReasonCodeId</b> is <code>9037</code> (Item(s) is unlawful importation of product bearing trademark). */
+            countries?: string[];
+            /** @description This field is used to provide further information about the VeRO reason code.<br><br>This field is required when the <b>veroReasonCodeId</b> is <code>9052</code> or <code>7052</code> (Other - Provide details information in additional information box below).<br><br><b>Max length:</b> 1000 characters */
+            detailedMessage?: string;
+            /** @description The unique identifier of the listing being reported for the alleged infringement. */
+            itemId?: string;
+            /** @description This field is used by the VeRO Program member to provide more details to the seller as to why the item is being reported for the alleged infringement.<br><br><b>Max length:</b> 1000 characters */
+            messageToSeller?: string;
+            /** @description This field is used to specify the number of a product patent that is being violated.<br><br>This field is required when the <b>veroReasonCodeId</b> is <code>9048</code> (Item(s) infringes a valid patent).<br><br><b>Max length:</b> 15 characters */
+            patent?: string;
+            /** @description If the infringement type stated in the <b>veroReasonCodeId</b> has anything to do with which geographical region the item is being shipped to, each region that would trigger this infringement type should be specified in this comma-delimited array. */
+            regions?: string[];
+            /** @description The unique identifier for the type of claimed infringement.<br><br>Use <a href="/api-docs/commerce/vero/resources/vero_reason_code/methods/getVeroReasonCodes" target="_blank ">getVeroReasonCodes</a> to retrieve a list of valid reason codes for a given eBay site. */
+            veroReasonCodeId?: string;
+        };
+        /** @description This type defines the response fields of the <b>getVeroReport</b> method. */
+        ReportStatusResponse: {
+            /** @description This array returns the status for each eBay item that was included as part of the report.<br><br>This array is only returned if the <b>includeItemDetails</b> query parameter is set to <code>true</code>. */
+            reportedItemDetails?: components['schemas']['ReportedItem'][];
+            /** @description The unique packet identifier of the VeRO report. */
+            veroReportId?: string;
+            /** @description The processing status of the requested VeRO report. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/vero/types/VeroReportStatusEnum'>eBay API documentation</a> */
+            veroReportStatus?: string;
+        };
+        /** @description This type defines the item ID and status of a VeRO report. If applicable, a reason for report failure is also returned. */
+        ReportedItem: {
+            /** @description The unique identifier of the listing that is being reported for copyright, trademark, or intellectual right infringement. */
+            itemId?: string;
+            /** @description This text explanation is submitted by eBay when the submission of a VeRO Report has failed or was blocked.<br><br>This field is conditionally returned if the <b>status</b> value of the report is <code>ClarificationRequired</code> or <code>SubmissionFailed</code>. */
+            reasonForFailure?: string;
+            /** @description The current status of the VeRO reported item. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/vero/types/VeroReportedItemStatusEnum'>eBay API documentation</a> */
+            status?: string;
+        };
+        /** @description This type is used to define the details of a VeRO reason code for a specific site. */
+        VeroReasonCode: {
+            /** @description The eBay site for which reason code details are returned. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/vero/types/br:MarketplaceIdEnum'>eBay API documentation</a> */
+            marketplaceId?: string;
+            /** @description This container includes both brief and detailed text descriptions for the VeRO program intellectual property right infringement reason, as well as the ID for the reason code. */
+            reasonCodeDetails?: components['schemas']['ReasonCodeDetailType'][];
+        };
+        /** @description This type defines the response fields returned in the <b>getCeroReasonCodes</b> method. */
+        VeroReasonCodeDetailResponse: {
+            /** @description This array provides a list of VeRO reason codes, as well as the ID and details of each code, based on the input criteria.<br><br>If a <b>X-EBAY-C-MARKETPLACE-ID</b> header is used, only VeRO reason codes for that specific site will be returned. If this header is not included, all reason codes for all sites are returned. */
+            veroReasonCodes?: components['schemas']['VeroReasonCode'][];
+        };
+        VeroReasonCodeResponse: {
+            /** @description The eBay site for which reason code details are returned. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/vero/types/br:MarketplaceIdEnum'>eBay API documentation</a> */
+            marketplaceId?: string;
+            /** @description This container includes both brief and detailed text descriptions for the VeRO program intellectual property right infringement reason, as well as the ID for the reason code */
+            reasonCodeDetails?: components['schemas']['ReasonCodeDetailType'];
+        };
+        /** @description This type defines the request fields used in the <b>createVeroReport</b> method. */
+        VeroReportItemsRequest: {
+            /** @description This array is used to report one or more eBay items that are allegedly violating the product owner's copyright, trademark, or intellectual property rights.<br><br>The <b>itemId</b> and <b>veroReasonCodeId</b> fields are required for each reported violation.<br><br><span class="tablenote"><b>Note:</b> You can report the same item more than once if a different reason code is used each time.</span> */
+            reportItems?: components['schemas']['ReportItemDetails'][];
+        };
+        /** @description This type defines the response fields used in the <b>createVeroReport</b> method. */
+        VeroReportItemsResponse: {
+            /** @description The unique identifier of the VeRO report that the item violations have been added to.<br><br><span class="tablenote"><b>Note:</b> Users should keep track of the returned <b>veroReportId</b>, as there is no programmatic way to retrieve this value at this time.</span> */
+            veroReportId?: string;
+            /** @description The processing status of the VeRO report. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/vero/types/VeroReportStatusEnum'>eBay API documentation</a> */
+            veroReportStatus?: string;
+        };
+        /** @description This type defines the response fields for the <b>getVeroReports</b> method. */
+        VeroReportStatusResponse: {
+            /** @description The URL to the current page of the VeRO reported item results. */
+            href?: string;
+            /**
+             * Format: int32
+             * @description The value of the <b>limit</b> parameter submitted in the request.
+             */
+            limit?: number;
+            /** @description The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set */
+            next?: string;
+            /**
+             * Format: int32
+             * @description The value off the <b>offset</b> parameter submitted in the request.
+             */
+            offset?: number;
+            /** @description The URI for the previous page of results. This is returned if there is a previous page of results from the result set. */
+            prev?: string;
+            /** @description This array returns the item ID and statuses of the reported items being returned. */
+            reportedItemDetails?: components['schemas']['ReportedItem'][];
+            /**
+             * Format: int32
+             * @description This is the total number of records that match the input criteria.
+             */
+            total?: number;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    getVeroReasonCode: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description This path parameter specifies the unique identifier of the VeRO reason code that is to be retrieved.<br><br>Use the <a href="/api-docs/commerce/vero/resources/vero_reason_code/methods/getVeroReasonCodes" target="_blank ">getVeroReasonCodes</a> method to retrieve supported VeRO reason code IDs. */
+                vero_reason_code_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: Record<string, unknown>;
+                content: {
+                    'application/json': components['schemas']['VeroReasonCodeResponse'];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+        };
+    };
+    getVeroReasonCodes: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description This header identifies the eBay marketplace for which to retrieve VeRO reason codes. If this header is used, only VeRO reason codes for the specified marketplace will be returned in the response.<br><br>See <a href="/api-docs/commerce/vero/types/br:MarketplaceIdEnum" target="_blank ">MarketplaceIdEnum</a> for a list of supported values. */
+                'X-EBAY-C-MARKETPLACE-ID'?: string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: Record<string, unknown>;
+                content: {
+                    'application/json': components['schemas']['VeroReasonCodeDetailResponse'];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+        };
+    };
+    createVeroReport: {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br>For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>. */
+                'Content-Type': string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': components['schemas']['VeroReportItemsRequest'];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    Location?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['VeroReportItemsResponse'];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+        };
+    };
+    getVeroReport: {
+        parameters: {
+            query?: {
+                /** @description Include this query and set it to <code>true</code> if you want to retrieve the <b>reportedItemDetails</b> container in the response, which contains item-level status information. This container may be helpful if you have reported violations on more than one eBay item in the report.<br><br>By default, this boolean is set to <code>false</code>. */
+                includeItemDetails?: string;
+            };
+            header?: never;
+            path: {
+                /** @description This path parameter specifies the unique identifier of the VeRO report being retrieved.<br><br>This value is returned when creating a VeRO report through the <a href="/api-docs/commerce/vero/resources/vero_report/methods/createVeroReport" target="_blank ">createVeroReport</a> method. */
+                vero_report_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: Record<string, unknown>;
+                content: {
+                    'application/json': components['schemas']['ReportStatusResponse'];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+        };
+    };
+    getVeroReportItems: {
+        parameters: {
+            query?: {
+                /** @description This query parameter can be used to filter the result set by a date range. Only items reported within the specified time period will be returned.<br><br>This parameter will be ignored if <b>itemId</b> has been specified.<br><br><b>Format:</b> <code>YYYY-MM-DD HH:MM:SS</code><br><br><b>Example</b>: <code>reportSubmittedDate:[2024-11-14T07:47:48Z..2024-12-14T07:47:48Z]</code>. */
+                filter?: string;
+                /** @description This query parameter specifies the unique identifier of an eBay listing. Only the specified reported item will be returned. */
+                itemId?: string;
+                /** @description The maximum number of entries that can be returned on each page of the paginated response. Use this parameter in conjunction with the <b>offset</b> parameter to control the pagination of the output.<br><br><span class="tablenote"><b>Note:</b> This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>.</span><br>For example, if <b>offset</b> is set to <code>10</code> and <b>limit</b> is set to <code>10</code>, the call retrieves entries 11 through 20 from the result set.<br><br>If this parameter is omitted, the default value is used.<br><br><b>Default:</b> 25 */
+                limit?: string;
+                /** @description The number of reports to skip in the result set before returning the first report in the paginated response. Combine offset with the <b>limit</b> query parameter to control the reports returned in the response. For example, if you supply an <b>offset</b> of <code>0</code> and a <b>limit</b> of <code>10</code>, the first page of the response contains the first 10 reports from the complete list of reports retrieved by the call. If this query parameter is not set, the default value is used and the first page of reports is returned.<br><br><b>Default:</b> 0 */
+                offset?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: Record<string, unknown>;
+                content: {
+                    'application/json': components['schemas']['VeroReportStatusResponse'];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: Record<string, unknown>;
+                content?: never;
+            };
+        };
+    };
+}

package/build/types/sell-apps/other-apis/commerceVeroV1Oas3.js

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export {};