@epilot/sdk 2.19.4 → 2.19.6-alpha.0

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 (133) hide show
  1. package/definitions/customer-portal.json +34 -8
  2. package/definitions/environments.json +135 -17
  3. package/dist/apis/access-token.cjs +6 -6
  4. package/dist/apis/access-token.js +1 -1
  5. package/dist/apis/address-suggestions.cjs +6 -6
  6. package/dist/apis/address-suggestions.js +1 -1
  7. package/dist/apis/address.cjs +6 -6
  8. package/dist/apis/address.js +1 -1
  9. package/dist/apis/ai-agents.cjs +6 -6
  10. package/dist/apis/ai-agents.js +1 -1
  11. package/dist/apis/app.cjs +6 -6
  12. package/dist/apis/app.js +1 -1
  13. package/dist/apis/audit-logs.cjs +6 -6
  14. package/dist/apis/audit-logs.js +1 -1
  15. package/dist/apis/automation.cjs +6 -6
  16. package/dist/apis/automation.js +1 -1
  17. package/dist/apis/billing.cjs +6 -6
  18. package/dist/apis/billing.js +1 -1
  19. package/dist/apis/blueprint-manifest.cjs +6 -6
  20. package/dist/apis/blueprint-manifest.js +1 -1
  21. package/dist/apis/calendar.cjs +6 -6
  22. package/dist/apis/calendar.js +1 -1
  23. package/dist/apis/configuration-hub.cjs +6 -6
  24. package/dist/apis/configuration-hub.js +1 -1
  25. package/dist/apis/consent.cjs +6 -6
  26. package/dist/apis/consent.js +1 -1
  27. package/dist/apis/customer-portal.cjs +6 -6
  28. package/dist/apis/customer-portal.d.cts +2 -2
  29. package/dist/apis/customer-portal.d.ts +2 -2
  30. package/dist/apis/customer-portal.js +1 -1
  31. package/dist/apis/dashboard.cjs +6 -6
  32. package/dist/apis/dashboard.js +1 -1
  33. package/dist/apis/data-governance.cjs +6 -6
  34. package/dist/apis/data-governance.js +1 -1
  35. package/dist/apis/deduplication.cjs +6 -6
  36. package/dist/apis/deduplication.js +1 -1
  37. package/dist/apis/design.cjs +6 -6
  38. package/dist/apis/design.js +1 -1
  39. package/dist/apis/document.cjs +6 -6
  40. package/dist/apis/document.js +1 -1
  41. package/dist/apis/email-settings.cjs +6 -6
  42. package/dist/apis/email-settings.js +1 -1
  43. package/dist/apis/email-template.cjs +6 -6
  44. package/dist/apis/email-template.js +1 -1
  45. package/dist/apis/entity-mapping.cjs +6 -6
  46. package/dist/apis/entity-mapping.js +1 -1
  47. package/dist/apis/entity.cjs +6 -6
  48. package/dist/apis/entity.js +1 -1
  49. package/dist/apis/environments.cjs +6 -6
  50. package/dist/apis/environments.d.cts +2 -2
  51. package/dist/apis/environments.d.ts +2 -2
  52. package/dist/apis/environments.js +1 -1
  53. package/dist/apis/event-catalog.cjs +6 -6
  54. package/dist/apis/event-catalog.js +1 -1
  55. package/dist/apis/file.cjs +6 -6
  56. package/dist/apis/file.js +1 -1
  57. package/dist/apis/iban.cjs +6 -6
  58. package/dist/apis/iban.js +1 -1
  59. package/dist/apis/integration-toolkit.cjs +6 -6
  60. package/dist/apis/integration-toolkit.js +1 -1
  61. package/dist/apis/journey.cjs +6 -6
  62. package/dist/apis/journey.js +1 -1
  63. package/dist/apis/kanban.cjs +6 -6
  64. package/dist/apis/kanban.js +1 -1
  65. package/dist/apis/message.cjs +6 -6
  66. package/dist/apis/message.js +1 -1
  67. package/dist/apis/metering.cjs +6 -6
  68. package/dist/apis/metering.js +1 -1
  69. package/dist/apis/notes.cjs +6 -6
  70. package/dist/apis/notes.js +1 -1
  71. package/dist/apis/notification.cjs +6 -6
  72. package/dist/apis/notification.js +1 -1
  73. package/dist/apis/organization.cjs +6 -6
  74. package/dist/apis/organization.js +1 -1
  75. package/dist/apis/partner-directory.cjs +6 -6
  76. package/dist/apis/partner-directory.js +1 -1
  77. package/dist/apis/permissions.cjs +6 -6
  78. package/dist/apis/permissions.js +1 -1
  79. package/dist/apis/pricing-tier.cjs +6 -6
  80. package/dist/apis/pricing-tier.js +1 -1
  81. package/dist/apis/pricing.cjs +6 -6
  82. package/dist/apis/pricing.js +1 -1
  83. package/dist/apis/purpose.cjs +6 -6
  84. package/dist/apis/purpose.js +1 -1
  85. package/dist/apis/query.cjs +6 -6
  86. package/dist/apis/query.js +1 -1
  87. package/dist/apis/sandbox.cjs +6 -6
  88. package/dist/apis/sandbox.js +1 -1
  89. package/dist/apis/sharing.cjs +6 -6
  90. package/dist/apis/sharing.js +1 -1
  91. package/dist/apis/snapshot.cjs +6 -6
  92. package/dist/apis/snapshot.js +1 -1
  93. package/dist/apis/submission.cjs +6 -6
  94. package/dist/apis/submission.js +1 -1
  95. package/dist/apis/target.cjs +6 -6
  96. package/dist/apis/target.js +1 -1
  97. package/dist/apis/targeting.cjs +6 -6
  98. package/dist/apis/targeting.js +1 -1
  99. package/dist/apis/template-variables.cjs +6 -6
  100. package/dist/apis/template-variables.js +1 -1
  101. package/dist/apis/user.cjs +6 -6
  102. package/dist/apis/user.js +1 -1
  103. package/dist/apis/validation-rules.cjs +6 -6
  104. package/dist/apis/validation-rules.js +1 -1
  105. package/dist/apis/webhooks.cjs +6 -6
  106. package/dist/apis/webhooks.js +1 -1
  107. package/dist/apis/workflow-definition.cjs +6 -6
  108. package/dist/apis/workflow-definition.js +1 -1
  109. package/dist/apis/workflow.cjs +6 -6
  110. package/dist/apis/workflow.js +1 -1
  111. package/dist/bin/cli.js +1 -1
  112. package/dist/{chunk-AD5FK5LK.cjs → chunk-F4OENWBE.cjs} +2 -2
  113. package/dist/{chunk-PHOP6DMJ.js → chunk-JCBXIJ45.js} +2 -2
  114. package/dist/customer-portal-CDFQM72A.js +7 -0
  115. package/dist/customer-portal-MS6WNXAO.cjs +7 -0
  116. package/dist/{customer-portal.d-DTnk0yQf.d.cts → customer-portal.d-DJHJY-vb.d.cts} +51 -8
  117. package/dist/{customer-portal.d-DTnk0yQf.d.ts → customer-portal.d-DJHJY-vb.d.ts} +51 -8
  118. package/dist/environments-JP2CPDH2.cjs +7 -0
  119. package/dist/environments-PGRMZY5G.js +7 -0
  120. package/dist/{environments.d-BvqvN-PD.d.cts → environments.d-840_mC07.d.cts} +144 -32
  121. package/dist/{environments.d-BvqvN-PD.d.ts → environments.d-840_mC07.d.ts} +144 -32
  122. package/dist/index.cjs +8 -8
  123. package/dist/index.d.cts +2 -2
  124. package/dist/index.d.ts +2 -2
  125. package/dist/index.js +1 -1
  126. package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
  127. package/docs/customer-portal.md +13 -4
  128. package/docs/environments.md +128 -20
  129. package/package.json +12 -11
  130. package/dist/customer-portal-FCUPDA7V.cjs +0 -7
  131. package/dist/customer-portal-GRWXQYKT.js +0 -7
  132. package/dist/environments-PXJOTQVM.js +0 -7
  133. package/dist/environments-QJ4UMJ5C.cjs +0 -7
