@epilot/customer-portal-client 0.3.0 → 0.3.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
@@ -73,6 +73,8 @@ declare namespace Components {
73
73
  * 1234
74
74
  */
75
75
  secondary_identifier?: string;
76
+ network?: {
77
+ };
76
78
  }
77
79
  export interface BrandCreate {
78
80
  /**
@@ -146,7 +148,7 @@ declare namespace Components {
146
148
  * xyz@asd.com
147
149
  */
148
150
  email?: string;
149
- _tags?: string[];
151
+ _tags?: File[];
150
152
  }[];
151
153
  phone?: {
152
154
  /**
@@ -154,7 +156,7 @@ declare namespace Components {
154
156
  * +1 123
155
157
  */
156
158
  phone?: string;
157
- _tags?: string[];
159
+ _tags?: File[];
158
160
  }[];
159
161
  }
160
162
  export type ContactId = string;
@@ -172,7 +174,303 @@ declare namespace Components {
172
174
  exists: boolean;
173
175
  active?: boolean;
174
176
  }
177
+ export interface File {
178
+ /**
179
+ * example:
180
+ * file
181
+ */
182
+ type?: string;
183
+ attachments?: {
184
+ /**
185
+ * example:
186
+ * files/ckvtga827000109mibnwu2got/original
187
+ */
188
+ key?: string;
189
+ /**
190
+ * example:
191
+ * application/pdf
192
+ */
193
+ mime?: string;
194
+ /**
195
+ * example:
196
+ * Wallbox_Pulsar-Plus_technisches-Datenblatt.pdf
197
+ */
198
+ name?: string;
199
+ /**
200
+ * example:
201
+ * 171501
202
+ */
203
+ size?: number; // int32
204
+ /**
205
+ * example:
206
+ * https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original?w=100
207
+ */
208
+ image_url?: string;
209
+ /**
210
+ * example:
211
+ * https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original
212
+ */
213
+ download_url?: string;
214
+ /**
215
+ * example:
216
+ */
217
+ alt_text?: string;
218
+ }[];
219
+ }
220
+ export interface Image {
221
+ /**
222
+ * example:
223
+ * image
224
+ */
225
+ type?: string;
226
+ attachments?: {
227
+ /**
228
+ * example:
229
+ * files/ckvtga2n1000009mifvbs1z0m/original
230
+ */
231
+ key?: string;
232
+ /**
233
+ * example:
234
+ * image/jpeg
235
+ */
236
+ mime?: string;
237
+ /**
238
+ * example:
239
+ * juice-charger-me_set.jpeg
240
+ */
241
+ name?: string;
242
+ /**
243
+ * example:
244
+ * 25618
245
+ */
246
+ size?: number; // int32
247
+ /**
248
+ * example:
249
+ * https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original?w=100
250
+ */
251
+ image_url?: string;
252
+ /**
253
+ * example:
254
+ * https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original
255
+ */
256
+ download_url?: string;
257
+ /**
258
+ * example:
259
+ */
260
+ alt_text?: string;
261
+ }[];
262
+ }
175
263
  export type InviteToken = string;
