@epilot/app-client 0.0.8 → 0.0.9
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 +47 -0
- package/dist/openapi.json +75 -0
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -39,6 +39,7 @@ declare namespace Components {
|
|
|
39
39
|
*/
|
|
40
40
|
documentation_url?: string;
|
|
41
41
|
description?: TranslatedString;
|
|
42
|
+
notifications?: NotificationConfig;
|
|
42
43
|
created_by?: string;
|
|
43
44
|
created_at?: string;
|
|
44
45
|
/**
|
|
@@ -108,6 +109,10 @@ declare namespace Components {
|
|
|
108
109
|
* Markdown description of the app.
|
|
109
110
|
*/
|
|
110
111
|
description?: TranslatedString;
|
|
112
|
+
/**
|
|
113
|
+
* Configuration for developer notifications
|
|
114
|
+
*/
|
|
115
|
+
notifications?: NotificationConfig;
|
|
111
116
|
created_by?: string;
|
|
112
117
|
created_at?: string;
|
|
113
118
|
updated_at?: string;
|
|
@@ -202,6 +207,25 @@ declare namespace Components {
|
|
|
202
207
|
component_type: "CUSTOM_JOURNEY_BLOCK";
|
|
203
208
|
configuration: JourneyBlockConfig;
|
|
204
209
|
}
|
|
210
|
+
export interface JourneyBlockComponentArgs {
|
|
211
|
+
/**
|
|
212
|
+
* Key matching a config_option from the component
|
|
213
|
+
*/
|
|
214
|
+
key: string;
|
|
215
|
+
/**
|
|
216
|
+
* Flag to indicate if this option is required
|
|
217
|
+
*/
|
|
218
|
+
required?: boolean;
|
|
219
|
+
/**
|
|
220
|
+
* Description of what this component arg does
|
|
221
|
+
*/
|
|
222
|
+
description?: TranslatedString;
|
|
223
|
+
/**
|
|
224
|
+
* Human-readable label for the component arg
|
|
225
|
+
*/
|
|
226
|
+
label?: TranslatedString;
|
|
227
|
+
type?: "text" | "number" | "boolean";
|
|
228
|
+
}
|
|
205
229
|
export interface JourneyBlockConfig {
|
|
206
230
|
/**
|
|
207
231
|
* URL of the web component object
|
|
@@ -213,7 +237,27 @@ declare namespace Components {
|
|
|
213
237
|
* Custom element tag for the component
|
|
214
238
|
*/
|
|
215
239
|
component_tag: string;
|
|
240
|
+
/**
|
|
241
|
+
* Arguments to pass to the component
|
|
242
|
+
*/
|
|
243
|
+
component_args?: JourneyBlockComponentArgs[];
|
|
244
|
+
}
|
|
245
|
+
export interface NotificationConfig {
|
|
246
|
+
/**
|
|
247
|
+
* Email address to receive notifications
|
|
248
|
+
* example:
|
|
249
|
+
* developer@example.com
|
|
250
|
+
*/
|
|
251
|
+
email: string; // email
|
|
252
|
+
/**
|
|
253
|
+
* List of events to subscribe to
|
|
254
|
+
*/
|
|
255
|
+
events: [
|
|
256
|
+
NotificationEvent,
|
|
257
|
+
...NotificationEvent[]
|
|
258
|
+
];
|
|
216
259
|
}
|
|
260
|
+
export type NotificationEvent = "app.installed" | "app.uninstalled";
|
|
217
261
|
export interface Option {
|
|
218
262
|
/**
|
|
219
263
|
* Key matching a config_option from the component
|
|
@@ -618,7 +662,10 @@ export type BaseComponentCommon = Components.Schemas.BaseComponentCommon;
|
|
|
618
662
|
export type CallerIdentity = Components.Schemas.CallerIdentity;
|
|
619
663
|
export type ComponentType = Components.Schemas.ComponentType;
|
|
620
664
|
export type JourneyBlockComponent = Components.Schemas.JourneyBlockComponent;
|
|
665
|
+
export type JourneyBlockComponentArgs = Components.Schemas.JourneyBlockComponentArgs;
|
|
621
666
|
export type JourneyBlockConfig = Components.Schemas.JourneyBlockConfig;
|
|
667
|
+
export type NotificationConfig = Components.Schemas.NotificationConfig;
|
|
668
|
+
export type NotificationEvent = Components.Schemas.NotificationEvent;
|
|
622
669
|
export type Option = Components.Schemas.Option;
|
|
623
670
|
export type Options = Components.Schemas.Options;
|
|
624
671
|
export type OptionsRef = Components.Schemas.OptionsRef;
|
package/dist/openapi.json
CHANGED
|
@@ -505,6 +505,36 @@
|
|
|
505
505
|
}
|
|
506
506
|
}
|
|
507
507
|
},
|
|
508
|
+
"NotificationConfig": {
|
|
509
|
+
"type": "object",
|
|
510
|
+
"required": [
|
|
511
|
+
"email",
|
|
512
|
+
"events"
|
|
513
|
+
],
|
|
514
|
+
"properties": {
|
|
515
|
+
"email": {
|
|
516
|
+
"type": "string",
|
|
517
|
+
"format": "email",
|
|
518
|
+
"description": "Email address to receive notifications",
|
|
519
|
+
"example": "developer@example.com"
|
|
520
|
+
},
|
|
521
|
+
"events": {
|
|
522
|
+
"type": "array",
|
|
523
|
+
"description": "List of events to subscribe to",
|
|
524
|
+
"items": {
|
|
525
|
+
"$ref": "#/components/schemas/NotificationEvent"
|
|
526
|
+
},
|
|
527
|
+
"minItems": 1
|
|
528
|
+
}
|
|
529
|
+
}
|
|
530
|
+
},
|
|
531
|
+
"NotificationEvent": {
|
|
532
|
+
"type": "string",
|
|
533
|
+
"enum": [
|
|
534
|
+
"app.installed",
|
|
535
|
+
"app.uninstalled"
|
|
536
|
+
]
|
|
537
|
+
},
|
|
508
538
|
"BaseComponentCommon": {
|
|
509
539
|
"type": "object",
|
|
510
540
|
"required": [
|
|
@@ -725,6 +755,47 @@
|
|
|
725
755
|
"component_tag": {
|
|
726
756
|
"type": "string",
|
|
727
757
|
"description": "Custom element tag for the component"
|
|
758
|
+
},
|
|
759
|
+
"component_args": {
|
|
760
|
+
"type": "array",
|
|
761
|
+
"description": "Arguments to pass to the component",
|
|
762
|
+
"items": {
|
|
763
|
+
"$ref": "#/components/schemas/JourneyBlockComponentArgs"
|
|
764
|
+
}
|
|
765
|
+
}
|
|
766
|
+
}
|
|
767
|
+
},
|
|
768
|
+
"JourneyBlockComponentArgs": {
|
|
769
|
+
"type": "object",
|
|
770
|
+
"required": [
|
|
771
|
+
"key"
|
|
772
|
+
],
|
|
773
|
+
"properties": {
|
|
774
|
+
"key": {
|
|
775
|
+
"type": "string",
|
|
776
|
+
"description": "Key matching a config_option from the component"
|
|
777
|
+
},
|
|
778
|
+
"required": {
|
|
779
|
+
"type": "boolean",
|
|
780
|
+
"description": "Flag to indicate if this option is required",
|
|
781
|
+
"default": false
|
|
782
|
+
},
|
|
783
|
+
"description": {
|
|
784
|
+
"description": "Description of what this component arg does",
|
|
785
|
+
"$ref": "#/components/schemas/TranslatedString"
|
|
786
|
+
},
|
|
787
|
+
"label": {
|
|
788
|
+
"description": "Human-readable label for the component arg",
|
|
789
|
+
"$ref": "#/components/schemas/TranslatedString"
|
|
790
|
+
},
|
|
791
|
+
"type": {
|
|
792
|
+
"type": "string",
|
|
793
|
+
"enum": [
|
|
794
|
+
"text",
|
|
795
|
+
"number",
|
|
796
|
+
"boolean"
|
|
797
|
+
],
|
|
798
|
+
"default": "text"
|
|
728
799
|
}
|
|
729
800
|
}
|
|
730
801
|
},
|
|
@@ -804,6 +875,10 @@
|
|
|
804
875
|
"$ref": "#/components/schemas/TranslatedString",
|
|
805
876
|
"description": "Markdown description of the app."
|
|
806
877
|
},
|
|
878
|
+
"notifications": {
|
|
879
|
+
"$ref": "#/components/schemas/NotificationConfig",
|
|
880
|
+
"description": "Configuration for developer notifications"
|
|
881
|
+
},
|
|
807
882
|
"created_by": {
|
|
808
883
|
"type": "string",
|
|
809
884
|
"readOnly": true
|