@@ -1460,6 +1460,10 @@ declare namespace Components {
1460
1460
  * Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
1461
1461
  */
1462
1462
  notification_triggers?: NotificationTriggerConfig[];
1463
+ /**
1464
+ * Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it.
1465
+ */
1466
+ engagement_center_enabled?: boolean;
1463
1467
  }
1464
1468
  export interface CommonConfigAttributesV3 {
1465
1469
  /**
@@ -3290,7 +3294,27 @@ declare namespace Components {
3290
3294
  templates?: {
3291
3295
  [name: string]: string;
3292
3296
  };
3293
- templates_ref?: /* Reference to admin-authored portal configuration (a page block or a global search configuration item) from which the API derives Handlebars templates server-side. This replaces client-supplied template strings so portal users can never submit arbitrary templates for resolution. When both a reference and raw `templates` are provided, the reference wins and the raw templates are ignored. */ TemplatesRef;
3297
+ /**
3298
+ * Reference to admin-authored portal configuration (a page block or a global search configuration item) from which the API derives Handlebars templates server-side. This replaces client-supplied template strings so portal users can never submit arbitrary templates for resolution. When both a reference and raw `templates` are provided, the reference wins and the raw templates are ignored.
3299
+ */
3300
+ templates_ref?: {
3301
+ /**
3302
+ * ID of the portal page to derive templates from. When given without `block_id`, templates are derived from every block of the page and returned resolved as a nested map keyed by block id (the entity detail page contract).
3303
+ */
3304
+ page_id?: string;
3305
+ /**
3306
+ * ID of a block within the page. Templates are derived from the block's content according to its block type (e.g. meter_selector, meter_reading, entity_list).
3307
+ */
3308
+ block_id?: string;
3309
+ /**
3310
+ * For blocks carrying a per-schema configuration array (entity_list), the id of the configuration item to derive templates from. Requires `page_id` and `block_id`.
3311
+ */
3312
+ config_id?: string;
3313
+ /**
3314
+ * ID of the portal's `global_search` configuration item to derive search result templates and the group title template from. Mutually exclusive with `page_id`.
3315
+ */
3316
+ global_search_config_id?: string;
3317
+ };
3294
3318
  }
