@sp-api-sdk/vendor-direct-fulfillment-inventory-api-v1 1.6.16

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 (57) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +58 -0
  3. package/dist/cjs/index.js +6 -0
  4. package/dist/cjs/src/api-model/api/update-inventory-api.js +125 -0
  5. package/dist/cjs/src/api-model/api.js +17 -0
  6. package/dist/cjs/src/api-model/base.js +62 -0
  7. package/dist/cjs/src/api-model/common.js +137 -0
  8. package/dist/cjs/src/api-model/configuration.js +42 -0
  9. package/dist/cjs/src/api-model/index.js +19 -0
  10. package/dist/cjs/src/api-model/models/index.js +11 -0
  11. package/dist/cjs/src/api-model/models/inventory-update.js +15 -0
  12. package/dist/cjs/src/api-model/models/item-details.js +15 -0
  13. package/dist/cjs/src/api-model/models/item-quantity.js +15 -0
  14. package/dist/cjs/src/api-model/models/model-error.js +15 -0
  15. package/dist/cjs/src/api-model/models/party-identification.js +15 -0
  16. package/dist/cjs/src/api-model/models/submit-inventory-update-request.js +15 -0
  17. package/dist/cjs/src/api-model/models/submit-inventory-update-response.js +15 -0
  18. package/dist/cjs/src/api-model/models/transaction-reference.js +15 -0
  19. package/dist/cjs/src/client.js +35 -0
  20. package/dist/cjs/src/error.js +10 -0
  21. package/dist/es/index.js +3 -0
  22. package/dist/es/src/api-model/api/update-inventory-api.js +117 -0
  23. package/dist/es/src/api-model/api.js +14 -0
  24. package/dist/es/src/api-model/base.js +56 -0
  25. package/dist/es/src/api-model/common.js +125 -0
  26. package/dist/es/src/api-model/configuration.js +38 -0
  27. package/dist/es/src/api-model/index.js +16 -0
  28. package/dist/es/src/api-model/models/index.js +8 -0
  29. package/dist/es/src/api-model/models/inventory-update.js +14 -0
  30. package/dist/es/src/api-model/models/item-details.js +14 -0
  31. package/dist/es/src/api-model/models/item-quantity.js +14 -0
  32. package/dist/es/src/api-model/models/model-error.js +14 -0
  33. package/dist/es/src/api-model/models/party-identification.js +14 -0
  34. package/dist/es/src/api-model/models/submit-inventory-update-request.js +14 -0
  35. package/dist/es/src/api-model/models/submit-inventory-update-response.js +14 -0
  36. package/dist/es/src/api-model/models/transaction-reference.js +14 -0
  37. package/dist/es/src/client.js +31 -0
  38. package/dist/es/src/error.js +6 -0
  39. package/dist/types/index.d.ts +3 -0
  40. package/dist/types/src/api-model/api/update-inventory-api.d.ts +93 -0
  41. package/dist/types/src/api-model/api.d.ts +12 -0
  42. package/dist/types/src/api-model/base.d.ts +55 -0
  43. package/dist/types/src/api-model/common.d.ts +65 -0
  44. package/dist/types/src/api-model/configuration.d.ts +83 -0
  45. package/dist/types/src/api-model/index.d.ts +14 -0
  46. package/dist/types/src/api-model/models/index.d.ts +8 -0
  47. package/dist/types/src/api-model/models/inventory-update.d.ts +38 -0
  48. package/dist/types/src/api-model/models/item-details.d.ts +43 -0
  49. package/dist/types/src/api-model/models/item-quantity.d.ts +30 -0
  50. package/dist/types/src/api-model/models/model-error.d.ts +36 -0
  51. package/dist/types/src/api-model/models/party-identification.d.ts +24 -0
  52. package/dist/types/src/api-model/models/submit-inventory-update-request.d.ts +25 -0
  53. package/dist/types/src/api-model/models/submit-inventory-update-response.d.ts +31 -0
  54. package/dist/types/src/api-model/models/transaction-reference.d.ts +24 -0
  55. package/dist/types/src/client.d.ts +13 -0
  56. package/dist/types/src/error.d.ts +3 -0
  57. package/package.json +53 -0
