amazon-creators-api 1.2.0

package/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,102 @@
+# 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)
+
+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).
+
+- [API Reference](https://affiliate-program.amazon.com/creatorsapi/docs/en-us/api-reference)
+- [Getting Started](https://affiliate-program.amazon.com/creatorsapi/docs/en-us/get-started/using-sdk)
+
+This package implements a thin TypeScript wrapper around Amazon's JS runtime internals to add proper types to the Node.js SDK.
+
+## Prerequisites
+
+- Node.js version 14 or higher
+- [Register](https://affiliate-program.amazon.com/creatorsapi/docs/en-us/onboarding/register-for-creators-api) for the Creators API
+
+## Installation
+
+```bash
+npm install amazon-creators-api
+```
+
+## Usage
+
+See the [examples](examples) directory for usage examples.
+
+### Get Items
+
+```ts
+import {
+  ApiClient,
+  GetItemsRequestContent,
+  GetItemsResource,
+  TypedDefaultApi,
+} from "amazon-creators-api";
+
+// Initialize API client
+const apiClient = new ApiClient();
+
+// Add credential details
+// You can find these in the Creators API dashboard: https://affiliate-program.amazon.com/creatorsapi
+apiClient.credentialId = "<YOUR CREDENTIAL ID>";
+apiClient.credentialSecret = "<YOUR CREDENTIAL SECRET>";
+apiClient.version = "<YOUR CREDENTIAL VERSION>";
+
+// Initialize typed API wrapper
+const api = new TypedDefaultApi(apiClient);
+
+/**
+ * Sample function to demonstrate GetItems API usage
+ */
+async function getItems(): Promise<void> {
+  /**
+   * Add marketplace. For more details, refer: https://affiliate-program.amazon.com/creatorsapi/docs/en-us/api-reference/common-request-headers-and-parameters#marketplace-locale-reference
+   */
+  const marketplace = "<YOUR MARKETPLACE>"; // e.g. "www.amazon.com" for US marketplace
+
+  // Create GetItems request
+  // Enter your partner tag (store/tracking id)
+  const partnerTag = "<YOUR PARTNER TAG>";
+
+  // Choose item id(s) - ASINs to retrieve
+  const itemIds = ["B0DLFMFBJW", "B0BFC7WQ6R", "B00ZV9RDKK"];
+
+  const getItemsRequest = new GetItemsRequestContent(partnerTag, itemIds);
+
+  /**
+   * Choose resources you want from GetItemsResource enum
+   * For more details, refer: https://affiliate-program.amazon.com/creatorsapi/docs/en-us/api-reference/operations/get-items#resources-parameter
+   */
+  const resources = [
+    "images.primary.medium",
+    "itemInfo.title",
+    "itemInfo.features",
+    "offersV2.listings.price",
+    "offersV2.listings.availability",
+    "offersV2.listings.condition",
+    "offersV2.listings.merchantInfo",
+  ].map((resource) => GetItemsResource.constructFromObject(resource));
+  getItemsRequest.resources = resources;
+
+  try {
+    const response = await api.getItems(marketplace, getItemsRequest);
+    console.log("API called successfully.");
+    console.log("Complete Response:\n", JSON.stringify(response, null, 2));
+  } catch (error) {
+    console.log("Error calling Creators API!");
+    console.log("Full Error Object:\n", JSON.stringify(error, null, 2));
+  }
+```
+
+## Contributing
+
+Contributions are welcome! Please open an [issue](https://github.com/ryanschiang/amazon-creators-api/issues) or submit a pull request.
+
+## License
+
+Licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for details.
+
+Original authorship belongs to Amazon.com, Inc. or its affiliates. See the [NOTICE](NOTICE.txt) file for details.
+
+Modifications copyright (c) 2026 Ryan Chiang.

package/dist/ApiClient.d.ts

@@ -0,0 +1,273 @@
+export default ApiClient;
+/**
+* @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
+*/
+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
+    */
+    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.
+    */
+    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.
+    */
+    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.
+    */
+    static constructFromObject(data: any | any[], obj: any | any[], itemType: any): void;
+    /**
+     * The base URL against which to resolve every API call's (relative) path.
+     * Overrides the default value set in spec file if present
+     * @param {String} basePath
+     */
+    constructor(basePath?: string);
+    /**
+     * The base URL against which to resolve every API call's (relative) path.
+     * @type {String}
+     * @default https://creatorsapi.amazon
+     */
+    basePath: string;
+    /**
+     * The authentication methods to be included for all API calls.
+     * @type {Array.<String>}
+     */
+    authentications: Array<string>;
+    /**
+         * 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.
+     * @type {Number}
+     * @default 60000
+     */
+    timeout: number;
+    /**
+     * If set to false an additional timestamp parameter is added to all API GET calls to
+     * prevent browser caching
+     * @type {Boolean}
+     * @default true
+     */
+    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
+         */
+    enableCookies: boolean;
+    agent: any;
+    requestAgent: any;
+    plugins: any;
+    /**
+     * OAuth2 credential ID
+     * @type {String}
+     */
+    credentialId: string;
+    /**
+     * OAuth2 credential secret
+     * @type {String}
+     */
+    credentialSecret: string;
+    /**
+     * OAuth2 credential version
+     * @type {String}
+     */
+    version: string;
+    /**
+     * Marketplace identifier
+     * @type {String}
+     */
+    marketplace: string;
+    /**
+     * OAuth2 token manager instance
+     * @type {OAuth2TokenManager}
+     */
+    tokenManager: OAuth2TokenManager;
+    /**
+     * Custom OAuth2 auth endpoint URL
+     * @type {String}
+     */
+    authEndpoint: string;
+    /**
+     * Sets the OAuth2 credential ID
+     * @param {String} credentialId The OAuth2 credential ID
+     */
+    setCredentialId(credentialId: string): void;
+    /**
+     * Gets the OAuth2 credential ID
+     * @returns {String} The OAuth2 credential ID
+     */
+    getCredentialId(): string;
+    /**
+     * Sets the OAuth2 credential secret
+     * @param {String} credentialSecret The OAuth2 credential secret
+     */
+    setCredentialSecret(credentialSecret: string): void;
+    /**
+     * Gets the OAuth2 credential secret
+     * @returns {String} The OAuth2 credential secret
+     */
+    getCredentialSecret(): string;
+    /**
+     * Sets the credential version
+     * @param {String} version The credential version
+     */
+    setVersion(version: string): void;
+    /**
+     * Gets the credential version
+     * @returns {String} The credential version
+     */
+    getVersion(): string;
+    /**
+     * Sets the custom OAuth2 auth endpoint URL
+     * @param {String} authEndpoint The custom OAuth2 auth endpoint URL
+     */
+    setAuthEndpoint(authEndpoint: string): void;
+    /**
+     * Gets the custom OAuth2 auth endpoint URL
+     * @returns {String} The custom OAuth2 auth endpoint URL
+     */
+    getAuthEndpoint(): string;
+    /**
+    * 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.
+     * NOTE: query parameters are not handled here.
+     * @param {String} path The path to append to the base URL.
+     * @param {Object} pathParams The parameter values to append.
+     * @param {String} apiBasePath Base path defined in the path, operation level to override the default one
+     * @returns {String} The encoded path with parameter values substituted.
+     */
+    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>.
+    */
+    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.
+    */
+    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.
+    */
+    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.
+    */
+    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>.
+    */
+    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;
+    /**
+     * Deserializes an HTTP response body into a value of the specified type.
+     * @param {Object} response A SuperAgent response object.
+     * @param {(String|Array.<String>|Object.<String, Object>|Function)} returnType 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 A value of the specified type.
+     */
+    deserialize(response: any, returnType: (string | Array<string> | any | Function)): any;
+    /**
+     * Invokes the REST service using the supplied settings and parameters.
+     * @param {String} path The base URL to invoke.
+     * @param {String} httpMethod The HTTP method to use.
+     * @param {Object.<String, String>} pathParams A map of path parameters and their values.
+     * @param {Object.<String, Object>} queryParams A map of query parameters and their values.
+     * @param {Object.<String, Object>} headerParams A map of header parameters and their values.
+     * @param {Object.<String, Object>} formParams A map of form parameters and their values.
+     * @param {Object} bodyParam The value to pass as the request body.
+     * @param {Array.<String>} authNames An array of authentication type names.
+     * @param {Array.<String>} contentTypes An array of request MIME types.
+     * @param {Array.<String>} accepts An array of acceptable response MIME types.
+     * @param {(String|Array|ObjectFunction)} returnType The required type to return; can be a string for simple types or the
+     * constructor for a complex type.
+     * @param {String} apiBasePath base path defined in the operation/path level to override the default one
+     * @returns {Promise} A {@link https://www.promisejs.org/|Promise} object.
+     */
+    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
+      */
+    hostSettings(): {
+        url: string;
+        description: string;
+    }[];
+    getBasePathFromSettings(index: any, variables?: {}): string;
+}
+declare namespace ApiClient {
+    namespace CollectionFormatEnum {
+        let CSV: string;
+        let SSV: string;
+        let TSV: string;
+        let PIPES: string;
+        let MULTI: string;
+    }
+    /**
+     * *
+     */
+    type CollectionFormatEnum = string;
+    let instance: any;
+}
+import OAuth2TokenManager = require("./auth/OAuth2TokenManager.js");