3295
3319
  export interface EntityTemplates {
3296
3320
  /**
@@ -6610,6 +6634,10 @@ declare namespace Components {
6610
6634
  * Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
6611
6635
  */
6612
6636
  notification_triggers?: NotificationTriggerConfig[];
6637
+ /**
6638
+ * Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it.
6639
+ */
6640
+ engagement_center_enabled?: boolean;
6613
6641
  /**
6614
6642
  * ID of the organization
6615
6643
  * example:
@@ -8103,11 +8131,14 @@ declare namespace Components {
8103
8131
  */
8104
8132
  code: string;
8105
8133
  /**
8106
- * The redirect uri
8134
+ * The redirect uri used in the authorization request. Optional: when omitted it is
8135
+ * resolved server-side from the provider's configured `redirect_uri`, falling back to
8136
+ * the portal's own callback route (`https://<domain>/sso`).
8137
+ *
8107
8138
  * example:
8108
- * https://customer-portal.com/login
8139
+ * https://customer-portal.com/sso
8109
8140
  */
8110
- redirect_uri: string;
8141
+ redirect_uri?: string;
8111
8142
  /**
8112
8143
  * The client id
8113
8144
  * example:
@@ -9011,6 +9042,10 @@ declare namespace Components {
9011
9042
  * Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
9012
9043
  */
9013
9044
  notification_triggers?: NotificationTriggerConfig[];
9045
+ /**
9046
+ * Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it.
9047
+ */
9048
+ engagement_center_enabled?: boolean;
9014
9049
  }
9015
9050
  export interface UpsertPortalConfigV3 {
9016
9051
  /**
@@ -9664,7 +9699,7 @@ declare namespace Components {
9664
9699
  /**
9665
9700
  * Intervals supported for the current context. If omitted, all intervals are assumed supported.
9666
9701
  */
9667
- intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
9702
+ intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y")[];
9668
9703
  data_range?: /* Earliest / latest timestamps for which data is available in the current context. */ VisualizationDataRange;
9669
9704
  }
