@sp-api-sdk/external-fulfillment-inventory-api-2024-09-11 1.1.11 → 2.0.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.
Files changed (71) hide show
  1. package/README.md +4 -4
  2. package/dist/index.cjs +320 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +498 -0
  5. package/dist/index.d.ts +498 -0
  6. package/dist/index.js +276 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +23 -12
  9. package/dist/cjs/api-model/api/external-fulfillment-inventory-api.js +0 -117
  10. package/dist/cjs/api-model/api.js +0 -30
  11. package/dist/cjs/api-model/base.js +0 -52
  12. package/dist/cjs/api-model/common.js +0 -123
  13. package/dist/cjs/api-model/configuration.js +0 -98
  14. package/dist/cjs/api-model/index.js +0 -32
  15. package/dist/cjs/api-model/models/actionable-error.js +0 -15
  16. package/dist/cjs/api-model/models/batch-inventory-request.js +0 -15
  17. package/dist/cjs/api-model/models/batch-inventory-response.js +0 -15
  18. package/dist/cjs/api-model/models/error-list.js +0 -15
  19. package/dist/cjs/api-model/models/http-method.js +0 -23
  20. package/dist/cjs/api-model/models/http-status-line.js +0 -15
  21. package/dist/cjs/api-model/models/index.js +0 -28
  22. package/dist/cjs/api-model/models/inventory-request-params.js +0 -15
  23. package/dist/cjs/api-model/models/inventory-request.js +0 -15
  24. package/dist/cjs/api-model/models/inventory-response-body.js +0 -15
  25. package/dist/cjs/api-model/models/inventory-response.js +0 -15
  26. package/dist/cjs/api-model/models/marketplace-attributes.js +0 -21
  27. package/dist/cjs/api-model/models/model-error.js +0 -15
  28. package/dist/cjs/client.js +0 -13
  29. package/dist/cjs/index.js +0 -19
  30. package/dist/es/api-model/api/external-fulfillment-inventory-api.js +0 -107
  31. package/dist/es/api-model/api.js +0 -14
  32. package/dist/es/api-model/base.js +0 -44
  33. package/dist/es/api-model/common.js +0 -110
  34. package/dist/es/api-model/configuration.js +0 -94
  35. package/dist/es/api-model/index.js +0 -16
  36. package/dist/es/api-model/models/actionable-error.js +0 -14
  37. package/dist/es/api-model/models/batch-inventory-request.js +0 -14
  38. package/dist/es/api-model/models/batch-inventory-response.js +0 -14
  39. package/dist/es/api-model/models/error-list.js +0 -14
  40. package/dist/es/api-model/models/http-method.js +0 -20
  41. package/dist/es/api-model/models/http-status-line.js +0 -14
  42. package/dist/es/api-model/models/index.js +0 -12
  43. package/dist/es/api-model/models/inventory-request-params.js +0 -14
  44. package/dist/es/api-model/models/inventory-request.js +0 -14
  45. package/dist/es/api-model/models/inventory-response-body.js +0 -14
  46. package/dist/es/api-model/models/inventory-response.js +0 -14
  47. package/dist/es/api-model/models/marketplace-attributes.js +0 -18
  48. package/dist/es/api-model/models/model-error.js +0 -14
  49. package/dist/es/client.js +0 -9
  50. package/dist/es/index.js +0 -3
  51. package/dist/types/api-model/api/external-fulfillment-inventory-api.d.ts +0 -74
  52. package/dist/types/api-model/api.d.ts +0 -12
  53. package/dist/types/api-model/base.d.ts +0 -42
  54. package/dist/types/api-model/common.d.ts +0 -34
  55. package/dist/types/api-model/configuration.d.ts +0 -98
  56. package/dist/types/api-model/index.d.ts +0 -14
  57. package/dist/types/api-model/models/actionable-error.d.ts +0 -24
  58. package/dist/types/api-model/models/batch-inventory-request.d.ts +0 -21
  59. package/dist/types/api-model/models/batch-inventory-response.d.ts +0 -21
  60. package/dist/types/api-model/models/error-list.d.ts +0 -20
  61. package/dist/types/api-model/models/http-method.d.ts +0 -19
  62. package/dist/types/api-model/models/http-status-line.d.ts +0 -24
  63. package/dist/types/api-model/models/index.d.ts +0 -12
  64. package/dist/types/api-model/models/inventory-request-params.d.ts +0 -26
  65. package/dist/types/api-model/models/inventory-request.d.ts +0 -24
  66. package/dist/types/api-model/models/inventory-response-body.d.ts +0 -43
  67. package/dist/types/api-model/models/inventory-response.d.ts +0 -20
  68. package/dist/types/api-model/models/marketplace-attributes.d.ts +0 -30
  69. package/dist/types/api-model/models/model-error.d.ts +0 -28
  70. package/dist/types/client.d.ts +0 -6
  71. package/dist/types/index.d.ts +0 -3
