@sp-api-sdk/solicitations-api-v1 1.7.1 → 1.7.5

package/README.md

@@ -2,6 +2,12 @@
 
 With the Solicitations API you can build applications that send non-critical solicitations to buyers. You can get a list of solicitation types that are available for an order that you specify, then call an operation that sends a solicitation to the buyer for that order. Buyers cannot respond to solicitations sent by this API, and these solicitations do not appear in the Messaging section of Seller Central or in the recipient's Message Center. The Solicitations API returns responses that are formed according to the <a href=https://tools.ietf.org/html/draft-kelly-json-hal-08>JSON Hypertext Application Language</a> (HAL) standard.
 
+## Documentation
+
+Learn more about this Selling Partner API by visiting the [official documentation](https://github.com/amzn/selling-partner-api-docs/tree/main/references/solicitations-api/solicitations.md).
+
+Also, see the [generated documentation](https://bizon.github.io/selling-partner-api-sdk/modules/_sp_api_sdk_solicitations_api_v1.html) for this API client.
+
 ## Installing
 
 ```sh
@@ -19,26 +25,25 @@ import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
 import {SolicitationsApiClient} from '@sp-api-sdk/solicitations-api-v1'
 
 const auth = new SellingPartnerApiAuth({
-  clientId: '',
-  clientSecret: '',
-  refreshToken: '',
-  secretAccessKey: '',
+  clientId: process.env.LWA_CLIENT_ID,
+  clientSecret: process.env.LWA_CLIENT_SECRET,
+  refreshToken: 'Atzr|…',
   accessKeyId: '',
-  region: '',
+  secretAccessKey: '',
   role: {
-    arn: '',
-  }
+    arn: 'arn:aws:iam::…',
+  },
 })
 
 const client = new SolicitationsApiClient({
   auth,
-  region: 'eu' // or 'eu-west-1'
+  region: 'eu',
 })
 ```
 
-## Handle Rate Limiting
+## Rate Limiting
 
-If you want to let the SDK retry after each 429 responses, instanciate the client like this:
+In order to retry rate limited requests (HTTP 429), you can configure the API client as such:
 
 ```javascript
 const client = new SolicitationsApiClient({
@@ -46,13 +51,28 @@ const client = new SolicitationsApiClient({
   region: 'eu',
   rateLimiting: {
     retry: true,
-    onRetry: (retryInfo) => console.log(retryInfo) // Optional
-  }
+    // Optionally specify a callback that will be called on every retry.
+    onRetry: (retryInfo) => {
+      console.log(retryInfo)
+    },
+  },
 })
 ```
 
-The SDK gets the rate limits for each routes from the API documentation
+The rate limits used for each route are specified in the [API documentation]((https://github.com/amzn/selling-partner-api-docs/tree/main/references/solicitations-api/solicitations.md)).
+
+## License
+
+MIT
 
-## API documentation
+## Miscellaneous
 
-See [here](https://github.com/amzn/selling-partner-api-docs/tree/main/references/solicitations-api/solicitations.md)
+```
+    ╚⊙ ⊙╝
+  ╚═(███)═╝
+ ╚═(███)═╝
+╚═(███)═╝
+ ╚═(███)═╝
+  ╚═(███)═╝
+   ╚═(███)═╝
+```

package/dist/types/src/api-model/api/solicitations-api.d.ts

@@ -132,7 +132,7 @@ export declare class SolicitationsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof SolicitationsApi
      */
-    createProductReviewAndSellerFeedbackSolicitation(requestParameters: SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest, options?: any): Promise<import("axios").AxiosResponse<CreateProductReviewAndSellerFeedbackSolicitationResponse>>;
+    createProductReviewAndSellerFeedbackSolicitation(requestParameters: SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest, options?: any): Promise<import("axios").AxiosResponse<CreateProductReviewAndSellerFeedbackSolicitationResponse, any>>;
     /**
      * Returns a list of solicitation types that are available for an order that you specify. A solicitation type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a solicitation. Currently only the productReviewAndSellerFeedbackSolicitation solicitation type is available.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {SolicitationsApiGetSolicitationActionsForOrderRequest} requestParameters Request parameters.
@@ -140,5 +140,5 @@ export declare class SolicitationsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof SolicitationsApi
      */
-    getSolicitationActionsForOrder(requestParameters: SolicitationsApiGetSolicitationActionsForOrderRequest, options?: any): Promise<import("axios").AxiosResponse<GetSolicitationActionsForOrderResponse>>;
+    getSolicitationActionsForOrder(requestParameters: SolicitationsApiGetSolicitationActionsForOrderRequest, options?: any): Promise<import("axios").AxiosResponse<GetSolicitationActionsForOrderResponse, any>>;
 }

package/dist/types/src/api-model/common.d.ts

@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
  *
  * @export
  */
-export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any>>;
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any, any>>;

package/dist/types/src/client.d.ts

@@ -1,11 +1,10 @@
-import { onRetry } from '@sp-api-sdk/common';
-import type { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
+import type { ClientConfiguration, RateLimit, OnRetryHandler } from '@sp-api-sdk/common';
 import { SolicitationsApi } from './api-model';
 export declare const RATE_LIMITS: RateLimit[];
 export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
     rateLimiting?: {
         retry: boolean;
-        onRetry?: onRetry;
+        onRetry?: OnRetryHandler;
     };
 }
 export declare class SolicitationsApiClient extends SolicitationsApi {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/solicitations-api-v1",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
   "description": "With the Solicitations API you can build applications that send non-critical solicitations to buyers. You can get a list of solicitation types that are available for an order that you specify, then call an operation that sends a solicitation to the buyer for that order. Buyers cannot respond to solicitations sent by this API, and these solicitations do not appear in the Messaging section of Seller Central or in the recipient's Message Center. The Solicitations API returns responses that are formed according to the JSON Hypertext Application Language (HAL) standard.",
-  "version": "1.7.1",
+  "version": "1.7.5",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -25,9 +25,9 @@
     "test": "NODE_ENV='test' yarn jest"
   },
   "dependencies": {
-    "@sp-api-sdk/auth": "^1.9.2",
-    "@sp-api-sdk/common": "^1.7.3",
-    "axios": "^0.21.1"
+    "@sp-api-sdk/auth": "^1.9.5",
+    "@sp-api-sdk/common": "^1.7.7",
+    "axios": "^0.24.0"
   },
   "repository": {
     "type": "git",
@@ -48,5 +48,5 @@
     "sp sdk",
     "solicitations api"
   ],
-  "gitHead": "af064cf72ac5a2111135439fc179580e6b495399"
+  "gitHead": "e8c21d7d481263e8a6663ee11f6708d4dc6968b6"
 }