9670
9705
  export interface VisualizationTypeOption {
@@ -11355,7 +11390,7 @@ declare namespace Paths {
11355
11390
  export type ExtensionId = string;
11356
11391
  export type From = string; // date-time
11357
11392
  export type HookId = string;
11358
- export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M";
11393
+ export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y";
11359
11394
  export type MeterId = string;
11360
11395
  export type To = string; // date-time
11361
11396
  }
@@ -11712,7 +11747,7 @@ declare namespace Paths {
11712
11747
  export type ExtensionId = string;
11713
11748
  export type From = string; // date-time
11714
11749
  export type HookId = string;
11715
- export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M";
11750
+ export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y";
11716
11751
  export type MeterId = string;
11717
11752
  export type To = string; // date-time
11718
11753
  }
@@ -13558,6 +13593,10 @@ declare namespace Paths {
13558
13593
  * Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
13559
13594
  */
13560
13595
  notification_triggers?: Components.Schemas.NotificationTriggerConfig[];
13596
+ /**
13597
+ * Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it.
13598
+ */
13599
+ engagement_center_enabled?: boolean;
13561
13600
  /**
13562
13601
  * ID of the organization
13563
13602
  * example:
@@ -14180,6 +14219,10 @@ declare namespace Paths {
14180
14219
  * Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
14181
14220
  */
14182
14221
  notification_triggers?: Components.Schemas.NotificationTriggerConfig[];
14222
+ /**
14223
+ * Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it.
14224
+ */
14225
+ engagement_center_enabled?: boolean;
14183
14226
  /**
14184
14227
  * ID of the organization
14185
14228
  * example:
@@ -14580,7 +14623,7 @@ declare namespace Paths {
14580
14623
  export type ExtensionId = string;
14581
14624
  export type From = string; // date-time
14582
14625
  export type HookId = string;
14583
- export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M";
14626
+ export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y";
14584
14627
  export type MeterId = string;
14585
14628
  export type To = string; // date-time
14586
14629
  }
@@ -1460,6 +1460,10 @@ declare namespace Components {
1460
1460
  * Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
1461
1461
  */
1462
1462
  notification_triggers?: NotificationTriggerConfig[];
1463
+ /**
1464
+ * Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it.
1465
+ */
1466
+ engagement_center_enabled?: boolean;
1463
1467
  }
1464
1468
  export interface CommonConfigAttributesV3 {
1465
1469
  /**
@@ -3290,7 +3294,27 @@ declare namespace Components {
3290
3294
  templates?: {
3291
3295
  [name: string]: string;
3292
3296
  };
3293
- templates_ref?: /* Reference to admin-authored portal configuration (a page block or a global search configuration item) from which the API derives Handlebars templates server-side. This replaces client-supplied template strings so portal users can never submit arbitrary templates for resolution. When both a reference and raw `templates` are provided, the reference wins and the raw templates are ignored. */ TemplatesRef;
3297
+ /**
3298
+ * Reference to admin-authored portal configuration (a page block or a global search configuration item) from which the API derives Handlebars templates server-side. This replaces client-supplied template strings so portal users can never submit arbitrary templates for resolution. When both a reference and raw `templates` are provided, the reference wins and the raw templates are ignored.
3299
+ */
3300
+ templates_ref?: {
3301
+ /**
3302
+ * ID of the portal page to derive templates from. When given without `block_id`, templates are derived from every block of the page and returned resolved as a nested map keyed by block id (the entity detail page contract).
3303
+ */
3304
+ page_id?: string;
3305
+ /**
3306
+ * ID of a block within the page. Templates are derived from the block's content according to its block type (e.g. meter_selector, meter_reading, entity_list).
3307
+ */
3308
+ block_id?: string;
3309
+ /**
3310
+ * For blocks carrying a per-schema configuration array (entity_list), the id of the configuration item to derive templates from. Requires `page_id` and `block_id`.
3311
+ */
3312
+ config_id?: string;
3313
+ /**
3314
+ * ID of the portal's `global_search` configuration item to derive search result templates and the group title template from. Mutually exclusive with `page_id`.
3315
+ */
3316
+ global_search_config_id?: string;
3317
+ };
3294
3318
  }
3295
3319
  export interface EntityTemplates {
3296
3320
  /**
@@ -6610,6 +6634,10 @@ declare namespace Components {
6610
6634
  * Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
6611
6635
  */
6612
6636
  notification_triggers?: NotificationTriggerConfig[];
6637
+ /**
6638
+ * Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it.
6639
+ */
6640
+ engagement_center_enabled?: boolean;
6613
6641
  /**
6614
6642
  * ID of the organization
6615
6643
  * example:
@@ -8103,11 +8131,14 @@ declare namespace Components {
8103
8131
  */
8104
8132
  code: string;
8105
8133
  /**
8106
- * The redirect uri
8134
+ * The redirect uri used in the authorization request. Optional: when omitted it is
8135
+ * resolved server-side from the provider's configured `redirect_uri`, falling back to
8136
+ * the portal's own callback route (`https://<domain>/sso`).
8137
+ *
8107
8138
  * example:
8108
- * https://customer-portal.com/login
8139
+ * https://customer-portal.com/sso
8109
8140
  */
8110
- redirect_uri: string;
8141
+ redirect_uri?: string;
8111
8142
  /**
8112
8143
  * The client id
8113
8144
  * example:
@@ -9011,6 +9042,10 @@ declare namespace Components {
9011
9042
  * Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
9012
9043
  */
9013
9044
  notification_triggers?: NotificationTriggerConfig[];
9045
+ /**
9046
+ * Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it.
9047
+ */
9048
+ engagement_center_enabled?: boolean;
9014
9049
  }
9015
9050
  export interface UpsertPortalConfigV3 {
9016
9051
  /**
@@ -9664,7 +9699,7 @@ declare namespace Components {
9664
9699
  /**
9665
9700
  * Intervals supported for the current context. If omitted, all intervals are assumed supported.
9666
9701
  */
9667
- intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
9702
+ intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y")[];
9668
9703
  data_range?: /* Earliest / latest timestamps for which data is available in the current context. */ VisualizationDataRange;
9669
9704
  }
9670
9705
  export interface VisualizationTypeOption {
@@ -11355,7 +11390,7 @@ declare namespace Paths {
11355
11390
  export type ExtensionId = string;
11356
11391
  export type From = string; // date-time
11357
11392
  export type HookId = string;
11358
- export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M";
11393
+ export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y";
11359
11394
  export type MeterId = string;
11360
11395
  export type To = string; // date-time
11361
11396
  }
@@ -11712,7 +11747,7 @@ declare namespace Paths {
11712
11747
  export type ExtensionId = string;
11713
11748
  export type From = string; // date-time
11714
11749
  export type HookId = string;
11715
- export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M";
11750
+ export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y";
11716
11751
  export type MeterId = string;
11717
11752
  export type To = string; // date-time
11718
11753
  }
@@ -13558,6 +13593,10 @@ declare namespace Paths {
13558
13593
  * Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
13559
13594
  */
13560
13595
  notification_triggers?: Components.Schemas.NotificationTriggerConfig[];
13596
+ /**
13597
+ * Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it.
13598
+ */
13599
+ engagement_center_enabled?: boolean;
13561
13600
  /**
13562
13601
  * ID of the organization
13563
13602
  * example:
@@ -14180,6 +14219,10 @@ declare namespace Paths {
14180
14219
  * Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
14181
14220
  */
14182
14221
  notification_triggers?: Components.Schemas.NotificationTriggerConfig[];
14222
+ /**
14223
+ * Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it.
14224
+ */
14225
+ engagement_center_enabled?: boolean;
14183
14226
  /**
14184
14227
  * ID of the organization
14185
14228
  * example:
@@ -14580,7 +14623,7 @@ declare namespace Paths {
14580
14623
  export type ExtensionId = string;
14581
14624
  export type From = string; // date-time
14582
14625
  export type HookId = string;
14583
- export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M";
14626
+ export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y";
14584
14627
  export type MeterId = string;
14585
14628
  export type To = string; // date-time
14586
14629
  }
@@ -0,0 +1,7 @@
1
+ "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
+
3
+ // src/docs/environments.json
4
+ var environments_default = '# Environments API\n\n- **Base URL:** `https://environments.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/environments](https://docs.epilot.io/api/environments)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.environments.listEnvironmentVariables(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/environments\'\n\nconst environmentsClient = getClient()\nauthorize(environmentsClient, () => \'<token>\')\nconst { data } = await environmentsClient.listEnvironmentVariables(...)\n```\n\n## Operations\n\n**environments**\n- [`listEnvironmentVariables`](#listenvironmentvariables)\n- [`createEnvironmentVariable`](#createenvironmentvariable)\n- [`listEnvironmentGroups`](#listenvironmentgroups)\n- [`putEnvironmentGroup`](#putenvironmentgroup)\n- [`deleteEnvironmentGroup`](#deleteenvironmentgroup)\n- [`getEnvironmentVariable`](#getenvironmentvariable)\n- [`updateEnvironmentVariable`](#updateenvironmentvariable)\n- [`deleteEnvironmentVariable`](#deleteenvironmentvariable)\n\n**Schemas**\n- [`EnvironmentValueType`](#environmentvaluetype)\n- [`EnvironmentOption`](#environmentoption)\n- [`OptionsValue`](#optionsvalue)\n- [`EnvironmentValue`](#environmentvalue)\n- [`EnvironmentVariable`](#environmentvariable)\n- [`EnvironmentVariableListItem`](#environmentvariablelistitem)\n- [`EnvironmentVariableList`](#environmentvariablelist)\n- [`EnvironmentVariableCreateRequest`](#environmentvariablecreaterequest)\n- [`EnvironmentVariableUpdateRequest`](#environmentvariableupdaterequest)\n- [`EnvironmentGroup`](#environmentgroup)\n- [`EnvironmentGroupList`](#environmentgrouplist)\n- [`EnvironmentGroupUpsertRequest`](#environmentgroupupsertrequest)\n\n### `listEnvironmentVariables`\n\nList all environment variables for the organization. Returns metadata only, no secret values.\n\n`GET /v1/environments`\n\n```ts\nconst { data } = await client.listEnvironmentVariables()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "items": [\n {\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createEnvironmentVariable`\n\nCreate a new environment variable or secret for the organization. If `group` is provided and the group does not yet exist, it is created automatically.\n\n`POST /v1/environments`\n\n```ts\nconst { data } = await client.createEnvironmentVariable(\n null,\n {\n key: \'string\',\n type: \'String\',\n description: \'string\',\n group: \'string\',\n value: \'string\',\n protected: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listEnvironmentGroups`\n\nList all environment groups for the organization.\n\n`GET /v1/environments/groups`\n\n```ts\nconst { data } = await client.listEnvironmentGroups()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "items": [\n {\n "name": "string",\n "description": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `putEnvironmentGroup`\n\nCreate or update an environment group by name. Acts as an upsert \u2014 creates the group if it does not exist.\n\n`PUT /v1/environments/groups/{name}`\n\n```ts\nconst { data } = await client.putEnvironmentGroup(\n {\n name: \'example\',\n },\n {\n description: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "description": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteEnvironmentGroup`\n\nDeletes a group. Variables assigned to this group become ungrouped.\n\n`DELETE /v1/environments/groups/{name}`\n\n```ts\nconst { data } = await client.deleteEnvironmentGroup({\n name: \'example\',\n})\n```\n\n---\n\n### `getEnvironmentVariable`\n\nGet an environment variable by key. Returns value for non-secret types, omitted for SecretString.\n\n`GET /v1/environments/{key}`\n\n```ts\nconst { data } = await client.getEnvironmentVariable({\n key: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateEnvironmentVariable`\n\nCreate or update an environment variable. Acts as an upsert \u2014 creates the variable if it does not exist. If `group` is provided and the group does not yet exist, it is created automatically.\n\n`PUT /v1/environments/{key}`\n\n```ts\nconst { data } = await client.updateEnvironmentVariable(\n {\n key: \'example\',\n },\n {\n type: \'String\',\n value: \'string\',\n description: \'string\',\n group: \'string\',\n protected: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteEnvironmentVariable`\n\nDelete an environment variable by key.\n\n`DELETE /v1/environments/{key}`\n\n```ts\nconst { data } = await client.deleteEnvironmentVariable({\n key: \'example\',\n})\n```\n\n---\n\n## Schemas\n\n### `EnvironmentValueType`\n\nThe structure a variable\'s value holds. `SecretString` is encrypted at rest and\nits value is never returned. `Text`, `Number`, `Boolean` and `Options` may be\nserved to browser-facing consumers; `String` and `SecretString` may not.\n\n\n```ts\ntype EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n```\n\n### `EnvironmentOption`\n\n```ts\ntype EnvironmentOption = {\n value: string\n label: string\n} | {\n value: string\n labels: Record<string, string>\n}\n```\n\n### `OptionsValue`\n\n```ts\ntype OptionsValue = {\n fallbackLanguage?: string\n options: Array<{\n value: string\n label: string\n } | {\n value: string\n labels: Record<string, string>\n }>\n}\n```\n\n### `EnvironmentValue`\n\nA variable\'s value. The JSON type corresponds to the variable\'s `type`:\n`String`, `SecretString` and `Text` are strings, `Number` is a number,\n`Boolean` is a boolean, and `Options` is an object. Numbers are IEEE 754\ndoubles; integers above 2^53 may lose precision on round-trip.\n\n\n```ts\ntype EnvironmentValue = string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: string\n label: string\n } | {\n value: string\n labels: Record<string, string>\n }>\n}\n```\n\n### `EnvironmentVariable`\n\n```ts\ntype EnvironmentVariable = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableListItem`\n\n```ts\ntype EnvironmentVariableListItem = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableList`\n\n```ts\ntype EnvironmentVariableList = {\n items: Array<{\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: { ... }\n options: { ... }\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n }>\n}\n```\n\n### `EnvironmentVariableCreateRequest`\n\n```ts\ntype EnvironmentVariableCreateRequest = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n protected?: boolean\n}\n```\n\n### `EnvironmentVariableUpdateRequest`\n\n```ts\ntype EnvironmentVariableUpdateRequest = {\n type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n description?: string\n group?: string\n protected?: boolean\n}\n```\n\n### `EnvironmentGroup`\n\n```ts\ntype EnvironmentGroup = {\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentGroupList`\n\n```ts\ntype EnvironmentGroupList = {\n items: Array<{\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n }>\n}\n```\n\n### `EnvironmentGroupUpsertRequest`\n\n```ts\ntype EnvironmentGroupUpsertRequest = {\n description?: string\n}\n```\n';
5
+
6
+
7
+ exports.default = environments_default;
@@ -0,0 +1,7 @@
1
+ import "./chunk-YPSWSI3M.js";
2
+
3
+ // src/docs/environments.json
4
+ var environments_default = '# Environments API\n\n- **Base URL:** `https://environments.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/environments](https://docs.epilot.io/api/environments)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.environments.listEnvironmentVariables(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/environments\'\n\nconst environmentsClient = getClient()\nauthorize(environmentsClient, () => \'<token>\')\nconst { data } = await environmentsClient.listEnvironmentVariables(...)\n```\n\n## Operations\n\n**environments**\n- [`listEnvironmentVariables`](#listenvironmentvariables)\n- [`createEnvironmentVariable`](#createenvironmentvariable)\n- [`listEnvironmentGroups`](#listenvironmentgroups)\n- [`putEnvironmentGroup`](#putenvironmentgroup)\n- [`deleteEnvironmentGroup`](#deleteenvironmentgroup)\n- [`getEnvironmentVariable`](#getenvironmentvariable)\n- [`updateEnvironmentVariable`](#updateenvironmentvariable)\n- [`deleteEnvironmentVariable`](#deleteenvironmentvariable)\n\n**Schemas**\n- [`EnvironmentValueType`](#environmentvaluetype)\n- [`EnvironmentOption`](#environmentoption)\n- [`OptionsValue`](#optionsvalue)\n- [`EnvironmentValue`](#environmentvalue)\n- [`EnvironmentVariable`](#environmentvariable)\n- [`EnvironmentVariableListItem`](#environmentvariablelistitem)\n- [`EnvironmentVariableList`](#environmentvariablelist)\n- [`EnvironmentVariableCreateRequest`](#environmentvariablecreaterequest)\n- [`EnvironmentVariableUpdateRequest`](#environmentvariableupdaterequest)\n- [`EnvironmentGroup`](#environmentgroup)\n- [`EnvironmentGroupList`](#environmentgrouplist)\n- [`EnvironmentGroupUpsertRequest`](#environmentgroupupsertrequest)\n\n### `listEnvironmentVariables`\n\nList all environment variables for the organization. Returns metadata only, no secret values.\n\n`GET /v1/environments`\n\n```ts\nconst { data } = await client.listEnvironmentVariables()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "items": [\n {\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createEnvironmentVariable`\n\nCreate a new environment variable or secret for the organization. If `group` is provided and the group does not yet exist, it is created automatically.\n\n`POST /v1/environments`\n\n```ts\nconst { data } = await client.createEnvironmentVariable(\n null,\n {\n key: \'string\',\n type: \'String\',\n description: \'string\',\n group: \'string\',\n value: \'string\',\n protected: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listEnvironmentGroups`\n\nList all environment groups for the organization.\n\n`GET /v1/environments/groups`\n\n```ts\nconst { data } = await client.listEnvironmentGroups()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "items": [\n {\n "name": "string",\n "description": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `putEnvironmentGroup`\n\nCreate or update an environment group by name. Acts as an upsert \u2014 creates the group if it does not exist.\n\n`PUT /v1/environments/groups/{name}`\n\n```ts\nconst { data } = await client.putEnvironmentGroup(\n {\n name: \'example\',\n },\n {\n description: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "description": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteEnvironmentGroup`\n\nDeletes a group. Variables assigned to this group become ungrouped.\n\n`DELETE /v1/environments/groups/{name}`\n\n```ts\nconst { data } = await client.deleteEnvironmentGroup({\n name: \'example\',\n})\n```\n\n---\n\n### `getEnvironmentVariable`\n\nGet an environment variable by key. Returns value for non-secret types, omitted for SecretString.\n\n`GET /v1/environments/{key}`\n\n```ts\nconst { data } = await client.getEnvironmentVariable({\n key: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateEnvironmentVariable`\n\nCreate or update an environment variable. Acts as an upsert \u2014 creates the variable if it does not exist. If `group` is provided and the group does not yet exist, it is created automatically.\n\n`PUT /v1/environments/{key}`\n\n```ts\nconst { data } = await client.updateEnvironmentVariable(\n {\n key: \'example\',\n },\n {\n type: \'String\',\n value: \'string\',\n description: \'string\',\n group: \'string\',\n protected: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteEnvironmentVariable`\n\nDelete an environment variable by key.\n\n`DELETE /v1/environments/{key}`\n\n```ts\nconst { data } = await client.deleteEnvironmentVariable({\n key: \'example\',\n})\n```\n\n---\n\n## Schemas\n\n### `EnvironmentValueType`\n\nThe structure a variable\'s value holds. `SecretString` is encrypted at rest and\nits value is never returned. `Text`, `Number`, `Boolean` and `Options` may be\nserved to browser-facing consumers; `String` and `SecretString` may not.\n\n\n```ts\ntype EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n```\n\n### `EnvironmentOption`\n\n```ts\ntype EnvironmentOption = {\n value: string\n label: string\n} | {\n value: string\n labels: Record<string, string>\n}\n```\n\n### `OptionsValue`\n\n```ts\ntype OptionsValue = {\n fallbackLanguage?: string\n options: Array<{\n value: string\n label: string\n } | {\n value: string\n labels: Record<string, string>\n }>\n}\n```\n\n### `EnvironmentValue`\n\nA variable\'s value. The JSON type corresponds to the variable\'s `type`:\n`String`, `SecretString` and `Text` are strings, `Number` is a number,\n`Boolean` is a boolean, and `Options` is an object. Numbers are IEEE 754\ndoubles; integers above 2^53 may lose precision on round-trip.\n\n\n```ts\ntype EnvironmentValue = string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: string\n label: string\n } | {\n value: string\n labels: Record<string, string>\n }>\n}\n```\n\n### `EnvironmentVariable`\n\n```ts\ntype EnvironmentVariable = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableListItem`\n\n```ts\ntype EnvironmentVariableListItem = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableList`\n\n```ts\ntype EnvironmentVariableList = {\n items: Array<{\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: { ... }\n options: { ... }\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n }>\n}\n```\n\n### `EnvironmentVariableCreateRequest`\n\n```ts\ntype EnvironmentVariableCreateRequest = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n protected?: boolean\n}\n```\n\n### `EnvironmentVariableUpdateRequest`\n\n```ts\ntype EnvironmentVariableUpdateRequest = {\n type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n value: { ... }\n label: { ... }\n } | {\n value: { ... }\n labels: { ... }\n }>\n }\n description?: string\n group?: string\n protected?: boolean\n}\n```\n\n### `EnvironmentGroup`\n\n```ts\ntype EnvironmentGroup = {\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentGroupList`\n\n```ts\ntype EnvironmentGroupList = {\n items: Array<{\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n }>\n}\n```\n\n### `EnvironmentGroupUpsertRequest`\n\n```ts\ntype EnvironmentGroupUpsertRequest = {\n description?: string\n}\n```\n';
5
+ export {
6
+ environments_default as default
7
+ };