@@ -1,98 +0,0 @@
1
- /**
2
- * The Selling Partner API for External Fulfillment Inventory Management
3
- * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- interface AWSv4Configuration {
13
- options?: {
14
- region?: string;
15
- service?: string;
16
- };
17
- credentials?: {
18
- accessKeyId?: string;
19
- secretAccessKey?: string;
20
- sessionToken?: string;
21
- };
22
- }
23
- export interface ConfigurationParameters {
24
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
25
- username?: string;
26
- password?: string;
27
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
28
- awsv4?: AWSv4Configuration;
29
- basePath?: string;
30
- serverIndex?: number;
31
- baseOptions?: any;
32
- formDataCtor?: new () => any;
33
- }
34
- export declare class Configuration {
35
- /**
36
- * parameter for apiKey security
37
- * @param name security name
38
- */
39
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
40
- /**
41
- * parameter for basic security
42
- */
43
- username?: string;
44
- /**
45
- * parameter for basic security
46
- */
47
- password?: string;
48
- /**
49
- * parameter for oauth2 security
50
- * @param name security name
51
- * @param scopes oauth2 scope
52
- */
53
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
54
- /**
55
- * parameter for aws4 signature security
56
- * @param {Object} AWS4Signature - AWS4 Signature security
57
- * @param {string} options.region - aws region
58
- * @param {string} options.service - name of the service.
59
- * @param {string} credentials.accessKeyId - aws access key id
60
- * @param {string} credentials.secretAccessKey - aws access key
61
- * @param {string} credentials.sessionToken - aws session token
62
- * @memberof Configuration
63
- */
64
- awsv4?: AWSv4Configuration;
65
- /**
66
- * override base path
67
- */
68
- basePath?: string;
69
- /**
70
- * override server index
71
- */
72
- serverIndex?: number;
73
- /**
74
- * base options for axios calls
75
- */
76
- baseOptions?: any;
77
- /**
78
- * The FormData constructor that will be used to create multipart form data
79
- * requests. You can inject this here so that execution environments that
80
- * do not support the FormData class can still run the generated client.
81
- *
82
- * @type {new () => FormData}
83
- */
84
- formDataCtor?: new () => any;
85
- constructor(param?: ConfigurationParameters);
86
- /**
87
- * Check if the given MIME is a JSON MIME.
88
- * JSON MIME examples:
89
- * application/json
90
- * application/json; charset=UTF8
91
- * APPLICATION/JSON
92
- * application/vnd.company+json
93
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
94
- * @return True if the given MIME is JSON, false otherwise.
95
- */
96
- isJsonMime(mime: string): boolean;
97
- }
98
- export {};
@@ -1,14 +0,0 @@
1
- /**
2
- * The Selling Partner API for External Fulfillment Inventory Management
3
- * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- export * from "./api";
13
- export * from "./configuration";
14
- export * from "./models";
@@ -1,24 +0,0 @@
1
- /**
2
- * The Selling Partner API for External Fulfillment Inventory Management
3
- * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- * Error details you can take action on.
14
- */
15
- export interface ActionableError {
16
- /**
17
- * The top level error type that may contain multiple error subtypes.
18
- */
19
- 'errorType'?: string;
20
- /**
21
- * The secondary level error type.
22
- */
23
- 'errorSubType'?: string;
24
- }
@@ -1,21 +0,0 @@
1
- /**
2
- * The Selling Partner API for External Fulfillment Inventory Management
3
- * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { InventoryRequest } from './inventory-request';
13
- /**
14
- * A list of inventory requests.
15
- */
16
- export interface BatchInventoryRequest {
17
- /**
18
- * A list of inventory requests.
19
- */
20
- 'requests'?: Array<InventoryRequest>;
21
- }
@@ -1,21 +0,0 @@
1
- /**
2
- * The Selling Partner API for External Fulfillment Inventory Management
3
- * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { InventoryResponse } from './inventory-response';
13
- /**
14
- * The response of the `batchInventory` operation.
15
- */
16
- export interface BatchInventoryResponse {
17
- /**
18
- * A list of inventory request responses.
19
- */
20
- 'responses'?: Array<InventoryResponse>;
21
- }
@@ -1,20 +0,0 @@
1
- /**
2
- * The Selling Partner API for External Fulfillment Inventory Management
3
- * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- * An object containing a list of error responses returned when a request is unsuccessful.
14
- */
15
- export interface ErrorList {
16
- /**
17
- * A list of error responses returned when a request is unsuccessful.
18
- */
19
- 'errors': Array<Error>;
20
- }
@@ -1,19 +0,0 @@
1
- /**
2
- * The Selling Partner API for External Fulfillment Inventory Management
3
- * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- * The HTTP method associated with an individual request within a batch.
14
- */
15
- export declare const HttpMethod: {
16
- readonly Get: "GET";
17
- readonly Post: "POST";
18
- };
19
- export type HttpMethod = typeof HttpMethod[keyof typeof HttpMethod];
@@ -1,24 +0,0 @@
1
- /**
2
- * The Selling Partner API for External Fulfillment Inventory Management
3
- * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- * The HTTP status associated with the response for an individual request within a batch.
14
- */
15
- export interface HttpStatusLine {
16
- /**
17
- * The HTTP response status code.
18
- */
19
- 'statusCode'?: number;
20
- /**
21
- * The HTTP response reason phrase.
22
- */
23
- 'reasonPhrase'?: string;
24
- }
@@ -1,12 +0,0 @@
1
- export * from './actionable-error';
2
- export * from './batch-inventory-request';
3
- export * from './batch-inventory-response';
4
- export * from './error-list';
5
- export * from './http-method';
6
- export * from './http-status-line';
7
- export * from './inventory-request';
8
- export * from './inventory-request-params';
9
- export * from './inventory-response';
10
- export * from './inventory-response-body';
11
- export * from './marketplace-attributes';
12
- export * from './model-error';
@@ -1,26 +0,0 @@
1
- /**
2
- * The Selling Partner API for External Fulfillment Inventory Management
3
- * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { MarketplaceAttributes } from './marketplace-attributes';
13
- /**
14
- * The parameters for an individual request.
15
- */
16
- export interface InventoryRequestParams {
17
- /**
18
- * The latest sequence number for the inventory update operation. You find this value in the `clientSequenceNumber` property in the response to the `batchInventory` operation.
19
- */
20
- 'clientSequenceNumber'?: number;
21
- /**
22
- * The absolute inventory quantity.
23
- */
24
- 'quantity'?: number;
25
- 'marketplaceAttributes'?: MarketplaceAttributes;
26
- }
@@ -1,24 +0,0 @@
1
- /**
2
- * The Selling Partner API for External Fulfillment Inventory Management
3
- * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { HttpMethod } from './http-method';
13
- import type { InventoryRequestParams } from './inventory-request-params';
14
- /**
15
- * An inventory request.
16
- */
17
- export interface InventoryRequest {
18
- /**
19
- * The URI associated with the individual APIs from the batch request. The user must provide the resource identifier for the operation they want to use.
20
- */
21
- 'uri': string;
22
- 'method': HttpMethod;
23
- 'body'?: InventoryRequestParams;
24
- }
@@ -1,43 +0,0 @@
1
- /**
2
- * The Selling Partner API for External Fulfillment Inventory Management
3
- * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { ActionableError } from './actionable-error';
13
- import type { MarketplaceAttributes } from './marketplace-attributes';
14
- /**
15
- * The response to an inventory request.
16
- */
17
- export interface InventoryResponseBody {
18
- /**
19
- * Latest sequence number for an inventory update.
20
- */
21
- 'clientSequenceNumber'?: number;
22
- /**
23
- * The location where inventory is updated or retrieved.
24
- */
25
- 'locationId'?: string;
26
- /**
27
- * The SKU ID for which inventory is updated or retrieved
28
- */
29
- 'skuId'?: string;
30
- /**
31
- * The number of items of the specified SKU that are available for purchase.
32
- */
33
- 'sellableQuantity'?: number;
34
- /**
35
- * The number of items of the specified SKU created in any marketplace that are reserved for shipment and yet to be fulfilled.
36
- */
37
- 'reservedQuantity'?: number;
38
- 'marketplaceAttributes'?: MarketplaceAttributes;
39
- /**
40
- * Inventory operation errors that require seller action before retrying the inventory request.
41
- */
42
- 'actionableErrors'?: Array<ActionableError>;
43
- }
@@ -1,20 +0,0 @@
1
- /**
2
- * The Selling Partner API for External Fulfillment Inventory Management
3
- * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { HttpStatusLine } from './http-status-line';
13
- import type { InventoryResponseBody } from './inventory-response-body';
14
- /**
15
- * A response to an individual inventory request.
16
- */
17
- export interface InventoryResponse {
18
- 'status': HttpStatusLine;
19
- 'body': InventoryResponseBody;
20
- }
@@ -1,30 +0,0 @@
1
- /**
2
- * The Selling Partner API for External Fulfillment Inventory Management
3
- * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- * The channel name and marketplace ID. This is required only when multiple channels have the same location ID.
14
- */
15
- export interface MarketplaceAttributes {
16
- /**
17
- * The name of the fulfillment channel in which to update inventory.
18
- */
19
- 'channelName'?: MarketplaceAttributesChannelNameEnum;
20
- /**
21
- * The marketplace ID of the marketplace where you want to update inventory.
22
- */
23
- 'marketplaceId'?: string;
24
- }
25
- export declare const MarketplaceAttributesChannelNameEnum: {
26
- readonly Fba: "FBA";
27
- readonly Mfn: "MFN";
28
- readonly Df: "DF";
29
- };
30
- export type MarketplaceAttributesChannelNameEnum = typeof MarketplaceAttributesChannelNameEnum[keyof typeof MarketplaceAttributesChannelNameEnum];
@@ -1,28 +0,0 @@
1
- /**
2
- * The Selling Partner API for External Fulfillment Inventory Management
3
- * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- * Error response returned when the request is unsuccessful.
14
- */
15
- export interface ModelError {
16
- /**
17
- * An error code that identifies the type of error that occurred.
18
- */
19
- 'code': string;
20
- /**
21
- * A message that describes the error condition.
22
- */
23
- 'message': string;
24
- /**
25
- * Additional details that can help the caller understand or fix the issue.
26
- */
27
- 'details'?: string;
28
- }
@@ -1,6 +0,0 @@
1
- import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
2
- import { ExternalFulfillmentInventoryApi } from './api-model';
3
- export declare const clientRateLimits: RateLimit[];
4
- export declare class ExternalFulfillmentInventoryApiClient extends ExternalFulfillmentInventoryApi {
5
- constructor(configuration: ClientConfiguration);
6
- }
@@ -1,3 +0,0 @@
1
- export * from './client';
2
- export * from './api-model/api';
3
- export * from './api-model/models';