264
+ export interface Order {
265
+ /**
266
+ * example:
267
+ * 123
268
+ */
269
+ id?: string;
270
+ metadata?: {
271
+ /**
272
+ * example:
273
+ * _origin
274
+ */
275
+ key?: string;
276
+ /**
277
+ * example:
278
+ * journey checkout
279
+ */
280
+ value?: string;
281
+ }[];
282
+ _tags?: File[];
283
+ /**
284
+ * example:
285
+ * 123234
286
+ */
287
+ order_number?: string;
288
+ /**
289
+ * example:
290
+ * Draft
291
+ */
292
+ status?: string;
293
+ /**
294
+ * example:
295
+ * John
296
+ */
297
+ billing_first_name?: string;
298
+ /**
299
+ * example:
300
+ * Doe
301
+ */
302
+ billing_last_name?: string;
303
+ /**
304
+ * example:
305
+ * john@doe.com
306
+ */
307
+ billing_email?: string;
308
+ /**
309
+ * example:
310
+ * 12344556
311
+ */
312
+ billing_phone?: string;
313
+ /**
314
+ * example:
315
+ * ABC Company
316
+ */
317
+ billing_company_name?: string;
318
+ /**
319
+ * example:
320
+ * 123456
321
+ */
322
+ billing_vat?: string;
323
+ billing_address?: {
324
+ /**
325
+ * example:
326
+ * Street 1
327
+ */
328
+ street?: string;
329
+ /**
330
+ * example:
331
+ * 11
332
+ */
333
+ street_number?: string;
334
+ /**
335
+ * example:
336
+ * Cologne
337
+ */
338
+ city?: string;
339
+ /**
340
+ * example:
341
+ * 10201
342
+ */
343
+ postal_code?: string;
344
+ /**
345
+ * example:
346
+ * de
347
+ */
348
+ country?: string;
349
+ }[];
350
+ delivery_address?: {
351
+ /**
352
+ * example:
353
+ * Street 1
354
+ */
355
+ street?: string;
356
+ /**
357
+ * example:
358
+ * 11
359
+ */
360
+ street_number?: string;
361
+ /**
362
+ * example:
363
+ * Cologne
364
+ */
365
+ city?: string;
366
+ /**
367
+ * example:
368
+ * 10201
369
+ */
370
+ postal_code?: string;
371
+ /**
372
+ * example:
373
+ * de
374
+ */
375
+ country?: string;
376
+ }[];
377
+ payment_method?: {
378
+ /**
379
+ * example:
380
+ * BankTransfer
381
+ */
382
+ type?: string;
383
+ }[];
384
+ /**
385
+ * example:
386
+ * EUR
387
+ */
388
+ currency?: string;
389
+ line_items?: OrderLineItem[];
390
+ /**
391
+ * example:
392
+ * 100
393
+ */
394
+ amount_subtotal?: number;
395
+ /**
396
+ * example:
397
+ * 100
398
+ */
399
+ amount_total?: number;
400
+ total_details?: {
401
+ /**
402
+ * example:
403
+ * 300
404
+ */
405
+ type?: any;
406
+ breakdown?: {
407
+ taxes?: Tax[];
408
+ };
409
+ };
410
+ org?: {
411
+ /**
412
+ * example:
413
+ * 123
414
+ */
415
+ id?: string;
416
+ /**
417
+ * example:
418
+ * https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
419
+ */
420
+ logo_url?: string;
421
+ /**
422
+ * example:
423
+ * https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
424
+ */
425
+ logo_thumbnail_url?: string;
426
+ };
427
+ }
428
+ export type OrderId = string;
429
+ export interface OrderLineItem {
430
+ /**
431
+ * example:
432
+ * 4f92b831-6465-4929-9dd3-3d64b5a33514
433
+ */
434
+ product_id?: string;
435
+ /**
436
+ * example:
437
+ * 4db12bb3-1773-409e-9f97-a2d8f5482142
438
+ */
439
+ price_id?: string;
440
+ _product?: Product;
441
+ _price?: Price;
442
+ /**
443
+ * example:
444
+ * 1
445
+ */
446
+ quantity?: number; // int32
447
+ /**
448
+ * example:
449
+ * EUR
450
+ */
451
+ currency?: string;
452
+ /**
453
+ * example:
454
+ * Winter Lease
455
+ */
456
+ description?: string;
457
+ /**
458
+ * example:
459
+ * 12055
460
+ */
461
+ unit_amount?: number; // int32
462
+ /**
463
+ * example:
464
+ * 12055
465
+ */
466
+ amount_subtotal?: number; // int32
467
+ /**
468
+ * example:
469
+ * 14346
470
+ */
471
+ amount_total?: number; // int32
472
+ taxes?: Tax[];
473
+ }
176
474
  export interface PortalConfig {
177
475
  auth_config?: AuthConfig;
178
476
  }
@@ -200,10 +498,219 @@ declare namespace Components {
200
498
  * xyz@asd.com
201
499
  */
202
500
  email?: string;
203
- _tags?: string[];
501
+ _tags?: File[];
204
502
  }[];
205
503
  }
206
504
  export type PortalUserId = string;
