ebay-api 8.5.1 → 8.6.0

package/lib/types/restful/specs/commerce_translation_v1_beta_oas3.d.ts

@@ -1,71 +1,39 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export interface paths {
     "/translate": {
-        /** @description This method translates listing title and listing description text from one language into another. For a full list of supported language translations, see the table in the API Overview page. */
         post: operations["translate"];
     };
 }
 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 is the base type of the translate method request payload. */
         TranslateRequest: {
-            /** @description The language of the input text to be translated. Not all LanguageEnum values are supported in this field. For a full list of supported language translations, see the table in the API Overview page. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/translation/types/api:LanguageEnum'>eBay API documentation</a> */
             from?: string;
-            /** @description The input text to translate. For ITEM_DESCRIPTION translations, HTML/CSS markup and links can be included, but will count toward max character limit. Max Length: 1,000 characters for ITEM_TITLE 100,000 characters for ITEM_DESCRIPTION, including markup/tagsMax Occurrence: 1. Only one continuous text string currently supported. */
             text?: (string)[];
-            /** @description The target language for the translation of the input text. Not all LanguageEnum values are supported in this field. For a full list of supported language translations, see the table in the API Overview page. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/translation/types/api:LanguageEnum'>eBay API documentation</a> */
             to?: string;
-            /** @description Input the listing entity to be translated. Valid Values: ITEM_TITLE and ITEM_DESCRIPTION For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/translation/types/api:TranslationContextEnum'>eBay API documentation</a> */
             translationContext?: string;
         };
-        /** @description This is the base type of the translate method response payload. */
         TranslateResponse: {
-            /** @description The enumeration value indicates the language of the input text. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/translation/types/api:LanguageEnum'>eBay API documentation</a> */
             from?: string;
-            /** @description The enumeration value indicates the language of the translated text. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/translation/types/api:LanguageEnum'>eBay API documentation</a> */
             to?: string;
-            /** @description An array showing the input and translated text. Only one input string can be translated at this time. Support for multiple continuous text strings is expected in the future. */
             translations?: (components["schemas"]["Translation"])[];
         };
-        /** @description This type is used by the translations array, which shows the original text supplied by the user in the request payload, and the text translated by eBay. Only one input string can be translated at this time. Support for multiple continuous text strings is expected in the future. */
         Translation: {
-            /** @description The original text, in the language specified in the from field, that was input into the text field in the request. */
             originalText?: string;
-            /** @description The translation of the original text into the language specified in the to field. */
             translatedText?: string;
         };
     };
