amazon-creators-api 1.2.0 → 1.2.2

package/README.md

@@ -1,6 +1,6 @@
 # Amazon Creators API Node.js SDK
 
-![https://github.com/ryanschiang/amazon-creators-api](https://img.shields.io/badge/github-repo-blue?logo=github) ![https://github.com/ryanschiang/amazon-creators-api/LICENSE.txt](https://img.shields.io/github/license/ryanschiang/amazon-creators-api) ![https://github.com/ryanschiang/amazon-creators-api](https://img.shields.io/github/package-json/v/ryanschiang/amazon-creators-api) ![https://npmjs.com/package/amazon-creators-api](https://img.shields.io/npm/v/amazon-creators-api)
+![https://github.com/ryanschiang/amazon-creators-api](https://img.shields.io/badge/github-repo-blue?logo=github) ![https://github.com/ryanschiang/amazon-creators-api/blob/main/LICENSE.txt](https://img.shields.io/github/license/ryanschiang/amazon-creators-api) ![https://github.com/ryanschiang/amazon-creators-api](https://img.shields.io/github/package-json/v/ryanschiang/amazon-creators-api) ![https://npmjs.com/package/amazon-creators-api](https://img.shields.io/npm/v/amazon-creators-api)
 
 This is an **unofficial TypeScript wrapper** for the [Amazon Creators API Node.js SDK](https://affiliate-program.amazon.com/creatorsapi/docs/en-us/get-started/using-sdk).
 
@@ -11,7 +11,7 @@ This package implements a thin TypeScript wrapper around Amazon's JS runtime int
 
 ## Prerequisites
 
-- Node.js version 14 or higher
+- Node.js version 18 or higher
 - [Register](https://affiliate-program.amazon.com/creatorsapi/docs/en-us/onboarding/register-for-creators-api) for the Creators API
 
 ## Installation
@@ -22,7 +22,7 @@ npm install amazon-creators-api
 
 ## Usage
 
-See the [examples](examples) directory for usage examples.
+See the [examples](https://github.com/ryanschiang/amazon-creators-api/tree/main/examples) directory for usage examples.
 
 ### Get Items
 
@@ -95,8 +95,8 @@ Contributions are welcome! Please open an [issue](https://github.com/ryanschiang
 
 ## License
 
-Licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for details.
+Licensed under the Apache License, Version 2.0. See the [https://github.com/ryanschiang/amazon-creators-api/blob/main/LICENSE.txt](LICENSE) file for details.
 
-Original authorship belongs to Amazon.com, Inc. or its affiliates. See the [NOTICE](NOTICE.txt) file for details.
+Original authorship belongs to Amazon.com, Inc. or its affiliates. See the [https://github.com/ryanschiang/amazon-creators-api/blob/main/NOTICE.txt](NOTICE.txt) file for details.
 
 Modifications copyright (c) 2026 Ryan Chiang.

package/dist/ApiClient.d.ts

@@ -1,43 +1,43 @@
 export default ApiClient;
 /**
-* @module ApiClient
-* @version 1.2.0
-*/
+ * @module ApiClient
+ * @version 1.2.0
+ */
 /**
-* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
-* application to use this class directly - the *Api and model classes provide the public API for the service. The
-* contents of this file should be regarded as internal but are documented for completeness.
-* @alias module:ApiClient
-* @class
-*/
+ * Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
+ * application to use this class directly - the *Api and model classes provide the public API for the service. The
+ * contents of this file should be regarded as internal but are documented for completeness.
+ * @alias module:ApiClient
+ * @class
+ */
 declare class ApiClient {
     /**
-    * Returns a boolean indicating if the parameter could be JSON.stringified
-    * @param param The actual parameter
-    * @returns {Boolean} Flag indicating if <code>param</code> can be JSON.stringified
-    */
+     * Returns a boolean indicating if the parameter could be JSON.stringified
+     * @param param The actual parameter
+     * @returns {Boolean} Flag indicating if <code>param</code> can be JSON.stringified
+     */
     static canBeJsonified(str: any): boolean;
     /**
-    * Parses an ISO-8601 string representation or epoch representation of a date value.
-    * @param {String} str The date value as a string.
-    * @returns {Date} The parsed date object.
-    */
+     * Parses an ISO-8601 string representation or epoch representation of a date value.
+     * @param {String} str The date value as a string.
+     * @returns {Date} The parsed date object.
+     */
     static parseDate(str: string): Date;
     /**
-    * Converts a value to the specified type.
-    * @param {(String|Object)} data The data to convert, as a string or object.
-    * @param {(String|Array.<String>|Object.<String, Object>|Function)} type The type to return. Pass a string for simple types
-    * or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To
-    * return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type:
-    * all properties on <code>data<code> will be converted to this type.
-    * @returns An instance of the specified type or null or undefined if data is null or undefined.
-    */
+     * Converts a value to the specified type.
+     * @param {(String|Object)} data The data to convert, as a string or object.
+     * @param {(String|Array.<String>|Object.<String, Object>|Function)} type The type to return. Pass a string for simple types
+     * or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To
+     * return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type:
+     * all properties on <code>data<code> will be converted to this type.
+     * @returns An instance of the specified type or null or undefined if data is null or undefined.
+     */
     static convertToType(data: (string | any), type: (string | Array<string> | any | Function)): any;
     /**
-    * Constructs a new map or array model from REST data.
-    * @param data {Object|Array} The REST data.
-    * @param obj {Object|Array} The target object or array.
-    */
+     * Constructs a new map or array model from REST data.
+     * @param data {Object|Array} The REST data.
+     * @param obj {Object|Array} The target object or array.
+     */
     static constructFromObject(data: any | any[], obj: any | any[], itemType: any): void;
     /**
      * The base URL against which to resolve every API call's (relative) path.
@@ -57,10 +57,10 @@ declare class ApiClient {
      */
     authentications: Array<string>;
     /**
-         * The default HTTP headers to be included for all API calls.
-         * @type {Array.<String>}
-         * @default {}
-         */
+     * The default HTTP headers to be included for all API calls.
+     * @type {Array.<String>}
+     * @default {}
+     */
     defaultHeaders: Array<string>;
     /**
      * The default HTTP timeout for all API calls.
@@ -76,14 +76,12 @@ declare class ApiClient {
      */
     cache: boolean;
     /**
-         * If set to true, the client will save the cookies from each server
-         * response, and return them in the next request.
-         * @default false
-         */
+     * If set to true, the client will save the cookies from each server
+     * response, and return them in the next request.
+     * @default false
+     */
     enableCookies: boolean;
-    agent: any;
     requestAgent: any;
-    plugins: any;
     /**
      * OAuth2 credential ID
      * @type {String}
@@ -155,10 +153,10 @@ declare class ApiClient {
      */
     getAuthEndpoint(): string;
     /**
-    * Returns a string representation for an actual parameter.
-    * @param param The actual parameter.
-    * @returns {String} The string representation of <code>param</code>.
-    */
+     * Returns a string representation for an actual parameter.
+     * @param param The actual parameter.
+     * @returns {String} The string representation of <code>param</code>.
+     */
     paramToString(param: any): string;
     /**
      * Builds full URL by appending the given path to the base URL and replacing path parameter place-holders with parameter values.
@@ -170,54 +168,79 @@ declare class ApiClient {
      */
     buildUrl(path: string, pathParams: any, apiBasePath: string): string;
     /**
-    * Checks whether the given content type represents JSON.<br>
-    * JSON content type examples:<br>
-    * <ul>
-    * <li>application/json</li>
-    * <li>application/json; charset=UTF8</li>
-    * <li>APPLICATION/JSON</li>
-    * </ul>
-    * @param {String} contentType The MIME content type to check.
-    * @returns {Boolean} <code>true</code> if <code>contentType</code> represents JSON, otherwise <code>false</code>.
-    */
+     * Checks whether the given content type represents JSON.<br>
+     * JSON content type examples:<br>
+     * <ul>
+     * <li>application/json</li>
+     * <li>application/json; charset=UTF8</li>
+     * <li>APPLICATION/JSON</li>
+     * </ul>
+     * @param {String} contentType The MIME content type to check.
+     * @returns {Boolean} <code>true</code> if <code>contentType</code> represents JSON, otherwise <code>false</code>.
+     */
     isJsonMime(contentType: string): boolean;
     /**
-    * Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first.
-    * @param {Array.<String>} contentTypes
-    * @returns {String} The chosen content type, preferring JSON.
-    */
+     * Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first.
+     * @param {Array.<String>} contentTypes
+     * @returns {String} The chosen content type, preferring JSON.
+     */
     jsonPreferredMime(contentTypes: Array<string>): string;
     /**
-    * Checks whether the given parameter value represents file-like content.
-    * @param param The parameter to check.
-    * @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
-    */
+     * Checks whether the given parameter value represents file-like content.
+     * @param param The parameter to check.
+     * @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
+     */
     isFileParam(param: any): boolean;
     /**
-    * Normalizes parameter values:
-    * <ul>
-    * <li>remove nils</li>
-    * <li>keep files and arrays</li>
-    * <li>format to string with `paramToString` for other cases</li>
-    * </ul>
-    * @param {Object.<String, Object>} params The parameters as object properties.
-    * @returns {Object.<String, Object>} normalized parameters.
-    */
+     * Normalizes parameter values:
+     * <ul>
+     * <li>remove nils</li>
+     * <li>keep files and arrays</li>
+     * <li>format to string with `paramToString` for other cases</li>
+     * </ul>
+     * @param {Object.<String, Object>} params The parameters as object properties.
+     * @returns {Object.<String, Object>} normalized parameters.
+     */
     normalizeParams(params: any): any;
     /**
-    * Builds a string representation of an array-type actual parameter, according to the given collection format.
-    * @param {Array} param An array parameter.
-    * @param {module:ApiClient.CollectionFormatEnum} collectionFormat The array element separator strategy.
-    * @returns {String|Array} A string representation of the supplied collection, using the specified delimiter. Returns
-    * <code>param</code> as is if <code>collectionFormat</code> is <code>multi</code>.
-    */
+     * Builds a string representation of an array-type actual parameter, according to the given collection format.
+     * @param {Array} param An array parameter.
+     * @param {module:ApiClient.CollectionFormatEnum} collectionFormat The array element separator strategy.
+     * @returns {String|Array} A string representation of the supplied collection, using the specified delimiter. Returns
+     * <code>param</code> as is if <code>collectionFormat</code> is <code>multi</code>.
+     */
     buildCollectionParam(param: any[], collectionFormat: any): string | any[];
     /**
-    * Applies authentication headers to the request.
-    * @param {Object} request The request object created by a <code>superagent()</code> call.
-    * @param {Array.<String>} authNames An array of authentication method names.
-    */
-    applyAuthToRequest(request: any, authNames: Array<string>): void;
+     * Applies authentication values to request headers/query.
+     * @param {{headers: Object.<String, Object>, query: Object.<String, Object>}} requestContext
+     * @param {Array.<String>} authNames An array of authentication method names.
+     */
+    applyAuthToRequest(requestContext: {
+        headers: any;
+        query: any;
+    }, authNames: Array<string>): void;
+    /**
+     * Builds URL query string.
+     * @param {Object.<String, Object>} params
+     * @returns {String}
+     */
+    buildQueryString(params: any): string;
+    /**
+     * Appends form fields/files to a FormData instance.
+     * @param {FormData} form
+     * @param {Object.<String, Object>} formParams
+     */
+    appendFormData(form: FormData, formParams: any): void;
+    /**
+     * Reads and normalizes fetch response body.
+     * @param {Response} response
+     * @param {*} returnType
+     * @returns {Promise<{body: *, text: (String|null)}>}
+     */
+    parseFetchResponse(response: Response, returnType: any): Promise<{
+        body: any;
+        text: (string | null);
+    }>;
     /**
      * Deserializes an HTTP response body into a value of the specified type.
      * @param {Object} response A SuperAgent response object.
@@ -247,9 +270,9 @@ declare class ApiClient {
      */
     callApi(path: string, httpMethod: string, pathParams: any, queryParams: any, headerParams: any, formParams: any, bodyParam: any, authNames: Array<string>, contentTypes: Array<string>, accepts: Array<string>, returnType: (string | any[] | ObjectFunction), apiBasePath: string): Promise<any>;
     /**
-      * Gets an array of host settings
-      * @returns An array of host settings
-      */
+     * Gets an array of host settings
+     * @returns An array of host settings
+     */
     hostSettings(): {
         url: string;
         description: string;