@epilot/pricing-client 3.35.14-beta.2 → 3.35.14

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
@@ -97,18 +97,6 @@ declare namespace Components {
97
97
  * The cashback amount as a string with all the decimal places.
98
98
  */
99
99
  cashback_amount_decimal?: string;
100
- /**
101
- * The cashback period, for now it's limited to either 0 months or 12 months
102
- */
103
- cashback_period?: "0" | "12";
104
- /**
105
- * Total amount after cashback is applied.
106
- */
107
- after_cashback_amount_total?: number;
108
- /**
109
- * Total amount after cashback is applied as a string with all the decimal places.
110
- */
111
- after_cashback_amount_total_decimal?: string;
112
100
  /**
113
101
  * The discount percentage, if the applied coupon had a percentage type.
114
102
  */
@@ -256,18 +244,6 @@ declare namespace Components {
256
244
  * The cashback amount as a string with all the decimal places.
257
245
  */
258
246
  cashback_amount_decimal?: string;
259
- /**
260
- * The cashback period, for now it's limited to either 0 months or 12 months
261
- */
262
- cashback_period?: "0" | "12";
263
- /**
264
- * Total amount after cashback is applied.
265
- */
266
- after_cashback_amount_total?: number;
267
- /**
268
- * Total amount after cashback is applied as a string with all the decimal places.
269
- */
270
- after_cashback_amount_total_decimal?: string;
271
247
  /**
272
248
  * The discount percentage, if the applied coupon had a percentage type.
273
249
  */
@@ -931,18 +907,6 @@ declare namespace Components {
931
907
  * The cashback amount as a string with all the decimal places.
932
908
  */
933
909
  cashback_amount_decimal?: string;
934
- /**
935
- * The cashback period, for now it's limited to either 0 months or 12 months
936
- */
937
- cashback_period?: "0" | "12";
938
- /**
939
- * Total amount after cashback is applied.
940
- */
941
- after_cashback_amount_total?: number;
942
- /**
943
- * Total amount after cashback is applied as a string with all the decimal places.
944
- */
945
- after_cashback_amount_total_decimal?: string;
946
910
  /**
947
911
  * The discount percentage, if the applied coupon had a percentage type.
948
912
  */
@@ -1032,19 +996,6 @@ declare namespace Components {
1032
996
  [name: string]: any;
1033
997
  };
1034
998
  }
1035
- /**
1036
- * An amount associated with a specific cashback period.
1037
- */
1038
- export interface CashbackAmount {
1039
- /**
1040
- * The cashback period, for now it's limited to either 0 months or 12 months
1041
- */
1042
- cashback_period?: "0" | "12";
1043
- /**
1044
- * The sum of all cashbacks for a specific cashback period
1045
- */
1046
- amount_total?: number;
1047
- }
1048
999
  /**
1049
1000
  * A catalog search payload
1050
1001
  * example:
@@ -1280,18 +1231,6 @@ declare namespace Components {
1280
1231
  * The cashback amount as a string with all the decimal places.
1281
1232
  */
1282
1233
  cashback_amount_decimal?: string;
1283
- /**
1284
- * The cashback period, for now it's limited to either 0 months or 12 months
1285
- */
1286
- cashback_period?: "0" | "12";
1287
- /**
1288
- * Total amount after cashback is applied.
1289
- */
1290
- after_cashback_amount_total?: number;
1291
- /**
1292
- * Total amount after cashback is applied as a string with all the decimal places.
1293
- */
1294
- after_cashback_amount_total_decimal?: string;
1295
1234
  /**
1296
1235
  * The discount percentage, if the applied coupon had a percentage type.
1297
1236
  */
@@ -2053,10 +1992,6 @@ declare namespace Components {
2053
1992
  * EUR
2054
1993
  */
2055
1994
  Currency;
2056
- /**
2057
- * The cashback period, for now it's limited to either 0 months or 12 months
2058
- */
2059
- cashback_period?: "0" | "12";
2060
1995
  active?: boolean;
2061
1996
  /**
2062
1997
  * The prices associated with the coupon. Will hold price entities if hydrated, relations otherwise.
@@ -2140,6 +2075,13 @@ declare namespace Components {
2140
2075
  */
2141
2076
  cause?: string;
2142
2077
  }
2078
+ /**
2079
+ * An external product & price information (already computed) from an external catalog.
2080
+ */
2081
+ export interface ExternalCatalogItem {
2082
+ pricing_details: /* The result from the calculation of a set of price items. */ PricingDetails;
2083
+ _meta: /* Signature meta data payload */ SignatureMeta;
2084
+ }
2143
2085
  export interface ExternalCompositePrice {
2144
2086
  /**
2145
2087
  * Fees structure with static and variable amounts
@@ -2388,74 +2330,6 @@ declare namespace Components {
2388
2330
  }[];
2389
2331
  };
2390
2332
  }
2391
- /**
2392
- * An external product & price information (already computed) from an external catalog.
2393
- */
2394
- export interface ExternalProduct {
2395
- /**
2396
- * The ID of the product in the external catalog.
2397
- */
2398
- id: string;
2399
- /**
2400
- * The name of the product.
2401
- */
2402
- name: string;
2403
- /**
2404
- * A description of the product.
2405
- */
2406
- description?: string;
2407
- /**
2408
- * A list of features of the product.
2409
- */
2410
- features?: string[];
2411
- /**
2412
- * A list of image URLs of the product. RECOMMENDED: Store files in Epilot for advantages such as resizing, versioning, easy access, and maintenance.
2413
- *
2414
- */
2415
- product_image_urls?: string[];
2416
- /**
2417
- * A list of file/attachment URLs of the product RECOMMENDED: Store files in Epilot for advantages such as resizing, versioning, easy access, and maintenance.
2418
- *
2419
- */
2420
- product_downloads_urls?: string[];
2421
- /**
2422
- * Legal footnotes for the product.
2423
- */
2424
- legal_footnotes?: string;
2425
- /**
2426
- * Additional notes for the product.
2427
- */
2428
- additional_notes?: string[];
2429
- /**
2430
- * Recommendation settings for the product.
2431
- * example:
2432
- * {
2433
- * "is_recommended": true,
2434
- * "recommended_label": "Best Value",
2435
- * "recommended_color": "#00FF00",
2436
- * "recommended_label_color": "#FFFFFF"
2437
- * }
2438
- */
2439
- recommendation_settings?: {
2440
- /**
2441
- * Flag to enable or disable the recommendation for this product.
2442
- */
2443
- is_recommended?: boolean;
2444
- /**
2445
- * Label to display when the product is recommended.
2446
- */
2447
- recommended_label?: string;
2448
- /**
2449
- * Color to display when the product is recommended.
2450
- */
2451
- recommended_color?: string;
2452
- /**
2453
- * Color of the recommended label.
2454
- */
2455
- recommended_label_color?: string;
2456
- };
2457
- price: ExternalSimplePrice | ExternalCompositePrice;
2458
- }
2459
2333
  export interface ExternalSimplePrice {
2460
2334
  /**
2461
2335
  * Fees structure with static and variable amounts
@@ -3481,18 +3355,6 @@ declare namespace Components {
3481
3355
  * The cashback amount as a string with all the decimal places.
3482
3356
  */
3483
3357
  cashback_amount_decimal?: string;
3484
- /**
3485
- * The cashback period, for now it's limited to either 0 months or 12 months
3486
- */
3487
- cashback_period?: "0" | "12";
3488
- /**
3489
- * Total amount after cashback is applied.
3490
- */
3491
- after_cashback_amount_total?: number;
3492
- /**
3493
- * Total amount after cashback is applied as a string with all the decimal places.
3494
- */
3495
- after_cashback_amount_total_decimal?: string;
3496
3358
  /**
3497
3359
  * The discount percentage, if the applied coupon had a percentage type.
3498
3360
  */
@@ -4484,18 +4346,6 @@ declare namespace Components {
4484
4346
  * The cashback amount as a string with all the decimal places.
4485
4347
  */
4486
4348
  cashback_amount_decimal?: string;
4487
- /**
4488
- * The cashback period, for now it's limited to either 0 months or 12 months
4489
- */
4490
- cashback_period?: "0" | "12";
4491
- /**
4492
- * Total amount after cashback is applied.
4493
- */
4494
- after_cashback_amount_total?: number;
4495
- /**
4496
- * Total amount after cashback is applied as a string with all the decimal places.
4497
- */
4498
- after_cashback_amount_total_decimal?: string;
4499
4349
  /**
4500
4350
  * The discount percentage, if the applied coupon had a percentage type.
4501
4351
  */
@@ -4573,18 +4423,6 @@ declare namespace Components {
4573
4423
  * The cashback amount as a string with all the decimal places.
4574
4424
  */
4575
4425
  cashback_amount_decimal?: string;
4576
- /**
4577
- * The cashback period, for now it's limited to either 0 months or 12 months
4578
- */
4579
- cashback_period?: "0" | "12";
4580
- /**
4581
- * Total amount after cashback is applied.
4582
- */
4583
- after_cashback_amount_total?: number;
4584
- /**
4585
- * Total amount after cashback is applied as a string with all the decimal places.
4586
- */
4587
- after_cashback_amount_total_decimal?: string;
4588
4426
  /**
4589
4427
  * The discount percentage, if the applied coupon had a percentage type.
4590
4428
  */
@@ -4659,7 +4497,7 @@ declare namespace Components {
4659
4497
  * The number os results returned.
4660
4498
  */
4661
4499
  hits: number;
4662
- results: /* An external product & price information (already computed) from an external catalog. */ ExternalProduct[];
4500
+ results: /* An external product & price information (already computed) from an external catalog. */ ExternalCatalogItem[];
4663
4501
  }
4664
4502
  /**
4665
4503
  * A search providers payload
@@ -4906,10 +4744,6 @@ declare namespace Components {
4906
4744
  * The aggregated price items tax amount per rate.
4907
4745
  */
4908
4746
  recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
4909
- /**
4910
- * The list of cashback sums for each cashback period.
4911
- */
4912
- cashbacks?: (/* An amount associated with a specific cashback period. */ CashbackAmount)[];
4913
4747
  /**
4914
4748
  * The aggregated price items recurrences by tax rate
4915
4749
  */
@@ -5637,7 +5471,6 @@ export type BasicAuthCredentials = Components.Schemas.BasicAuthCredentials;
5637
5471
  export type BillingPeriod = Components.Schemas.BillingPeriod;
5638
5472
  export type Cart = Components.Schemas.Cart;
5639
5473
  export type CartDto = Components.Schemas.CartDto;
5640
- export type CashbackAmount = Components.Schemas.CashbackAmount;
5641
5474
  export type CatalogSearch = Components.Schemas.CatalogSearch;
5642
5475
  export type CatalogSearchResult = Components.Schemas.CatalogSearchResult;
5643
5476
  export type CheckoutCart = Components.Schemas.CheckoutCart;
@@ -5662,13 +5495,13 @@ export type EntityId = Components.Schemas.EntityId;
5662
5495
  export type EntityItem = Components.Schemas.EntityItem;
5663
5496
  export type EntityRelation = Components.Schemas.EntityRelation;
5664
5497
  export type Error = Components.Schemas.Error;
5498
+ export type ExternalCatalogItem = Components.Schemas.ExternalCatalogItem;
5665
5499
  export type ExternalCompositePrice = Components.Schemas.ExternalCompositePrice;
5666
5500
  export type ExternalFeeMapping = Components.Schemas.ExternalFeeMapping;
5667
5501
  export type ExternalFeeMappings = Components.Schemas.ExternalFeeMappings;
5668
5502
  export type ExternalFeeMetadata = Components.Schemas.ExternalFeeMetadata;
5669
5503
  export type ExternalPriceFees = Components.Schemas.ExternalPriceFees;
5670
5504
  export type ExternalPriceTotalDetails = Components.Schemas.ExternalPriceTotalDetails;
5671
- export type ExternalProduct = Components.Schemas.ExternalProduct;
5672
5505
  export type ExternalSimplePrice = Components.Schemas.ExternalSimplePrice;
5673
5506
  export type File = Components.Schemas.File;
5674
5507
  export type GasConcessionType = Components.Schemas.GasConcessionType;
package/dist/openapi.json CHANGED
@@ -4099,24 +4099,6 @@
4099
4099
  "description": "The cashback amount as a string with all the decimal places.",
4100
4100
  "readOnly": true
4101
4101
  },
4102
- "cashback_period": {
4103
- "type": "string",
4104
- "description": "The cashback period, for now it's limited to either 0 months or 12 months",
4105
- "enum": [
4106
- "0",
4107
- "12"
4108
- ]
4109
- },
4110
- "after_cashback_amount_total": {
4111
- "type": "integer",
4112
- "description": "Total amount after cashback is applied.",
4113
- "readOnly": true
4114
- },
4115
- "after_cashback_amount_total_decimal": {
4116
- "type": "string",
4117
- "description": "Total amount after cashback is applied as a string with all the decimal places.",
4118
- "readOnly": true
4119
- },
4120
4102
  "discount_percentage": {
4121
4103
  "type": "integer",
4122
4104
  "description": "The discount percentage, if the applied coupon had a percentage type.",
@@ -4285,24 +4267,6 @@
4285
4267
  "amount_total_decimal"
4286
4268
  ]
4287
4269
  },
4288
- "CashbackAmount": {
4289
- "type": "object",
4290
- "description": "An amount associated with a specific cashback period.",
4291
- "properties": {
4292
- "cashback_period": {
4293
- "type": "string",
4294
- "description": "The cashback period, for now it's limited to either 0 months or 12 months",
4295
- "enum": [
4296
- "0",
4297
- "12"
4298
- ]
4299
- },
4300
- "amount_total": {
4301
- "type": "integer",
4302
- "description": "The sum of all cashbacks for a specific cashback period"
4303
- }
4304
- }
4305
- },
4306
4270
  "RecurrenceAmountWithTax": {
4307
4271
  "type": "object",
4308
4272
  "description": "An amount associated with a specific recurrence.",
@@ -4390,17 +4354,6 @@
4390
4354
  ]
4391
4355
  }
4392
4356
  },
4393
- "cashbacks": {
4394
- "type": "array",
4395
- "description": "The list of cashback sums for each cashback period.",
4396
- "items": {
4397
- "oneOf": [
4398
- {
4399
- "$ref": "#/components/schemas/CashbackAmount"
4400
- }
4401
- ]
4402
- }
4403
- },
4404
4357
  "recurrencesByTax": {
4405
4358
  "type": "array",
4406
4359
  "description": "The aggregated price items recurrences by tax rate",
@@ -5033,14 +4986,6 @@
5033
4986
  }
5034
4987
  ]
5035
4988
  },
