@teemill/orders 1.24.0 → 1.25.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 (60) hide show
  1. package/README.md +11 -8
  2. package/api.ts +457 -146
  3. package/base.ts +1 -1
  4. package/common.ts +1 -1
  5. package/configuration.ts +1 -1
  6. package/dist/api.d.ts +444 -135
  7. package/dist/api.js +52 -32
  8. package/dist/base.d.ts +1 -1
  9. package/dist/base.js +1 -1
  10. package/dist/common.d.ts +1 -1
  11. package/dist/common.js +1 -1
  12. package/dist/configuration.d.ts +1 -1
  13. package/dist/configuration.js +1 -1
  14. package/dist/esm/api.d.ts +444 -135
  15. package/dist/esm/api.js +51 -31
  16. package/dist/esm/base.d.ts +1 -1
  17. package/dist/esm/base.js +1 -1
  18. package/dist/esm/common.d.ts +1 -1
  19. package/dist/esm/common.js +1 -1
  20. package/dist/esm/configuration.d.ts +1 -1
  21. package/dist/esm/configuration.js +1 -1
  22. package/dist/esm/index.d.ts +1 -1
  23. package/dist/esm/index.js +1 -1
  24. package/dist/index.d.ts +1 -1
  25. package/dist/index.js +1 -1
  26. package/docs/Address.md +9 -9
  27. package/docs/ApiError.md +3 -2
  28. package/docs/ConfirmOrderFulfillment.md +4 -3
  29. package/docs/ConfirmOrderFulfillmentWithShipment.md +3 -2
  30. package/docs/ConfirmOrderFulfillmentWithShippingMethod.md +3 -2
  31. package/docs/ConfirmOrderValidationError.md +2 -0
  32. package/docs/ContactInformation.md +2 -2
  33. package/docs/ContactInformation1.md +23 -0
  34. package/docs/CreateOrder.md +7 -7
  35. package/docs/CreateOrderItem.md +24 -0
  36. package/docs/CustomsInformation.md +4 -4
  37. package/docs/CustomsInformation1.md +5 -4
  38. package/docs/DeliveryEstimates.md +4 -3
  39. package/docs/Fulfiller.md +25 -0
  40. package/docs/FulfillerLocation.md +23 -0
  41. package/docs/Fulfillment.md +9 -8
  42. package/docs/FulfillmentItem.md +3 -3
  43. package/docs/Image.md +5 -5
  44. package/docs/Order.md +17 -16
  45. package/docs/OrderItem.md +10 -9
  46. package/docs/OrderTracking.md +4 -3
  47. package/docs/OrdersApi.md +31 -31
  48. package/docs/Origin.md +3 -2
  49. package/docs/PaymentAttempt.md +4 -5
  50. package/docs/PaymentMethod.md +2 -1
  51. package/docs/Price.md +3 -3
  52. package/docs/ProductUnavailableError.md +35 -0
  53. package/docs/RecipientCost.md +23 -0
  54. package/docs/Shipment.md +21 -0
  55. package/docs/ShippingMethod.md +8 -7
  56. package/docs/Status.md +1 -0
  57. package/docs/StockConflictError.md +34 -0
  58. package/docs/StockUnavailableError.md +35 -0
  59. package/index.ts +1 -1
  60. package/package.json +2 -2
@@ -0,0 +1,34 @@
1
+ # StockConflictError
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **code** | **string** | | [default to undefined]
9
+ **message** | **string** | Human-readable description including the product name. | [default to undefined]
10
+ **productTitle** | **string** | Display name of the product. | [default to undefined]
11
+ **variantId** | **string** | Unique object identifier | [default to undefined]
12
+ **variantRef** | **string** | A reference to the variant being ordered | [default to undefined]
13
+ **requestedQuantity** | **number** | The quantity that was requested in the order. | [default to undefined]
14
+ **availableQuantity** | **number** | Always 0 for this error type. | [default to undefined]
15
+ **shortage** | **number** | The full requested quantity, representing the total unfulfillable amount. | [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { StockConflictError } from '@teemill/orders';
21
+
22
+ const instance: StockConflictError = {
23
+ code,
24
+ message,
25
+ productTitle,
26
+ variantId,
27
+ variantRef,
28
+ requestedQuantity,
29
+ availableQuantity,
30
+ shortage,
31
+ };
32
+ ```
33
+
34
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,35 @@
1
+ # StockUnavailableError
2
+
3
+ The requested quantity exceeds available stock. The item can still be ordered in a smaller quantity.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **string** | | [default to undefined]
10
+ **message** | **string** | Human-readable description including the product name and available quantity. | [default to undefined]
11
+ **productTitle** | **string** | Display name of the product. | [default to undefined]
12
+ **variantId** | **string** | Unique object identifier | [default to undefined]
13
+ **variantRef** | **string** | A reference to the variant being ordered | [default to undefined]
14
+ **requestedQuantity** | **number** | The quantity that was requested in the order. | [default to undefined]
15
+ **availableQuantity** | **number** | The quantity currently available for fulfillment. | [default to undefined]
16
+ **shortage** | **number** | The difference between requested and available quantity (positive value indicating the deficit). | [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { StockUnavailableError } from '@teemill/orders';
22
+
23
+ const instance: StockUnavailableError = {
24
+ code,
25
+ message,
26
+ productTitle,
27
+ variantId,
28
+ variantRef,
29
+ requestedQuantity,
30
+ availableQuantity,
31
+ shortage,
32
+ };
33
+ ```
34
+
35
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Orders API
5
5
  * Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
6
6
  *
7
- * The version of the OpenAPI document: 1.24.0
7
+ * The version of the OpenAPI document: 1.25.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teemill/orders",
3
- "version": "1.24.0",
3
+ "version": "1.25.0",
4
4
  "description": "OpenAPI client for @teemill/orders",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -24,7 +24,7 @@
24
24
  "prepare": "npm run build"
25
25
  },
26
26
  "dependencies": {
27
- "axios": "1.12.2"
27
+ "axios": "1.13.5"
28
28
  },
29
29
  "devDependencies": {
30
30
  "@types/node": "12.11.5 - 12.20.42",