505
+ export interface Price {
506
+ /**
507
+ * example:
508
+ * 4db12bb3-1773-409e-9f97-a2d8f5482142
509
+ */
510
+ _id?: string;
511
+ /**
512
+ * example:
513
+ * 12055
514
+ */
515
+ unit_amount?: number; // int32
516
+ /**
517
+ * example:
518
+ * Recurring
519
+ */
520
+ type?: string;
521
+ /**
522
+ * example:
523
+ * Monthly
524
+ */
525
+ billing_period?: string;
526
+ /**
527
+ * example:
528
+ * 1
529
+ */
530
+ billing_duration_amount?: string;
531
+ /**
532
+ * example:
533
+ * Years
534
+ */
535
+ billing_duration_unit?: string;
536
+ /**
537
+ * example:
538
+ * 3
539
+ */
540
+ notice_time_amount?: string;
541
+ /**
542
+ * example:
543
+ * Months
544
+ */
545
+ notice_time_unit?: string;
546
+ /**
547
+ * example:
548
+ * 1
549
+ */
550
+ termination_time_amount?: string;
551
+ /**
552
+ * example:
553
+ * Months
554
+ */
555
+ termination_time_unit?: string;
556
+ /**
557
+ * example:
558
+ * 1
559
+ */
560
+ renewal_duration_amount?: string;
561
+ /**
562
+ * example:
563
+ * Years
564
+ */
565
+ renewal_duration_unit?: string;
566
+ active?: boolean;
567
+ /**
568
+ * example:
569
+ * Standard (19%)
570
+ */
571
+ sales_tax?: string;
572
+ /**
573
+ * example:
574
+ * Exclusive (Price amount excludes Tax)
575
+ */
576
+ tax_behavior?: string;
577
+ /**
578
+ * example:
579
+ * Winter Lease
580
+ */
581
+ description?: string;
582
+ /**
583
+ * example:
584
+ * Per Unit
585
+ */
586
+ billing_scheme?: string;
587
+ /**
588
+ * example:
589
+ * Standard
590
+ */
591
+ tiers_mode?: string;
592
+ /**
593
+ * example:
594
+ * price
595
+ */
596
+ _schema?: string;
597
+ /**
598
+ * example:
599
+ * 739224
600
+ */
601
+ _org?: string;
602
+ /**
603
+ * example:
604
+ * "2021-11-10T11:58:24.322Z"
605
+ */
606
+ _created_at?: string;
607
+ /**
608
+ * example:
609
+ * "2021-11-26T11:50:15.574Z"
610
+ */
611
+ _updated_at?: string;
612
+ /**
613
+ * example:
614
+ * Winter Lease
615
+ */
616
+ _title?: string;
617
+ /**
618
+ * example:
619
+ * 120.55456634
620
+ */
621
+ unit_amount_decimal?: string;
622
+ /**
623
+ * example:
624
+ * EUR
625
+ */
626
+ unit_amount_currency?: string;
627
+ }
628
+ export interface Product {
629
+ /**
630
+ * example:
631
+ * Product
632
+ */
633
+ type?: string;
634
+ /**
635
+ * example:
636
+ * JUICE CHARGER Wallbox
637
+ */
638
+ name?: string;
639
+ active?: boolean;
640
+ /**
641
+ * example:
642
+ * EL-JCME11
643
+ */
644
+ code?: string;
645
+ categories?: string[];
646
+ feature?: {
647
+ _tags?: any[];
648
+ /**
649
+ * example:
650
+ * Test new feature
651
+ */
652
+ feature?: string;
653
+ }[];
654
+ /**
655
+ * example:
656
+ * product
657
+ */
658
+ _schema?: string;
659
+ /**
660
+ * example:
661
+ * 4f92b831-6465-4929-9dd3-3d64b5a33514
662
+ */
663
+ _id?: string;
664
+ /**
665
+ * example:
666
+ * 739224
667
+ */
668
+ _org?: string;
669
+ /**
670
+ * example:
671
+ * "2021-11-10T09:48:16.834Z"
672
+ */
673
+ _created_at?: string;
674
+ /**
675
+ * example:
676
+ * "2021-12-08T10:37:21.833Z"
677
+ */
678
+ _updated_at?: string;
679
+ /**
680
+ * example:
681
+ * JUICE CHARGER Wallbox
682
+ */
683
+ _title?: string;
684
+ price_options?: {
685
+ $relation?: {
686
+ /**
687
+ * example:
688
+ * 48e1792e-79a5-49be-92dc-e50c7ddbf96c
689
+ */
690
+ entity_id?: string;
691
+ }[];
692
+ };
693
+ _images?: Image;
694
+ _files?: File;
695
+ _tags?: File[];
696
+ }
697
+ /**
698
+ * example:
699
+ * primary
700
+ */
701
+ export type Tag = string;
702
+ export interface Tax {
703
+ /**
704
+ * example:
705
+ * Standard (19%)
706
+ */
707
+ rate?: string;
708
+ /**
709
+ * example:
710
+ * 2291
711
+ */
712
+ amount?: number; // int32
713
+ }
207
714
  export interface UserActivationPayload {
208
715
  /**
209
716
  * User's display name (default: email address)
@@ -230,6 +737,33 @@ declare namespace Paths {
230
737
  }
231
738
  export type RequestBody = Components.Schemas.UserActivationPayload;
232
739
  }
740
+ namespace ConfigureDistribution {
741
+ namespace Parameters {
742
+ /**
743
+ * example:
744
+ * 123
745
+ */
746
+ export type BrandId = string;
747
+ /**
748
+ * example:
749
+ * 123
750
+ */
751
+ export type OrgId = string;
752
+ }
753
+ export interface QueryParameters {
754
+ org_id: Parameters.OrgId;
755
+ brand_id: Parameters.BrandId;
756
+ }
757
+ namespace Responses {
758
+ export interface $200 {
759
+ /**
760
+ * example:
761
+ * dsj8op4ha01jha23.cloudfront.net
762
+ */
763
+ domainName?: string;
764
+ }
765
+ }
766
+ }
233
767
  namespace ConfirmUser {
234
768
  namespace Parameters {
235
769
  export type Id = Components.Schemas.PortalUserId;
@@ -326,6 +860,29 @@ declare namespace Paths {
326
860
  export type $200 = string;
327
861
  }
328
862
  }
863
+ namespace GetAllOrders {
864
+ namespace Parameters {
865
+ /**
866
+ * example:
867
+ * 123
868
+ */
869
+ export type OrgId = string;
870
+ /**
871
+ * example:
872
+ * 123
873
+ */
874
+ export type UserId = string;
875
+ }
876
+ export interface QueryParameters {
877
+ user_id: Parameters.UserId;
878
+ org_id: Parameters.OrgId;
879
+ }
880
+ namespace Responses {
881
+ export interface $200 {
882
+ data?: Components.Schemas.Order[];
883
+ }
884
+ }
885
+ }
329
886
  namespace GetContact {
330
887
  namespace Parameters {
331
888
  export type Id = Components.Schemas.ContactId;
@@ -343,6 +900,7 @@ declare namespace Paths {
343
900
  }
344
901
  namespace Responses {
345
902
  export type $200 = Components.Schemas.Contact;
903
+ export type $500 = Components.Schemas.ErrorResp;
346
904
  }
347
905
  }
348
906
  namespace GetCountByEmail {
@@ -372,6 +930,27 @@ declare namespace Paths {
372
930
  }
373
931
  }
374
932
  }
933
+ namespace GetOrder {
934
+ namespace Parameters {
935
+ export type Id = Components.Schemas.OrderId;
936
+ /**
937
+ * example:
938
+ * 123
939
+ */
940
+ export type OrgId = string;
941
+ }
942
+ export interface PathParameters {
943
+ id: Parameters.Id;
944
+ }
945
+ export interface QueryParameters {
946
+ org_id: Parameters.OrgId;
947
+ }
948
+ namespace Responses {
949
+ export interface $200 {
950
+ data?: Components.Schemas.Order;
951
+ }
952
+ }
953
+ }
375
954
  namespace GetPortalConfig {
376
955
  namespace Parameters {
377
956
  /**
@@ -592,7 +1171,7 @@ export interface OperationMethods {
592
1171
  parameters?: Parameters<Paths.GetContact.PathParameters & Paths.GetContact.QueryParameters> | null,
593
1172
  data?: any,
594
1173
  config?: AxiosRequestConfig
595
- ): OperationResponse<Paths.GetContact.Responses.$200>
1174
+ ): OperationResponse<Paths.GetContact.Responses.$200 | Paths.GetContact.Responses.$500>
596
1175
  /**
597
1176
  * updateContact - updateContact
598
1177
  *
@@ -673,6 +1252,36 @@ export interface OperationMethods {
673
1252
  data?: any,
674
1253
  config?: AxiosRequestConfig
675
1254
  ): OperationResponse<Paths.UserExists.Responses.$200 | Paths.UserExists.Responses.$404>
1255
+ /**
1256
+ * configureDistribution - configureDistribution
1257
+ *
1258
+ * TODO
1259
+ */
1260
+ 'configureDistribution'(
1261
+ parameters?: Parameters<Paths.ConfigureDistribution.QueryParameters> | null,
1262
+ data?: any,
1263
+ config?: AxiosRequestConfig
1264
+ ): OperationResponse<Paths.ConfigureDistribution.Responses.$200>
1265
+ /**
1266
+ * getAllOrders - getAllOrders
1267
+ *
1268
+ * TODO
1269
+ */
1270
+ 'getAllOrders'(
1271
+ parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null,
1272
+ data?: any,
1273
+ config?: AxiosRequestConfig
1274
+ ): OperationResponse<Paths.GetAllOrders.Responses.$200>
1275
+ /**
1276
+ * getOrder - getOrder
1277
+ *
1278
+ * TODO
1279
+ */
1280
+ 'getOrder'(
1281
+ parameters?: Parameters<Paths.GetOrder.PathParameters & Paths.GetOrder.QueryParameters> | null,
1282
+ data?: any,
1283
+ config?: AxiosRequestConfig
1284
+ ): OperationResponse<Paths.GetOrder.Responses.$200>
676
1285
  }
677
1286
 
678
1287
  export interface PathsDictionary {
@@ -758,7 +1367,7 @@ export interface PathsDictionary {
758
1367
  parameters?: Parameters<Paths.GetContact.PathParameters & Paths.GetContact.QueryParameters> | null,
759
1368
  data?: any,
760
1369
  config?: AxiosRequestConfig
761
- ): OperationResponse<Paths.GetContact.Responses.$200>
1370
+ ): OperationResponse<Paths.GetContact.Responses.$200 | Paths.GetContact.Responses.$500>
762
1371
  /**
763
1372
  * updateContact - updateContact
764
1373
  *
@@ -850,6 +1459,42 @@ export interface PathsDictionary {
850
1459
  config?: AxiosRequestConfig
851
1460
  ): OperationResponse<Paths.UserExists.Responses.$200 | Paths.UserExists.Responses.$404>
852
1461
  }
1462
+ ['/v1/customer-portal/configure-distribution']: {
1463
+ /**
1464
+ * configureDistribution - configureDistribution
1465
+ *
1466
+ * TODO
1467
+ */
1468
+ 'get'(
1469
+ parameters?: Parameters<Paths.ConfigureDistribution.QueryParameters> | null,
1470
+ data?: any,
1471
+ config?: AxiosRequestConfig
1472
+ ): OperationResponse<Paths.ConfigureDistribution.Responses.$200>
1473
+ }
1474
+ ['/v1/customer-portal/order']: {
1475
+ /**
1476
+ * getAllOrders - getAllOrders
1477
+ *
1478
+ * TODO
1479
+ */
1480
+ 'get'(
1481
+ parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null,
1482
+ data?: any,
1483
+ config?: AxiosRequestConfig
1484
+ ): OperationResponse<Paths.GetAllOrders.Responses.$200>
1485
+ }
1486
+ ['/v1/customer-portal/order/{id}']: {
1487
+ /**
1488
+ * getOrder - getOrder
1489
+ *
1490
+ * TODO
1491
+ */
1492
+ 'get'(
1493
+ parameters?: Parameters<Paths.GetOrder.PathParameters & Paths.GetOrder.QueryParameters> | null,
1494
+ data?: any,
1495
+ config?: AxiosRequestConfig
1496
+ ): OperationResponse<Paths.GetOrder.Responses.$200>
1497
+ }
853
1498
  }
854
1499
 
855
1500
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>