@epilot/app-client 0.5.0 → 0.5.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
@@ -193,36 +193,12 @@ declare namespace Components {
193
193
  * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
194
194
  */
195
195
  app_id: string;
196
- }
197
- export interface BasicCustomActionConfig {
198
- /**
199
- * Name of the custom action
200
- */
201
- name?: string;
202
- /**
203
- * Description of the custom action
204
- */
205
- description?: string;
206
196
  /**
207
- * The ID of the app to fetch configuration from the app API
197
+ * The ID of the component to fetch configuration from the app API
208
198
  * example:
209
- * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
199
+ * 12345678-1234-1234-1234-123456789012
210
200
  */
211
- app_id: string;
212
- type: "basic";
213
- basic_settings?: {
214
- /**
215
- * URL to call
216
- */
217
- url?: string;
218
- headers?: {
219
- [name: string]: any;
220
- };
221
- /**
222
- * SSM Reference to the auth token to use for the request
223
- */
224
- auth_token_ref?: string;
225
- };
201
+ component_id: string;
226
202
  }
227
203
  /**
228
204
  * How often the subscription is billed
@@ -591,7 +567,7 @@ declare namespace Components {
591
567
  component_type: "CUSTOM_FLOW_ACTION";
592
568
  configuration: CustomFlowConfig;
593
569
  }
594
- export type CustomFlowConfig = BasicCustomActionConfig;
570
+ export type CustomFlowConfig = ExternalIntegrationCustomActionConfig;
595
571
  export interface EnumArg {
596
572
  type?: "enum";
597
573
  /**
@@ -642,6 +618,42 @@ declare namespace Components {
642
618
  }[]
643
619
  ];
644
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
+ }
645
657
  /**
646
658
  * Information about the installed app. Has configuration data of the installed version
647
659
  */
@@ -939,6 +951,10 @@ declare namespace Components {
939
951
  * Flag to indicate if the app is public.
940
952
  */
941
953
  public?: boolean;
954
+ /**
955
+ * List of available versions of the app
956
+ */
957
+ versions?: /* Configuration data about your app which is versionable */ ConfigurationVersion[];
942
958
  }
943
959
  export interface S3Reference {
944
960
  /**
@@ -1251,6 +1267,8 @@ declare namespace Paths {
1251
1267
  pageSize?: number;
1252
1268
  };
1253
1269
  }
1270
+ export interface $400 {
1271
+ }
1254
1272
  }
1255
1273
  }
1256
1274
  namespace PatchComponent {
@@ -1814,7 +1832,6 @@ export type Author = Components.Schemas.Author;
1814
1832
  export type BaseComponent = Components.Schemas.BaseComponent;
1815
1833
  export type BaseComponentCommon = Components.Schemas.BaseComponentCommon;
1816
1834
  export type BaseCustomActionConfig = Components.Schemas.BaseCustomActionConfig;
1817
- export type BasicCustomActionConfig = Components.Schemas.BasicCustomActionConfig;
1818
1835
  export type BillingFrequency = Components.Schemas.BillingFrequency;
1819
1836
  export type BooleanArg = Components.Schemas.BooleanArg;
1820
1837
  export type CallerIdentity = Components.Schemas.CallerIdentity;
@@ -1825,6 +1842,7 @@ export type ConfigurationVersion = Components.Schemas.ConfigurationVersion;
1825
1842
  export type CustomFlowActionComponent = Components.Schemas.CustomFlowActionComponent;
1826
1843
  export type CustomFlowConfig = Components.Schemas.CustomFlowConfig;
1827
1844
  export type EnumArg = Components.Schemas.EnumArg;
1845
+ export type ExternalIntegrationCustomActionConfig = Components.Schemas.ExternalIntegrationCustomActionConfig;
1828
1846
  export type Installation = Components.Schemas.Installation;
1829
1847
  export type JourneyBlockComponent = Components.Schemas.JourneyBlockComponent;
1830
1848
  export type JourneyBlockComponentArgs = Components.Schemas.JourneyBlockComponentArgs;
package/dist/openapi.json CHANGED
@@ -443,6 +443,9 @@
443
443
  }
444
444
  }
445
445
  }
446
+ },
447
+ "400": {
448
+ "description": "Invalid parameter"
446
449
  }
447
450
  }
448
451
  }
@@ -1435,13 +1438,19 @@
1435
1438
  "type": "string",
1436
1439
  "description": "The ID of the app to fetch configuration from the app API",
1437
1440
  "example": "c451c26a-cc7a-4c1c-92bf-1c6246cbfe88"
1441
+ },
1442
+ "component_id": {
1443
+ "type": "string",
1444
+ "description": "The ID of the component to fetch configuration from the app API",
1445
+ "example": "12345678-1234-1234-1234-123456789012"
1438
1446
  }
1439
1447
  },
1440
1448
  "required": [
1441
- "app_id"
1449
+ "app_id",
1450
+ "component_id"
1442
1451
  ]
1443
1452
  },
1444
- "BasicCustomActionConfig": {
1453
+ "ExternalIntegrationCustomActionConfig": {
1445
1454
  "allOf": [
1446
1455
  {
1447
1456
  "$ref": "#/components/schemas/BaseCustomActionConfig"
@@ -1452,10 +1461,10 @@
1452
1461
  "type": {
1453
1462
  "type": "string",
1454
1463
  "enum": [
1455
- "basic"
1464
+ "external_integration"
1456
1465
  ]
1457
1466
  },
1458
- "basic_settings": {
1467
+ "external_integration_settings": {
1459
1468
  "type": "object",
1460
1469
  "properties": {
1461
1470
  "url": {
@@ -1483,13 +1492,13 @@
1483
1492
  "type": "object",
1484
1493
  "oneOf": [
1485
1494
  {
1486
- "$ref": "#/components/schemas/BasicCustomActionConfig"
1495
+ "$ref": "#/components/schemas/ExternalIntegrationCustomActionConfig"
1487
1496
  }
1488
1497
  ],
1489
1498
  "discriminator": {
1490
1499
  "propertyName": "type",
1491
1500
  "mapping": {
1492
- "basic": "#/components/schemas/BasicCustomActionConfig"
1501
+ "external_integration": "#/components/schemas/ExternalIntegrationCustomActionConfig"
1493
1502
  }
1494
1503
  }
1495
1504
  },
@@ -2236,6 +2245,13 @@
2236
2245
  "default": true,
2237
2246
  "description": "Flag to indicate if the app is public.",
2238
2247
  "readOnly": true
2248
+ },
2249
+ "versions": {
2250
+ "type": "array",
2251
+ "items": {
2252
+ "$ref": "#/components/schemas/ConfigurationVersion"
2253
+ },
2254
+ "description": "List of available versions of the app"
2239
2255
  }
2240
2256
  }
2241
2257
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/app-client",
3
- "version": "0.5.0",
3
+ "version": "0.5.2",
4
4
  "description": "JavaScript client library for the epilot App API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",