refactor: mark deprecated options

ScaleLeap · Nov 14, 2023 · f361367 · f361367
1 parent b3a3cb4
commit f361367
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/src/types/api-clients/amazon-selling-partner-api-credentials.ts b/src/types/api-clients/amazon-selling-partner-api-credentials.ts
@@ -0,0 +1,5 @@
+export interface AmazonSellingPartnerAPICredentials {
+  accessKeyId: string
+  secretAccessKey: string
+  sessionToken?: string
+}
diff --git a/src/types/api-clients/api-configuration-parameters.ts b/src/types/api-clients/api-configuration-parameters.ts
@@ -1,5 +1,7 @@
 import { AxiosInstance, AxiosRequestConfig } from 'axios'
 
+import { AmazonSellingPartnerAPICredentials } from './amazon-selling-partner-api-credentials'
+
 export interface APIConfigurationParameters {
   /**
    * Axios Instance
@@ -32,11 +34,29 @@ export interface APIConfigurationParameters {
    */
   baseOptions?: AxiosRequestConfig
 
+  /**
+   * Selling partner API credentials
+   *
+   * @deprecated Amazon no longer requires the requests to be signed with AWS4
+   * @type {AmazonSellingPartnerAPICredentials}
+   * @memberof APIConfigurationParameters
+   */
+  credentials?: AmazonSellingPartnerAPICredentials
+
   /**
    * Selling partner API region
    *
    * @type {string}
    * @memberof APIConfigurationParameters
    */
   region?: string
+
+  /**
+   * ARN of the IAM Role to be assumed to get the credentials from.
+   *
+   * @deprecated Amazon no longer requires the requests to be signed with AWS4
+   * @type {string}
+   * @memberof APIConfigurationParameters
+   */
+  roleArn?: string
 }
diff --git a/src/types/api-clients/index.ts b/src/types/api-clients/index.ts
@@ -1,2 +1,3 @@
 export * from './amazon-selling-partner-api-base-path'
+export * from './amazon-selling-partner-api-credentials'
 export * from './api-configuration-parameters'