@epilot/pricing-client 3.9.0 → 3.9.2
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.
- package/dist/openapi.d.ts +32 -0
- package/dist/openapi.json +85 -223
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -174,6 +174,10 @@ declare namespace Components {
|
|
|
174
174
|
* The unit amount value
|
|
175
175
|
*/
|
|
176
176
|
unit_amount?: number;
|
|
177
|
+
/**
|
|
178
|
+
* The unit gross amount value.
|
|
179
|
+
*/
|
|
180
|
+
unit_amount_gross?: number;
|
|
177
181
|
/**
|
|
178
182
|
* Total before any (discounts or) taxes are applied.
|
|
179
183
|
*/
|
|
@@ -703,6 +707,10 @@ declare namespace Components {
|
|
|
703
707
|
* The unit amount value
|
|
704
708
|
*/
|
|
705
709
|
unit_amount?: number;
|
|
710
|
+
/**
|
|
711
|
+
* The unit gross amount value.
|
|
712
|
+
*/
|
|
713
|
+
unit_amount_gross?: number;
|
|
706
714
|
/**
|
|
707
715
|
* Total before any (discounts or) taxes are applied.
|
|
708
716
|
*/
|
|
@@ -1755,6 +1763,10 @@ declare namespace Components {
|
|
|
1755
1763
|
* The unit amount value
|
|
1756
1764
|
*/
|
|
1757
1765
|
unit_amount?: number;
|
|
1766
|
+
/**
|
|
1767
|
+
* The unit gross amount value.
|
|
1768
|
+
*/
|
|
1769
|
+
unit_amount_gross?: number;
|
|
1758
1770
|
/**
|
|
1759
1771
|
* Total before any (discounts or) taxes are applied.
|
|
1760
1772
|
*/
|
|
@@ -2015,6 +2027,10 @@ declare namespace Components {
|
|
|
2015
2027
|
* The unit amount value
|
|
2016
2028
|
*/
|
|
2017
2029
|
unit_amount?: number;
|
|
2030
|
+
/**
|
|
2031
|
+
* The unit gross amount value.
|
|
2032
|
+
*/
|
|
2033
|
+
unit_amount_gross?: number;
|
|
2018
2034
|
unit_amount_currency?: /**
|
|
2019
2035
|
* Three-letter ISO currency code, in lowercase. Must be a supported currency.
|
|
2020
2036
|
* ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
|
|
@@ -2271,6 +2287,10 @@ declare namespace Components {
|
|
|
2271
2287
|
* Total of all items after (discounts and) taxes are applied.
|
|
2272
2288
|
*/
|
|
2273
2289
|
amount_total?: number;
|
|
2290
|
+
/**
|
|
2291
|
+
* The unit gross amount value.
|
|
2292
|
+
*/
|
|
2293
|
+
unit_amount_gross?: number;
|
|
2274
2294
|
total_details?: /* The total details with tax (and discount) aggregated totals. */ TotalDetails;
|
|
2275
2295
|
}
|
|
2276
2296
|
/**
|
|
@@ -2384,6 +2404,10 @@ declare namespace Components {
|
|
|
2384
2404
|
* Total of all items, with same recurrence, after (discounts and) taxes are applied.
|
|
2385
2405
|
*/
|
|
2386
2406
|
amount_total: number;
|
|
2407
|
+
/**
|
|
2408
|
+
* The unit gross amount value.
|
|
2409
|
+
*/
|
|
2410
|
+
unit_amount_gross?: number;
|
|
2387
2411
|
/**
|
|
2388
2412
|
* Total of all items taxes, with same recurrence.
|
|
2389
2413
|
*/
|
|
@@ -2409,6 +2433,10 @@ declare namespace Components {
|
|
|
2409
2433
|
* Total of all items, with same recurrence, after (discounts and) taxes are applied.
|
|
2410
2434
|
*/
|
|
2411
2435
|
amount_total: number;
|
|
2436
|
+
/**
|
|
2437
|
+
* The unit gross amount value.
|
|
2438
|
+
*/
|
|
2439
|
+
unit_amount_gross?: number;
|
|
2412
2440
|
/**
|
|
2413
2441
|
* Total of all items taxes, with same recurrence.
|
|
2414
2442
|
*/
|
|
@@ -2595,6 +2623,10 @@ declare namespace Components {
|
|
|
2595
2623
|
* The error message
|
|
2596
2624
|
*/
|
|
2597
2625
|
msg: string;
|
|
2626
|
+
/**
|
|
2627
|
+
* Data related with the error
|
|
2628
|
+
*/
|
|
2629
|
+
data?: string;
|
|
2598
2630
|
}
|
|
2599
2631
|
/**
|
|
2600
2632
|
* The availability map file result payload
|
package/dist/openapi.json
CHANGED
|
@@ -66,24 +66,15 @@
|
|
|
66
66
|
"x-tagGroups": [
|
|
67
67
|
{
|
|
68
68
|
"name": "Commerce Schemas",
|
|
69
|
-
"tags": [
|
|
70
|
-
"order_schema",
|
|
71
|
-
"opportunity_schema"
|
|
72
|
-
]
|
|
69
|
+
"tags": ["order_schema", "opportunity_schema"]
|
|
73
70
|
},
|
|
74
71
|
{
|
|
75
72
|
"name": "Pricing Schemas",
|
|
76
|
-
"tags": [
|
|
77
|
-
"product_schema",
|
|
78
|
-
"simple_price_schema",
|
|
79
|
-
"dynamic_price_schema"
|
|
80
|
-
]
|
|
73
|
+
"tags": ["product_schema", "simple_price_schema", "dynamic_price_schema"]
|
|
81
74
|
},
|
|
82
75
|
{
|
|
83
76
|
"name": "Examples",
|
|
84
|
-
"tags": [
|
|
85
|
-
"order_composite_prices"
|
|
86
|
-
]
|
|
77
|
+
"tags": ["order_composite_prices"]
|
|
87
78
|
},
|
|
88
79
|
{
|
|
89
80
|
"name": "APIs",
|
|
@@ -115,9 +106,7 @@
|
|
|
115
106
|
"description": "Create an order",
|
|
116
107
|
"operationId": "createOrder",
|
|
117
108
|
"summary": "createOrder",
|
|
118
|
-
"tags": [
|
|
119
|
-
"Order API"
|
|
120
|
-
],
|
|
109
|
+
"tags": ["Order API"],
|
|
121
110
|
"requestBody": {
|
|
122
111
|
"required": true,
|
|
123
112
|
"content": {
|
|
@@ -183,9 +172,7 @@
|
|
|
183
172
|
"delivery_address": [],
|
|
184
173
|
"dates": [
|
|
185
174
|
{
|
|
186
|
-
"_tags": [
|
|
187
|
-
"Instalation Date"
|
|
188
|
-
],
|
|
175
|
+
"_tags": ["Instalation Date"],
|
|
189
176
|
"dates": "",
|
|
190
177
|
"value": "2022-06-30T16:29:00.000Z"
|
|
191
178
|
}
|
|
@@ -249,9 +236,7 @@
|
|
|
249
236
|
"delivery_address": [],
|
|
250
237
|
"dates": [
|
|
251
238
|
{
|
|
252
|
-
"_tags": [
|
|
253
|
-
"Instalation Date"
|
|
254
|
-
],
|
|
239
|
+
"_tags": ["Instalation Date"],
|
|
255
240
|
"dates": "",
|
|
256
241
|
"value": "2022-06-30T16:29:00.000Z"
|
|
257
242
|
}
|
|
@@ -324,9 +309,7 @@
|
|
|
324
309
|
"delivery_address": [],
|
|
325
310
|
"dates": [
|
|
326
311
|
{
|
|
327
|
-
"_tags": [
|
|
328
|
-
"Instalation Date"
|
|
329
|
-
],
|
|
312
|
+
"_tags": ["Instalation Date"],
|
|
330
313
|
"dates": "",
|
|
331
314
|
"value": "2022-06-30T16:29:00.000Z"
|
|
332
315
|
}
|
|
@@ -369,9 +352,7 @@
|
|
|
369
352
|
"description": "Update an existing Order",
|
|
370
353
|
"operationId": "putOrder",
|
|
371
354
|
"summary": "putOrder",
|
|
372
|
-
"tags": [
|
|
373
|
-
"Order API"
|
|
374
|
-
],
|
|
355
|
+
"tags": ["Order API"],
|
|
375
356
|
"parameters": [
|
|
376
357
|
{
|
|
377
358
|
"in": "path",
|
|
@@ -452,9 +433,7 @@
|
|
|
452
433
|
"delivery_address": [],
|
|
453
434
|
"dates": [
|
|
454
435
|
{
|
|
455
|
-
"_tags": [
|
|
456
|
-
"Instalation Date"
|
|
457
|
-
],
|
|
436
|
+
"_tags": ["Instalation Date"],
|
|
458
437
|
"dates": "",
|
|
459
438
|
"value": "2022-06-30T16:29:00.000Z"
|
|
460
439
|
}
|
|
@@ -495,9 +474,7 @@
|
|
|
495
474
|
"operationId": "$checkoutCart",
|
|
496
475
|
"summary": "checkoutCart",
|
|
497
476
|
"security": [],
|
|
498
|
-
"tags": [
|
|
499
|
-
"Cart API"
|
|
500
|
-
],
|
|
477
|
+
"tags": ["Cart API"],
|
|
501
478
|
"parameters": [
|
|
502
479
|
{
|
|
503
480
|
"in": "header",
|
|
@@ -559,9 +536,7 @@
|
|
|
559
536
|
"operationId": "$searchCatalog",
|
|
560
537
|
"summary": "searchCatalog",
|
|
561
538
|
"security": [],
|
|
562
|
-
"tags": [
|
|
563
|
-
"Catalog API"
|
|
564
|
-
],
|
|
539
|
+
"tags": ["Catalog API"],
|
|
565
540
|
"parameters": [
|
|
566
541
|
{
|
|
567
542
|
"in": "header",
|
|
@@ -613,9 +588,7 @@
|
|
|
613
588
|
"operationId": "$availabilityCheck",
|
|
614
589
|
"summary": "availabilityCheck",
|
|
615
590
|
"security": [],
|
|
616
|
-
"tags": [
|
|
617
|
-
"Availability API"
|
|
618
|
-
],
|
|
591
|
+
"tags": ["Availability API"],
|
|
619
592
|
"parameters": [
|
|
620
593
|
{
|
|
621
594
|
"in": "header",
|
|
@@ -637,9 +610,7 @@
|
|
|
637
610
|
"examples": {
|
|
638
611
|
"Check availability with location dimension": {
|
|
639
612
|
"value": {
|
|
640
|
-
"products": [
|
|
641
|
-
"cd75456a-30e4-4912-95be-e743d5ea175b"
|
|
642
|
-
],
|
|
613
|
+
"products": ["cd75456a-30e4-4912-95be-e743d5ea175b"],
|
|
643
614
|
"filters": {
|
|
644
615
|
"location": {
|
|
645
616
|
"postal_code": "57008",
|
|
@@ -652,9 +623,7 @@
|
|
|
652
623
|
},
|
|
653
624
|
"Check availability with location & available date dimension": {
|
|
654
625
|
"value": {
|
|
655
|
-
"products": [
|
|
656
|
-
"cd75456a-30e4-4912-95be-e743d5ea175b"
|
|
657
|
-
],
|
|
626
|
+
"products": ["cd75456a-30e4-4912-95be-e743d5ea175b"],
|
|
658
627
|
"filters": {
|
|
659
628
|
"location": {
|
|
660
629
|
"postal_code": "57008",
|
|
@@ -699,9 +668,7 @@
|
|
|
699
668
|
},
|
|
700
669
|
"Response with available and unavailable products": {
|
|
701
670
|
"value": {
|
|
702
|
-
"availableProducts": [
|
|
703
|
-
"my-product-id-123-2"
|
|
704
|
-
],
|
|
671
|
+
"availableProducts": ["my-product-id-123-2"],
|
|
705
672
|
"checkResults": [
|
|
706
673
|
{
|
|
707
674
|
"productId": "my-product-id-123-1",
|
|
@@ -738,9 +705,7 @@
|
|
|
738
705
|
"description": "Validates an availability file, it returns an array of errors if the file is invalid",
|
|
739
706
|
"operationId": "$validateAvailabilityFile",
|
|
740
707
|
"summary": "validateAvailabilityFile",
|
|
741
|
-
"tags": [
|
|
742
|
-
"Availability API"
|
|
743
|
-
],
|
|
708
|
+
"tags": ["Availability API"],
|
|
744
709
|
"parameters": [
|
|
745
710
|
{
|
|
746
711
|
"in": "path",
|
|
@@ -811,9 +776,7 @@
|
|
|
811
776
|
"operationId": "$createOpportunity",
|
|
812
777
|
"summary": "createOpportunity",
|
|
813
778
|
"security": [],
|
|
814
|
-
"tags": [
|
|
815
|
-
"Deprecated"
|
|
816
|
-
],
|
|
779
|
+
"tags": ["Deprecated"],
|
|
817
780
|
"parameters": [
|
|
818
781
|
{
|
|
819
782
|
"in": "header",
|
|
@@ -855,16 +818,11 @@
|
|
|
855
818
|
"$relation": [
|
|
856
819
|
{
|
|
857
820
|
"entity_id": "c8dbe8f3-28b6-4d77-aae8-47bc24a2532f",
|
|
858
|
-
"_tags": [
|
|
859
|
-
"journey"
|
|
860
|
-
]
|
|
821
|
+
"_tags": ["journey"]
|
|
861
822
|
}
|
|
862
823
|
]
|
|
863
824
|
},
|
|
864
|
-
"_tags": [
|
|
865
|
-
"journey",
|
|
866
|
-
"ORWNr4iCN"
|
|
867
|
-
]
|
|
825
|
+
"_tags": ["journey", "ORWNr4iCN"]
|
|
868
826
|
}
|
|
869
827
|
}
|
|
870
828
|
}
|
|
@@ -906,9 +864,7 @@
|
|
|
906
864
|
},
|
|
907
865
|
"schemas": {
|
|
908
866
|
"Error": {
|
|
909
|
-
"required": [
|
|
910
|
-
"message"
|
|
911
|
-
],
|
|
867
|
+
"required": ["message"],
|
|
912
868
|
"properties": {
|
|
913
869
|
"message": {
|
|
914
870
|
"type": "string",
|
|
@@ -944,10 +900,7 @@
|
|
|
944
900
|
"type": {
|
|
945
901
|
"type": "string",
|
|
946
902
|
"description": "The type of Product:\n\n| type | description |\n|----| ----|\n| `product` | Represents a physical good |\n| `service` | Represents a service or virtual product |\n",
|
|
947
|
-
"enum": [
|
|
948
|
-
"product",
|
|
949
|
-
"service"
|
|
950
|
-
]
|
|
903
|
+
"enum": ["product", "service"]
|
|
951
904
|
},
|
|
952
905
|
"name": {
|
|
953
906
|
"type": "string",
|
|
@@ -1544,10 +1497,7 @@
|
|
|
1544
1497
|
"type": {
|
|
1545
1498
|
"type": "string",
|
|
1546
1499
|
"description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.",
|
|
1547
|
-
"enum": [
|
|
1548
|
-
"one_time",
|
|
1549
|
-
"recurring"
|
|
1550
|
-
]
|
|
1500
|
+
"enum": ["one_time", "recurring"]
|
|
1551
1501
|
},
|
|
1552
1502
|
"billing_period": {
|
|
1553
1503
|
"description": "For recurring prices `billing_period` defines the default extent of the recurrence.",
|
|
@@ -1589,11 +1539,7 @@
|
|
|
1589
1539
|
"billing_duration_unit": {
|
|
1590
1540
|
"description": "The billing period duration unit",
|
|
1591
1541
|
"type": "string",
|
|
1592
|
-
"enum": [
|
|
1593
|
-
"weeks",
|
|
1594
|
-
"months",
|
|
1595
|
-
"years"
|
|
1596
|
-
]
|
|
1542
|
+
"enum": ["weeks", "months", "years"]
|
|
1597
1543
|
},
|
|
1598
1544
|
"notice_time_amount": {
|
|
1599
1545
|
"description": "The notice period duration",
|
|
@@ -1602,11 +1548,7 @@
|
|
|
1602
1548
|
"notice_time_unit": {
|
|
1603
1549
|
"description": "The notice period duration unit",
|
|
1604
1550
|
"type": "string",
|
|
1605
|
-
"enum": [
|
|
1606
|
-
"weeks",
|
|
1607
|
-
"months",
|
|
1608
|
-
"years"
|
|
1609
|
-
]
|
|
1551
|
+
"enum": ["weeks", "months", "years"]
|
|
1610
1552
|
},
|
|
1611
1553
|
"termination_time_amount": {
|
|
1612
1554
|
"description": "The termination period duration",
|
|
@@ -1615,11 +1557,7 @@
|
|
|
1615
1557
|
"termination_time_unit": {
|
|
1616
1558
|
"description": "The termination period duration unit",
|
|
1617
1559
|
"type": "string",
|
|
1618
|
-
"enum": [
|
|
1619
|
-
"weeks",
|
|
1620
|
-
"months",
|
|
1621
|
-
"years"
|
|
1622
|
-
]
|
|
1560
|
+
"enum": ["weeks", "months", "years"]
|
|
1623
1561
|
},
|
|
1624
1562
|
"renewal_duration_amount": {
|
|
1625
1563
|
"description": "The renewal period duration",
|
|
@@ -1628,11 +1566,7 @@
|
|
|
1628
1566
|
"renewal_duration_unit": {
|
|
1629
1567
|
"description": "The renewal period duration unit",
|
|
1630
1568
|
"type": "string",
|
|
1631
|
-
"enum": [
|
|
1632
|
-
"weeks",
|
|
1633
|
-
"months",
|
|
1634
|
-
"years"
|
|
1635
|
-
]
|
|
1569
|
+
"enum": ["weeks", "months", "years"]
|
|
1636
1570
|
},
|
|
1637
1571
|
"variable_price": {
|
|
1638
1572
|
"description": "The flag for prices that can be influenced by external variables such as user input.",
|
|
@@ -1694,9 +1628,7 @@
|
|
|
1694
1628
|
}
|
|
1695
1629
|
}
|
|
1696
1630
|
},
|
|
1697
|
-
"required": [
|
|
1698
|
-
"pricing_model"
|
|
1699
|
-
]
|
|
1631
|
+
"required": ["pricing_model"]
|
|
1700
1632
|
},
|
|
1701
1633
|
"CompositePrice": {
|
|
1702
1634
|
"type": "object",
|
|
@@ -1925,9 +1857,7 @@
|
|
|
1925
1857
|
}
|
|
1926
1858
|
}
|
|
1927
1859
|
},
|
|
1928
|
-
"required": [
|
|
1929
|
-
"q"
|
|
1930
|
-
]
|
|
1860
|
+
"required": ["q"]
|
|
1931
1861
|
},
|
|
1932
1862
|
"CatalogSearchResult": {
|
|
1933
1863
|
"description": "The query result payload",
|
|
@@ -1981,10 +1911,7 @@
|
|
|
1981
1911
|
"$ref": "#/components/schemas/AvailabilityFilters"
|
|
1982
1912
|
}
|
|
1983
1913
|
},
|
|
1984
|
-
"required": [
|
|
1985
|
-
"products",
|
|
1986
|
-
"filters"
|
|
1987
|
-
]
|
|
1914
|
+
"required": ["products", "filters"]
|
|
1988
1915
|
},
|
|
1989
1916
|
"AvailabilityResult": {
|
|
1990
1917
|
"description": "The availability check result payload",
|
|
@@ -2016,15 +1943,11 @@
|
|
|
2016
1943
|
"additionalProperties": true
|
|
2017
1944
|
}
|
|
2018
1945
|
},
|
|
2019
|
-
"required": [
|
|
2020
|
-
"product_id"
|
|
2021
|
-
]
|
|
1946
|
+
"required": ["product_id"]
|
|
2022
1947
|
}
|
|
2023
1948
|
}
|
|
2024
1949
|
},
|
|
2025
|
-
"required": [
|
|
2026
|
-
"available_products"
|
|
2027
|
-
],
|
|
1950
|
+
"required": ["available_products"],
|
|
2028
1951
|
"example": {
|
|
2029
1952
|
"available_products": [],
|
|
2030
1953
|
"check_results": [
|
|
@@ -2050,11 +1973,13 @@
|
|
|
2050
1973
|
"msg": {
|
|
2051
1974
|
"description": "The error message",
|
|
2052
1975
|
"type": "string"
|
|
1976
|
+
},
|
|
1977
|
+
"data": {
|
|
1978
|
+
"description": "Data related with the error",
|
|
1979
|
+
"type": "string"
|
|
2053
1980
|
}
|
|
2054
1981
|
},
|
|
2055
|
-
"required": [
|
|
2056
|
-
"msg"
|
|
2057
|
-
]
|
|
1982
|
+
"required": ["msg"]
|
|
2058
1983
|
},
|
|
2059
1984
|
"ValidateAvailabilityFileResult": {
|
|
2060
1985
|
"description": "The availability map file result payload",
|
|
@@ -2063,10 +1988,7 @@
|
|
|
2063
1988
|
"status": {
|
|
2064
1989
|
"description": "The status of the validation",
|
|
2065
1990
|
"type": "string",
|
|
2066
|
-
"enum": [
|
|
2067
|
-
"success",
|
|
2068
|
-
"error"
|
|
2069
|
-
]
|
|
1991
|
+
"enum": ["success", "error"]
|
|
2070
1992
|
},
|
|
2071
1993
|
"rules_parsed_count": {
|
|
2072
1994
|
"description": "The number of rules successfully parsed",
|
|
@@ -2080,11 +2002,7 @@
|
|
|
2080
2002
|
}
|
|
2081
2003
|
}
|
|
2082
2004
|
},
|
|
2083
|
-
"required": [
|
|
2084
|
-
"status",
|
|
2085
|
-
"rules_parsed_count",
|
|
2086
|
-
"errors"
|
|
2087
|
-
],
|
|
2005
|
+
"required": ["status", "rules_parsed_count", "errors"],
|
|
2088
2006
|
"example": {
|
|
2089
2007
|
"rules_parsed_count": 8,
|
|
2090
2008
|
"errors": [
|
|
@@ -2160,9 +2078,7 @@
|
|
|
2160
2078
|
"additionalProperties": true
|
|
2161
2079
|
}
|
|
2162
2080
|
},
|
|
2163
|
-
"required": [
|
|
2164
|
-
"line_items"
|
|
2165
|
-
]
|
|
2081
|
+
"required": ["line_items"]
|
|
2166
2082
|
},
|
|
2167
2083
|
"CheckoutCart": {
|
|
2168
2084
|
"type": "object",
|
|
@@ -2196,21 +2112,11 @@
|
|
|
2196
2112
|
"CheckoutMode": {
|
|
2197
2113
|
"type": "string",
|
|
2198
2114
|
"description": "The checkout mode for the cart checkout.",
|
|
2199
|
-
"enum": [
|
|
2200
|
-
"create_order",
|
|
2201
|
-
"create_invoice",
|
|
2202
|
-
"create_quote"
|
|
2203
|
-
]
|
|
2115
|
+
"enum": ["create_order", "create_invoice", "create_quote"]
|
|
2204
2116
|
},
|
|
2205
2117
|
"OrderStatus": {
|
|
2206
2118
|
"type": "string",
|
|
2207
|
-
"enum": [
|
|
2208
|
-
"draft",
|
|
2209
|
-
"quote",
|
|
2210
|
-
"placed",
|
|
2211
|
-
"cancelled",
|
|
2212
|
-
"completed"
|
|
2213
|
-
],
|
|
2119
|
+
"enum": ["draft", "quote", "placed", "cancelled", "completed"],
|
|
2214
2120
|
"description": "\n| status | description |\n|-------------|-------|\n| `draft` | Starting state for all orders, at this point we can still edit the order |\n| `quote` | The order is in a quoting phase, bound to an expiration date |\n| `placed` | The order has been paid and can now be fulfilled (shipped, delivered, complete) or canceled |\n| `cancelled` | The order has been cancelled |\n| `completed` | The order is now closed and finalized |\n"
|
|
2215
2121
|
},
|
|
2216
2122
|
"PriceItemsDto": {
|
|
@@ -2304,15 +2210,16 @@
|
|
|
2304
2210
|
"type": {
|
|
2305
2211
|
"type": "string",
|
|
2306
2212
|
"description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.",
|
|
2307
|
-
"enum": [
|
|
2308
|
-
"one_time",
|
|
2309
|
-
"recurring"
|
|
2310
|
-
]
|
|
2213
|
+
"enum": ["one_time", "recurring"]
|
|
2311
2214
|
},
|
|
2312
2215
|
"unit_amount": {
|
|
2313
2216
|
"type": "integer",
|
|
2314
2217
|
"description": "The unit amount value"
|
|
2315
2218
|
},
|
|
2219
|
+
"unit_amount_gross": {
|
|
2220
|
+
"type": "integer",
|
|
2221
|
+
"description": "The unit gross amount value."
|
|
2222
|
+
},
|
|
2316
2223
|
"unit_amount_currency": {
|
|
2317
2224
|
"$ref": "#/components/schemas/Currency"
|
|
2318
2225
|
},
|
|
@@ -2339,9 +2246,7 @@
|
|
|
2339
2246
|
]
|
|
2340
2247
|
}
|
|
2341
2248
|
},
|
|
2342
|
-
"required": [
|
|
2343
|
-
"pricing_model"
|
|
2344
|
-
]
|
|
2249
|
+
"required": ["pricing_model"]
|
|
2345
2250
|
},
|
|
2346
2251
|
"CompositePriceItemDto": {
|
|
2347
2252
|
"allOf": [
|
|
@@ -2430,15 +2335,16 @@
|
|
|
2430
2335
|
"type": "integer",
|
|
2431
2336
|
"description": "Total of all items, with same recurrence, after (discounts and) taxes are applied."
|
|
2432
2337
|
},
|
|
2338
|
+
"unit_amount_gross": {
|
|
2339
|
+
"type": "integer",
|
|
2340
|
+
"description": "The unit gross amount value."
|
|
2341
|
+
},
|
|
2433
2342
|
"amount_tax": {
|
|
2434
2343
|
"type": "integer",
|
|
2435
2344
|
"description": "Total of all items taxes, with same recurrence."
|
|
2436
2345
|
}
|
|
2437
2346
|
},
|
|
2438
|
-
"required": [
|
|
2439
|
-
"amount_subtotal",
|
|
2440
|
-
"amount_total"
|
|
2441
|
-
]
|
|
2347
|
+
"required": ["amount_subtotal", "amount_total"]
|
|
2442
2348
|
},
|
|
2443
2349
|
"Cart": {
|
|
2444
2350
|
"description": "Supports shopping for products and services until ready for checkout.",
|
|
@@ -2453,11 +2359,7 @@
|
|
|
2453
2359
|
"readOnly": true
|
|
2454
2360
|
},
|
|
2455
2361
|
"status": {
|
|
2456
|
-
"enum": [
|
|
2457
|
-
"open",
|
|
2458
|
-
"complete",
|
|
2459
|
-
"expired"
|
|
2460
|
-
],
|
|
2362
|
+
"enum": ["open", "complete", "expired"],
|
|
2461
2363
|
"type": "string",
|
|
2462
2364
|
"readOnly": true,
|
|
2463
2365
|
"description": "The status of the Cart:\n- open - the cart checkout is still in progress. Payment processing has not started\n- complete - the cart checkout is complete. Payment processing may still be in progress\n- expired - the cart checkout has expired. No further processing will occur\n"
|
|
@@ -2647,6 +2549,11 @@
|
|
|
2647
2549
|
"description": "The unit amount value",
|
|
2648
2550
|
"readOnly": true
|
|
2649
2551
|
},
|
|
2552
|
+
"unit_amount_gross": {
|
|
2553
|
+
"type": "integer",
|
|
2554
|
+
"description": "The unit gross amount value.",
|
|
2555
|
+
"readOnly": true
|
|
2556
|
+
},
|
|
2650
2557
|
"amount_subtotal": {
|
|
2651
2558
|
"type": "integer",
|
|
2652
2559
|
"description": "Total before any (discounts or) taxes are applied.",
|
|
@@ -2752,10 +2659,7 @@
|
|
|
2752
2659
|
"type": {
|
|
2753
2660
|
"type": "string",
|
|
2754
2661
|
"description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.",
|
|
2755
|
-
"enum": [
|
|
2756
|
-
"one_time",
|
|
2757
|
-
"recurring"
|
|
2758
|
-
]
|
|
2662
|
+
"enum": ["one_time", "recurring"]
|
|
2759
2663
|
},
|
|
2760
2664
|
"pricing_model": {
|
|
2761
2665
|
"type": "string",
|
|
@@ -2768,9 +2672,7 @@
|
|
|
2768
2672
|
]
|
|
2769
2673
|
}
|
|
2770
2674
|
},
|
|
2771
|
-
"required": [
|
|
2772
|
-
"pricing_model"
|
|
2773
|
-
]
|
|
2675
|
+
"required": ["pricing_model"]
|
|
2774
2676
|
},
|
|
2775
2677
|
"TaxAmount": {
|
|
2776
2678
|
"type": "object",
|
|
@@ -2847,15 +2749,16 @@
|
|
|
2847
2749
|
"type": "integer",
|
|
2848
2750
|
"description": "Total of all items, with same recurrence, after (discounts and) taxes are applied."
|
|
2849
2751
|
},
|
|
2752
|
+
"unit_amount_gross": {
|
|
2753
|
+
"type": "integer",
|
|
2754
|
+
"description": "The unit gross amount value."
|
|
2755
|
+
},
|
|
2850
2756
|
"amount_tax": {
|
|
2851
2757
|
"type": "integer",
|
|
2852
2758
|
"description": "Total of all items taxes, with same recurrence."
|
|
2853
2759
|
}
|
|
2854
2760
|
},
|
|
2855
|
-
"required": [
|
|
2856
|
-
"amount_subtotal",
|
|
2857
|
-
"amount_total"
|
|
2858
|
-
]
|
|
2761
|
+
"required": ["amount_subtotal", "amount_total"]
|
|
2859
2762
|
},
|
|
2860
2763
|
"TotalDetails": {
|
|
2861
2764
|
"type": "object",
|
|
@@ -2925,6 +2828,10 @@
|
|
|
2925
2828
|
"type": "integer",
|
|
2926
2829
|
"description": "Total of all items after (discounts and) taxes are applied."
|
|
2927
2830
|
},
|
|
2831
|
+
"unit_amount_gross": {
|
|
2832
|
+
"type": "integer",
|
|
2833
|
+
"description": "The unit gross amount value."
|
|
2834
|
+
},
|
|
2928
2835
|
"total_details": {
|
|
2929
2836
|
"$ref": "#/components/schemas/TotalDetails"
|
|
2930
2837
|
}
|
|
@@ -2943,11 +2850,7 @@
|
|
|
2943
2850
|
},
|
|
2944
2851
|
"SalesTax": {
|
|
2945
2852
|
"type": "string",
|
|
2946
|
-
"enum": [
|
|
2947
|
-
"nontaxable",
|
|
2948
|
-
"reduced",
|
|
2949
|
-
"standard"
|
|
2950
|
-
]
|
|
2853
|
+
"enum": ["nontaxable", "reduced", "standard"]
|
|
2951
2854
|
},
|
|
2952
2855
|
"AvailabilityLocation": {
|
|
2953
2856
|
"type": "object",
|
|
@@ -3005,9 +2908,7 @@
|
|
|
3005
2908
|
"description": "A value to be matched against the availability window (start & end date)"
|
|
3006
2909
|
}
|
|
3007
2910
|
},
|
|
3008
|
-
"required": [
|
|
3009
|
-
"location"
|
|
3010
|
-
]
|
|
2911
|
+
"required": ["location"]
|
|
3011
2912
|
},
|
|
3012
2913
|
"Address": {
|
|
3013
2914
|
"type": "object",
|
|
@@ -3018,9 +2919,7 @@
|
|
|
3018
2919
|
"items": {
|
|
3019
2920
|
"type": "string"
|
|
3020
2921
|
},
|
|
3021
|
-
"example": [
|
|
3022
|
-
"billing"
|
|
3023
|
-
]
|
|
2922
|
+
"example": ["billing"]
|
|
3024
2923
|
},
|
|
3025
2924
|
"street": {
|
|
3026
2925
|
"type": "string",
|
|
@@ -3147,15 +3046,10 @@
|
|
|
3147
3046
|
"type": "string"
|
|
3148
3047
|
}
|
|
3149
3048
|
},
|
|
3150
|
-
"required": [
|
|
3151
|
-
"bucket",
|
|
3152
|
-
"key"
|
|
3153
|
-
]
|
|
3049
|
+
"required": ["bucket", "key"]
|
|
3154
3050
|
}
|
|
3155
3051
|
},
|
|
3156
|
-
"required": [
|
|
3157
|
-
"s3ref"
|
|
3158
|
-
]
|
|
3052
|
+
"required": ["s3ref"]
|
|
3159
3053
|
}
|
|
3160
3054
|
},
|
|
3161
3055
|
"_schema": {
|
|
@@ -3238,10 +3132,7 @@
|
|
|
3238
3132
|
"_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
3239
3133
|
"_org": "123",
|
|
3240
3134
|
"_schema": "contact",
|
|
3241
|
-
"_tags": [
|
|
3242
|
-
"example",
|
|
3243
|
-
"mock"
|
|
3244
|
-
],
|
|
3135
|
+
"_tags": ["example", "mock"],
|
|
3245
3136
|
"_created_at": "2021-02-09T12:41:43.662Z",
|
|
3246
3137
|
"_updated_at": "2021-02-09T12:41:43.662Z"
|
|
3247
3138
|
}
|
|
@@ -3306,11 +3197,7 @@
|
|
|
3306
3197
|
},
|
|
3307
3198
|
"type": {
|
|
3308
3199
|
"type": "string",
|
|
3309
|
-
"enum": [
|
|
3310
|
-
"VAT",
|
|
3311
|
-
"GST",
|
|
3312
|
-
"Custom"
|
|
3313
|
-
]
|
|
3200
|
+
"enum": ["VAT", "GST", "Custom"]
|
|
3314
3201
|
},
|
|
3315
3202
|
"description": {
|
|
3316
3203
|
"type": "string"
|
|
@@ -3337,10 +3224,7 @@
|
|
|
3337
3224
|
"region_label": "Germany",
|
|
3338
3225
|
"_org": "123",
|
|
3339
3226
|
"_schema": "tax",
|
|
3340
|
-
"_tags": [
|
|
3341
|
-
"example",
|
|
3342
|
-
"mock"
|
|
3343
|
-
],
|
|
3227
|
+
"_tags": ["example", "mock"],
|
|
3344
3228
|
"_created_at": "2021-02-09T12:41:43.662Z",
|
|
3345
3229
|
"_updated_at": "2021-02-09T12:41:43.662Z"
|
|
3346
3230
|
}
|
|
@@ -3353,11 +3237,7 @@
|
|
|
3353
3237
|
},
|
|
3354
3238
|
"type": {
|
|
3355
3239
|
"type": "string",
|
|
3356
|
-
"enum": [
|
|
3357
|
-
"VAT",
|
|
3358
|
-
"GST",
|
|
3359
|
-
"Custom"
|
|
3360
|
-
]
|
|
3240
|
+
"enum": ["VAT", "GST", "Custom"]
|
|
3361
3241
|
},
|
|
3362
3242
|
"_id": {
|
|
3363
3243
|
"type": "string"
|
|
@@ -3390,10 +3270,7 @@
|
|
|
3390
3270
|
},
|
|
3391
3271
|
"PriceTierDisplayMode": {
|
|
3392
3272
|
"type": "string",
|
|
3393
|
-
"enum": [
|
|
3394
|
-
"hidden",
|
|
3395
|
-
"on_request"
|
|
3396
|
-
]
|
|
3273
|
+
"enum": ["hidden", "on_request"]
|
|
3397
3274
|
}
|
|
3398
3275
|
},
|
|
3399
3276
|
"examples": {
|
|
@@ -3870,14 +3747,8 @@
|
|
|
3870
3747
|
"_id": "065d6618-cc59-45f4-8e3a-700edf6813c3",
|
|
3871
3748
|
"name": "Smartmeter: Schneider Electric PM5000 LCD Energiemessgerät / 3-phasig",
|
|
3872
3749
|
"code": "1312378123",
|
|
3873
|
-
"_tags": [
|
|
3874
|
-
|
|
3875
|
-
"review demo",
|
|
3876
|
-
"1"
|
|
3877
|
-
],
|
|
3878
|
-
"categories": [
|
|
3879
|
-
"Power"
|
|
3880
|
-
],
|
|
3750
|
+
"_tags": ["wallbox", "review demo", "1"],
|
|
3751
|
+
"categories": ["Power"],
|
|
3881
3752
|
"type": "product",
|
|
3882
3753
|
"active": true,
|
|
3883
3754
|
"feature": [
|
|
@@ -4083,9 +3954,7 @@
|
|
|
4083
3954
|
"delivery_address": [],
|
|
4084
3955
|
"dates": [
|
|
4085
3956
|
{
|
|
4086
|
-
"_tags": [
|
|
4087
|
-
"Instalation Date"
|
|
4088
|
-
],
|
|
3957
|
+
"_tags": ["Instalation Date"],
|
|
4089
3958
|
"dates": "",
|
|
4090
3959
|
"value": "2022-06-30T16:29:00.000Z"
|
|
4091
3960
|
}
|
|
@@ -4163,9 +4032,7 @@
|
|
|
4163
4032
|
"delivery_address": [],
|
|
4164
4033
|
"dates": [
|
|
4165
4034
|
{
|
|
4166
|
-
"_tags": [
|
|
4167
|
-
"Instalation Date"
|
|
4168
|
-
],
|
|
4035
|
+
"_tags": ["Instalation Date"],
|
|
4169
4036
|
"dates": "",
|
|
4170
4037
|
"value": "2022-06-30T16:29:00.000Z"
|
|
4171
4038
|
}
|
|
@@ -4184,10 +4051,7 @@
|
|
|
4184
4051
|
"value": "journey checkout"
|
|
4185
4052
|
}
|
|
4186
4053
|
],
|
|
4187
|
-
"_tags": [
|
|
4188
|
-
"journey",
|
|
4189
|
-
"automation"
|
|
4190
|
-
],
|
|
4054
|
+
"_tags": ["journey", "automation"],
|
|
4191
4055
|
"status": "quote",
|
|
4192
4056
|
"order_number": "OREabZxnO",
|
|
4193
4057
|
"billing_first_name": "Paulo",
|
|
@@ -4594,9 +4458,7 @@
|
|
|
4594
4458
|
},
|
|
4595
4459
|
"dates": [
|
|
4596
4460
|
{
|
|
4597
|
-
"_tags": [
|
|
4598
|
-
"Installation Date"
|
|
4599
|
-
],
|
|
4461
|
+
"_tags": ["Installation Date"],
|
|
4600
4462
|
"dates": "",
|
|
4601
4463
|
"value": "2022-06-30T15:21:00.000Z"
|
|
4602
4464
|
}
|