@epilot/pricing-client 1.11.0 → 1.12.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 CHANGED
@@ -11,6 +11,13 @@ declare namespace Components {
11
11
  namespace Schemas {
12
12
  export interface Address {
13
13
  [name: string]: any;
14
+ /**
15
+ * example:
16
+ * [
17
+ * "billing"
18
+ * ]
19
+ */
20
+ _tags?: string[];
14
21
  /**
15
22
  * The first line of the address. Typically the street address or PO Box number.
16
23
  */
@@ -298,6 +305,8 @@ declare namespace Components {
298
305
  * Three-letter ISO currency code, in lowercase. Must be a supported currency.
299
306
  * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
300
307
  *
308
+ * example:
309
+ * EUR
301
310
  */
302
311
  export type Currency = string;
303
312
  export interface Customer {
@@ -427,6 +436,19 @@ declare namespace Components {
427
436
  */
428
437
  cart_id?: string;
429
438
  status?: /* The order status */ OrderStatus;
439
+ /**
440
+ * type of source, e.g. journey or manual
441
+ * example:
442
+ * journey
443
+ */
444
+ source_type?: string;
445
+ /**
446
+ * identifier for source e.g. journey ID
447
+ * example:
448
+ * ce99875f-fba9-4fe2-a8f9-afaf52059051
449
+ */
450
+ source_id?: string;
451
+ source?: /* Order Source */ OrderSource;
430
452
  metadata?: /* A set of key-value pairs. */ MetaData;
431
453
  billing_first_name?: string;
432
454
  billing_last_name?: string;
@@ -439,6 +461,8 @@ declare namespace Components {
439
461
  * Three-letter ISO currency code, in lowercase. Must be a supported currency.
440
462
  * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
441
463
  *
464
+ * example:
465
+ * EUR
442
466
  */
443
467
  Currency;
444
468
  delivery_address?: Address[];
@@ -470,6 +494,45 @@ declare namespace Components {
470
494
  _updated_at?: string;
471
495
  _tags?: string[];
472
496
  }
497
+ /**
498
+ * Order Entity Payload
499
+ */
500
+ export interface OrderPayload {
501
+ status?: /* The order status */ OrderStatus;
502
+ line_items?: /* Tracks a set of product prices, quantities, (discounts) and taxes. */ PriceItems;
503
+ /**
504
+ * type of source, e.g. journey or manual
505
+ * example:
506
+ * journey
507
+ */
508
+ source_type?: string;
509
+ currency?: /**
510
+ * Three-letter ISO currency code, in lowercase. Must be a supported currency.
511
+ * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
512
+ *
513
+ * example:
514
+ * EUR
515
+ */
516
+ Currency;
517
+ /**
518
+ * The id of an existing contact.
519
+ */
520
+ contact?: string;
521
+ billing_first_name?: string;
522
+ billing_last_name?: string;
523
+ billing_company_name?: string;
524
+ billing_vat?: string;
525
+ billing_email?: string;
526
+ billing_phone?: string;
527
+ billing_address?: Address[];
528
+ delivery_address?: Address[];
529
+ payment_method?: /**
530
+ * A PaymentMethod represent your customer's payment instruments.
531
+ *
532
+ */
533
+ PaymentMethod[];
534
+ _tags?: string[];
535
+ }
473
536
  /**
474
537
  * An order relation reference
475
538
  */
@@ -536,6 +599,8 @@ declare namespace Components {
536
599
  * Three-letter ISO currency code, in lowercase. Must be a supported currency.
537
600
  * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
538
601
  *
602
+ * example:
603
+ * EUR
539
604
  */
540
605
  Currency;
541
606
  billing_duration_amount?: number;
@@ -568,6 +633,10 @@ declare namespace Components {
568
633
  * Total before any (discounts or) taxes are applied.
569
634
  */
570
635
  amount_subtotal?: number;
636
+ /**
637
+ * Total net unit amount without taxes.
638
+ */
639
+ unit_amount_net?: number;
571
640
  /**
572
641
  * Total after (discounts and) taxes.
573
642
  */
@@ -576,6 +645,8 @@ declare namespace Components {
576
645
  * Three-letter ISO currency code, in lowercase. Must be a supported currency.
577
646
  * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
578
647
  *
648
+ * example:
649
+ * EUR
579
650
  */
580
651
  Currency;
581
652
  /**
@@ -905,9 +976,49 @@ declare namespace Paths {
905
976
  export type $400 = Components.Schemas.Error;
906
977
  }
907
978
  }
979
+ namespace CreateOrder {
980
+ export type RequestBody = /* Order Entity Payload */ Components.Schemas.OrderPayload;
981
+ namespace Responses {
982
+ export type $201 = /* The order entity */ Components.Schemas.Order;
983
+ export type $400 = Components.Schemas.Error;
984
+ }
985
+ }
986
+ namespace PutOrder {
987
+ namespace Parameters {
988
+ export type Id = string;
989
+ }
990
+ export interface PathParameters {
991
+ id: Parameters.Id;
992
+ }
993
+ export type RequestBody = /* Order Entity Payload */ Components.Schemas.OrderPayload;
994
+ namespace Responses {
995
+ export type $200 = /* The order entity */ Components.Schemas.Order;
996
+ export type $400 = Components.Schemas.Error;
997
+ }
998
+ }
908
999
  }
909
1000
 
910
1001
  export interface OperationMethods {
1002
+ /**
1003
+ * createOrder - createOrder
1004
+ *
1005
+ * Create an order
1006
+ */
1007
+ 'createOrder'(
1008
+ parameters?: Parameters<UnknownParamsObject> | null,
1009
+ data?: Paths.CreateOrder.RequestBody,
1010
+ config?: AxiosRequestConfig
1011
+ ): OperationResponse<Paths.CreateOrder.Responses.$201>
1012
+ /**
1013
+ * putOrder - putOrder
1014
+ *
1015
+ * Update an existing Order
1016
+ */
1017
+ 'putOrder'(
1018
+ parameters?: Parameters<Paths.PutOrder.PathParameters> | null,
1019
+ data?: Paths.PutOrder.RequestBody,
1020
+ config?: AxiosRequestConfig
1021
+ ): OperationResponse<Paths.PutOrder.Responses.$200>
911
1022
  /**
912
1023
  * $checkoutCart - checkoutCart
913
1024
  *
@@ -952,7 +1063,7 @@ export interface OperationMethods {
952
1063
  /**
953
1064
  * $createOpportunity - createOpportunity
954
1065
  *
955
- * Creates a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
1066
+ * This API is Deprecated. Please use the Entity API or Submission API to create opportunities. Creates a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
956
1067
  * The `opportunity_number` can be used to universally identify an opportunity within epilot platform.
957
1068
  *
958
1069
  */
@@ -964,6 +1075,30 @@ export interface OperationMethods {
964
1075
  }
965
1076
 
966
1077
  export interface PathsDictionary {
1078
+ ['/v1/order']: {
1079
+ /**
1080
+ * createOrder - createOrder
1081
+ *
1082
+ * Create an order
1083
+ */
1084
+ 'post'(
1085
+ parameters?: Parameters<UnknownParamsObject> | null,
1086
+ data?: Paths.CreateOrder.RequestBody,
1087
+ config?: AxiosRequestConfig
1088
+ ): OperationResponse<Paths.CreateOrder.Responses.$201>
1089
+ }
1090
+ ['/v1/order/{id}']: {
1091
+ /**
1092
+ * putOrder - putOrder
1093
+ *
1094
+ * Update an existing Order
1095
+ */
1096
+ 'put'(
1097
+ parameters?: Parameters<Paths.PutOrder.PathParameters> | null,
1098
+ data?: Paths.PutOrder.RequestBody,
1099
+ config?: AxiosRequestConfig
1100
+ ): OperationResponse<Paths.PutOrder.Responses.$200>
1101
+ }
967
1102
  ['/v1/public/cart:checkout']: {
968
1103
  /**
969
1104
  * $checkoutCart - checkoutCart
@@ -1015,7 +1150,7 @@ export interface PathsDictionary {
1015
1150
  /**
1016
1151
  * $createOpportunity - createOpportunity
1017
1152
  *
1018
- * Creates a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
1153
+ * This API is Deprecated. Please use the Entity API or Submission API to create opportunities. Creates a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
1019
1154
  * The `opportunity_number` can be used to universally identify an opportunity within epilot platform.
1020
1155
  *
1021
1156
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/pricing-client",
3
- "version": "1.11.0",
3
+ "version": "1.12.2",
4
4
  "description": "Client for epilot Pricing APIs",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -62,5 +62,6 @@
62
62
  "typescript": "^4.1.3",
63
63
  "webpack": "~5.18.0",
64
64
  "webpack-cli": "^4.4.0"
65
- }
65
+ },
66
+ "gitHead": "30bad200bf330cc632ee48414a4c1700b1a84f53"
66
67
  }