@epilot/customer-portal-client 0.7.2 → 0.7.3

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.
Files changed (2) hide show
  1. package/package.json +3 -3
  2. package/src/openapi.d.ts +0 -2147
package/src/openapi.d.ts DELETED
@@ -1,2147 +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 AddPortalResp {
13
- message?: string;
14
- }
15
- export interface AuthConfig {
16
- /**
17
- * example:
18
- * eu-central-1_CUEQRNbUb
19
- */
20
- user_pool_id: string;
21
- /**
22
- * example:
23
- * 6bsd0jkgoie74k2i8mrhc1vest
24
- */
25
- user_pool_client_id: string;
26
- /**
27
- * example:
28
- * eu-central-1:a63af1f7-ab86-4ab5-a0eb-f461cb37c2b1
29
- */
30
- user_pool_identity_pool_id?: string;
31
- /**
32
- * example:
33
- * 7h2hwdj7hhjsdcjkq03eidna3ep
34
- */
35
- portal_id: string;
36
- }
37
- /**
38
- * example:
39
- * {
40
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
41
- * "_org": "123",
42
- * "_schema": "contact",
43
- * "_tags": [
44
- * "example",
45
- * "mock"
46
- * ],
47
- * "_created_at": "2021-02-09T12:41:43.662Z",
48
- * "_updated_at": "2021-02-09T12:41:43.662Z"
49
- * }
50
- */
51
- export interface BaseEntity {
52
- _id: EntityId;
53
- /**
54
- * Title of entity
55
- */
56
- _title: string;
57
- /**
58
- * Organization Id the entity belongs to
59
- */
60
- _org: string;
61
- _schema: /**
62
- * URL-friendly identifier for the entity schema
63
- * example:
64
- * contact
65
- */
66
- EntitySlug;
67
- _tags?: string[];
68
- _created_at: string; // date-time
69
- _updated_at: string; // date-time
70
- }
71
- export interface Brand {
72
- /**
73
- * example:
74
- * 12345
75
- */
76
- id?: string;
77
- /**
78
- * example:
79
- * test@test.com
80
- */
81
- domain?: string;
82
- /**
83
- * example:
84
- * true
85
- */
86
- enabled?: boolean;
87
- /**
88
- * example:
89
- * true
90
- */
91
- is_epilot_domain?: boolean;
92
- /**
93
- * example:
94
- * 3134
95
- */
96
- design_id?: string;
97
- default_user_to_notify?: {
98
- [key: string]: any;
99
- };
100
- cognito_details?: {
101
- /**
102
- * example:
103
- * 6bsd0jkgoie74k2i8mrhc1vest
104
- */
105
- cognito_user_pool_client_id?: string;
106
- /**
107
- * example:
108
- * arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341
109
- */
110
- cognito_user_pool_arn?: string;
111
- /**
112
- * example:
113
- * eu-central-1_CUEQRNbUb
114
- */
115
- cognito_user_pool_id?: string;
116
- };
117
- config?: string;
118
- /**
119
- * example:
120
- * full_name
121
- */
122
- contact_secondary_identifier?: string;
123
- email_templates?: {
124
- /**
125
- * example:
126
- * 701f089d-6953-48b5-ac35-442de7c59cd3
127
- */
128
- confirmAccount?: string;
129
- /**
130
- * example:
131
- * 6538fddb-f0e9-4f0f-af51-6e57891ff20a
132
- */
133
- forgotPassword?: string;
134
- /**
135
- * example:
136
- * 14ae65fb-0dc1-4863-8743-6bc01da469f6
137
- */
138
- invitation?: string;
139
- };
140
- grants?: Grant[];
141
- images?: {
142
- /**
143
- * example:
144
- * https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg
145
- */
146
- orderLeftTeaser?: string;
147
- /**
148
- * example:
149
- * https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg
150
- */
151
- orderRightTeaser?: string;
152
- /**
153
- * example:
154
- * https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg
155
- */
156
- welcomeBanner?: string;
157
- };
158
- entity_identifiers?: {
159
- [name: string]: {
160
- isEnabled?: boolean;
161
- attributes?: string[];
162
- };
163
- };
164
- entity_actions?: {
165
- journey_id?: string;
166
- slug?: /**
167
- * URL-friendly identifier for the entity schema
168
- * example:
169
- * contact
170
- */
171
- EntitySlug;
172
- action_Label?: {
173
- en?: string;
174
- de?: string;
175
- };
176
- }[];
177
- }
178
- export interface DeleteEntityFile {
179
- /**
180
- * example:
181
- * 123456
182
- */
183
- entity_id: string;
184
- /**
185
- * example:
186
- * order
187
- */
188
- entity_type: string;
189
- file_entity_ids: string[];
190
- }
191
- export interface EmailTemplates {
192
- confirmAccount?: string;
193
- forgotPassword?: string;
194
- invitation?: string;
195
- onNewQuote?: string;
196
- onMapAPendingUser?: string;
197
- }
198
- export interface Entity {
199
- [name: string]: any;
200
- }
201
- export type EntityId = string;
202
- /**
203
- * example:
204
- * {
205
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
206
- * "_org": "123",
207
- * "_schema": "contact",
208
- * "_tags": [
209
- * "example",
210
- * "mock"
211
- * ],
212
- * "_created_at": {},
213
- * "_updated_at": {}
214
- * }
215
- */
216
- export interface EntityItem {
217
- [name: string]: any;
218
- _id: EntityId;
219
- /**
220
- * Title of entity
221
- */
222
- _title: string;
223
- /**
224
- * Organization Id the entity belongs to
225
- */
226
- _org: string;
227
- _schema: /**
228
- * URL-friendly identifier for the entity schema
229
- * example:
230
- * contact
231
- */
232
- EntitySlug;
233
- _tags?: string[];
234
- _created_at: string; // date-time
235
- _updated_at: string; // date-time
236
- }
237
- /**
238
- * URL-friendly identifier for the entity schema
239
- * example:
240
- * contact
241
- */
242
- export type EntitySlug = string;
243
- export interface ErrorResp {
244
- message?: string;
245
- }
246
- /**
247
- * example:
248
- * {
249
- * "exists": true,
250
- * "active": false
251
- * }
252
- */
253
- export interface Exists {
254
- exists: boolean;
255
- active?: boolean;
256
- }
257
- export type ExtraSchemaAttributes = {
258
- name?: string;
259
- label?: string;
260
- group?: string;
261
- }[];
262
- export interface Grant {
263
- /**
264
- * example:
265
- * entity-read
266
- */
267
- action: string;
268
- /**
269
- * example:
270
- * entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947
271
- */
272
- resource?: string;
273
- effect?: "allow" | "deny";
274
- }
275
- export type InviteToken = string;
276
- export interface OrganizationSettings {
277
- automation_entity_mapping?: {
278
- enabled?: boolean;
279
- };
280
- automation_preview?: {
281
- enabled?: boolean;
282
- };
283
- central_inbox_preview_setting?: {
284
- enabled?: boolean;
285
- };
286
- contracts_preview_setting?: {
287
- enabled?: boolean;
288
- };
289
- disable_ivy?: {
290
- enabled?: boolean;
291
- };
292
- double_opt_in?: {
293
- enabled?: boolean;
294
- };
295
- ecommerce_catalog_preview?: {
296
- enabled?: boolean;
297
- };
298
- ecommerce_opportunities_preview?: {
299
- enabled?: boolean;
300
- };
301
- ecommerce_preview?: {
302
- enabled?: boolean;
303
- };
304
- end_customer_portal?: {
305
- enabled?: boolean;
306
- };
307
- entity_schema_builder?: {
308
- enabled?: boolean;
309
- };
310
- logic_editor_preview?: {
311
- enabled?: boolean;
312
- };
313
- new_navigation?: {
314
- enabled?: boolean;
315
- };
316
- partnering?: {
317
- enabled?: boolean;
318
- };
319
- "product-availability"?: {
320
- enabled?: boolean;
321
- };
322
- sso?: {
323
- enabled?: boolean;
324
- };
325
- submission_preview?: {
326
- enabled?: boolean;
327
- };
328
- user_roles_preview?: {
329
- enabled?: boolean;
330
- };
331
- }
332
- export interface PortalConfig {
333
- auth_config?: AuthConfig;
334
- }
335
- export interface SaveEntityFile {
336
- /**
337
- * example:
338
- * 123456
339
- */
340
- entity_id: string;
341
- /**
342
- * example:
343
- * order
344
- */
345
- entity_type: string;
346
- files: {
347
- /**
348
- * example:
349
- * 12345
350
- */
351
- filename: string;
352
- /**
353
- * example:
354
- * 12345
355
- */
356
- file_entity_id?: string;
357
- /**
358
- * example:
359
- * 12345
360
- */
361
- document_type?: string;
362
- access_control?: "private" | "public-read";
363
- _tags?: string[];
364
- s3ref: {
365
- /**
366
- * example:
367
- * 12345
368
- */
369
- bucket: string;
370
- /**
371
- * example:
372
- * 12345
373
- */
374
- key: string;
375
- };
376
- }[];
377
- }
378
- export interface SavePortalFile {
379
- files: {
380
- /**
381
- * example:
382
- * 12345
383
- */
384
- filename?: string;
385
- /**
386
- * example:
387
- * orderRightTeaser
388
- */
389
- file_type: string;
390
- _tags?: string[];
391
- s3ref?: {
392
- /**
393
- * example:
394
- * 12345
395
- */
396
- bucket: string;
397
- /**
398
- * example:
399
- * 12345
400
- */
401
- key: string;
402
- };
403
- }[];
404
- }
405
- export interface UserActivationPayload {
406
- /**
407
- * User's display name (default: email address)
408
- * example:
409
- * Example User
410
- */
411
- display_name?: string;
412
- /**
413
- * User's password
414
- * example:
415
- * AKjhdakjsdh@!34
416
- */
417
- password?: string;
418
- }
419
- }
420
- }
421
- declare namespace Paths {
422
- namespace ActivateUser {
423
- namespace Parameters {
424
- export type Token = Components.Schemas.InviteToken;
425
- }
426
- export interface QueryParameters {
427
- token: Parameters.Token;
428
- }
429
- export type RequestBody = Components.Schemas.UserActivationPayload;
430
- namespace Responses {
431
- export interface $200 {
432
- }
433
- export interface $404 {
434
- }
435
- }
436
- }
437
- namespace AddEndCustomerRelationToEntity {
438
- namespace Parameters {
439
- export type Id = Components.Schemas.EntityId;
440
- export type Slug = /**
441
- * URL-friendly identifier for the entity schema
442
- * example:
443
- * contact
444
- */
445
- Components.Schemas.EntitySlug;
446
- }
447
- export interface PathParameters {
448
- slug: Parameters.Slug;
449
- id: Parameters.Id;
450
- }
451
- namespace Responses {
452
- export interface $200 {
453
- entity?: /**
454
- * example:
455
- * {
456
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
457
- * "_org": "123",
458
- * "_schema": "contact",
459
- * "_tags": [
460
- * "example",
461
- * "mock"
462
- * ],
463
- * "_created_at": {},
464
- * "_updated_at": {}
465
- * }
466
- */
467
- Components.Schemas.EntityItem;
468
- relations?: /**
469
- * example:
470
- * {
471
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
472
- * "_org": "123",
473
- * "_schema": "contact",
474
- * "_tags": [
475
- * "example",
476
- * "mock"
477
- * ],
478
- * "_created_at": {},
479
- * "_updated_at": {}
480
- * }
481
- */
482
- Components.Schemas.EntityItem[];
483
- }
484
- }
485
- }
486
- namespace ConfigureDistribution {
487
- namespace Responses {
488
- export interface $200 {
489
- /**
490
- * example:
491
- * dsj8op4ha01jha23.cloudfront.net
492
- */
493
- domainName?: string;
494
- }
495
- }
496
- }
497
- namespace ConfirmUser {
498
- namespace Parameters {
499
- export type Id = Components.Schemas.EntityId;
500
- /**
501
- * example:
502
- * 123
503
- */
504
- export type OrgId = string;
505
- }
506
- export interface PathParameters {
507
- id: Parameters.Id;
508
- }
509
- export interface QueryParameters {
510
- org_id: /**
511
- * example:
512
- * 123
513
- */
514
- Parameters.OrgId;
515
- }
516
- namespace Responses {
517
- export type $200 = /**
518
- * example:
519
- * {
520
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
521
- * "_org": "123",
522
- * "_schema": "contact",
523
- * "_tags": [
524
- * "example",
525
- * "mock"
526
- * ],
527
- * "_created_at": {},
528
- * "_updated_at": {}
529
- * }
530
- */
531
- Components.Schemas.EntityItem;
532
- }
533
- }
534
- namespace CreateUser {
535
- export interface RequestBody {
536
- /**
537
- * example:
538
- * testemail921@yopmail.com
539
- */
540
- email?: string;
541
- /**
542
- * example:
543
- * Pass1234!
544
- */
545
- password?: string;
546
- /**
547
- * example:
548
- * 728
549
- */
550
- orgId?: string;
551
- /**
552
- * example:
553
- * eu-central-1_391JDA1HFO
554
- */
555
- userPoolId?: string;
556
- /**
557
- * example:
558
- * aj123jfoavnashf2fj
559
- */
560
- clientId?: string;
561
- /**
562
- * example:
563
- * 123456
564
- */
565
- secondaryIdentifier?: string;
566
- /**
567
- * example:
568
- * 123456
569
- */
570
- contactId?: string;
571
- }
572
- namespace Responses {
573
- export type $201 = Components.Schemas.AddPortalResp;
574
- export type $400 = Components.Schemas.ErrorResp;
575
- export type $401 = Components.Schemas.ErrorResp;
576
- export type $500 = Components.Schemas.ErrorResp;
577
- }
578
- }
579
- namespace DeleteEntityFile {
580
- export type RequestBody = Components.Schemas.DeleteEntityFile;
581
- namespace Responses {
582
- export interface $200 {
583
- deletedFiles?: string[];
584
- }
585
- }
586
- }
587
- namespace DeletePortalUser {
588
- namespace Responses {
589
- /**
590
- * example:
591
- * 123
592
- */
593
- export type $200 = string;
594
- }
595
- }
596
- namespace ExtraPermissionAttributes {
597
- namespace Responses {
598
- export interface $200 {
599
- data?: {
600
- contact?: Components.Schemas.ExtraSchemaAttributes;
601
- contract?: Components.Schemas.ExtraSchemaAttributes;
602
- order?: Components.Schemas.ExtraSchemaAttributes;
603
- opportunity?: Components.Schemas.ExtraSchemaAttributes;
604
- };
605
- }
606
- }
607
- }
608
- namespace GetAllContracts {
609
- namespace Responses {
610
- export interface $200 {
611
- data?: /**
612
- * example:
613
- * {
614
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
615
- * "_org": "123",
616
- * "_schema": "contact",
617
- * "_tags": [
618
- * "example",
619
- * "mock"
620
- * ],
621
- * "_created_at": {},
622
- * "_updated_at": {}
623
- * }
624
- */
625
- Components.Schemas.EntityItem[];
626
- }
627
- }
628
- }
629
- namespace GetAllOpportunities {
630
- namespace Responses {
631
- export interface $200 {
632
- data?: /**
633
- * example:
634
- * {
635
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
636
- * "_org": "123",
637
- * "_schema": "contact",
638
- * "_tags": [
639
- * "example",
640
- * "mock"
641
- * ],
642
- * "_created_at": {},
643
- * "_updated_at": {}
644
- * }
645
- */
646
- Components.Schemas.EntityItem[];
647
- }
648
- }
649
- }
650
- namespace GetAllOrders {
651
- namespace Responses {
652
- export interface $200 {
653
- data?: /**
654
- * example:
655
- * {
656
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
657
- * "_org": "123",
658
- * "_schema": "contact",
659
- * "_tags": [
660
- * "example",
661
- * "mock"
662
- * ],
663
- * "_created_at": {},
664
- * "_updated_at": {}
665
- * }
666
- */
667
- Components.Schemas.EntityItem[];
668
- }
669
- }
670
- }
671
- namespace GetContact {
672
- namespace Responses {
673
- export type $200 = /**
674
- * example:
675
- * {
676
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
677
- * "_org": "123",
678
- * "_schema": "contact",
679
- * "_tags": [
680
- * "example",
681
- * "mock"
682
- * ],
683
- * "_created_at": {},
684
- * "_updated_at": {}
685
- * }
686
- */
687
- Components.Schemas.EntityItem;
688
- export type $500 = Components.Schemas.ErrorResp;
689
- }
690
- }
691
- namespace GetContract {
692
- namespace Parameters {
693
- export type Id = Components.Schemas.EntityId;
694
- }
695
- export interface PathParameters {
696
- id: Parameters.Id;
697
- }
698
- namespace Responses {
699
- export interface $200 {
700
- entity?: /**
701
- * example:
702
- * {
703
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
704
- * "_org": "123",
705
- * "_schema": "contact",
706
- * "_tags": [
707
- * "example",
708
- * "mock"
709
- * ],
710
- * "_created_at": {},
711
- * "_updated_at": {}
712
- * }
713
- */
714
- Components.Schemas.EntityItem;
715
- relations?: /**
716
- * example:
717
- * {
718
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
719
- * "_org": "123",
720
- * "_schema": "contact",
721
- * "_tags": [
722
- * "example",
723
- * "mock"
724
- * ],
725
- * "_created_at": {},
726
- * "_updated_at": {}
727
- * }
728
- */
729
- Components.Schemas.EntityItem[];
730
- }
731
- }
732
- }
733
- namespace GetCountByEmail {
734
- namespace Parameters {
735
- /**
736
- * example:
737
- * test@test.com
738
- */
739
- export type Email = string;
740
- /**
741
- * example:
742
- * 123
743
- */
744
- export type OrgId = string;
745
- }
746
- export interface QueryParameters {
747
- email: /**
748
- * example:
749
- * test@test.com
750
- */
751
- Parameters.Email;
752
- org_id: /**
753
- * example:
754
- * 123
755
- */
756
- Parameters.OrgId;
757
- }
758
- namespace Responses {
759
- export interface $200 {
760
- /**
761
- * example:
762
- * 2
763
- */
764
- count?: number;
765
- }
766
- }
767
- }
768
- namespace GetECPContact {
769
- namespace Parameters {
770
- /**
771
- * example:
772
- * 1234
773
- */
774
- export type Id = string;
775
- }
776
- export interface QueryParameters {
777
- id: /**
778
- * example:
779
- * 1234
780
- */
781
- Parameters.Id;
782
- }
783
- namespace Responses {
784
- export type $200 = /**
785
- * example:
786
- * {
787
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
788
- * "_org": "123",
789
- * "_schema": "contact",
790
- * "_tags": [
791
- * "example",
792
- * "mock"
793
- * ],
794
- * "_created_at": {},
795
- * "_updated_at": {}
796
- * }
797
- */
798
- Components.Schemas.EntityItem;
799
- export type $500 = Components.Schemas.ErrorResp;
800
- }
801
- }
802
- namespace GetEmailTemplates {
803
- namespace Responses {
804
- export type $200 = Components.Schemas.EmailTemplates;
805
- }
806
- }
807
- namespace GetEntitiesByIdentifiers {
808
- namespace Parameters {
809
- export type Slug = /**
810
- * URL-friendly identifier for the entity schema
811
- * example:
812
- * contact
813
- */
814
- Components.Schemas.EntitySlug;
815
- }
816
- export interface PathParameters {
817
- slug: Parameters.Slug;
818
- }
819
- export type RequestBody = Components.Schemas.Entity;
820
- namespace Responses {
821
- export interface $200 {
822
- data?: /**
823
- * example:
824
- * {
825
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
826
- * "_org": "123",
827
- * "_schema": "contact",
828
- * "_tags": [
829
- * "example",
830
- * "mock"
831
- * ],
832
- * "_created_at": {},
833
- * "_updated_at": {}
834
- * }
835
- */
836
- Components.Schemas.EntityItem[];
837
- }
838
- }
839
- }
840
- namespace GetEntityIdentifiers {
841
- namespace Parameters {
842
- export type Slug = /**
843
- * URL-friendly identifier for the entity schema
844
- * example:
845
- * contact
846
- */
847
- Components.Schemas.EntitySlug;
848
- }
849
- export interface PathParameters {
850
- slug: Parameters.Slug;
851
- }
852
- namespace Responses {
853
- export interface $200 {
854
- data?: {
855
- /**
856
- * example:
857
- * contract_number
858
- */
859
- name?: string;
860
- /**
861
- * example:
862
- * string
863
- */
864
- type?: string;
865
- }[];
866
- }
867
- }
868
- }
869
- namespace GetOpportunity {
870
- namespace Parameters {
871
- export type Id = Components.Schemas.EntityId;
872
- }
873
- export interface PathParameters {
874
- id: Parameters.Id;
875
- }
876
- namespace Responses {
877
- export interface $200 {
878
- entity?: /**
879
- * example:
880
- * {
881
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
882
- * "_org": "123",
883
- * "_schema": "contact",
884
- * "_tags": [
885
- * "example",
886
- * "mock"
887
- * ],
888
- * "_created_at": {},
889
- * "_updated_at": {}
890
- * }
891
- */
892
- Components.Schemas.EntityItem;
893
- relations?: /**
894
- * example:
895
- * {
896
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
897
- * "_org": "123",
898
- * "_schema": "contact",
899
- * "_tags": [
900
- * "example",
901
- * "mock"
902
- * ],
903
- * "_created_at": {},
904
- * "_updated_at": {}
905
- * }
906
- */
907
- Components.Schemas.EntityItem[];
908
- }
909
- }
910
- }
911
- namespace GetOrder {
912
- namespace Parameters {
913
- export type Id = Components.Schemas.EntityId;
914
- }
915
- export interface PathParameters {
916
- id: Parameters.Id;
917
- }
918
- namespace Responses {
919
- export interface $200 {
920
- entity?: /**
921
- * example:
922
- * {
923
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
924
- * "_org": "123",
925
- * "_schema": "contact",
926
- * "_tags": [
927
- * "example",
928
- * "mock"
929
- * ],
930
- * "_created_at": {},
931
- * "_updated_at": {}
932
- * }
933
- */
934
- Components.Schemas.EntityItem;
935
- relations?: /**
936
- * example:
937
- * {
938
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
939
- * "_org": "123",
940
- * "_schema": "contact",
941
- * "_tags": [
942
- * "example",
943
- * "mock"
944
- * ],
945
- * "_created_at": {},
946
- * "_updated_at": {}
947
- * }
948
- */
949
- Components.Schemas.EntityItem[];
950
- }
951
- }
952
- }
953
- namespace GetOrgPortalConfig {
954
- namespace Responses {
955
- export type $200 = Components.Schemas.Brand;
956
- }
957
- }
958
- namespace GetOrganizationSettings {
959
- namespace Responses {
960
- export type $200 = Components.Schemas.OrganizationSettings;
961
- }
962
- }
963
- namespace GetPortalConfig {
964
- namespace Responses {
965
- export type $200 = Components.Schemas.Brand;
966
- }
967
- }
968
- namespace GetPortalConfigByDomain {
969
- namespace Parameters {
970
- /**
971
- * example:
972
- * example.com
973
- */
974
- export type Domain = string;
975
- }
976
- export interface QueryParameters {
977
- domain: /**
978
- * example:
979
- * example.com
980
- */
981
- Parameters.Domain;
982
- }
983
- namespace Responses {
984
- export type $200 = Components.Schemas.Brand;
985
- }
986
- }
987
- namespace GetPortalUser {
988
- namespace Responses {
989
- export type $200 = /**
990
- * example:
991
- * {
992
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
993
- * "_org": "123",
994
- * "_schema": "contact",
995
- * "_tags": [
996
- * "example",
997
- * "mock"
998
- * ],
999
- * "_created_at": {},
1000
- * "_updated_at": {}
1001
- * }
1002
- */
1003
- Components.Schemas.EntityItem;
1004
- }
1005
- }
1006
- namespace GetPublicPortalConfig {
1007
- namespace Parameters {
1008
- /**
1009
- * example:
1010
- * 12324
1011
- */
1012
- export type OrgId = string;
1013
- }
1014
- export interface QueryParameters {
1015
- org_id: /**
1016
- * example:
1017
- * 12324
1018
- */
1019
- Parameters.OrgId;
1020
- }
1021
- namespace Responses {
1022
- export type $200 = Components.Schemas.Brand;
1023
- }
1024
- }
1025
- namespace GetSchemas {
1026
- namespace Responses {
1027
- export interface $200 {
1028
- schemas?: /**
1029
- * example:
1030
- * {
1031
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1032
- * "_org": "123",
1033
- * "_schema": "contact",
1034
- * "_tags": [
1035
- * "example",
1036
- * "mock"
1037
- * ],
1038
- * "_created_at": {},
1039
- * "_updated_at": {}
1040
- * }
1041
- */
1042
- Components.Schemas.EntityItem[];
1043
- }
1044
- }
1045
- }
1046
- namespace GetValidSecondaryAttributes {
1047
- namespace Responses {
1048
- export interface $200 {
1049
- data?: {
1050
- /**
1051
- * example:
1052
- * first_name
1053
- */
1054
- name?: string;
1055
- /**
1056
- * example:
1057
- * string
1058
- */
1059
- type?: string;
1060
- }[];
1061
- }
1062
- }
1063
- }
1064
- namespace ReplaceECPTemplateVariables {
1065
- export interface RequestBody {
1066
- /**
1067
- * example:
1068
- * 7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51
1069
- */
1070
- contactId?: string;
1071
- }
1072
- namespace Responses {
1073
- export interface $200 {
1074
- portalUser?: {
1075
- /**
1076
- * example:
1077
- * https://end-customer-portal.ecp.dev.epilot.io/register/existing-customer?contactId=7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51&email=john@doe.com
1078
- */
1079
- invitationLink?: string;
1080
- };
1081
- }
1082
- }
1083
- }
1084
- namespace SaveEntityFile {
1085
- export type RequestBody = Components.Schemas.SaveEntityFile;
1086
- namespace Responses {
1087
- export interface $200 {
1088
- createdFiles?: /**
1089
- * example:
1090
- * {
1091
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1092
- * "_org": "123",
1093
- * "_schema": "contact",
1094
- * "_tags": [
1095
- * "example",
1096
- * "mock"
1097
- * ],
1098
- * "_created_at": {},
1099
- * "_updated_at": {}
1100
- * }
1101
- */
1102
- Components.Schemas.EntityItem[];
1103
- }
1104
- }
1105
- }
1106
- namespace SavePortalFiles {
1107
- export type RequestBody = Components.Schemas.SavePortalFile;
1108
- namespace Responses {
1109
- export type $200 = /**
1110
- * example:
1111
- * {
1112
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1113
- * "_org": "123",
1114
- * "_schema": "contact",
1115
- * "_tags": [
1116
- * "example",
1117
- * "mock"
1118
- * ],
1119
- * "_created_at": {},
1120
- * "_updated_at": {}
1121
- * }
1122
- */
1123
- Components.Schemas.EntityItem;
1124
- }
1125
- }
1126
- namespace TestAuth {
1127
- namespace Responses {
1128
- export interface $200 {
1129
- }
1130
- }
1131
- }
1132
- namespace UpdateContact {
1133
- export type RequestBody = /**
1134
- * example:
1135
- * {
1136
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1137
- * "_org": "123",
1138
- * "_schema": "contact",
1139
- * "_tags": [
1140
- * "example",
1141
- * "mock"
1142
- * ],
1143
- * "_created_at": {},
1144
- * "_updated_at": {}
1145
- * }
1146
- */
1147
- Components.Schemas.EntityItem;
1148
- namespace Responses {
1149
- export type $200 = /**
1150
- * example:
1151
- * {
1152
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1153
- * "_org": "123",
1154
- * "_schema": "contact",
1155
- * "_tags": [
1156
- * "example",
1157
- * "mock"
1158
- * ],
1159
- * "_created_at": {},
1160
- * "_updated_at": {}
1161
- * }
1162
- */
1163
- Components.Schemas.EntityItem;
1164
- }
1165
- }
1166
- namespace UpdateOrder {
1167
- namespace Parameters {
1168
- export type Id = Components.Schemas.EntityId;
1169
- }
1170
- export interface PathParameters {
1171
- id: Parameters.Id;
1172
- }
1173
- export type RequestBody = /**
1174
- * example:
1175
- * {
1176
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1177
- * "_org": "123",
1178
- * "_schema": "contact",
1179
- * "_tags": [
1180
- * "example",
1181
- * "mock"
1182
- * ],
1183
- * "_created_at": {},
1184
- * "_updated_at": {}
1185
- * }
1186
- */
1187
- Components.Schemas.EntityItem;
1188
- namespace Responses {
1189
- export type $200 = /**
1190
- * example:
1191
- * {
1192
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1193
- * "_org": "123",
1194
- * "_schema": "contact",
1195
- * "_tags": [
1196
- * "example",
1197
- * "mock"
1198
- * ],
1199
- * "_created_at": {},
1200
- * "_updated_at": {}
1201
- * }
1202
- */
1203
- Components.Schemas.EntityItem;
1204
- }
1205
- }
1206
- namespace UpdatePortalUser {
1207
- export type RequestBody = /**
1208
- * example:
1209
- * {
1210
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1211
- * "_org": "123",
1212
- * "_schema": "contact",
1213
- * "_tags": [
1214
- * "example",
1215
- * "mock"
1216
- * ],
1217
- * "_created_at": {},
1218
- * "_updated_at": {}
1219
- * }
1220
- */
1221
- Components.Schemas.EntityItem;
1222
- namespace Responses {
1223
- export type $200 = /**
1224
- * example:
1225
- * {
1226
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1227
- * "_org": "123",
1228
- * "_schema": "contact",
1229
- * "_tags": [
1230
- * "example",
1231
- * "mock"
1232
- * ],
1233
- * "_created_at": {},
1234
- * "_updated_at": {}
1235
- * }
1236
- */
1237
- Components.Schemas.EntityItem;
1238
- }
1239
- }
1240
- namespace UpsertEmailTemplates {
1241
- export type RequestBody = Components.Schemas.EmailTemplates;
1242
- namespace Responses {
1243
- export interface $200 {
1244
- message?: string;
1245
- emailTemplates?: Components.Schemas.EmailTemplates;
1246
- }
1247
- }
1248
- }
1249
- namespace UpsertPortal {
1250
- export type RequestBody = Components.Schemas.Brand;
1251
- namespace Responses {
1252
- export type $201 = Components.Schemas.AddPortalResp;
1253
- export type $400 = Components.Schemas.ErrorResp;
1254
- export type $401 = Components.Schemas.ErrorResp;
1255
- export type $500 = Components.Schemas.ErrorResp;
1256
- }
1257
- }
1258
- namespace UserExists {
1259
- namespace Parameters {
1260
- /**
1261
- * example:
1262
- * user@example.com
1263
- */
1264
- export type Email = string;
1265
- /**
1266
- * example:
1267
- * 123
1268
- */
1269
- export type OrgId = string;
1270
- }
1271
- export interface QueryParameters {
1272
- email: /**
1273
- * example:
1274
- * user@example.com
1275
- */
1276
- Parameters.Email;
1277
- org_id: /**
1278
- * example:
1279
- * 123
1280
- */
1281
- Parameters.OrgId;
1282
- }
1283
- namespace Responses {
1284
- export interface $200 {
1285
- /**
1286
- * example:
1287
- * true
1288
- */
1289
- exists?: boolean;
1290
- user?: /**
1291
- * example:
1292
- * {
1293
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1294
- * "_org": "123",
1295
- * "_schema": "contact",
1296
- * "_tags": [
1297
- * "example",
1298
- * "mock"
1299
- * ],
1300
- * "_created_at": {},
1301
- * "_updated_at": {}
1302
- * }
1303
- */
1304
- Components.Schemas.EntityItem;
1305
- }
1306
- export interface $404 {
1307
- /**
1308
- * example:
1309
- * false
1310
- */
1311
- exists?: boolean;
1312
- }
1313
- }
1314
- }
1315
- }
1316
-
1317
- export interface OperationMethods {
1318
- /**
1319
- * upsertPortal - upserts a portal
1320
- *
1321
- * upserts a portal and db item
1322
- */
1323
- 'upsertPortal'(
1324
- parameters?: Parameters<UnknownParamsObject> | null,
1325
- data?: Paths.UpsertPortal.RequestBody,
1326
- config?: AxiosRequestConfig
1327
- ): OperationResponse<Paths.UpsertPortal.Responses.$201>
1328
- /**
1329
- * createUser - creates a user
1330
- *
1331
- * Creates a user in cognito pool and db item
1332
- */
1333
- 'createUser'(
1334
- parameters?: Parameters<UnknownParamsObject> | null,
1335
- data?: Paths.CreateUser.RequestBody,
1336
- config?: AxiosRequestConfig
1337
- ): OperationResponse<Paths.CreateUser.Responses.$201>
1338
- /**
1339
- * activateUser - activateUser
1340
- *
1341
- * Activates the user
1342
- */
1343
- 'activateUser'(
1344
- parameters?: Parameters<Paths.ActivateUser.QueryParameters> | null,
1345
- data?: Paths.ActivateUser.RequestBody,
1346
- config?: AxiosRequestConfig
1347
- ): OperationResponse<Paths.ActivateUser.Responses.$200>
1348
- /**
1349
- * testAuth - testAuth
1350
- *
1351
- * TODO
1352
- */
1353
- 'testAuth'(
1354
- parameters?: Parameters<UnknownParamsObject> | null,
1355
- data?: any,
1356
- config?: AxiosRequestConfig
1357
- ): OperationResponse<Paths.TestAuth.Responses.$200>
1358
- /**
1359
- * getPortalConfigByDomain - getPortalConfigByDomain
1360
- *
1361
- * TODO
1362
- */
1363
- 'getPortalConfigByDomain'(
1364
- parameters?: Parameters<Paths.GetPortalConfigByDomain.QueryParameters> | null,
1365
- data?: any,
1366
- config?: AxiosRequestConfig
1367
- ): OperationResponse<Paths.GetPortalConfigByDomain.Responses.$200>
1368
- /**
1369
- * getPortalConfig - getPortalConfig
1370
- *
1371
- * TODO
1372
- */
1373
- 'getPortalConfig'(
1374
- parameters?: Parameters<UnknownParamsObject> | null,
1375
- data?: any,
1376
- config?: AxiosRequestConfig
1377
- ): OperationResponse<Paths.GetPortalConfig.Responses.$200>
1378
- /**
1379
- * getPublicPortalConfig - getPublicPortalConfig
1380
- *
1381
- * TODO
1382
- */
1383
- 'getPublicPortalConfig'(
1384
- parameters?: Parameters<Paths.GetPublicPortalConfig.QueryParameters> | null,
1385
- data?: any,
1386
- config?: AxiosRequestConfig
1387
- ): OperationResponse<Paths.GetPublicPortalConfig.Responses.$200>
1388
- /**
1389
- * getOrgPortalConfig - getOrgPortalConfig
1390
- *
1391
- * TODO
1392
- */
1393
- 'getOrgPortalConfig'(
1394
- parameters?: Parameters<UnknownParamsObject> | null,
1395
- data?: any,
1396
- config?: AxiosRequestConfig
1397
- ): OperationResponse<Paths.GetOrgPortalConfig.Responses.$200>
1398
- /**
1399
- * getEmailTemplates - getEmailTemplates
1400
- *
1401
- * TODO
1402
- */
1403
- 'getEmailTemplates'(
1404
- parameters?: Parameters<UnknownParamsObject> | null,
1405
- data?: any,
1406
- config?: AxiosRequestConfig
1407
- ): OperationResponse<Paths.GetEmailTemplates.Responses.$200>
1408
- /**
1409
- * upsertEmailTemplates - upsertEmailTemplates
1410
- *
1411
- * TODO
1412
- */
1413
- 'upsertEmailTemplates'(
1414
- parameters?: Parameters<UnknownParamsObject> | null,
1415
- data?: Paths.UpsertEmailTemplates.RequestBody,
1416
- config?: AxiosRequestConfig
1417
- ): OperationResponse<Paths.UpsertEmailTemplates.Responses.$200>
1418
- /**
1419
- * replaceECPTemplateVariables - replaceECPTemplateVariables
1420
- *
1421
- * TODO
1422
- */
1423
- 'replaceECPTemplateVariables'(
1424
- parameters?: Parameters<UnknownParamsObject> | null,
1425
- data?: Paths.ReplaceECPTemplateVariables.RequestBody,
1426
- config?: AxiosRequestConfig
1427
- ): OperationResponse<Paths.ReplaceECPTemplateVariables.Responses.$200>
1428
- /**
1429
- * getOrganizationSettings - getOrganizationSettings
1430
- *
1431
- * get organization settings
1432
- */
1433
- 'getOrganizationSettings'(
1434
- parameters?: Parameters<UnknownParamsObject> | null,
1435
- data?: any,
1436
- config?: AxiosRequestConfig
1437
- ): OperationResponse<Paths.GetOrganizationSettings.Responses.$200>
1438
- /**
1439
- * getSchemas - getSchemas
1440
- *
1441
- * TODO
1442
- */
1443
- 'getSchemas'(
1444
- parameters?: Parameters<UnknownParamsObject> | null,
1445
- data?: any,
1446
- config?: AxiosRequestConfig
1447
- ): OperationResponse<Paths.GetSchemas.Responses.$200>
1448
- /**
1449
- * extraPermissionAttributes - extraPermissionAttributes
1450
- *
1451
- * TODO
1452
- */
1453
- 'extraPermissionAttributes'(
1454
- parameters?: Parameters<UnknownParamsObject> | null,
1455
- data?: any,
1456
- config?: AxiosRequestConfig
1457
- ): OperationResponse<Paths.ExtraPermissionAttributes.Responses.$200>
1458
- /**
1459
- * getContact - getContact
1460
- *
1461
- * Get the Contact by id
1462
- */
1463
- 'getContact'(
1464
- parameters?: Parameters<UnknownParamsObject> | null,
1465
- data?: any,
1466
- config?: AxiosRequestConfig
1467
- ): OperationResponse<Paths.GetContact.Responses.$200>
1468
- /**
1469
- * updateContact - updateContact
1470
- *
1471
- * Update the contact details
1472
- */
1473
- 'updateContact'(
1474
- parameters?: Parameters<UnknownParamsObject> | null,
1475
- data?: Paths.UpdateContact.RequestBody,
1476
- config?: AxiosRequestConfig
1477
- ): OperationResponse<Paths.UpdateContact.Responses.$200>
1478
- /**
1479
- * getECPContact - getECPContact
1480
- *
1481
- * Get the Contact by id
1482
- */
1483
- 'getECPContact'(
1484
- parameters?: Parameters<Paths.GetECPContact.QueryParameters> | null,
1485
- data?: any,
1486
- config?: AxiosRequestConfig
1487
- ): OperationResponse<Paths.GetECPContact.Responses.$200>
1488
- /**
1489
- * getCountByEmail - getCountByEmail
1490
- *
1491
- * Check Contact by email
1492
- */
1493
- 'getCountByEmail'(
1494
- parameters?: Parameters<Paths.GetCountByEmail.QueryParameters> | null,
1495
- data?: any,
1496
- config?: AxiosRequestConfig
1497
- ): OperationResponse<Paths.GetCountByEmail.Responses.$200>
1498
- /**
1499
- * getValidSecondaryAttributes - getValidSecondaryAttributes
1500
- *
1501
- * Get Valid Secondary Attributes
1502
- */
1503
- 'getValidSecondaryAttributes'(
1504
- parameters?: Parameters<UnknownParamsObject> | null,
1505
- data?: any,
1506
- config?: AxiosRequestConfig
1507
- ): OperationResponse<Paths.GetValidSecondaryAttributes.Responses.$200>
1508
- /**
1509
- * getPortalUser - getPortalUser
1510
- *
1511
- * TODO
1512
- */
1513
- 'getPortalUser'(
1514
- parameters?: Parameters<UnknownParamsObject> | null,
1515
- data?: any,
1516
- config?: AxiosRequestConfig
1517
- ): OperationResponse<Paths.GetPortalUser.Responses.$200>
1518
- /**
1519
- * updatePortalUser - updatePortalUser
1520
- *
1521
- * Update the portal user details
1522
- */
1523
- 'updatePortalUser'(
1524
- parameters?: Parameters<UnknownParamsObject> | null,
1525
- data?: Paths.UpdatePortalUser.RequestBody,
1526
- config?: AxiosRequestConfig
1527
- ): OperationResponse<Paths.UpdatePortalUser.Responses.$200>
1528
- /**
1529
- * deletePortalUser - deletePortalUser
1530
- *
1531
- * TODO
1532
- */
1533
- 'deletePortalUser'(
1534
- parameters?: Parameters<UnknownParamsObject> | null,
1535
- data?: any,
1536
- config?: AxiosRequestConfig
1537
- ): OperationResponse<Paths.DeletePortalUser.Responses.$200>
1538
- /**
1539
- * confirmUser - confirmUser
1540
- *
1541
- * TODO
1542
- */
1543
- 'confirmUser'(
1544
- parameters?: Parameters<Paths.ConfirmUser.PathParameters & Paths.ConfirmUser.QueryParameters> | null,
1545
- data?: any,
1546
- config?: AxiosRequestConfig
1547
- ): OperationResponse<Paths.ConfirmUser.Responses.$200>
1548
- /**
1549
- * userExists - userExists
1550
- *
1551
- * Checks whether a user exists in the customer portal
1552
- */
1553
- 'userExists'(
1554
- parameters?: Parameters<Paths.UserExists.QueryParameters> | null,
1555
- data?: any,
1556
- config?: AxiosRequestConfig
1557
- ): OperationResponse<Paths.UserExists.Responses.$200>
1558
- /**
1559
- * configureDistribution - configureDistribution
1560
- *
1561
- * TODO
1562
- */
1563
- 'configureDistribution'(
1564
- parameters?: Parameters<UnknownParamsObject> | null,
1565
- data?: any,
1566
- config?: AxiosRequestConfig
1567
- ): OperationResponse<Paths.ConfigureDistribution.Responses.$200>
1568
- /**
1569
- * getAllOrders - getAllOrders
1570
- *
1571
- * TODO
1572
- */
1573
- 'getAllOrders'(
1574
- parameters?: Parameters<UnknownParamsObject> | null,
1575
- data?: any,
1576
- config?: AxiosRequestConfig
1577
- ): OperationResponse<Paths.GetAllOrders.Responses.$200>
1578
- /**
1579
- * getOrder - getOrder
1580
- *
1581
- * TODO
1582
- */
1583
- 'getOrder'(
1584
- parameters?: Parameters<Paths.GetOrder.PathParameters> | null,
1585
- data?: any,
1586
- config?: AxiosRequestConfig
1587
- ): OperationResponse<Paths.GetOrder.Responses.$200>
1588
- /**
1589
- * updateOrder - updateOrder
1590
- *
1591
- * Update the order details
1592
- */
1593
- 'updateOrder'(
1594
- parameters?: Parameters<Paths.UpdateOrder.PathParameters> | null,
1595
- data?: Paths.UpdateOrder.RequestBody,
1596
- config?: AxiosRequestConfig
1597
- ): OperationResponse<Paths.UpdateOrder.Responses.$200>
1598
- /**
1599
- * getAllOpportunities - getAllOpportunities
1600
- *
1601
- * TODO
1602
- */
1603
- 'getAllOpportunities'(
1604
- parameters?: Parameters<UnknownParamsObject> | null,
1605
- data?: any,
1606
- config?: AxiosRequestConfig
1607
- ): OperationResponse<Paths.GetAllOpportunities.Responses.$200>
1608
- /**
1609
- * getOpportunity - getOpportunity
1610
- *
1611
- * TODO
1612
- */
1613
- 'getOpportunity'(
1614
- parameters?: Parameters<Paths.GetOpportunity.PathParameters> | null,
1615
- data?: any,
1616
- config?: AxiosRequestConfig
1617
- ): OperationResponse<Paths.GetOpportunity.Responses.$200>
1618
- /**
1619
- * getAllContracts - getAllContracts
1620
- *
1621
- * TODO
1622
- */
1623
- 'getAllContracts'(
1624
- parameters?: Parameters<UnknownParamsObject> | null,
1625
- data?: any,
1626
- config?: AxiosRequestConfig
1627
- ): OperationResponse<Paths.GetAllContracts.Responses.$200>
1628
- /**
1629
- * getContract - get contract based on id
1630
- *
1631
- * TODO
1632
- */
1633
- 'getContract'(
1634
- parameters?: Parameters<Paths.GetContract.PathParameters> | null,
1635
- data?: any,
1636
- config?: AxiosRequestConfig
1637
- ): OperationResponse<Paths.GetContract.Responses.$200>
1638
- /**
1639
- * getEntityIdentifiers - getEntityIdentifiers
1640
- *
1641
- * Get Entity's Identifiers
1642
- */
1643
- 'getEntityIdentifiers'(
1644
- parameters?: Parameters<Paths.GetEntityIdentifiers.PathParameters> | null,
1645
- data?: any,
1646
- config?: AxiosRequestConfig
1647
- ): OperationResponse<Paths.GetEntityIdentifiers.Responses.$200>
1648
- /**
1649
- * getEntitiesByIdentifiers - getEntitiesByIdentifiers
1650
- *
1651
- * Get Entities By Identifiers
1652
- */
1653
- 'getEntitiesByIdentifiers'(
1654
- parameters?: Parameters<Paths.GetEntitiesByIdentifiers.PathParameters> | null,
1655
- data?: Paths.GetEntitiesByIdentifiers.RequestBody,
1656
- config?: AxiosRequestConfig
1657
- ): OperationResponse<Paths.GetEntitiesByIdentifiers.Responses.$200>
1658
- /**
1659
- * addEndCustomerRelationToEntity - addEndCustomerRelationToEntity
1660
- *
1661
- * Add EndCustomer Relation To an Entity
1662
- */
1663
- 'addEndCustomerRelationToEntity'(
1664
- parameters?: Parameters<Paths.AddEndCustomerRelationToEntity.PathParameters> | null,
1665
- data?: any,
1666
- config?: AxiosRequestConfig
1667
- ): OperationResponse<Paths.AddEndCustomerRelationToEntity.Responses.$200>
1668
- /**
1669
- * saveEntityFile - Add files to an entity
1670
- *
1671
- * Add files to an entity
1672
- */
1673
- 'saveEntityFile'(
1674
- parameters?: Parameters<UnknownParamsObject> | null,
1675
- data?: Paths.SaveEntityFile.RequestBody,
1676
- config?: AxiosRequestConfig
1677
- ): OperationResponse<Paths.SaveEntityFile.Responses.$200>
1678
- /**
1679
- * deleteEntityFile - Delete files from an entity
1680
- *
1681
- * Delete files from an entity
1682
- */
1683
- 'deleteEntityFile'(
1684
- parameters?: Parameters<UnknownParamsObject> | null,
1685
- data?: Paths.DeleteEntityFile.RequestBody,
1686
- config?: AxiosRequestConfig
1687
- ): OperationResponse<Paths.DeleteEntityFile.Responses.$200>
1688
- /**
1689
- * savePortalFiles - Add files to portal
1690
- *
1691
- * Add files to portal
1692
- */
1693
- 'savePortalFiles'(
1694
- parameters?: Parameters<UnknownParamsObject> | null,
1695
- data?: Paths.SavePortalFiles.RequestBody,
1696
- config?: AxiosRequestConfig
1697
- ): OperationResponse<Paths.SavePortalFiles.Responses.$200>
1698
- }
1699
-
1700
- export interface PathsDictionary {
1701
- ['/v1/customer-portal/portal']: {
1702
- /**
1703
- * upsertPortal - upserts a portal
1704
- *
1705
- * upserts a portal and db item
1706
- */
1707
- 'post'(
1708
- parameters?: Parameters<UnknownParamsObject> | null,
1709
- data?: Paths.UpsertPortal.RequestBody,
1710
- config?: AxiosRequestConfig
1711
- ): OperationResponse<Paths.UpsertPortal.Responses.$201>
1712
- }
1713
- ['/v1/customer-portal/public/user']: {
1714
- /**
1715
- * createUser - creates a user
1716
- *
1717
- * Creates a user in cognito pool and db item
1718
- */
1719
- 'post'(
1720
- parameters?: Parameters<UnknownParamsObject> | null,
1721
- data?: Paths.CreateUser.RequestBody,
1722
- config?: AxiosRequestConfig
1723
- ): OperationResponse<Paths.CreateUser.Responses.$201>
1724
- }
1725
- ['/v1/customer-portal/public/activate']: {
1726
- /**
1727
- * activateUser - activateUser
1728
- *
1729
- * Activates the user
1730
- */
1731
- 'post'(
1732
- parameters?: Parameters<Paths.ActivateUser.QueryParameters> | null,
1733
- data?: Paths.ActivateUser.RequestBody,
1734
- config?: AxiosRequestConfig
1735
- ): OperationResponse<Paths.ActivateUser.Responses.$200>
1736
- }
1737
- ['/v1/customer-portal/auth']: {
1738
- /**
1739
- * testAuth - testAuth
1740
- *
1741
- * TODO
1742
- */
1743
- 'get'(
1744
- parameters?: Parameters<UnknownParamsObject> | null,
1745
- data?: any,
1746
- config?: AxiosRequestConfig
1747
- ): OperationResponse<Paths.TestAuth.Responses.$200>
1748
- }
1749
- ['/v1/customer-portal/public/config']: {
1750
- /**
1751
- * getPortalConfigByDomain - getPortalConfigByDomain
1752
- *
1753
- * TODO
1754
- */
1755
- 'get'(
1756
- parameters?: Parameters<Paths.GetPortalConfigByDomain.QueryParameters> | null,
1757
- data?: any,
1758
- config?: AxiosRequestConfig
1759
- ): OperationResponse<Paths.GetPortalConfigByDomain.Responses.$200>
1760
- }
1761
- ['/v1/customer-portal/config']: {
1762
- /**
1763
- * getPortalConfig - getPortalConfig
1764
- *
1765
- * TODO
1766
- */
1767
- 'get'(
1768
- parameters?: Parameters<UnknownParamsObject> | null,
1769
- data?: any,
1770
- config?: AxiosRequestConfig
1771
- ): OperationResponse<Paths.GetPortalConfig.Responses.$200>
1772
- }
1773
- ['/v1/customer-portal/public/portal/config']: {
1774
- /**
1775
- * getPublicPortalConfig - getPublicPortalConfig
1776
- *
1777
- * TODO
1778
- */
1779
- 'get'(
1780
- parameters?: Parameters<Paths.GetPublicPortalConfig.QueryParameters> | null,
1781
- data?: any,
1782
- config?: AxiosRequestConfig
1783
- ): OperationResponse<Paths.GetPublicPortalConfig.Responses.$200>
1784
- }
1785
- ['/v1/customer-portal/org/portal/config']: {
1786
- /**
1787
- * getOrgPortalConfig - getOrgPortalConfig
1788
- *
1789
- * TODO
1790
- */
1791
- 'get'(
1792
- parameters?: Parameters<UnknownParamsObject> | null,
1793
- data?: any,
1794
- config?: AxiosRequestConfig
1795
- ): OperationResponse<Paths.GetOrgPortalConfig.Responses.$200>
1796
- }
1797
- ['/v1/customer-portal/email-templates']: {
1798
- /**
1799
- * upsertEmailTemplates - upsertEmailTemplates
1800
- *
1801
- * TODO
1802
- */
1803
- 'post'(
1804
- parameters?: Parameters<UnknownParamsObject> | null,
1805
- data?: Paths.UpsertEmailTemplates.RequestBody,
1806
- config?: AxiosRequestConfig
1807
- ): OperationResponse<Paths.UpsertEmailTemplates.Responses.$200>
1808
- /**
1809
- * getEmailTemplates - getEmailTemplates
1810
- *
1811
- * TODO
1812
- */
1813
- 'get'(
1814
- parameters?: Parameters<UnknownParamsObject> | null,
1815
- data?: any,
1816
- config?: AxiosRequestConfig
1817
- ): OperationResponse<Paths.GetEmailTemplates.Responses.$200>
1818
- }
1819
- ['/v1/customer-portal/replace-ecp-template-variables']: {
1820
- /**
1821
- * replaceECPTemplateVariables - replaceECPTemplateVariables
1822
- *
1823
- * TODO
1824
- */
1825
- 'post'(
1826
- parameters?: Parameters<UnknownParamsObject> | null,
1827
- data?: Paths.ReplaceECPTemplateVariables.RequestBody,
1828
- config?: AxiosRequestConfig
1829
- ): OperationResponse<Paths.ReplaceECPTemplateVariables.Responses.$200>
1830
- }
1831
- ['/v1/customer-portal/org/settings']: {
1832
- /**
1833
- * getOrganizationSettings - getOrganizationSettings
1834
- *
1835
- * get organization settings
1836
- */
1837
- 'get'(
1838
- parameters?: Parameters<UnknownParamsObject> | null,
1839
- data?: any,
1840
- config?: AxiosRequestConfig
1841
- ): OperationResponse<Paths.GetOrganizationSettings.Responses.$200>
1842
- }
1843
- ['/v1/customer-portal/schemas']: {
1844
- /**
1845
- * getSchemas - getSchemas
1846
- *
1847
- * TODO
1848
- */
1849
- 'get'(
1850
- parameters?: Parameters<UnknownParamsObject> | null,
1851
- data?: any,
1852
- config?: AxiosRequestConfig
1853
- ): OperationResponse<Paths.GetSchemas.Responses.$200>
1854
- }
1855
- ['/v1/customer-portal/extra-permission-attributes']: {
1856
- /**
1857
- * extraPermissionAttributes - extraPermissionAttributes
1858
- *
1859
- * TODO
1860
- */
1861
- 'get'(
1862
- parameters?: Parameters<UnknownParamsObject> | null,
1863
- data?: any,
1864
- config?: AxiosRequestConfig
1865
- ): OperationResponse<Paths.ExtraPermissionAttributes.Responses.$200>
1866
- }
1867
- ['/v1/customer-portal/contact']: {
1868
- /**
1869
- * getContact - getContact
1870
- *
1871
- * Get the Contact by id
1872
- */
1873
- 'get'(
1874
- parameters?: Parameters<UnknownParamsObject> | null,
1875
- data?: any,
1876
- config?: AxiosRequestConfig
1877
- ): OperationResponse<Paths.GetContact.Responses.$200>
1878
- /**
1879
- * updateContact - updateContact
1880
- *
1881
- * Update the contact details
1882
- */
1883
- 'patch'(
1884
- parameters?: Parameters<UnknownParamsObject> | null,
1885
- data?: Paths.UpdateContact.RequestBody,
1886
- config?: AxiosRequestConfig
1887
- ): OperationResponse<Paths.UpdateContact.Responses.$200>
1888
- }
1889
- ['/v1/customer-portal/ecp/contact']: {
1890
- /**
1891
- * getECPContact - getECPContact
1892
- *
1893
- * Get the Contact by id
1894
- */
1895
- 'get'(
1896
- parameters?: Parameters<Paths.GetECPContact.QueryParameters> | null,
1897
- data?: any,
1898
- config?: AxiosRequestConfig
1899
- ): OperationResponse<Paths.GetECPContact.Responses.$200>
1900
- }
1901
- ['/v1/customer-portal/contact/email/count']: {
1902
- /**
1903
- * getCountByEmail - getCountByEmail
1904
- *
1905
- * Check Contact by email
1906
- */
1907
- 'get'(
1908
- parameters?: Parameters<Paths.GetCountByEmail.QueryParameters> | null,
1909
- data?: any,
1910
- config?: AxiosRequestConfig
1911
- ): OperationResponse<Paths.GetCountByEmail.Responses.$200>
1912
- }
1913
- ['/v1/customer-portal/contact/valid/secondary/attributes']: {
1914
- /**
1915
- * getValidSecondaryAttributes - getValidSecondaryAttributes
1916
- *
1917
- * Get Valid Secondary Attributes
1918
- */
1919
- 'get'(
1920
- parameters?: Parameters<UnknownParamsObject> | null,
1921
- data?: any,
1922
- config?: AxiosRequestConfig
1923
- ): OperationResponse<Paths.GetValidSecondaryAttributes.Responses.$200>
1924
- }
1925
- ['/v1/customer-portal/user']: {
1926
- /**
1927
- * getPortalUser - getPortalUser
1928
- *
1929
- * TODO
1930
- */
1931
- 'get'(
1932
- parameters?: Parameters<UnknownParamsObject> | null,
1933
- data?: any,
1934
- config?: AxiosRequestConfig
1935
- ): OperationResponse<Paths.GetPortalUser.Responses.$200>
1936
- /**
1937
- * updatePortalUser - updatePortalUser
1938
- *
1939
- * Update the portal user details
1940
- */
1941
- 'patch'(
1942
- parameters?: Parameters<UnknownParamsObject> | null,
1943
- data?: Paths.UpdatePortalUser.RequestBody,
1944
- config?: AxiosRequestConfig
1945
- ): OperationResponse<Paths.UpdatePortalUser.Responses.$200>
1946
- /**
1947
- * deletePortalUser - deletePortalUser
1948
- *
1949
- * TODO
1950
- */
1951
- 'delete'(
1952
- parameters?: Parameters<UnknownParamsObject> | null,
1953
- data?: any,
1954
- config?: AxiosRequestConfig
1955
- ): OperationResponse<Paths.DeletePortalUser.Responses.$200>
1956
- }
1957
- ['/v1/customer-portal/user/confirm/{id}']: {
1958
- /**
1959
- * confirmUser - confirmUser
1960
- *
1961
- * TODO
1962
- */
1963
- 'get'(
1964
- parameters?: Parameters<Paths.ConfirmUser.PathParameters & Paths.ConfirmUser.QueryParameters> | null,
1965
- data?: any,
1966
- config?: AxiosRequestConfig
1967
- ): OperationResponse<Paths.ConfirmUser.Responses.$200>
1968
- }
1969
- ['/v1/customer-portal/public/user/exists']: {
1970
- /**
1971
- * userExists - userExists
1972
- *
1973
- * Checks whether a user exists in the customer portal
1974
- */
1975
- 'get'(
1976
- parameters?: Parameters<Paths.UserExists.QueryParameters> | null,
1977
- data?: any,
1978
- config?: AxiosRequestConfig
1979
- ): OperationResponse<Paths.UserExists.Responses.$200>
1980
- }
1981
- ['/v1/customer-portal/configure-distribution']: {
1982
- /**
1983
- * configureDistribution - configureDistribution
1984
- *
1985
- * TODO
1986
- */
1987
- 'get'(
1988
- parameters?: Parameters<UnknownParamsObject> | null,
1989
- data?: any,
1990
- config?: AxiosRequestConfig
1991
- ): OperationResponse<Paths.ConfigureDistribution.Responses.$200>
1992
- }
1993
- ['/v1/customer-portal/order']: {
1994
- /**
1995
- * getAllOrders - getAllOrders
1996
- *
1997
- * TODO
1998
- */
1999
- 'get'(
2000
- parameters?: Parameters<UnknownParamsObject> | null,
2001
- data?: any,
2002
- config?: AxiosRequestConfig
2003
- ): OperationResponse<Paths.GetAllOrders.Responses.$200>
2004
- }
2005
- ['/v1/customer-portal/order/{id}']: {
2006
- /**
2007
- * getOrder - getOrder
2008
- *
2009
- * TODO
2010
- */
2011
- 'get'(
2012
- parameters?: Parameters<Paths.GetOrder.PathParameters> | null,
2013
- data?: any,
2014
- config?: AxiosRequestConfig
2015
- ): OperationResponse<Paths.GetOrder.Responses.$200>
2016
- /**
2017
- * updateOrder - updateOrder
2018
- *
2019
- * Update the order details
2020
- */
2021
- 'patch'(
2022
- parameters?: Parameters<Paths.UpdateOrder.PathParameters> | null,
2023
- data?: Paths.UpdateOrder.RequestBody,
2024
- config?: AxiosRequestConfig
2025
- ): OperationResponse<Paths.UpdateOrder.Responses.$200>
2026
- }
2027
- ['/v1/customer-portal/opportunity']: {
2028
- /**
2029
- * getAllOpportunities - getAllOpportunities
2030
- *
2031
- * TODO
2032
- */
2033
- 'get'(
2034
- parameters?: Parameters<UnknownParamsObject> | null,
2035
- data?: any,
2036
- config?: AxiosRequestConfig
2037
- ): OperationResponse<Paths.GetAllOpportunities.Responses.$200>
2038
- }
2039
- ['/v1/customer-portal/opportunities/{id}']: {
2040
- /**
2041
- * getOpportunity - getOpportunity
2042
- *
2043
- * TODO
2044
- */
2045
- 'get'(
2046
- parameters?: Parameters<Paths.GetOpportunity.PathParameters> | null,
2047
- data?: any,
2048
- config?: AxiosRequestConfig
2049
- ): OperationResponse<Paths.GetOpportunity.Responses.$200>
2050
- }
2051
- ['/v1/customer-portal/contract']: {
2052
- /**
2053
- * getAllContracts - getAllContracts
2054
- *
2055
- * TODO
2056
- */
2057
- 'get'(
2058
- parameters?: Parameters<UnknownParamsObject> | null,
2059
- data?: any,
2060
- config?: AxiosRequestConfig
2061
- ): OperationResponse<Paths.GetAllContracts.Responses.$200>
2062
- }
2063
- ['/v1/customer-portal/contract/{id}']: {
2064
- /**
2065
- * getContract - get contract based on id
2066
- *
2067
- * TODO
2068
- */
2069
- 'get'(
2070
- parameters?: Parameters<Paths.GetContract.PathParameters> | null,
2071
- data?: any,
2072
- config?: AxiosRequestConfig
2073
- ): OperationResponse<Paths.GetContract.Responses.$200>
2074
- }
2075
- ['/v1/customer-portal/entity/identifiers/{slug}']: {
2076
- /**
2077
- * getEntityIdentifiers - getEntityIdentifiers
2078
- *
2079
- * Get Entity's Identifiers
2080
- */
2081
- 'get'(
2082
- parameters?: Parameters<Paths.GetEntityIdentifiers.PathParameters> | null,
2083
- data?: any,
2084
- config?: AxiosRequestConfig
2085
- ): OperationResponse<Paths.GetEntityIdentifiers.Responses.$200>
2086
- }
2087
- ['/v1/customer-portal/entity/by-identifiers/{slug}']: {
2088
- /**
2089
- * getEntitiesByIdentifiers - getEntitiesByIdentifiers
2090
- *
2091
- * Get Entities By Identifiers
2092
- */
2093
- 'post'(
2094
- parameters?: Parameters<Paths.GetEntitiesByIdentifiers.PathParameters> | null,
2095
- data?: Paths.GetEntitiesByIdentifiers.RequestBody,
2096
- config?: AxiosRequestConfig
2097
- ): OperationResponse<Paths.GetEntitiesByIdentifiers.Responses.$200>
2098
- }
2099
- ['/v1/customer-portal/entity/add-end-customer/{slug}/{id}']: {
2100
- /**
2101
- * addEndCustomerRelationToEntity - addEndCustomerRelationToEntity
2102
- *
2103
- * Add EndCustomer Relation To an Entity
2104
- */
2105
- 'put'(
2106
- parameters?: Parameters<Paths.AddEndCustomerRelationToEntity.PathParameters> | null,
2107
- data?: any,
2108
- config?: AxiosRequestConfig
2109
- ): OperationResponse<Paths.AddEndCustomerRelationToEntity.Responses.$200>
2110
- }
2111
- ['/v1/customer-portal/entity/file']: {
2112
- /**
2113
- * saveEntityFile - Add files to an entity
2114
- *
2115
- * Add files to an entity
2116
- */
2117
- 'post'(
2118
- parameters?: Parameters<UnknownParamsObject> | null,
2119
- data?: Paths.SaveEntityFile.RequestBody,
2120
- config?: AxiosRequestConfig
2121
- ): OperationResponse<Paths.SaveEntityFile.Responses.$200>
2122
- /**
2123
- * deleteEntityFile - Delete files from an entity
2124
- *
2125
- * Delete files from an entity
2126
- */
2127
- 'delete'(
2128
- parameters?: Parameters<UnknownParamsObject> | null,
2129
- data?: Paths.DeleteEntityFile.RequestBody,
2130
- config?: AxiosRequestConfig
2131
- ): OperationResponse<Paths.DeleteEntityFile.Responses.$200>
2132
- }
2133
- ['/v1/customer-portal/portal/files']: {
2134
- /**
2135
- * savePortalFiles - Add files to portal
2136
- *
2137
- * Add files to portal
2138
- */
2139
- 'post'(
2140
- parameters?: Parameters<UnknownParamsObject> | null,
2141
- data?: Paths.SavePortalFiles.RequestBody,
2142
- config?: AxiosRequestConfig
2143
- ): OperationResponse<Paths.SavePortalFiles.Responses.$200>
2144
- }
2145
- }
2146
-
2147
- export type Client = OpenAPIClient<OperationMethods, PathsDictionary>