@epilot/app-client 0.4.0 → 0.5.1

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
@@ -194,48 +194,12 @@ declare namespace Components {
194
194
  */
195
195
  app_id: string;
196
196
  /**
197
- * The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component
197
+ * The ID of the component to fetch configuration from the app API
198
198
  * example:
199
- * 2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88
199
+ * 12345678-1234-1234-1234-123456789012
200
200
  */
201
201
  component_id: string;
202
202
  }
203
- export interface BasicCustomActionConfig {
204
- /**
205
- * Name of the custom action
206
- */
207
- name?: string;
208
- /**
209
- * Description of the custom action
210
- */
211
- description?: string;
212
- /**
213
- * The ID of the app to fetch configuration from the app API
214
- * example:
215
- * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
216
- */
217
- app_id: string;
218
- /**
219
- * The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component
220
- * example:
221
- * 2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88
222
- */
223
- component_id: string;
224
- type: "basic";
225
- basic_settings?: {
226
- /**
227
- * URL to call
228
- */
229
- url?: string;
230
- headers?: {
231
- [name: string]: any;
232
- };
233
- /**
234
- * SSM Reference to the auth token to use for the request
235
- */
236
- auth_token_ref?: string;
237
- };
238
- }
239
203
  /**
240
204
  * How often the subscription is billed
241
205
  */
@@ -603,7 +567,7 @@ declare namespace Components {
603
567
  component_type: "CUSTOM_FLOW_ACTION";
604
568
  configuration: CustomFlowConfig;
605
569
  }
606
- export type CustomFlowConfig = BasicCustomActionConfig;
570
+ export type CustomFlowConfig = ExternalIntegrationCustomActionConfig;
607
571
  export interface EnumArg {
608
572
  type?: "enum";
609
573
  /**
@@ -654,6 +618,42 @@ declare namespace Components {
654
618
  }[]
655
619
  ];
656
620
  }
621
+ export interface ExternalIntegrationCustomActionConfig {
622
+ /**
623
+ * Name of the custom action
624
+ */
625
+ name?: string;
626
+ /**
627
+ * Description of the custom action
628
+ */
629
+ description?: string;
630
+ /**
631
+ * The ID of the app to fetch configuration from the app API
632
+ * example:
633
+ * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
634
+ */
635
+ app_id: string;
636
+ /**
637
+ * The ID of the component to fetch configuration from the app API
638
+ * example:
639
+ * 12345678-1234-1234-1234-123456789012
640
+ */
641
+ component_id: string;
642
+ type: "external_integration";
643
+ external_integration_settings?: {
644
+ /**
645
+ * URL to call
646
+ */
647
+ url?: string;
648
+ headers?: {
649
+ [name: string]: any;
650
+ };
651
+ /**
652
+ * SSM Reference to the auth token to use for the request
653
+ */
654
+ auth_token_ref?: string;
655
+ };
656
+ }
657
657
  /**
658
658
  * Information about the installed app. Has configuration data of the installed version
659
659
  */
@@ -772,7 +772,7 @@ declare namespace Components {
772
772
  * Define data which is mapped to entity mapping ui blocks
773
773
  */
774
774
  component_mapping?: {
775
- [name: string]: "string" | "boolean" | "date" | "datetime" | "link";
775
+ [name: string]: "string" | "boolean" | "date" | "datetime" | "link" | "number";
776
776
  };
777
777
  }
778
778
  export interface NotificationConfig {
@@ -1826,7 +1826,6 @@ export type Author = Components.Schemas.Author;
1826
1826
  export type BaseComponent = Components.Schemas.BaseComponent;
1827
1827
  export type BaseComponentCommon = Components.Schemas.BaseComponentCommon;
1828
1828
  export type BaseCustomActionConfig = Components.Schemas.BaseCustomActionConfig;
1829
- export type BasicCustomActionConfig = Components.Schemas.BasicCustomActionConfig;
1830
1829
  export type BillingFrequency = Components.Schemas.BillingFrequency;
1831
1830
  export type BooleanArg = Components.Schemas.BooleanArg;
1832
1831
  export type CallerIdentity = Components.Schemas.CallerIdentity;
@@ -1837,6 +1836,7 @@ export type ConfigurationVersion = Components.Schemas.ConfigurationVersion;
1837
1836
  export type CustomFlowActionComponent = Components.Schemas.CustomFlowActionComponent;
1838
1837
  export type CustomFlowConfig = Components.Schemas.CustomFlowConfig;
1839
1838
  export type EnumArg = Components.Schemas.EnumArg;
1839
+ export type ExternalIntegrationCustomActionConfig = Components.Schemas.ExternalIntegrationCustomActionConfig;
1840
1840
  export type Installation = Components.Schemas.Installation;
1841
1841
  export type JourneyBlockComponent = Components.Schemas.JourneyBlockComponent;
1842
1842
  export type JourneyBlockComponentArgs = Components.Schemas.JourneyBlockComponentArgs;
package/dist/openapi.json CHANGED
@@ -1438,8 +1438,8 @@
1438
1438
  },
1439
1439
  "component_id": {
1440
1440
  "type": "string",
1441
- "description": "The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component",
1442
- "example": "2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88"
1441
+ "description": "The ID of the component to fetch configuration from the app API",
1442
+ "example": "12345678-1234-1234-1234-123456789012"
1443
1443
  }
1444
1444
  },
1445
1445
  "required": [
@@ -1447,7 +1447,7 @@
1447
1447
  "component_id"
1448
1448
  ]
1449
1449
  },
1450
- "BasicCustomActionConfig": {
1450
+ "ExternalIntegrationCustomActionConfig": {
1451
1451
  "allOf": [
1452
1452
  {
1453
1453
  "$ref": "#/components/schemas/BaseCustomActionConfig"
@@ -1458,10 +1458,10 @@
1458
1458
  "type": {
1459
1459
  "type": "string",
1460
1460
  "enum": [
1461
- "basic"
1461
+ "external_integration"
1462
1462
  ]
1463
1463
  },
1464
- "basic_settings": {
1464
+ "external_integration_settings": {
1465
1465
  "type": "object",
1466
1466
  "properties": {
1467
1467
  "url": {
@@ -1489,13 +1489,13 @@
1489
1489
  "type": "object",
1490
1490
  "oneOf": [
1491
1491
  {
1492
- "$ref": "#/components/schemas/BasicCustomActionConfig"
1492
+ "$ref": "#/components/schemas/ExternalIntegrationCustomActionConfig"
1493
1493
  }
1494
1494
  ],
1495
1495
  "discriminator": {
1496
1496
  "propertyName": "type",
1497
1497
  "mapping": {
1498
- "basic": "#/components/schemas/BasicCustomActionConfig"
1498
+ "external_integration": "#/components/schemas/ExternalIntegrationCustomActionConfig"
1499
1499
  }
1500
1500
  }
1501
1501
  },
@@ -1677,7 +1677,8 @@
1677
1677
  "boolean",
1678
1678
  "date",
1679
1679
  "datetime",
1680
- "link"
1680
+ "link",
1681
+ "number"
1681
1682
  ]
1682
1683
  }
1683
1684
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/app-client",
3
- "version": "0.4.0",
3
+ "version": "0.5.1",
4
4
  "description": "JavaScript client library for the epilot App API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",