@sp-api-sdk/data-kiosk-api-2023-11-15 1.1.1 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -59,7 +59,7 @@ const QueriesApiAxiosParamCreator = function (configuration) {
59
59
  },
60
60
  /**
61
61
  * Creates a Data Kiosk query request. **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
62
- * @param {CreateQuerySpecification} body
62
+ * @param {CreateQuerySpecification} body The body of the request.
63
63
  * @param {*} [options] Override http request option.
64
64
  * @throws {RequiredError}
65
65
  */
@@ -212,7 +212,7 @@ const QueriesApiFp = function (configuration) {
212
212
  },
213
213
  /**
214
214
  * Creates a Data Kiosk query request. **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
215
- * @param {CreateQuerySpecification} body
215
+ * @param {CreateQuerySpecification} body The body of the request.
216
216
  * @param {*} [options] Override http request option.
217
217
  * @throws {RequiredError}
218
218
  */
@@ -53,7 +53,7 @@ export const QueriesApiAxiosParamCreator = function (configuration) {
53
53
  },
54
54
  /**
55
55
  * Creates a Data Kiosk query request. **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
56
- * @param {CreateQuerySpecification} body
56
+ * @param {CreateQuerySpecification} body The body of the request.
57
57
  * @param {*} [options] Override http request option.
58
58
  * @throws {RequiredError}
59
59
  */
@@ -205,7 +205,7 @@ export const QueriesApiFp = function (configuration) {
205
205
  },
206
206
  /**
207
207
  * Creates a Data Kiosk query request. **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
208
- * @param {CreateQuerySpecification} body
208
+ * @param {CreateQuerySpecification} body The body of the request.
209
209
  * @param {*} [options] Override http request option.
210
210
  * @throws {RequiredError}
211
211
  */
@@ -32,7 +32,7 @@ export declare const QueriesApiAxiosParamCreator: (configuration?: Configuration
32
32
  cancelQuery: (queryId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
33
  /**
34
34
  * Creates a Data Kiosk query request. **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
35
- * @param {CreateQuerySpecification} body
35
+ * @param {CreateQuerySpecification} body The body of the request.
36
36
  * @param {*} [options] Override http request option.
37
37
  * @throws {RequiredError}
38
38
  */
@@ -77,7 +77,7 @@ export declare const QueriesApiFp: (configuration?: Configuration) => {
77
77
  cancelQuery(queryId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
78
78
  /**
79
79
  * Creates a Data Kiosk query request. **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
80
- * @param {CreateQuerySpecification} body
80
+ * @param {CreateQuerySpecification} body The body of the request.
81
81
  * @param {*} [options] Override http request option.
82
82
  * @throws {RequiredError}
83
83
  */
@@ -169,7 +169,7 @@ export interface QueriesApiCancelQueryRequest {
169
169
  */
170
170
  export interface QueriesApiCreateQueryRequest {
171
171
  /**
172
- *
172
+ * The body of the request.
173
173
  * @type {CreateQuerySpecification}
174
174
  * @memberof QueriesApiCreateQuery
175
175
  */
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface ErrorList {
18
18
  /**
19
- *
19
+ * Error response returned when the request is unsuccessful.
20
20
  * @type {Array<Error>}
21
21
  * @memberof ErrorList
22
22
  */
@@ -22,7 +22,7 @@ export interface ModelError {
22
22
  */
23
23
  'code': string;
24
24
  /**
25
- * A message that describes the error condition in a human-readable form.
25
+ * A message that describes the error condition.
26
26
  * @type {string}
27
27
  * @memberof ModelError
28
28
  */
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/data-kiosk-api-2023-11-15",
3
3
  "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.",
5
- "version": "1.1.1",
5
+ "version": "1.2.0",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.0.4",
22
- "axios": "^1.6.2"
21
+ "@sp-api-sdk/common": "2.0.5",
22
+ "axios": "^1.6.7"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "data kiosk api"
42
42
  ],
43
- "gitHead": "96729dd2eabfca855da5eb33f271c0b09b449972"
43
+ "gitHead": "014aad96509aba433e07461efbe936a6062cc66a"
44
44
  }