@epilot/app-client 0.1.0 → 0.1.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
@@ -161,7 +161,7 @@ declare namespace Components {
161
161
  * Configuration of the published app
162
162
  */
163
163
  export interface Configuration {
164
- app_id?: string;
164
+ app_id: string;
165
165
  name: TranslatedString;
166
166
  author?: Author;
167
167
  /**
@@ -191,7 +191,7 @@ declare namespace Components {
191
191
  description: TranslatedString;
192
192
  notifications?: NotificationConfig;
193
193
  /**
194
- * Organization ID of the app owner, required for private apps or sandbox accounts
194
+ * Organization ID of the app owner
195
195
  */
196
196
  owner_org_id: string;
197
197
  /**
@@ -260,7 +260,7 @@ declare namespace Components {
260
260
  * Basic metadata about your app configuration which does not get versioned
261
261
  */
262
262
  export interface ConfigurationMetadata {
263
- app_id?: string;
263
+ app_id: string;
264
264
  name: TranslatedString;
265
265
  author?: Author;
266
266
  /**
@@ -316,6 +316,11 @@ declare namespace Components {
316
316
  * Configuration data about your app which is versionable
317
317
  */
318
318
  export interface ConfigurationVersion {
319
+ app_id: string;
320
+ /**
321
+ * Organization ID of the app owner
322
+ */
323
+ owner_org_id: string;
319
324
  components: BaseComponent[];
320
325
  /**
321
326
  * Flag to indicate if the app is public.
@@ -408,6 +413,10 @@ declare namespace Components {
408
413
  * Information about the installed app. Has configuration data of the installed version
409
414
  */
410
415
  export interface Installation {
416
+ /**
417
+ * ID of the app configuration
418
+ */
419
+ app_id: string;
411
420
  /**
412
421
  * Unique identifier for the organization the app is installed in
413
422
  */
@@ -479,7 +488,7 @@ declare namespace Components {
479
488
  * example:
480
489
  * developer@example.com
481
490
  */
482
- email?: string;
491
+ email?: string; // email
483
492
  /**
484
493
  * List of events to subscribe to
485
494
  */
@@ -700,7 +709,7 @@ declare namespace Paths {
700
709
  version?: Parameters.Version;
701
710
  }
702
711
  namespace Responses {
703
- export type $200 = /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation;
712
+ export type $200 = /* Configuration of the published app */ Components.Schemas.Configuration;
704
713
  export interface $404 {
705
714
  }
706
715
  }
package/dist/openapi.json CHANGED
@@ -143,7 +143,7 @@
143
143
  "content": {
144
144
  "application/json": {
145
145
  "schema": {
146
- "$ref": "#/components/schemas/Installation"
146
+ "$ref": "#/components/schemas/Configuration"
147
147
  }
148
148
  }
149
149
  }
@@ -1019,6 +1019,7 @@
1019
1019
  "properties": {
1020
1020
  "email": {
1021
1021
  "type": "string",
1022
+ "format": "email",
1022
1023
  "description": "Email address to receive notifications",
1023
1024
  "example": "developer@example.com"
1024
1025
  },
@@ -1468,7 +1469,8 @@
1468
1469
  "description",
1469
1470
  "latest_version",
1470
1471
  "owner_org_id",
1471
- "has_public_version"
1472
+ "has_public_version",
1473
+ "app_id"
1472
1474
  ],
1473
1475
  "properties": {
1474
1476
  "app_id": {
@@ -1546,9 +1548,20 @@
1546
1548
  "required": [
1547
1549
  "version",
1548
1550
  "components",
1549
- "version_audit"
1551
+ "app_id",
1552
+ "version_audit",
1553
+ "owner_org_id"
1550
1554
  ],
1551
1555
  "properties": {
1556
+ "app_id": {
1557
+ "type": "string",
1558
+ "readOnly": true
1559
+ },
1560
+ "owner_org_id": {
1561
+ "type": "string",
1562
+ "description": "Organization ID of the app owner",
1563
+ "readOnly": true
1564
+ },
1552
1565
  "components": {
1553
1566
  "type": "array",
1554
1567
  "items": {
@@ -1626,6 +1639,7 @@
1626
1639
  "description": "Information about the installed app. Has configuration data of the installed version",
1627
1640
  "type": "object",
1628
1641
  "required": [
1642
+ "app_id",
1629
1643
  "installer_org_id",
1630
1644
  "enabled",
1631
1645
  "name",
@@ -1633,6 +1647,11 @@
1633
1647
  "installed_version"
1634
1648
  ],
1635
1649
  "properties": {
1650
+ "app_id": {
1651
+ "type": "string",
1652
+ "description": "ID of the app configuration",
1653
+ "readOnly": true
1654
+ },
1636
1655
  "installer_org_id": {
1637
1656
  "type": "string",
1638
1657
  "description": "Unique identifier for the organization the app is installed in",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/app-client",
3
- "version": "0.1.0",
3
+ "version": "0.1.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",