@@ -77,7 +45,6 @@ export interface components {
 }
 export type external = Record<string, never>;
 export interface operations {
-    /** @description This method translates listing title and listing description text from one language into another. For a full list of supported language translations, see the table in the API Overview page. */
     translate: {
         requestBody: {
             content: {
@@ -85,15 +52,12 @@ export interface operations {
             };
         };
         responses: {
-            /** @description OK */
             200: {
                 content: {
                     "application/json": components["schemas"]["TranslateResponse"];
                 };
             };
-            /** @description Bad Request */
             400: never;
-            /** @description Internal Server Error */
             500: never;
         };
     };

package/lib/types/restful/specs/commerce_translation_v1_beta_oas3.js

@@ -1,6 +1,2 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/restful/specs/developer_analytics_v1_beta_oas3.d.ts

@@ -1,91 +1,46 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export interface paths {
     "/rate_limit/": {
-        /** @description This method retrieves the call limit and utilization data for an application. The data is retrieved for all RESTful APIs and resources. The response from getRateLimits includes a list of the applicable resources and the "call limit", or quota, that is set for each resource. In addition to quota information, the response also includes the number of remaining calls available before the limit is reached, the time remaining before the quota resets, and the length of the "time window" to which the quota applies. By default, this method returns utilization data for all RESTful API resources. Use the api_name and api_context query parameters to filter the response to only the desired APIs. For more on call limits, see Compatible Application Check. */
         get: operations["getRateLimits"];
     };
     "/user_rate_limit/": {
-        /** @description This method retrieves the call limit and utilization data for an application user. The call-limit data is returned for all RESTful APIs and resources that limit calls on a per-user basis. The response from getUserRateLimits includes a list of the applicable resources and the "call limit", or quota, that is set for each resource. In addition to quota information, the response also includes the number of remaining calls available before the limit is reached, the time remaining before the quota resets, and the length of the "time window" to which the quota applies. By default, this method returns utilization data for all RESTful API resources that limit request access by user. Use the api_name and api_context query parameters to filter the response to only the desired APIs. For more on call limits, see Compatible Application Check. */
         get: operations["getUserRateLimits"];
     };
 }
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
-        /** @description This complex type defines a &quot;rate&quot; as the quota of calls that can be made to a resource per time window, the remaining number of calls before the threshold is met, the amount of time until the time window resets, and the length of the time window (in seconds). */
         Rate: {
-            /**
-             * Format: int32
-             * @description The maximum number of requests that can be made to this resource during a set time period. The length of time to which the limit is applied is defined by the associated timeWindow value. This value is often referred to as the &quot;call quota&quot; for the resource.
-             */
             limit?: number;
-            /**
-             * Format: int32
-             * @description The remaining number of requests that can be made to this resource before the associated time window resets.
-             */
             remaining?: number;
-            /** @description The data and time the time window and accumulated calls for this resource reset. When the reset time is reached, the remaining value is reset to the value of limit, and this reset value is reset to the current time plus the number of seconds defined by the timeWindow value. The time stamp is formatted as an ISO 8601 string, which is based on the 24-hour Universal Coordinated Time (UTC) clock. Format: YYYY-MM-DDTHH:MM:SS.SSSZ Example: 2018-08-04T07:09:00.000Z */
             reset?: string;
-            /**
-             * Format: int32
-             * @description A period of time, expressed in seconds. The call quota for a resource is applied to the period of time defined by the value of this field.
-             */
             timeWindow?: number;
         };
-        /** @description This complex types defines the resource (such as an API method) for which the rate-limit data is returned. A method is included in an API, and an API is part of an API context for the API version specified. */
         RateLimit: {
-            /** @description The context of the API for which rate-limit data is returned. For example buy, sell, commerce, or developer. */
             apiContext?: string;
-            /** @description The name of the API for which rate-limit data is returned. For example browse for the Buy API, inventory for the Sell API, or taxonomy for the Commerce API. */
             apiName?: string;
-            /** @description The version of the API for which rate-limit data is returned. For example v1 or v2. */
             apiVersion?: string;
-            /** @description A list of the methods for which rate-limit data is returned. For example item for the Feed API, getOrder for the Fulfillment API, and getProduct for the Catalog API. */
             resources?: (components["schemas"]["Resource"])[];
         };
-        /** @description This complex type defines a list of rate-limit data as it pertains to a method within the specified version of an API. */
         RateLimitsResponse: {
-            /** @description The rate-limit data for the specified APIs. The rate-limit data is returned for all the methods in the specified APIs and data pertains to the current time window. */
             rateLimits?: (components["schemas"]["RateLimit"])[];
         };
-        /** @description This complex type defines the resource (API method) and the current rate-limit data for that resource. */
         Resource: {
-            /** @description The name of the resource (an API or an API method) to which the rate-limit data applies. */
             name?: string;
-            /** @description A list of rate-limit data, where each list element represents the rate-limit data for a specific resource. */
             rates?: (components["schemas"]["Rate"])[];
         };
-        /** @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;
         };
     };
@@ -97,26 +52,20 @@ export interface components {
 }
 export type external = Record<string, never>;
 export interface operations {
-    /** @description This method retrieves the call limit and utilization data for an application. The data is retrieved for all RESTful APIs and resources. The response from getRateLimits includes a list of the applicable resources and the &quot;call limit&quot;, or quota, that is set for each resource. In addition to quota information, the response also includes the number of remaining calls available before the limit is reached, the time remaining before the quota resets, and the length of the &quot;time window&quot; to which the quota applies. By default, this method returns utilization data for all RESTful API resources. Use the api_name and api_context query parameters to filter the response to only the desired APIs. For more on call limits, see Compatible Application Check. */
     getRateLimits: {
         parameters: {
             query?: {
-                /** @description This optional query parameter filters the result to include only the specified API context. Acceptable values for the parameter are buy, sell, commerce, and developer. */
                 api_context?: string;
-                /** @description This optional query parameter filters the result to include only the APIs specified. Example values are browse for the Buy APIs context, inventory for the Sell APIs context, and taxonomy for the Commerce APIs context. */
                 api_name?: string;
             };
         };
         responses: {
-            /** @description OK */
             200: {
                 content: {
                     "application/json": components["schemas"]["RateLimitsResponse"];
                 };
             };
-            /** @description No Content */
             204: never;
-            /** @description Internal Server Error */
             500: {
                 content: {
                     "application/json": {
@@ -126,26 +75,20 @@ export interface operations {
             };
         };
     };
-    /** @description This method retrieves the call limit and utilization data for an application user. The call-limit data is returned for all RESTful APIs and resources that limit calls on a per-user basis. The response from getUserRateLimits includes a list of the applicable resources and the &quot;call limit&quot;, or quota, that is set for each resource. In addition to quota information, the response also includes the number of remaining calls available before the limit is reached, the time remaining before the quota resets, and the length of the &quot;time window&quot; to which the quota applies. By default, this method returns utilization data for all RESTful API resources that limit request access by user. Use the api_name and api_context query parameters to filter the response to only the desired APIs. For more on call limits, see Compatible Application Check. */
     getUserRateLimits: {
         parameters: {
             query?: {
-                /** @description This optional query parameter filters the result to include only the specified API context. Acceptable values for the parameter are buy, sell, commerce, and developer. */
                 api_context?: string;
-                /** @description This optional query parameter filters the result to include only the APIs specified. Example values are browse for the Buy APIs context, inventory for the Sell APIs context, and taxonomy for the Commerce APIs context. */
                 api_name?: string;
             };
         };
         responses: {
-            /** @description OK */
             200: {
                 content: {
                     "application/json": components["schemas"]["RateLimitsResponse"];
                 };
             };
-            /** @description No Content */
             204: never;
-            /** @description Internal Server Error */
             500: {
                 content: {
                     "application/json": {

package/lib/types/restful/specs/developer_analytics_v1_beta_oas3.js

@@ -1,6 +1,2 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/restful/specs/developer_key_management_v1_oas3.d.ts

@@ -1,83 +1,43 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export interface paths {
     "/signing_key": {
-        /** @description This method returns the <b>Public Key</b>, <b>Public Key as JWE</b>, and metadata for all keypairs associated with the application key making the call.<br/><br/><span class="tablenote"><b>Note:</b> It is important to note that <code>privateKey</code> values are <b>not</b> returned. In order to further ensure the security of confidential client information, eBay does <b>not</b> store <code>privateKey</code> values in any system. If a developer loses their <code>privateKey</code> they must generate new keypairs set using the <code>createSigningKey</code> method.</span> */
         get: operations["getSigningKeys"];
-        /** @description This method creates keypairs using one of the following ciphers:<ul><li>ED25519 (Edwards Curve)</li><li>RSA</li></ul><span class="tablenote"><b>Note:</b> The recommended signature cipher is <b>ED25519</b> (Edwards Curve) since it uses much shorter keys and therefore decreases the header size. However, for development frameworks that do not support ED25519, RSA is also supported.</span><br/>Following a successful completion, the following keys are returned:<ul><li>Private Key</li><li>Public Key</li><li>Public Key as JWE</li></ul>Once keypairs are created, developers are <b>strongly advised</b> to create and store a local copy of each keypair for future reference. Although the <b>Public Key</b>, <b>Public Key as JWE</b>, and metadata for keypairs may be retrieved by the <code>getSigningKey</code> and <code>getSigningKeys</code> methods, in order to further ensure the security of confidential client information, eBay does not store the <b>Private Key</b> value in any system. If a developer loses their <b>Private Key</b> they must generate new keypairs using the <code>createSigningKey</code> method.<br/><span class="tablenote"><b>Note:</b> For additional information about using keypairs, refer to <a href= "/develop/guides/digital-signatures-for-apis " target= "_blank ">Digital Signatures for APIs</a>.</span> */
         post: operations["createSigningKey"];
     };
     "/signing_key/{signing_key_id}": {
-        /** @description This method returns the <b>Public Key</b>, <b>Public Key as JWE</b>, and metadata for a specified <code>signingKeyId</code> associated with the application key making the call.<br/><br/><span class="tablenote"><b>Note:</b> It is important to note that the <code>privateKey</code> value is <b>not</b> returned. In order to further ensure the security of confidential client information, eBay does <b>not</b> store the <code>privateKey</code> value in any system. If a developer loses their <code>privateKey</code> they must generate new keypairs using the <code>createSigningKey</code> method.</span> */
         get: operations["getSigningKey"];
     };
 }
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
-        /** @description This request creates a new signing key. */
         CreateSigningKeyRequest: {
-            /** @description The enumerated value for the cipher to be used to create the signing key. Refer to <a href= "/api-docs/developer/key-management/types/api:SigningKeyCipher" target= "_blank">SigningKeyCiper</a> for the list of supported enum values. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/developer/key_management/types/api:SigningKeyCipher'>eBay API documentation</a> */
             signingKeyCipher?: string;
         };
-        /** @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 container stores metadata information for all keypairs that are owned by a user. */
         QuerySigningKeysResponse: {
-            /** @description An array of metadata information for keypairs owned by a user. */
             signingKeys?: (components["schemas"]["SigningKey"])[];
         };
-        /** @description This container stores metadata for a signing key. */
         SigningKey: {
-            /**
-             * Format: int32
-             * @description The UNIX timestamp when the <code>SigningKey</code> was created. This time is represented as the number of seconds from "1970-01-01T00:00:00Z", as measured in UTC, until the date and time the <code>SigningKey</code> was created.
-             */
             creationTime?: number;
-            /**
-             * Format: int32
-             * @description The UNIX timestamp when the <code>SigningKey</code> expires. This time is represented as the number of seconds from "1970-01-01T00:00:00Z", as measured in UTC, until the date and time the <code>SigningKey</code> expires.<br/><span class="tablenote"><b>Note:</b> All keys have an expiration date of three (3) years after their <code>creationTime</code>.</span>
-             */
             expirationTime?: number;
-            /** @description This is the JSON Web Encrypted (JWE) value for the <code>publicKey</code>. */
             jwe?: string;
-            /** @description This is the Private Key that has been generated using the specified <code>signingKeyCipher</code>.<br/><span class="tablenote"><b>Note:</b> The <code>privateKey</code> value will <b>only</b> be returned in the response payload of the  <code>createSigningKey</code> method.<br/><br/>It will <i>never</i> be returned by the <code>getSigningKey</code> or <code>getSigningKeys</code> methods.</span>Developers are <b>strongly advised</b> to download their <code>privateKey</code> value as Privacy Enhance Mail (PEM) format and store it locally for future reference. In order to guarantee the security of confidential client information, eBay does not store <code>privateKey</code> values on any system.<br/><span class="tablenote"><b>Note:</b> If a developer loses their <code>privateKey</code> they must generate new keypairs set using the <code>createSigningKey</code> method.</span> */
             privateKey?: string;
-            /** @description This is the Public Key that has been generated using the specified <code>signingKeyCipher</code>.<br/><br/>As a matter of good practice, developers are <b>strongly advised</b> to download this value and store it locally for safe-keeping and future reference. */
             publicKey?: string;
-            /** @description Indicates the cipher used to create the keypairs. Refer to <a href= "/api-docs/developer/key-management/types/api:SigningKeyCipher" target= "_blank">SigningKeyCiper</a> for the list of supported enum values. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/developer/key_management/types/api:SigningKeyCipher'>eBay API documentation</a> */
             signingKeyCipher?: string;
-            /** @description The system-generated eBay ID for the keypairs. */
             signingKeyId?: string;
         };
     };
@@ -89,26 +49,19 @@ export interface components {
 }
 export type external = Record<string, never>;
 export interface operations {
-    /** @description This method returns the <b>Public Key</b>, <b>Public Key as JWE</b>, and metadata for all keypairs associated with the application key making the call.<br/><br/><span class="tablenote"><b>Note:</b> It is important to note that <code>privateKey</code> values are <b>not</b> returned. In order to further ensure the security of confidential client information, eBay does <b>not</b> store <code>privateKey</code> values in any system. If a developer loses their <code>privateKey</code> they must generate new keypairs set using the <code>createSigningKey</code> method.</span> */
     getSigningKeys: {
         responses: {
-            /** @description OK */
             200: {
                 content: {
                     "application/json": components["schemas"]["QuerySigningKeysResponse"];
                 };
             };
-            /** @description Bad Request */
             400: never;
-            /** @description Unauthorized */
             401: never;
-            /** @description Forbidden */
             403: never;
-            /** @description Internal Server Error */
             500: never;
         };
     };
-    /** @description This method creates keypairs using one of the following ciphers:<ul><li>ED25519 (Edwards Curve)</li><li>RSA</li></ul><span class="tablenote"><b>Note:</b> The recommended signature cipher is <b>ED25519</b> (Edwards Curve) since it uses much shorter keys and therefore decreases the header size. However, for development frameworks that do not support ED25519, RSA is also supported.</span><br/>Following a successful completion, the following keys are returned:<ul><li>Private Key</li><li>Public Key</li><li>Public Key as JWE</li></ul>Once keypairs are created, developers are <b>strongly advised</b> to create and store a local copy of each keypair for future reference. Although the <b>Public Key</b>, <b>Public Key as JWE</b>, and metadata for keypairs may be retrieved by the <code>getSigningKey</code> and <code>getSigningKeys</code> methods, in order to further ensure the security of confidential client information, eBay does not store the <b>Private Key</b> value in any system. If a developer loses their <b>Private Key</b> they must generate new keypairs using the <code>createSigningKey</code> method.<br/><span class="tablenote"><b>Note:</b> For additional information about using keypairs, refer to <a href= "/develop/guides/digital-signatures-for-apis " target= "_blank ">Digital Signatures for APIs</a>.</span> */
     createSigningKey: {
         requestBody?: {
             content: {
@@ -116,46 +69,33 @@ export interface operations {
             };
         };
         responses: {
-            /** @description OK */
             200: {
                 content: {
                     "application/json": components["schemas"]["SigningKey"];
                 };
             };
-            /** @description Bad Request */
             400: never;
-            /** @description Unauthorized */
             401: never;
-            /** @description Forbidden */
             403: never;
-            /** @description Internal Server Error */
             500: never;
         };
     };
-    /** @description This method returns the <b>Public Key</b>, <b>Public Key as JWE</b>, and metadata for a specified <code>signingKeyId</code> associated with the application key making the call.<br/><br/><span class="tablenote"><b>Note:</b> It is important to note that the <code>privateKey</code> value is <b>not</b> returned. In order to further ensure the security of confidential client information, eBay does <b>not</b> store the <code>privateKey</code> value in any system. If a developer loses their <code>privateKey</code> they must generate new keypairs using the <code>createSigningKey</code> method.</span> */
     getSigningKey: {
         parameters: {
             path: {
-                /** @description The system-generated eBay ID of the keypairs being requested. */
                 signing_key_id: string;
             };
         };
         responses: {
-            /** @description OK */
             200: {
                 content: {
                     "application/json": components["schemas"]["SigningKey"];
                 };
             };
-            /** @description Bad Request */
             400: never;
-            /** @description Unauthorized */
             401: never;
-            /** @description Forbidden */
             403: never;
-            /** @description Not found */
             404: never;
-            /** @description Internal Server Error */
             500: never;
         };
     };

package/lib/types/restful/specs/developer_key_management_v1_oas3.js

@@ -1,6 +1,2 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/restful/specs/inquiry_oas3.d.ts

@@ -1,50 +1,35 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export interface paths {
     "/inquiry/check_eligibility": {
-        /** @description Check if a buyer is eligible to open an inquiry on an order */
         post: operations["checkInquiryEligibility"];
     };
     "/inquiry/{inquiryId}/close": {
-        /** @description Close an inquiry for the buyer */
         post: operations["closeInquiry"];
     };
     "/inquiry/{inquiryId}/confirm_refund": {
-        /** @description Buyer confirms the refund from an inquiry was received */
         post: operations["confirmInquiryRefund"];
     };
     "/inquiry": {
-        /** @description Buyer confirms the refund from an inquiry was received */
         post: operations["createInquiry"];
     };
     "/inquiry/{inquiryId}/escalate": {
-        /** @description Escalate an inquiry to an INR case */
         post: operations["escalateInquiry"];
     };
     "/inquiry/{inquiryId}": {
-        /** @description Retrieve the history and details related to a specific inquiry */
         get: operations["getInquiry"];
     };
     "/inquiry/{inquiryId}/issue_refund": {
-        /** @description Issue a refund for an inquiry */
         post: operations["issueInquiryRefund"];
     };
     "/inquiry/{inquiryId}/provide_refund_info": {
-        /** @description Provide refund information about an inquiry to the buyer */
         post: operations["provideInquiryRefundInfo"];
     };
     "/inquiry/{inquiryId}/provide_shipment_info": {
-        /** @description Provide shipment information for an inquiry */
         post: operations["provideInquiryShipmentInfo"];
     };
     "/inquiry/search": {
-        /** @description This call is used to search for inquiries using multiple filter types. */
         get: operations["search"];
     };
     "/inquiry/{inquiryId}/send_message": {
-        /** @description Contact the buyer or seller about an inquiry */
         post: operations["sendInquiryMessage"];
     };
 }
@@ -52,128 +37,98 @@ export type webhooks = Record<string, never>;
 export type components = Record<string, never>;
 export type external = Record<string, never>;
 export interface operations {
-    /** @description Check if a buyer is eligible to open an inquiry on an order */
     checkInquiryEligibility: {
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Close an inquiry for the buyer */
     closeInquiry: {
         parameters: {
             path: {
-                /** @description The unique ID of the inquiry to be closed. */
                 inquiryId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Buyer confirms the refund from an inquiry was received */
     confirmInquiryRefund: {
         parameters: {
             path: {
-                /** @description The unique ID of the inquiry to be closed. */
                 inquiryId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Buyer confirms the refund from an inquiry was received */
     createInquiry: {
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Escalate an inquiry to an INR case */
     escalateInquiry: {
         parameters: {
             path: {
-                /** @description The unique ID of the inquiry to be closed. */
                 inquiryId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Retrieve the history and details related to a specific inquiry */
     getInquiry: {
         parameters: {
             path: {
-                /** @description The unique ID of the inquiry to be closed. */
                 inquiryId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Issue a refund for an inquiry */
     issueInquiryRefund: {
         parameters: {
             path: {
-                /** @description The unique ID of the inquiry to be closed. */
                 inquiryId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Provide refund information about an inquiry to the buyer */
     provideInquiryRefundInfo: {
         parameters: {
             path: {
-                /** @description The unique ID of the inquiry to be closed. */
                 inquiryId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Provide shipment information for an inquiry */
     provideInquiryShipmentInfo: {
         parameters: {
             path: {
-                /** @description The unique ID of the inquiry to be closed. */
                 inquiryId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description This call is used to search for inquiries using multiple filter types. */
     search: {
         responses: {
-            /** @description OK */
             200: never;
         };
     };
-    /** @description Contact the buyer or seller about an inquiry */
     sendInquiryMessage: {
         parameters: {
             path: {
-                /** @description The unique ID of the inquiry to be closed. */
                 inquiryId: string;
             };
         };
         responses: {
-            /** @description OK */
             200: never;
         };
     };

package/lib/types/restful/specs/inquiry_oas3.js

@@ -1,6 +1,2 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });