@epilot/pricing-client 1.12.3 → 1.13.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/src/openapi.d.ts DELETED
@@ -1,1165 +0,0 @@
1
- /* eslint-disable */
2
- import type {
3
- OpenAPIClient,
4
- Parameters,
5
- UnknownParamsObject,
6
- OperationResponse,
7
- AxiosRequestConfig,
8
- } from 'openapi-client-axios';
9
-
10
- declare namespace Components {
11
- namespace Schemas {
12
- export interface Address {
13
- [name: string]: any;
14
- /**
15
- * example:
16
- * [
17
- * "billing"
18
- * ]
19
- */
20
- _tags?: string[];
21
- /**
22
- * The first line of the address. Typically the street address or PO Box number.
23
- */
24
- street?: string;
25
- /**
26
- * The second line of the address. Typically the number of the apartment, suite, or unit.
27
- */
28
- street_number?: string;
29
- /**
30
- * The postal code for the address.
31
- */
32
- postal_code?: string;
33
- /**
34
- * The name of the city, district, village, or town.
35
- */
36
- city?: string;
37
- /**
38
- * The two-letter code for the country of the address.
39
- */
40
- country?: string;
41
- /**
42
- * An additional description for the address
43
- */
44
- additional_info?: string;
45
- }
46
- /**
47
- * Availability check request payload
48
- */
49
- export interface AvailabilityCheckParams {
50
- /**
51
- * Products to check availability
52
- */
53
- products: string[];
54
- filters: /* Availability filters dimensions */ AvailabilityFilters;
55
- }
56
- export interface AvailabilityDate {
57
- /**
58
- * The availability interval start date
59
- * example:
60
- * 2017-07-21
61
- */
62
- available_start_date?: string; // date
63
- /**
64
- * The availability interval end date
65
- * example:
66
- * 2017-07-21
67
- */
68
- available_end_date?: string; // date
69
- }
70
- /**
71
- * Availability filters dimensions
72
- */
73
- export interface AvailabilityFilters {
74
- location: AvailabilityLocation;
75
- /**
76
- * A value to be matched against the availability window (start & end date)
77
- * example:
78
- * 2017-07-21
79
- */
80
- available_date?: string; // date
81
- }
82
- export interface AvailabilityLocation {
83
- /**
84
- * The first line of the address. Typically the street address or PO Box number.
85
- */
86
- street?: string;
87
- /**
88
- * The second line of the address. Typically the number of the apartment, suite, or unit.
89
- */
90
- street_number?: string;
91
- /**
92
- * The postal code for the address.
93
- */
94
- postal_code?: string;
95
- /**
96
- * The name of the city, district, village, or town.
97
- */
98
- city?: string;
99
- /**
100
- * The name of the country.
101
- */
102
- country?: string;
103
- }
104
- /**
105
- * The availability check result payload
106
- * example:
107
- * {
108
- * "available_products": [],
109
- * "check_results": [
110
- * {
111
- * "product_id": "my-product-id-123-1",
112
- * "matching_hits": 0
113
- * },
114
- * {
115
- * "product_id": "my-product-id-123-2",
116
- * "matching_hits": 0
117
- * }
118
- * ]
119
- * }
120
- */
121
- export interface AvailabilityResult {
122
- available_products: string[];
123
- /**
124
- * The check result details
125
- */
126
- check_results?: {
127
- product_id: string;
128
- /**
129
- * The number of rules matched
130
- */
131
- matching_hits?: number;
132
- /**
133
- * A set of matching errors when checking availability
134
- */
135
- matching_error?: {
136
- [name: string]: any;
137
- };
138
- }[];
139
- }
140
- export type BillingPeriod = "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
141
- /**
142
- * Supports shopping for products and services until ready for checkout.
143
- */
144
- export interface Cart {
145
- /**
146
- * The cart identifier
147
- */
148
- id?: string;
149
- /**
150
- * The user's Organization Id the cart belongs to
151
- */
152
- org_id?: string;
153
- /**
154
- * The status of the Cart:
155
- * - open - the cart checkout is still in progress. Payment processing has not started
156
- * - complete - the cart checkout is complete. Payment processing may still be in progress
157
- * - expired - the cart checkout has expired. No further processing will occur
158
- *
159
- */
160
- status?: "open" | "complete" | "expired";
161
- customer?: Customer;
162
- billing_address?: Address;
163
- delivery_address?: Address;
164
- metadata?: /* A set of key-value pairs. */ MetaData;
165
- line_items?: /* Tracks a set of product prices, quantities, (discounts) and taxes. */ PriceItems;
166
- /**
167
- * Total of all items before (discounts or) taxes are applied.
168
- */
169
- amount_subtotal?: number;
170
- /**
171
- * Total of all items after (discounts and) taxes are applied.
172
- */
173
- amount_total?: number;
174
- total_details?: /* The total details with tax (and discount) aggregated totals. */ TotalDetails;
175
- created_at?: string; // date-time
176
- updated_at?: string; // date-time
177
- }
178
- /**
179
- * A valid cart payload from a client.
180
- */
181
- export interface CartDto {
182
- metadata?: /* A set of key-value pairs. */ MetaData;
183
- customer?: Customer;
184
- billing_address?: Address;
185
- delivery_address?: Address;
186
- /**
187
- * type of source, e.g. journey or manual
188
- * example:
189
- * journey
190
- */
191
- source_type?: string;
192
- /**
193
- * identifier for source e.g. journey ID
194
- * example:
195
- * ce99875f-fba9-4fe2-a8f9-afaf52059051
196
- */
197
- source_id?: string;
198
- source?: /* Order Source */ OrderSource;
199
- additional_addresses?: Address[];
200
- payment_method?: /**
201
- * A PaymentMethod represent your customer's payment instruments.
202
- *
203
- */
204
- PaymentMethod;
205
- line_items: /* A valid set of product prices, quantities, (discounts) and taxes from a client. */ PriceItemsDto;
206
- /**
207
- * An array of file IDs, already upload into the File API, that are related with this cart
208
- */
209
- files?: string[];
210
- status?: /* The order status */ OrderStatus;
211
- tags?: string[];
212
- journey_data?: {
213
- [name: string]: any;
214
- };
215
- consents?: {
216
- [name: string]: any;
217
- };
218
- }
219
- /**
220
- * A catalog search payload
221
- * example:
222
- * {
223
- * "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
224
- * "sort": "description ASC",
225
- * "from": 0,
226
- * "size": 200,
227
- * "availability": {
228
- * "location": {
229
- * "postal_code": "57008,",
230
- * "city": "Cologne,",
231
- * "street": "Media Park,",
232
- * "street_number": "8a"
233
- * },
234
- * "available_date": {
235
- * "value": "2022-05-01"
236
- * }
237
- * }
238
- * }
239
- */
240
- export interface CatalogSearch {
241
- /**
242
- * The query to perform using lucene query syntax.
243
- */
244
- q: string;
245
- /**
246
- * The sort expression to sort the results.
247
- */
248
- sort?: string;
249
- /**
250
- * The index from which to query, used for pagination purposes. Defaults to 0
251
- */
252
- from?: number;
253
- /**
254
- * The max size of the response, defaults to 2000.
255
- */
256
- size?: number;
257
- /**
258
- * When true, enables entity hydration to resolve nested $relation references in-place.
259
- */
260
- hydrate?: boolean;
261
- availability?: /* Availability filters dimensions */ AvailabilityFilters;
262
- }
263
- /**
264
- * The query result payload
265
- * example:
266
- * {
267
- * "hits": 2,
268
- * "results": [
269
- * {
270
- * "schema": "product",
271
- * "description": "product a"
272
- * },
273
- * {
274
- * "schema": "price",
275
- * "unit_amount_decimal": "124.342343434"
276
- * }
277
- * ]
278
- * }
279
- */
280
- export interface CatalogSearchResult {
281
- /**
282
- * The number os results returned.
283
- */
284
- hits?: number;
285
- results?: (/* The product configuration */ Product | /* The price configuration */ Price)[];
286
- }
287
- /**
288
- * The cart checkout request payload
289
- */
290
- export interface CheckoutCart {
291
- cart?: string | /* A valid cart payload from a client. */ CartDto;
292
- mode?: /* The checkout mode for the cart checkout. */ CheckoutMode;
293
- }
294
- /**
295
- * The cart checkout result
296
- */
297
- export interface CheckoutCartResult {
298
- order?: /* The order entity */ Order;
299
- }
300
- /**
301
- * The checkout mode for the cart checkout.
302
- */
303
- export type CheckoutMode = "create_order" | "create_invoice" | "create_quote";
304
- /**
305
- * Three-letter ISO currency code, in lowercase. Must be a supported currency.
306
- * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
307
- *
308
- * example:
309
- * EUR
310
- */
311
- export type Currency = string;
312
- export interface Customer {
313
- first_name?: string;
314
- last_name?: string;
315
- company_name?: string;
316
- vat_id?: string;
317
- /**
318
- * A valid email identifying the customer.
319
- */
320
- email?: string;
321
- phone?: string;
322
- }
323
- export interface EntityRelation {
324
- [name: string]: any;
325
- entity_id?: string;
326
- _tags?: string[];
327
- }
328
- export interface Error {
329
- /**
330
- * Error message
331
- */
332
- message: string;
333
- }
334
- export interface File {
335
- [name: string]: any;
336
- _id: string;
337
- filename: string;
338
- mime_type: string;
339
- versions: {
340
- [name: string]: any;
341
- s3ref: {
342
- bucket: string;
343
- key: string;
344
- };
345
- }[];
346
- _schema: string;
347
- _org: string;
348
- _created_at: string; // date-time
349
- _updated_at: string; // date-time
350
- _title?: string;
351
- $relation?: EntityRelation;
352
- }
353
- /**
354
- * A set of key-value pairs.
355
- */
356
- export type MetaData = ({
357
- /**
358
- * Item key
359
- */
360
- key?: string;
361
- /**
362
- * Item value
363
- */
364
- value?: string;
365
- })[];
366
- /**
367
- * The opportunity entity
368
- */
369
- export interface Opportunity {
370
- [name: string]: any;
371
- /**
372
- * The opportunity id number for the customer (autogenerated if left blank)
373
- */
374
- opportunity_number?: string;
375
- /**
376
- * A description to frame this opportunity within its sales process
377
- */
378
- description?: string;
379
- /**
380
- * The opportunity status
381
- */
382
- status?: "lead" | "qualification" | "validation" | "offering" | "supply" | "approval" | "operations" | "complete";
383
- items?: /* The order entity */ Order[] | {
384
- $relation?: /* An order relation reference */ OrderRelation[];
385
- };
386
- /**
387
- * Organization Id the order belongs to
388
- */
389
- _org_id?: string;
390
- _id?: string;
391
- _created_at?: string;
392
- _updated_at?: string;
393
- /**
394
- * type of source, e.g. journey or manual
395
- * example:
396
- * journey
397
- */
398
- source_type?: string;
399
- /**
400
- * identifier for source e.g. journey ID
401
- * example:
402
- * ce99875f-fba9-4fe2-a8f9-afaf52059051
403
- */
404
- source_id?: string;
405
- source?: /* Order Source */ OpportunitySource;
406
- _tags?: string[];
407
- }
408
- /**
409
- * Order Source
410
- */
411
- export interface OpportunitySource {
412
- /**
413
- * Link path for the source
414
- * example:
415
- * /app/v2/journey-builder/editor/db7f6940-994b-11ec-a46d-9f1824ff2939
416
- */
417
- http?: string;
418
- /**
419
- * Title for the source
420
- * example:
421
- * Journey: PH Journey
422
- */
423
- title?: string;
424
- }
425
- /**
426
- * The order entity
427
- */
428
- export interface Order {
429
- [name: string]: any;
430
- /**
431
- * The order id number for the customer
432
- */
433
- order_number?: string;
434
- /**
435
- * The cart id that originated or is associated with the order
436
- */
437
- cart_id?: string;
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;
452
- metadata?: /* A set of key-value pairs. */ MetaData;
453
- billing_first_name?: string;
454
- billing_last_name?: string;
455
- billing_company_name?: string;
456
- billing_vat?: string;
457
- billing_email?: string;
458
- billing_phone?: string;
459
- billing_address?: Address[];
460
- currency?: /**
461
- * Three-letter ISO currency code, in lowercase. Must be a supported currency.
462
- * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
463
- *
464
- * example:
465
- * EUR
466
- */
467
- Currency;
468
- delivery_address?: Address[];
469
- payment_method?: /**
470
- * A PaymentMethod represent your customer's payment instruments.
471
- *
472
- */
473
- PaymentMethod[];
474
- /**
475
- * The id of an existing contact.
476
- */
477
- contact?: string;
478
- line_items?: /* Tracks a set of product prices, quantities, (discounts) and taxes. */ PriceItems;
479
- /**
480
- * Total of all items before (discounts or) taxes are applied.
481
- */
482
- amount_subtotal?: number;
483
- /**
484
- * Total of all items after (discounts and) taxes are applied.
485
- */
486
- amount_total?: number;
487
- total_details?: /* The total details with tax (and discount) aggregated totals. */ TotalDetails;
488
- /**
489
- * Organization Id the order belongs to
490
- */
491
- _org_id?: string;
492
- _id?: string;
493
- _created_at?: string;
494
- _updated_at?: string;
495
- _tags?: string[];
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
- }
536
- /**
537
- * An order relation reference
538
- */
539
- export interface OrderRelation {
540
- /**
541
- * The relation order id
542
- */
543
- entity_id?: string;
544
- _tags?: string[];
545
- }
546
- /**
547
- * Order Source
548
- */
549
- export interface OrderSource {
550
- /**
551
- * Link path for the source
552
- * example:
553
- * /app/v2/journey-builder/editor/db7f6940-994b-11ec-a46d-9f1824ff2939
554
- */
555
- http?: string;
556
- /**
557
- * Title for the source
558
- * example:
559
- * Journey: PH Journey
560
- */
561
- title?: string;
562
- }
563
- /**
564
- * The order status
565
- */
566
- export type OrderStatus = "draft" | "quote" | "placed" | "cancelled" | "completed";
567
- /**
568
- * A PaymentMethod represent your customer's payment instruments.
569
- *
570
- */
571
- export interface PaymentMethod {
572
- /**
573
- * The type of the PaymentMethod.
574
- */
575
- type?: string;
576
- /**
577
- * Contains relevant data associated with the payment method type.
578
- */
579
- details?: {
580
- [name: string]: any;
581
- };
582
- }
583
- /**
584
- * The price configuration
585
- */
586
- export interface Price {
587
- [name: string]: any;
588
- active?: boolean;
589
- billing_scheme?: "Per Unit";
590
- description?: string;
591
- sales_tax?: SalesTax;
592
- tax_behavior?: "inclusive" | "exclusive";
593
- tiers_mode?: "Standard";
594
- type?: "one_time" | "recurring";
595
- billing_period?: BillingPeriod;
596
- unit_amount?: number;
597
- unit_amount_decimal?: string;
598
- unit_amount_currency?: /**
599
- * Three-letter ISO currency code, in lowercase. Must be a supported currency.
600
- * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
601
- *
602
- * example:
603
- * EUR
604
- */
605
- Currency;
606
- billing_duration_amount?: number;
607
- billing_duration_unit?: "weeks" | "months" | "years";
608
- notice_time_amount?: number;
609
- notice_time_unit?: "weeks" | "months" | "years";
610
- termination_time_amount?: number;
611
- termination_time_unit?: "weeks" | "months" | "years";
612
- renewal_duration_amount?: number;
613
- renewal_duration_unit?: "weeks" | "months" | "years";
614
- _created_at?: string;
615
- _id?: string;
616
- _title?: string;
617
- _updated_at?: string;
618
- }
619
- /**
620
- * Represents a price item
621
- */
622
- export interface PriceItem {
623
- /**
624
- * price item id
625
- */
626
- id?: string;
627
- metadata?: /* A set of key-value pairs. */ MetaData;
628
- /**
629
- * The unit amount value
630
- */
631
- unit_amount?: number;
632
- /**
633
- * Total before any (discounts or) taxes are applied.
634
- */
635
- amount_subtotal?: number;
636
- /**
637
- * Net unit amount without taxes.
638
- */
639
- unit_amount_net?: number;
640
- /**
641
- * Total after (discounts and) taxes.
642
- */
643
- amount_total?: number;
644
- currency?: /**
645
- * Three-letter ISO currency code, in lowercase. Must be a supported currency.
646
- * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
647
- *
648
- * example:
649
- * EUR
650
- */
651
- Currency;
652
- /**
653
- * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
654
- */
655
- description?: string;
656
- /**
657
- * The quantity of products being purchased.
658
- */
659
- quantity?: number;
660
- /**
661
- * The id of the product.
662
- */
663
- product_id?: string;
664
- /**
665
- * The id of the price.
666
- */
667
- price_id?: string;
668
- _price?: /* The price configuration */ Price;
669
- _product?: /* The product configuration */ Product;
670
- /**
671
- * The taxes applied to the price item.
672
- */
673
- taxes?: (/* A tax amount associated with a specific tax rate. */ TaxAmount)[];
674
- /**
675
- * The sum of amounts of the price items by recurrence.
676
- */
677
- recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
678
- }
679
- /**
680
- * Represents a valid price item from a client.
681
- */
682
- export interface PriceItemDto {
683
- metadata?: /* A set of key-value pairs. */ MetaData;
684
- /**
685
- * The quantity of products being purchased.
686
- */
687
- quantity?: number;
688
- /**
689
- * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
690
- */
691
- description?: string;
692
- /**
693
- * The id of the product.
694
- */
695
- product_id?: string;
696
- /**
697
- * The id of the price.
698
- */
699
- price_id?: string;
700
- /**
701
- * The taxes applied to the price item.
702
- */
703
- taxes?: (/* A valid tax rate from a client. */ TaxAmountDto)[];
704
- /**
705
- * The taxes applied to the price item.
706
- */
707
- recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmountDto)[];
708
- _price?: /* The price configuration */ Price;
709
- /**
710
- * The product linked to the price item.
711
- */
712
- _product?: /* The product configuration */ Product;
713
- }
714
- /**
715
- * Tracks a set of product prices, quantities, (discounts) and taxes.
716
- */
717
- export type PriceItems = (/* Represents a price item */ PriceItem)[];
718
- /**
719
- * A valid set of product prices, quantities, (discounts) and taxes from a client.
720
- */
721
- export type PriceItemsDto = (/* Represents a valid price item from a client. */ PriceItemDto)[];
722
- /**
723
- * The result from the calculation of a set of price items.
724
- */
725
- export interface PricingDetails {
726
- items?: (/* Represents a price item */ PriceItem)[];
727
- /**
728
- * Total of all items before (discounts or) taxes are applied.
729
- */
730
- amount_subtotal?: number;
731
- /**
732
- * Total of all items after (discounts and) taxes are applied.
733
- */
734
- amount_total?: number;
735
- total_details?: /* The total details with tax (and discount) aggregated totals. */ TotalDetails;
736
- }
737
- /**
738
- * The product configuration
739
- */
740
- export interface Product {
741
- [name: string]: any;
742
- code?: string;
743
- type?: "Product" | "Service";
744
- name?: string;
745
- _id?: string;
746
- _title?: string;
747
- _availability_files?: File[];
748
- }
749
- /**
750
- * An amount associated with a specific recurrence.
751
- */
752
- export interface RecurrenceAmount {
753
- /**
754
- * The price type.
755
- */
756
- type: string;
757
- /**
758
- * The price billing period.
759
- */
760
- billing_period?: string;
761
- /**
762
- * Total of all items, with same recurrence, before (discounts or) taxes are applied.
763
- */
764
- amount_subtotal: number;
765
- /**
766
- * Total of all items, with same recurrence, after (discounts and) taxes are applied.
767
- */
768
- amount_total: number;
769
- /**
770
- * Total of all items taxes, with same recurrence.
771
- */
772
- amount_tax?: number;
773
- }
774
- /**
775
- * An amount associated with a specific recurrence.
776
- */
777
- export interface RecurrenceAmountDto {
778
- /**
779
- * The price type.
780
- */
781
- type: string;
782
- /**
783
- * The price billing period.
784
- */
785
- billing_period?: string;
786
- /**
787
- * Total of all items, with same recurrence, before (discounts or) taxes are applied.
788
- */
789
- amount_subtotal: number;
790
- /**
791
- * Total of all items, with same recurrence, after (discounts and) taxes are applied.
792
- */
793
- amount_total: number;
794
- /**
795
- * Total of all items taxes, with same recurrence.
796
- */
797
- amount_tax?: number;
798
- }
799
- export type SalesTax = "nontaxable" | "reduced" | "standard";
800
- /**
801
- * the tax configuration
802
- */
803
- export interface Tax {
804
- [name: string]: any;
805
- type: "VAT" | "GST" | "Custom";
806
- description?: string;
807
- rate: number;
808
- behavior: "Exclusive" | "Inclusive";
809
- active?: boolean;
810
- region?: string;
811
- region_label?: string;
812
- }
813
- /**
814
- * A tax amount associated with a specific tax rate.
815
- */
816
- export interface TaxAmount {
817
- /**
818
- * The tax amount.
819
- */
820
- amount?: number;
821
- /**
822
- * The tax rate applied.
823
- */
824
- rate?: string;
825
- /**
826
- * The tax applied.
827
- */
828
- tax?: /* The tax applied. */ /* the tax configuration */ Tax;
829
- }
830
- /**
831
- * A valid tax rate from a client.
832
- */
833
- export interface TaxAmountDto {
834
- /**
835
- * The tax rate applied.
836
- */
837
- rate?: string;
838
- /**
839
- * The tax applied.
840
- */
841
- tax?: /* The tax applied. */ /* the tax configuration */ Tax;
842
- }
843
- /**
844
- * The total details with tax (and discount) aggregated totals.
845
- */
846
- export interface TotalDetails {
847
- /**
848
- * This is the sum of all the price item shipping amounts.
849
- */
850
- amount_shipping?: number;
851
- /**
852
- * This is the sum of all the price item tax amounts.
853
- */
854
- amount_tax?: number;
855
- /**
856
- * Breakdown of individual tax (and discount) amounts that add up to the totals.
857
- */
858
- breakdown?: {
859
- /**
860
- * The aggregated price items tax amount per rate.
861
- */
862
- taxes?: (/* A tax amount associated with a specific tax rate. */ TaxAmount)[];
863
- /**
864
- * The aggregated price items tax amount per rate.
865
- */
866
- recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
867
- };
868
- }
869
- }
870
- }
871
- declare namespace Paths {
872
- namespace $AvailabilityCheck {
873
- export interface HeaderParameters {
874
- "X-Ivy-Org-ID": Parameters.XIvyOrgID;
875
- }
876
- namespace Parameters {
877
- export type XIvyOrgID = string;
878
- }
879
- export type RequestBody = /* Availability check request payload */ Components.Schemas.AvailabilityCheckParams;
880
- namespace Responses {
881
- export type $200 = /**
882
- * The availability check result payload
883
- * example:
884
- * {
885
- * "available_products": [],
886
- * "check_results": [
887
- * {
888
- * "product_id": "my-product-id-123-1",
889
- * "matching_hits": 0
890
- * },
891
- * {
892
- * "product_id": "my-product-id-123-2",
893
- * "matching_hits": 0
894
- * }
895
- * ]
896
- * }
897
- */
898
- Components.Schemas.AvailabilityResult;
899
- export type $400 = Components.Schemas.Error;
900
- }
901
- }
902
- namespace $CheckoutCart {
903
- export interface HeaderParameters {
904
- "X-Ivy-Org-ID": Parameters.XIvyOrgID;
905
- }
906
- namespace Parameters {
907
- export type XIvyOrgID = string;
908
- }
909
- export type RequestBody = /* The cart checkout request payload */ Components.Schemas.CheckoutCart;
910
- namespace Responses {
911
- export type $200 = /* The cart checkout result */ Components.Schemas.CheckoutCartResult;
912
- export type $400 = Components.Schemas.Error;
913
- }
914
- }
915
- namespace $CreateOpportunity {
916
- export interface HeaderParameters {
917
- "X-Ivy-Org-ID": Parameters.XIvyOrgID;
918
- }
919
- namespace Parameters {
920
- export type XIvyOrgID = string;
921
- }
922
- export type RequestBody = /* The opportunity entity */ Components.Schemas.Opportunity;
923
- namespace Responses {
924
- export type $201 = /* The opportunity entity */ Components.Schemas.Opportunity;
925
- export type $400 = Components.Schemas.Error;
926
- }
927
- }
928
- namespace $SearchCatalog {
929
- export interface HeaderParameters {
930
- "X-Ivy-Org-ID": Parameters.XIvyOrgID;
931
- }
932
- namespace Parameters {
933
- export type XIvyOrgID = string;
934
- }
935
- export type RequestBody = /**
936
- * A catalog search payload
937
- * example:
938
- * {
939
- * "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
940
- * "sort": "description ASC",
941
- * "from": 0,
942
- * "size": 200,
943
- * "availability": {
944
- * "location": {
945
- * "postal_code": "57008,",
946
- * "city": "Cologne,",
947
- * "street": "Media Park,",
948
- * "street_number": "8a"
949
- * },
950
- * "available_date": {
951
- * "value": "2022-05-01"
952
- * }
953
- * }
954
- * }
955
- */
956
- Components.Schemas.CatalogSearch;
957
- namespace Responses {
958
- export type $200 = /**
959
- * The query result payload
960
- * example:
961
- * {
962
- * "hits": 2,
963
- * "results": [
964
- * {
965
- * "schema": "product",
966
- * "description": "product a"
967
- * },
968
- * {
969
- * "schema": "price",
970
- * "unit_amount_decimal": "124.342343434"
971
- * }
972
- * ]
973
- * }
974
- */
975
- Components.Schemas.CatalogSearchResult;
976
- export type $400 = Components.Schemas.Error;
977
- }
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
- }
999
- }
1000
-
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>
1022
- /**
1023
- * $checkoutCart - checkoutCart
1024
- *
1025
- * Checkouts a cart and executes the specified checkout `mode` process.
1026
- *
1027
- * A Checkout implicitly finalizes the provided cart (if not transient from a fast-checkout) and behaves in one of the following modes:
1028
- * - `create_order` (**default**): the payment happens at a later date or managed by 3rd-party CRM (SAP)
1029
- * - `create_invoice`: the payment happens on the online checkout (paypal, stripe, adyen)
1030
- * - `create_quote`: the checkout represents a price quote request
1031
- *
1032
- * Fast checkout is also supported, by passing the Cart contents directly.
1033
- * When a fast checkout is performed the cart is considered transient and there is no cart persistance.
1034
- *
1035
- * If the checkout `mode` is omitted, the `mode` will default to `create_order`.
1036
- *
1037
- */
1038
- '$checkoutCart'(
1039
- parameters?: Parameters<Paths.$CheckoutCart.HeaderParameters> | null,
1040
- data?: Paths.$CheckoutCart.RequestBody,
1041
- config?: AxiosRequestConfig
1042
- ): OperationResponse<Paths.$CheckoutCart.Responses.$200>
1043
- /**
1044
- * $searchCatalog - searchCatalog
1045
- *
1046
- * Provides a querying functionalities over products and prices of the Catalog for a given organization.
1047
- */
1048
- '$searchCatalog'(
1049
- parameters?: Parameters<Paths.$SearchCatalog.HeaderParameters> | null,
1050
- data?: Paths.$SearchCatalog.RequestBody,
1051
- config?: AxiosRequestConfig
1052
- ): OperationResponse<Paths.$SearchCatalog.Responses.$200>
1053
- /**
1054
- * $availabilityCheck - availabilityCheck
1055
- *
1056
- * The availability check endpoint
1057
- */
1058
- '$availabilityCheck'(
1059
- parameters?: Parameters<Paths.$AvailabilityCheck.HeaderParameters> | null,
1060
- data?: Paths.$AvailabilityCheck.RequestBody,
1061
- config?: AxiosRequestConfig
1062
- ): OperationResponse<Paths.$AvailabilityCheck.Responses.$200>
1063
- /**
1064
- * $createOpportunity - createOpportunity
1065
- *
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.
1067
- * The `opportunity_number` can be used to universally identify an opportunity within epilot platform.
1068
- *
1069
- */
1070
- '$createOpportunity'(
1071
- parameters?: Parameters<Paths.$CreateOpportunity.HeaderParameters> | null,
1072
- data?: Paths.$CreateOpportunity.RequestBody,
1073
- config?: AxiosRequestConfig
1074
- ): OperationResponse<Paths.$CreateOpportunity.Responses.$201>
1075
- }
1076
-
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
- }
1102
- ['/v1/public/cart:checkout']: {
1103
- /**
1104
- * $checkoutCart - checkoutCart
1105
- *
1106
- * Checkouts a cart and executes the specified checkout `mode` process.
1107
- *
1108
- * A Checkout implicitly finalizes the provided cart (if not transient from a fast-checkout) and behaves in one of the following modes:
1109
- * - `create_order` (**default**): the payment happens at a later date or managed by 3rd-party CRM (SAP)
1110
- * - `create_invoice`: the payment happens on the online checkout (paypal, stripe, adyen)
1111
- * - `create_quote`: the checkout represents a price quote request
1112
- *
1113
- * Fast checkout is also supported, by passing the Cart contents directly.
1114
- * When a fast checkout is performed the cart is considered transient and there is no cart persistance.
1115
- *
1116
- * If the checkout `mode` is omitted, the `mode` will default to `create_order`.
1117
- *
1118
- */
1119
- 'post'(
1120
- parameters?: Parameters<Paths.$CheckoutCart.HeaderParameters> | null,
1121
- data?: Paths.$CheckoutCart.RequestBody,
1122
- config?: AxiosRequestConfig
1123
- ): OperationResponse<Paths.$CheckoutCart.Responses.$200>
1124
- }
1125
- ['/v1/public/catalog']: {
1126
- /**
1127
- * $searchCatalog - searchCatalog
1128
- *
1129
- * Provides a querying functionalities over products and prices of the Catalog for a given organization.
1130
- */
1131
- 'post'(
1132
- parameters?: Parameters<Paths.$SearchCatalog.HeaderParameters> | null,
1133
- data?: Paths.$SearchCatalog.RequestBody,
1134
- config?: AxiosRequestConfig
1135
- ): OperationResponse<Paths.$SearchCatalog.Responses.$200>
1136
- }
1137
- ['/v1/public/availability:check']: {
1138
- /**
1139
- * $availabilityCheck - availabilityCheck
1140
- *
1141
- * The availability check endpoint
1142
- */
1143
- 'post'(
1144
- parameters?: Parameters<Paths.$AvailabilityCheck.HeaderParameters> | null,
1145
- data?: Paths.$AvailabilityCheck.RequestBody,
1146
- config?: AxiosRequestConfig
1147
- ): OperationResponse<Paths.$AvailabilityCheck.Responses.$200>
1148
- }
1149
- ['/v1/public/opportunity']: {
1150
- /**
1151
- * $createOpportunity - createOpportunity
1152
- *
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.
1154
- * The `opportunity_number` can be used to universally identify an opportunity within epilot platform.
1155
- *
1156
- */
1157
- 'post'(
1158
- parameters?: Parameters<Paths.$CreateOpportunity.HeaderParameters> | null,
1159
- data?: Paths.$CreateOpportunity.RequestBody,
1160
- config?: AxiosRequestConfig
1161
- ): OperationResponse<Paths.$CreateOpportunity.Responses.$201>
1162
- }
1163
- }
1164
-
1165
- export type Client = OpenAPIClient<OperationMethods, PathsDictionary>