@@ -0,0 +1,83 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Inventory Updates
3
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
4
+ *
5
+ * The version of the OpenAPI document: v1
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 interface ConfigurationParameters {
13
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
14
+ username?: string;
15
+ password?: string;
16
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
17
+ basePath?: string;
18
+ baseOptions?: any;
19
+ formDataCtor?: new () => any;
20
+ }
21
+ export declare class Configuration {
22
+ /**
23
+ * parameter for apiKey security
24
+ * @param name security name
25
+ * @memberof Configuration
26
+ */
27
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
28
+ /**
29
+ * parameter for basic security
30
+ *
31
+ * @type {string}
32
+ * @memberof Configuration
33
+ */
34
+ username?: string;
35
+ /**
36
+ * parameter for basic security
37
+ *
38
+ * @type {string}
39
+ * @memberof Configuration
40
+ */
41
+ password?: string;
42
+ /**
43
+ * parameter for oauth2 security
44
+ * @param name security name
45
+ * @param scopes oauth2 scope
46
+ * @memberof Configuration
47
+ */
48
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
49
+ /**
50
+ * override base path
51
+ *
52
+ * @type {string}
53
+ * @memberof Configuration
54
+ */
55
+ basePath?: string;
56
+ /**
57
+ * base options for axios calls
58
+ *
59
+ * @type {any}
60
+ * @memberof Configuration
61
+ */
62
+ baseOptions?: any;
63
+ /**
64
+ * The FormData constructor that will be used to create multipart form data
65
+ * requests. You can inject this here so that execution environments that
66
+ * do not support the FormData class can still run the generated client.
67
+ *
68
+ * @type {new () => FormData}
69
+ */
70
+ formDataCtor?: new () => any;
71
+ constructor(param?: ConfigurationParameters);
72
+ /**
73
+ * Check if the given MIME is a JSON MIME.
74
+ * JSON MIME examples:
75
+ * application/json
76
+ * application/json; charset=UTF8
77
+ * APPLICATION/JSON
78
+ * application/vnd.company+json
79
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
80
+ * @return True if the given MIME is JSON, false otherwise.
81
+ */
82
+ isJsonMime(mime: string): boolean;
83
+ }
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Inventory Updates
3
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
4
+ *
5
+ * The version of the OpenAPI document: v1
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";
@@ -0,0 +1,8 @@
1
+ export * from './inventory-update';
2
+ export * from './item-details';
3
+ export * from './item-quantity';
4
+ export * from './model-error';
5
+ export * from './party-identification';
6
+ export * from './submit-inventory-update-request';
7
+ export * from './submit-inventory-update-response';
8
+ export * from './transaction-reference';
@@ -0,0 +1,38 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Inventory Updates
3
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
4
+ *
5
+ * The version of the OpenAPI document: v1
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 { ItemDetails } from './item-details';
13
+ import { PartyIdentification } from './party-identification';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface InventoryUpdate
18
+ */
19
+ export interface InventoryUpdate {
20
+ /**
21
+ *
22
+ * @type {PartyIdentification}
23
+ * @memberof InventoryUpdate
24
+ */
25
+ sellingParty: PartyIdentification;
26
+ /**
27
+ * When true, this request contains a full feed. Otherwise, this request contains a partial feed. When sending a full feed, you must send information about all items in the warehouse. Any items not in the full feed are updated as not available. When sending a partial feed, only include the items that need an update to inventory. The status of other items will remain unchanged.
28
+ * @type {boolean}
29
+ * @memberof InventoryUpdate
30
+ */
31
+ isFullUpdate: boolean;
32
+ /**
33
+ * A list of inventory items with updated details, including quantity available.
34
+ * @type {Array<ItemDetails>}
35
+ * @memberof InventoryUpdate
36
+ */
37
+ items: Array<ItemDetails>;
38
+ }
@@ -0,0 +1,43 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Inventory Updates
3
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
4
+ *
5
+ * The version of the OpenAPI document: v1
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 { ItemQuantity } from './item-quantity';
13
+ /**
14
+ * Updated inventory details for an item.
15
+ * @export
16
+ * @interface ItemDetails
17
+ */
18
+ export interface ItemDetails {
19
+ /**
20
+ * The buyer selected product identification of the item. Either buyerProductIdentifier or vendorProductIdentifier should be submitted.
21
+ * @type {string}
22
+ * @memberof ItemDetails
23
+ */
24
+ buyerProductIdentifier?: string;
25
+ /**
26
+ * The vendor selected product identification of the item. Either buyerProductIdentifier or vendorProductIdentifier should be submitted.
27
+ * @type {string}
28
+ * @memberof ItemDetails
29
+ */
30
+ vendorProductIdentifier?: string;
31
+ /**
32
+ *
33
+ * @type {ItemQuantity}
34
+ * @memberof ItemDetails
35
+ */
36
+ availableQuantity: ItemQuantity;
37
+ /**
38
+ * When true, the item is permanently unavailable.
39
+ * @type {boolean}
40
+ * @memberof ItemDetails
41
+ */
42
+ isObsolete?: boolean;
43
+ }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Inventory Updates
3
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
4
+ *
5
+ * The version of the OpenAPI document: v1
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
+ * Details of item quantity.
14
+ * @export
15
+ * @interface ItemQuantity
16
+ */
17
+ export interface ItemQuantity {
18
+ /**
19
+ * Quantity of units available for a specific item.
20
+ * @type {number}
21
+ * @memberof ItemQuantity
22
+ */
23
+ amount?: number;
24
+ /**
25
+ * Unit of measure for the available quantity.
26
+ * @type {string}
27
+ * @memberof ItemQuantity
28
+ */
29
+ unitOfMeasure: string;
30
+ }
@@ -0,0 +1,36 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Inventory Updates
3
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
4
+ *
5
+ * The version of the OpenAPI document: v1
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
+ * @export
15
+ * @interface ModelError
16
+ */
17
+ export interface ModelError {
18
+ /**
19
+ * An error code that identifies the type of error that occurred.
20
+ * @type {string}
21
+ * @memberof ModelError
22
+ */
23
+ code: string;
24
+ /**
25
+ * A message that describes the error condition.
26
+ * @type {string}
27
+ * @memberof ModelError
28
+ */
29
+ message: string;
30
+ /**
31
+ * Additional details that can help the caller understand or fix the issue.
32
+ * @type {string}
33
+ * @memberof ModelError
34
+ */
35
+ details?: string;
36
+ }
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Inventory Updates
3
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
4
+ *
5
+ * The version of the OpenAPI document: v1
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
+ *
14
+ * @export
15
+ * @interface PartyIdentification
16
+ */
17
+ export interface PartyIdentification {
18
+ /**
19
+ * Assigned identification for the party.
20
+ * @type {string}
21
+ * @memberof PartyIdentification
22
+ */
23
+ partyId: string;
24
+ }
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Inventory Updates
3
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
4
+ *
5
+ * The version of the OpenAPI document: v1
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 { InventoryUpdate } from './inventory-update';
13
+ /**
14
+ * The request body for the submitInventoryUpdate operation.
15
+ * @export
16
+ * @interface SubmitInventoryUpdateRequest
17
+ */
18
+ export interface SubmitInventoryUpdateRequest {
19
+ /**
20
+ *
21
+ * @type {InventoryUpdate}
22
+ * @memberof SubmitInventoryUpdateRequest
23
+ */
24
+ inventory?: InventoryUpdate;
25
+ }
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Inventory Updates
3
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
4
+ *
5
+ * The version of the OpenAPI document: v1
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 { TransactionReference } from './transaction-reference';
13
+ /**
14
+ * The response schema for the submitInventoryUpdate operation.
15
+ * @export
16
+ * @interface SubmitInventoryUpdateResponse
17
+ */
18
+ export interface SubmitInventoryUpdateResponse {
19
+ /**
20
+ *
21
+ * @type {TransactionReference}
22
+ * @memberof SubmitInventoryUpdateResponse
23
+ */
24
+ payload?: TransactionReference;
25
+ /**
26
+ * A list of error responses returned when a request is unsuccessful.
27
+ * @type {Array<Error>}
28
+ * @memberof SubmitInventoryUpdateResponse
29
+ */
30
+ errors?: Array<Error>;
31
+ }
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Inventory Updates
3
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
4
+ *
5
+ * The version of the OpenAPI document: v1
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
+ *
14
+ * @export
15
+ * @interface TransactionReference
16
+ */
17
+ export interface TransactionReference {
18
+ /**
19
+ * GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.
20
+ * @type {string}
21
+ * @memberof TransactionReference
22
+ */
23
+ transactionId?: string;
24
+ }
@@ -0,0 +1,13 @@
1
+ import { onRetry } from '@sp-api-sdk/common';
2
+ import type { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
3
+ import { UpdateInventoryApi } from './api-model';
4
+ export declare const RATE_LIMITS: RateLimit[];
5
+ export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
6
+ rateLimiting?: {
7
+ retry: boolean;
8
+ onRetry?: onRetry;
9
+ };
10
+ }
11
+ export declare class VendorDirectFulfillmentInventoryApiClient extends UpdateInventoryApi {
12
+ constructor(parameters: ClientParameters);
13
+ }
@@ -0,0 +1,3 @@
1
+ export declare class VendorDirectFulfillmentInventoryApiError extends Error {
2
+ constructor(message: string);
3
+ }
package/package.json ADDED
@@ -0,0 +1,53 @@
1
+ {
2
+ "name": "@sp-api-sdk/vendor-direct-fulfillment-inventory-api-v1",
3
+ "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
4
+ "description": "The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor's inventory updates.",
5
+ "version": "1.6.16",
6
+ "main": "dist/cjs/index.js",
7
+ "module": "dist/es/index.js",
8
+ "types": "dist/types/index.d.ts",
9
+ "license": "MIT",
10
+ "publishConfig": {
11
+ "access": "public"
12
+ },
13
+ "directories": {
14
+ "lib": "dist"
15
+ },
16
+ "files": [
17
+ "dist/**/*.js",
18
+ "dist/**/*.d.ts"
19
+ ],
20
+ "scripts": {
21
+ "build:cjs": "tsc -p tsconfig.json",
22
+ "build:es": "tsc -p tsconfig.es.json",
23
+ "build": "yarn build:cjs && yarn build:es",
24
+ "clean": "rimraf dist",
25
+ "lint": "xo --cwd=../../ $PWD",
26
+ "test": "NODE_ENV='test' yarn jest"
27
+ },
28
+ "dependencies": {
29
+ "@sp-api-sdk/auth": "^1.9.1",
30
+ "@sp-api-sdk/common": "^1.7.2",
31
+ "axios": "^0.21.1"
32
+ },
33
+ "repository": {
34
+ "type": "git",
35
+ "url": "https://github.com/bizon/selling-partner-api-sdk.git",
36
+ "directory": "clients/vendor-direct-fulfillment-inventory-api-v1"
37
+ },
38
+ "bugs": {
39
+ "url": "https://github.com/bizon/selling-partner-api-sdk/issues"
40
+ },
41
+ "homepage": "https://github.com/bizon/selling-partner-api-sdk/tree/master/clients/vendor-direct-fulfillment-inventory-api-v1",
42
+ "keywords": [
43
+ "amazon",
44
+ "bizon",
45
+ "marketplace web services",
46
+ "mws",
47
+ "selling partner api",
48
+ "sp api",
49
+ "sp sdk",
50
+ "vendor direct fulfillment inventory api"
51
+ ],
52
+ "gitHead": "dc4286920dc77e99d6ad71f71bcb78ae22b9ab06"
53
+ }