5036
- "cashback_period": {
5037
- "type": "string",
5038
- "description": "The cashback period, for now it's limited to either 0 months or 12 months",
5039
- "enum": [
5040
- "0",
5041
- "12"
5042
- ]
5043
- },
5044
4989
  "active": {
5045
4990
  "type": "boolean"
5046
4991
  },
@@ -5404,7 +5349,7 @@
5404
5349
  "results": {
5405
5350
  "type": "array",
5406
5351
  "items": {
5407
- "$ref": "#/components/schemas/ExternalProduct"
5352
+ "$ref": "#/components/schemas/ExternalCatalogItem"
5408
5353
  }
5409
5354
  }
5410
5355
  },
@@ -5413,97 +5358,20 @@
5413
5358
  "hits"
5414
5359
  ]
5415
5360
  },
5416
- "ExternalProduct": {
5361
+ "ExternalCatalogItem": {
5417
5362
  "type": "object",
5418
5363
  "description": "An external product & price information (already computed) from an external catalog.",
5419
5364
  "properties": {
5420
- "id": {
5421
- "type": "string",
5422
- "description": "The ID of the product in the external catalog."
5423
- },
5424
- "name": {
5425
- "type": "string",
5426
- "description": "The name of the product."
5427
- },
5428
- "description": {
5429
- "type": "string",
5430
- "description": "A description of the product."
5431
- },
5432
- "features": {
5433
- "type": "array",
5434
- "description": "A list of features of the product.",
5435
- "items": {
5436
- "type": "string"
5437
- }
5438
- },
5439
- "product_image_urls": {
5440
- "type": "array",
5441
- "items": {
5442
- "type": "string"
5443
- },
5444
- "description": "A list of image URLs of the product. RECOMMENDED: Store files in Epilot for advantages such as resizing, versioning, easy access, and maintenance.\n"
5445
- },
5446
- "product_downloads_urls": {
5447
- "type": "array",
5448
- "items": {
5449
- "type": "string"
5450
- },
5451
- "description": "A list of file/attachment URLs of the product RECOMMENDED: Store files in Epilot for advantages such as resizing, versioning, easy access, and maintenance.\n"
5452
- },
5453
- "legal_footnotes": {
5454
- "type": "string",
5455
- "description": "Legal footnotes for the product."
5456
- },
5457
- "additional_notes": {
5458
- "type": "array",
5459
- "description": "Additional notes for the product.",
5460
- "items": {
5461
- "type": "string"
5462
- }
5463
- },
5464
- "recommendation_settings": {
5465
- "type": "object",
5466
- "description": "Recommendation settings for the product.",
5467
- "properties": {
5468
- "is_recommended": {
5469
- "type": "boolean",
5470
- "description": "Flag to enable or disable the recommendation for this product."
5471
- },
5472
- "recommended_label": {
5473
- "type": "string",
5474
- "description": "Label to display when the product is recommended."
5475
- },
5476
- "recommended_color": {
5477
- "type": "string",
5478
- "description": "Color to display when the product is recommended."
5479
- },
5480
- "recommended_label_color": {
5481
- "type": "string",
5482
- "description": "Color of the recommended label."
5483
- }
5484
- },
5485
- "example": {
5486
- "is_recommended": true,
5487
- "recommended_label": "Best Value",
5488
- "recommended_color": "#00FF00",
5489
- "recommended_label_color": "#FFFFFF"
5490
- }
5365
+ "pricing_details": {
5366
+ "$ref": "#/components/schemas/PricingDetails"
5491
5367
  },
5492
- "price": {
5493
- "oneOf": [
5494
- {
5495
- "$ref": "#/components/schemas/ExternalSimplePrice"
5496
- },
5497
- {
5498
- "$ref": "#/components/schemas/ExternalCompositePrice"
5499
- }
5500
- ]
5368
+ "_meta": {
5369
+ "$ref": "#/components/schemas/SignatureMeta"
5501
5370
  }
5502
5371
  },
5503
5372
  "required": [
5504
- "price",
5505
- "name",
5506
- "id"
5373
+ "pricing_details",
5374
+ "_meta"
5507
5375
  ]
5508
5376
  },
5509
5377
  "ExternalPriceFees": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/pricing-client",
3
- "version": "3.35.14-beta.2",
3
+ "version": "3.35.14",
4
4
  "description": "Client for epilot Pricing APIs",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",