@icepanel/sdk 0.1.2 → 0.1.6

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 (191) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/BaseClient.d.ts +7 -9
  3. package/dist/cjs/BaseClient.js +8 -3
  4. package/dist/cjs/Client.d.ts +2 -2
  5. package/dist/cjs/Client.js +1 -1
  6. package/dist/cjs/IcePanelClient.d.ts +7 -8
  7. package/dist/cjs/IcePanelClient.js +11 -11
  8. package/dist/cjs/api/requests/requests.d.ts +62 -142
  9. package/dist/cjs/api/resources/catalog/client/Client.d.ts +2 -2
  10. package/dist/cjs/api/resources/catalog/client/Client.js +1 -1
  11. package/dist/cjs/api/resources/catalog/resources/technologies/client/Client.d.ts +2 -71
  12. package/dist/cjs/api/resources/catalog/resources/technologies/client/Client.js +5 -262
  13. package/dist/cjs/api/resources/catalog/resources/technologies/types/types.d.ts +0 -12
  14. package/dist/cjs/api/resources/comments/client/Client.d.ts +7 -5
  15. package/dist/cjs/api/resources/comments/client/Client.js +25 -28
  16. package/dist/cjs/api/resources/comments/resources/replies/client/Client.d.ts +5 -3
  17. package/dist/cjs/api/resources/comments/resources/replies/client/Client.js +23 -26
  18. package/dist/cjs/api/resources/diagrams/client/Client.d.ts +4 -3
  19. package/dist/cjs/api/resources/diagrams/client/Client.js +31 -32
  20. package/dist/cjs/api/resources/diagrams/resources/content/client/Client.d.ts +2 -2
  21. package/dist/cjs/api/resources/diagrams/resources/content/client/Client.js +10 -7
  22. package/dist/cjs/api/resources/diagrams/resources/export/client/Client.d.ts +2 -2
  23. package/dist/cjs/api/resources/diagrams/resources/export/client/Client.js +7 -5
  24. package/dist/cjs/api/resources/diagrams/resources/groups/client/Client.d.ts +6 -4
  25. package/dist/cjs/api/resources/diagrams/resources/groups/client/Client.js +27 -29
  26. package/dist/cjs/api/resources/domains/client/Client.d.ts +5 -3
  27. package/dist/cjs/api/resources/domains/client/Client.js +26 -28
  28. package/dist/cjs/api/resources/drafts/client/Client.d.ts +2 -2
  29. package/dist/cjs/api/resources/drafts/client/Client.js +22 -15
  30. package/dist/cjs/api/resources/flows/client/Client.d.ts +2 -2
  31. package/dist/cjs/api/resources/flows/client/Client.js +28 -19
  32. package/dist/cjs/api/resources/flows/resources/export/client/Client.d.ts +2 -2
  33. package/dist/cjs/api/resources/flows/resources/export/client/Client.js +10 -7
  34. package/dist/cjs/api/resources/landscapes/client/Client.d.ts +2 -2
  35. package/dist/cjs/api/resources/landscapes/client/Client.js +19 -13
  36. package/dist/cjs/api/resources/landscapes/resources/export/client/Client.d.ts +2 -2
  37. package/dist/cjs/api/resources/landscapes/resources/export/client/Client.js +7 -5
  38. package/dist/cjs/api/resources/landscapes/resources/logs/client/Client.d.ts +2 -2
  39. package/dist/cjs/api/resources/landscapes/resources/logs/client/Client.js +10 -7
  40. package/dist/cjs/api/resources/landscapes/resources/logs/resources/stats/client/Client.d.ts +2 -2
  41. package/dist/cjs/api/resources/landscapes/resources/logs/resources/stats/client/Client.js +7 -5
  42. package/dist/cjs/api/resources/model/client/Client.d.ts +2 -2
  43. package/dist/cjs/api/resources/model/client/Client.js +1 -1
  44. package/dist/cjs/api/resources/model/resources/connections/client/Client.d.ts +28 -5
  45. package/dist/cjs/api/resources/model/resources/connections/client/Client.js +95 -17
  46. package/dist/cjs/api/resources/model/resources/connections/resources/export/client/Client.d.ts +3 -3
  47. package/dist/cjs/api/resources/model/resources/connections/resources/export/client/Client.js +6 -4
  48. package/dist/cjs/api/resources/model/resources/connections/types/types.d.ts +6 -0
  49. package/dist/cjs/api/resources/model/resources/objects/client/Client.d.ts +6 -4
  50. package/dist/cjs/api/resources/model/resources/objects/client/Client.js +24 -27
  51. package/dist/cjs/api/resources/model/resources/objects/resources/export/client/Client.d.ts +3 -3
  52. package/dist/cjs/api/resources/model/resources/objects/resources/export/client/Client.js +9 -6
  53. package/dist/cjs/api/resources/organizations/client/Client.d.ts +2 -2
  54. package/dist/cjs/api/resources/organizations/client/Client.js +16 -11
  55. package/dist/cjs/api/resources/organizations/resources/landscapes/client/Client.d.ts +2 -2
  56. package/dist/cjs/api/resources/organizations/resources/landscapes/client/Client.js +7 -5
  57. package/dist/cjs/api/resources/organizations/resources/logs/client/Client.d.ts +2 -2
  58. package/dist/cjs/api/resources/organizations/resources/logs/client/Client.js +7 -5
  59. package/dist/cjs/api/resources/organizations/resources/logs/resources/stats/client/Client.d.ts +2 -2
  60. package/dist/cjs/api/resources/organizations/resources/logs/resources/stats/client/Client.js +7 -5
  61. package/dist/cjs/api/resources/organizations/resources/technologies/client/Client.d.ts +2 -2
  62. package/dist/cjs/api/resources/organizations/resources/technologies/client/Client.js +16 -11
  63. package/dist/cjs/api/resources/organizations/resources/users/client/Client.d.ts +2 -2
  64. package/dist/cjs/api/resources/organizations/resources/users/client/Client.js +10 -7
  65. package/dist/cjs/api/resources/organizations/resources/users/resources/invites/client/Client.d.ts +2 -2
  66. package/dist/cjs/api/resources/organizations/resources/users/resources/invites/client/Client.js +10 -7
  67. package/dist/cjs/api/resources/shareLink/client/Client.d.ts +2 -2
  68. package/dist/cjs/api/resources/shareLink/client/Client.js +13 -9
  69. package/dist/cjs/api/resources/tags/client/Client.d.ts +8 -6
  70. package/dist/cjs/api/resources/tags/client/Client.js +26 -29
  71. package/dist/cjs/api/resources/tags/resources/groups/client/Client.d.ts +7 -5
  72. package/dist/cjs/api/resources/tags/resources/groups/client/Client.js +25 -28
  73. package/dist/cjs/api/resources/teams/client/Client.d.ts +2 -2
  74. package/dist/cjs/api/resources/teams/client/Client.js +22 -15
  75. package/dist/cjs/api/resources/versions/client/Client.d.ts +2 -2
  76. package/dist/cjs/api/resources/versions/client/Client.js +16 -11
  77. package/dist/cjs/api/resources/versions/resources/reverts/client/Client.d.ts +2 -2
  78. package/dist/cjs/api/resources/versions/resources/reverts/client/Client.js +13 -9
  79. package/dist/cjs/api/types/types.d.ts +187 -1487
  80. package/dist/cjs/api/types/types.js +14 -329
  81. package/dist/cjs/auth/AnyAuthProvider.d.ts +23 -0
  82. package/dist/cjs/auth/AnyAuthProvider.js +46 -0
  83. package/dist/cjs/auth/BearerAuthProvider.d.ts +23 -0
  84. package/dist/cjs/auth/BearerAuthProvider.js +82 -0
  85. package/dist/cjs/auth/HeaderAuthProvider.d.ts +17 -10
  86. package/dist/cjs/auth/HeaderAuthProvider.js +22 -9
  87. package/dist/cjs/auth/index.d.ts +2 -0
  88. package/dist/cjs/auth/index.js +5 -1
  89. package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +2 -2
  90. package/dist/cjs/environments.d.ts +2 -2
  91. package/dist/cjs/environments.js +1 -1
  92. package/dist/cjs/helpers/index.d.ts +1 -1
  93. package/dist/cjs/helpers/index.js +1 -1
  94. package/dist/cjs/version.d.ts +1 -1
  95. package/dist/cjs/version.js +1 -1
  96. package/dist/esm/BaseClient.d.mts +7 -9
  97. package/dist/esm/BaseClient.mjs +8 -3
  98. package/dist/esm/Client.d.mts +2 -2
  99. package/dist/esm/Client.mjs +2 -2
  100. package/dist/esm/IcePanelClient.d.mts +7 -8
  101. package/dist/esm/IcePanelClient.mjs +10 -10
  102. package/dist/esm/api/requests/requests.d.mts +62 -142
  103. package/dist/esm/api/resources/catalog/client/Client.d.mts +2 -2
  104. package/dist/esm/api/resources/catalog/client/Client.mjs +2 -2
  105. package/dist/esm/api/resources/catalog/resources/technologies/client/Client.d.mts +2 -71
  106. package/dist/esm/api/resources/catalog/resources/technologies/client/Client.mjs +6 -263
  107. package/dist/esm/api/resources/catalog/resources/technologies/types/types.d.mts +0 -12
  108. package/dist/esm/api/resources/comments/client/Client.d.mts +7 -5
  109. package/dist/esm/api/resources/comments/client/Client.mjs +26 -29
  110. package/dist/esm/api/resources/comments/resources/replies/client/Client.d.mts +5 -3
  111. package/dist/esm/api/resources/comments/resources/replies/client/Client.mjs +24 -27
  112. package/dist/esm/api/resources/diagrams/client/Client.d.mts +4 -3
  113. package/dist/esm/api/resources/diagrams/client/Client.mjs +32 -33
  114. package/dist/esm/api/resources/diagrams/resources/content/client/Client.d.mts +2 -2
  115. package/dist/esm/api/resources/diagrams/resources/content/client/Client.mjs +11 -8
  116. package/dist/esm/api/resources/diagrams/resources/export/client/Client.d.mts +2 -2
  117. package/dist/esm/api/resources/diagrams/resources/export/client/Client.mjs +8 -6
  118. package/dist/esm/api/resources/diagrams/resources/groups/client/Client.d.mts +6 -4
  119. package/dist/esm/api/resources/diagrams/resources/groups/client/Client.mjs +28 -30
  120. package/dist/esm/api/resources/domains/client/Client.d.mts +5 -3
  121. package/dist/esm/api/resources/domains/client/Client.mjs +27 -29
  122. package/dist/esm/api/resources/drafts/client/Client.d.mts +2 -2
  123. package/dist/esm/api/resources/drafts/client/Client.mjs +23 -16
  124. package/dist/esm/api/resources/flows/client/Client.d.mts +2 -2
  125. package/dist/esm/api/resources/flows/client/Client.mjs +29 -20
  126. package/dist/esm/api/resources/flows/resources/export/client/Client.d.mts +2 -2
  127. package/dist/esm/api/resources/flows/resources/export/client/Client.mjs +11 -8
  128. package/dist/esm/api/resources/landscapes/client/Client.d.mts +2 -2
  129. package/dist/esm/api/resources/landscapes/client/Client.mjs +20 -14
  130. package/dist/esm/api/resources/landscapes/resources/export/client/Client.d.mts +2 -2
  131. package/dist/esm/api/resources/landscapes/resources/export/client/Client.mjs +8 -6
  132. package/dist/esm/api/resources/landscapes/resources/logs/client/Client.d.mts +2 -2
  133. package/dist/esm/api/resources/landscapes/resources/logs/client/Client.mjs +11 -8
  134. package/dist/esm/api/resources/landscapes/resources/logs/resources/stats/client/Client.d.mts +2 -2
  135. package/dist/esm/api/resources/landscapes/resources/logs/resources/stats/client/Client.mjs +8 -6
  136. package/dist/esm/api/resources/model/client/Client.d.mts +2 -2
  137. package/dist/esm/api/resources/model/client/Client.mjs +2 -2
  138. package/dist/esm/api/resources/model/resources/connections/client/Client.d.mts +28 -5
  139. package/dist/esm/api/resources/model/resources/connections/client/Client.mjs +96 -18
  140. package/dist/esm/api/resources/model/resources/connections/resources/export/client/Client.d.mts +3 -3
  141. package/dist/esm/api/resources/model/resources/connections/resources/export/client/Client.mjs +7 -5
  142. package/dist/esm/api/resources/model/resources/connections/types/types.d.mts +6 -0
  143. package/dist/esm/api/resources/model/resources/objects/client/Client.d.mts +6 -4
  144. package/dist/esm/api/resources/model/resources/objects/client/Client.mjs +25 -28
  145. package/dist/esm/api/resources/model/resources/objects/resources/export/client/Client.d.mts +3 -3
  146. package/dist/esm/api/resources/model/resources/objects/resources/export/client/Client.mjs +10 -7
  147. package/dist/esm/api/resources/organizations/client/Client.d.mts +2 -2
  148. package/dist/esm/api/resources/organizations/client/Client.mjs +17 -12
  149. package/dist/esm/api/resources/organizations/resources/landscapes/client/Client.d.mts +2 -2
  150. package/dist/esm/api/resources/organizations/resources/landscapes/client/Client.mjs +8 -6
  151. package/dist/esm/api/resources/organizations/resources/logs/client/Client.d.mts +2 -2
  152. package/dist/esm/api/resources/organizations/resources/logs/client/Client.mjs +8 -6
  153. package/dist/esm/api/resources/organizations/resources/logs/resources/stats/client/Client.d.mts +2 -2
  154. package/dist/esm/api/resources/organizations/resources/logs/resources/stats/client/Client.mjs +8 -6
  155. package/dist/esm/api/resources/organizations/resources/technologies/client/Client.d.mts +2 -2
  156. package/dist/esm/api/resources/organizations/resources/technologies/client/Client.mjs +17 -12
  157. package/dist/esm/api/resources/organizations/resources/users/client/Client.d.mts +2 -2
  158. package/dist/esm/api/resources/organizations/resources/users/client/Client.mjs +11 -8
  159. package/dist/esm/api/resources/organizations/resources/users/resources/invites/client/Client.d.mts +2 -2
  160. package/dist/esm/api/resources/organizations/resources/users/resources/invites/client/Client.mjs +11 -8
  161. package/dist/esm/api/resources/shareLink/client/Client.d.mts +2 -2
  162. package/dist/esm/api/resources/shareLink/client/Client.mjs +14 -10
  163. package/dist/esm/api/resources/tags/client/Client.d.mts +8 -6
  164. package/dist/esm/api/resources/tags/client/Client.mjs +27 -30
  165. package/dist/esm/api/resources/tags/resources/groups/client/Client.d.mts +7 -5
  166. package/dist/esm/api/resources/tags/resources/groups/client/Client.mjs +26 -29
  167. package/dist/esm/api/resources/teams/client/Client.d.mts +2 -2
  168. package/dist/esm/api/resources/teams/client/Client.mjs +23 -16
  169. package/dist/esm/api/resources/versions/client/Client.d.mts +2 -2
  170. package/dist/esm/api/resources/versions/client/Client.mjs +17 -12
  171. package/dist/esm/api/resources/versions/resources/reverts/client/Client.d.mts +2 -2
  172. package/dist/esm/api/resources/versions/resources/reverts/client/Client.mjs +14 -10
  173. package/dist/esm/api/types/types.d.mts +187 -1487
  174. package/dist/esm/api/types/types.mjs +11 -325
  175. package/dist/esm/auth/AnyAuthProvider.d.mts +23 -0
  176. package/dist/esm/auth/AnyAuthProvider.mjs +42 -0
  177. package/dist/esm/auth/BearerAuthProvider.d.mts +23 -0
  178. package/dist/esm/auth/BearerAuthProvider.mjs +45 -0
  179. package/dist/esm/auth/HeaderAuthProvider.d.mts +17 -10
  180. package/dist/esm/auth/HeaderAuthProvider.mjs +22 -9
  181. package/dist/esm/auth/index.d.mts +2 -0
  182. package/dist/esm/auth/index.mjs +2 -0
  183. package/dist/esm/core/fetcher/EndpointSupplier.d.mts +2 -2
  184. package/dist/esm/environments.d.mts +2 -2
  185. package/dist/esm/environments.mjs +1 -1
  186. package/dist/esm/helpers/index.d.mts +1 -1
  187. package/dist/esm/helpers/index.mjs +1 -1
  188. package/dist/esm/version.d.mts +1 -1
  189. package/dist/esm/version.mjs +1 -1
  190. package/package.json +1 -1
  191. package/reference.md +107 -280
package/README.md CHANGED
@@ -35,7 +35,7 @@ A full reference for this library is available [here](https://github.com/IcePane
35
35
 
36
36
  ## Getting Started
37
37
 
38
- Use the following constant to specify the latest version.
38
+ Use the following example to list the model objects in the latest version of a landscape.
39
39
  ```typescript
40
40
  import { IcePanelClient, LandscapeVersion } from "@icepanel/sdk";
41
41
 
@@ -1,3 +1,5 @@
1
+ import { AnyAuthProvider } from "./auth/AnyAuthProvider.js";
2
+ import { BearerAuthProvider } from "./auth/BearerAuthProvider.js";
1
3
  import { HeaderAuthProvider } from "./auth/HeaderAuthProvider.js";
2
4
  import * as core from "./core/index.js";
3
5
  import type * as environments from "./environments.js";
@@ -5,8 +7,6 @@ export type BaseClientOptions = {
5
7
  environment?: core.Supplier<environments.IcePanelEnvironment | string>;
6
8
  /** Specify a custom URL to connect the client to. */
7
9
  baseUrl?: core.Supplier<string>;
8
- /** Override the Authorization header */
9
- authorization?: core.Supplier<string | undefined>;
10
10
  /** Additional headers to include in requests. */
11
11
  headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
12
12
  /** The default maximum time to wait for a response in seconds. */
@@ -17,7 +17,7 @@ export type BaseClientOptions = {
17
17
  fetch?: typeof fetch;
18
18
  /** Configure logging for the client. */
19
19
  logging?: core.logging.LogConfig | core.logging.Logger;
20
- } & HeaderAuthProvider.AuthOptions;
20
+ } & AnyAuthProvider.AuthOptions<[HeaderAuthProvider.AuthOptions, BearerAuthProvider.AuthOptions]>;
21
21
  export interface BaseRequestOptions {
22
22
  /** The maximum time to wait for a response in seconds. */
23
23
  timeoutInSeconds?: number;
@@ -25,19 +25,17 @@ export interface BaseRequestOptions {
25
25
  maxRetries?: number;
26
26
  /** A hook to abort the request. */
27
27
  abortSignal?: AbortSignal;
28
- /** Override the Authorization header */
29
- authorization?: string | undefined;
30
28
  /** Additional query string parameters to include in the request. */
31
29
  queryParams?: Record<string, unknown>;
32
30
  /** Additional headers to include in the request. */
33
31
  headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
34
32
  }
35
- export type NormalizedClientOptions<T extends BaseClientOptions> = T & {
33
+ export type NormalizedClientOptions<T extends BaseClientOptions = BaseClientOptions> = T & {
36
34
  logging: core.logging.Logger;
37
35
  authProvider?: core.AuthProvider;
38
36
  };
39
- export type NormalizedClientOptionsWithAuth<T extends BaseClientOptions> = NormalizedClientOptions<T> & {
37
+ export type NormalizedClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions> = NormalizedClientOptions<T> & {
40
38
  authProvider: core.AuthProvider;
41
39
  };
42
- export declare function normalizeClientOptions<T extends BaseClientOptions>(options: T): NormalizedClientOptions<T>;
43
- export declare function normalizeClientOptionsWithAuth<T extends BaseClientOptions>(options: T): NormalizedClientOptionsWithAuth<T>;
40
+ export declare function normalizeClientOptions<T extends BaseClientOptions = BaseClientOptions>(options: T): NormalizedClientOptions<T>;
41
+ export declare function normalizeClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions>(options: T): NormalizedClientOptionsWithAuth<T>;
@@ -36,6 +36,8 @@ var __importStar = (this && this.__importStar) || (function () {
36
36
  Object.defineProperty(exports, "__esModule", { value: true });
37
37
  exports.normalizeClientOptions = normalizeClientOptions;
38
38
  exports.normalizeClientOptionsWithAuth = normalizeClientOptionsWithAuth;
39
+ const AnyAuthProvider_js_1 = require("./auth/AnyAuthProvider.js");
40
+ const BearerAuthProvider_js_1 = require("./auth/BearerAuthProvider.js");
39
41
  const HeaderAuthProvider_js_1 = require("./auth/HeaderAuthProvider.js");
40
42
  const headers_js_1 = require("./core/headers.js");
41
43
  const core = __importStar(require("./core/index.js"));
@@ -43,8 +45,8 @@ function normalizeClientOptions(options) {
43
45
  const headers = (0, headers_js_1.mergeHeaders)({
44
46
  "X-Fern-Language": "JavaScript",
45
47
  "X-Fern-SDK-Name": "@icepanel/sdk",
46
- "X-Fern-SDK-Version": "0.1.1",
47
- "User-Agent": "@icepanel/sdk/0.1.1",
48
+ "X-Fern-SDK-Version": "0.1.6",
49
+ "User-Agent": "@icepanel/sdk/0.1.6",
48
50
  "X-Fern-Runtime": core.RUNTIME.type,
49
51
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
52
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -54,7 +56,10 @@ function normalizeClientOptionsWithAuth(options) {
54
56
  var _a;
55
57
  const normalized = normalizeClientOptions(options);
56
58
  const normalizedWithNoOpAuthProvider = withNoOpAuthProvider(normalized);
57
- (_a = normalized.authProvider) !== null && _a !== void 0 ? _a : (normalized.authProvider = new HeaderAuthProvider_js_1.HeaderAuthProvider(normalizedWithNoOpAuthProvider));
59
+ (_a = normalized.authProvider) !== null && _a !== void 0 ? _a : (normalized.authProvider = AnyAuthProvider_js_1.AnyAuthProvider.createInstance(normalizedWithNoOpAuthProvider, [
60
+ HeaderAuthProvider_js_1.HeaderAuthProvider,
61
+ BearerAuthProvider_js_1.BearerAuthProvider,
62
+ ]));
58
63
  return normalized;
59
64
  }
60
65
  function withNoOpAuthProvider(options) {
@@ -12,14 +12,14 @@ import { TagsClient } from "./api/resources/tags/client/Client.js";
12
12
  import { TeamsClient } from "./api/resources/teams/client/Client.js";
13
13
  import { VersionsClient } from "./api/resources/versions/client/Client.js";
14
14
  import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
15
- import { type NormalizedClientOptions } from "./BaseClient.js";
15
+ import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
16
16
  export declare namespace IcePanelClient {
17
17
  type Options = BaseClientOptions;
18
18
  interface RequestOptions extends BaseRequestOptions {
19
19
  }
20
20
  }
21
21
  export declare class IcePanelClient {
22
- protected readonly _options: NormalizedClientOptions<IcePanelClient.Options>;
22
+ protected readonly _options: NormalizedClientOptionsWithAuth<IcePanelClient.Options>;
23
23
  protected _comments: CommentsClient | undefined;
24
24
  protected _diagrams: DiagramsClient | undefined;
25
25
  protected _domains: DomainsClient | undefined;
@@ -18,7 +18,7 @@ const Client_js_13 = require("./api/resources/versions/client/Client.js");
18
18
  const BaseClient_js_1 = require("./BaseClient.js");
19
19
  class IcePanelClient {
20
20
  constructor(options = {}) {
21
- this._options = (0, BaseClient_js_1.normalizeClientOptions)(options);
21
+ this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
22
22
  }
23
23
  get comments() {
24
24
  var _a;
@@ -1,12 +1,11 @@
1
- import { IcePanelClient as Client } from "./Client";
2
- import type { BaseClientOptions } from "./BaseClient";
3
- import * as core from "./core/index";
4
- import type { IcePanelAPIVersion } from "./consts";
5
- export interface IcePanelOptions extends Omit<BaseClientOptions, 'environment' | 'apiKey' | 'authorization'> {
1
+ import { IcePanelClient as Client } from "./Client.js";
2
+ import type { BaseClientOptions } from "./BaseClient.js";
3
+ import * as core from "./core/index.js";
4
+ import type { IcePanelAPIVersion } from "./consts.js";
5
+ export interface IcePanelOptions extends Omit<BaseClientOptions, 'apiKeyAuth' | 'bearerAuth'> {
6
6
  apiVersion: IcePanelAPIVersion;
7
- environment?: core.Supplier<string | undefined>;
8
- apiKey?: core.Supplier<string | undefined>;
9
- authorization?: core.Supplier<string | undefined>;
7
+ apiKey?: core.Supplier<string>;
8
+ token?: core.Supplier<string>;
10
9
  }
11
10
  export declare class IcePanelClient extends Client {
12
11
  constructor(options: IcePanelOptions);
@@ -43,27 +43,27 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
43
43
  };
44
44
  Object.defineProperty(exports, "__esModule", { value: true });
45
45
  exports.IcePanelClient = void 0;
46
- const Client_1 = require("./Client");
47
- const core = __importStar(require("./core/index"));
48
- class IcePanelClient extends Client_1.IcePanelClient {
46
+ const Client_js_1 = require("./Client.js");
47
+ const core = __importStar(require("./core/index.js"));
48
+ class IcePanelClient extends Client_js_1.IcePanelClient {
49
49
  constructor(options) {
50
- const updatedOptions = Object.assign(Object.assign({}, options), { environment: undefined, apiKey: undefined, authorization: undefined });
50
+ const updatedOptions = Object.assign(Object.assign({}, options), { apiKeyAuth: undefined, bearerAuth: undefined });
51
51
  updatedOptions.baseUrl = () => __awaiter(this, void 0, void 0, function* () {
52
52
  const baseUrl = options.baseUrl ? yield core.Supplier.get(options.baseUrl) : undefined;
53
53
  if (baseUrl) {
54
54
  return `${baseUrl}/${options.apiVersion}`;
55
55
  }
56
- const environment = options.environment ? yield core.Supplier.get(options.environment) : undefined;
57
- if (environment) {
58
- return `https://api.${environment}.icepanel.cloud/${options.apiVersion}`;
59
- }
60
56
  return `https://api.icepanel.io/${options.apiVersion}`;
61
57
  });
62
58
  if (options.apiKey) {
63
- updatedOptions.headers = Object.assign(Object.assign({}, updatedOptions.headers), { 'Authorization': `ApiKey ${options.apiKey}` });
59
+ updatedOptions.apiKeyAuth = {
60
+ apiKey: options.apiKey
61
+ };
64
62
  }
65
- if (options.authorization) {
66
- updatedOptions.headers = Object.assign(Object.assign({}, updatedOptions.headers), { Authorization: options.authorization });
63
+ if (options.token) {
64
+ updatedOptions.bearerAuth = {
65
+ token: options.token
66
+ };
67
67
  }
68
68
  super(updatedOptions);
69
69
  }
@@ -50,9 +50,11 @@ export interface CommentFindRequest {
50
50
  * versionId: "versionId",
51
51
  * commentId: "commentId",
52
52
  * body: {
53
- * content: "content",
54
- * status: "open",
55
- * type: "question"
53
+ * body: {
54
+ * content: "content",
55
+ * status: "open",
56
+ * type: "question"
57
+ * }
56
58
  * }
57
59
  * }
58
60
  */
@@ -60,10 +62,7 @@ export interface CommentUpsertRequest {
60
62
  landscapeId: string;
61
63
  versionId: string;
62
64
  commentId: string;
63
- body: IcePanel.CommentBody;
64
- commit?: number;
65
- mentionedUserIds?: string[];
66
- handleId?: string;
65
+ body: IcePanel.CommentUpsert;
67
66
  }
68
67
  /**
69
68
  * @example
@@ -178,7 +177,8 @@ export interface DiagramDeleteRequest {
178
177
  * {
179
178
  * landscapeId: "landscapeId",
180
179
  * versionId: "versionId",
181
- * diagramId: "diagramId"
180
+ * diagramId: "diagramId",
181
+ * body: {}
182
182
  * }
183
183
  */
184
184
  export interface DiagramUpdateRequest {
@@ -186,24 +186,7 @@ export interface DiagramUpdateRequest {
186
186
  versionId: string;
187
187
  diagramId: string;
188
188
  updateViewedAt?: boolean;
189
- commit?: number;
190
- description?: string;
191
- groupId?: string | null;
192
- index?: number;
193
- labels?: Record<string, string>;
194
- /** model object id this object belongs to */
195
- modelId?: string;
196
- name?: string;
197
- parentId?: string | null;
198
- pinned?: boolean;
199
- pinnedAt?: string;
200
- pinnedIndex?: number;
201
- status?: IcePanel.DiagramStatus;
202
- /** Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id. */
203
- zoomOverrides?: Record<string, string | null> | null;
204
- comments?: IcePanel.DiagramContentPartialComments;
205
- connections?: IcePanel.DiagramContentPartialConnections;
206
- objects?: IcePanel.DiagramContentPartialObjects;
189
+ body: IcePanel.DiagramUpsert;
207
190
  }
208
191
  /**
209
192
  * @example
@@ -290,18 +273,16 @@ export interface DomainFindRequest {
290
273
  * landscapeId: "landscapeId",
291
274
  * versionId: "versionId",
292
275
  * domainId: "domainId",
293
- * name: "name"
276
+ * body: {
277
+ * name: "name"
278
+ * }
294
279
  * }
295
280
  */
296
281
  export interface DomainUpsertRequest {
297
282
  landscapeId: string;
298
283
  versionId: string;
299
284
  domainId: string;
300
- commit?: number;
301
- index?: number;
302
- labels?: Record<string, string>;
303
- name: string;
304
- handleId?: string;
285
+ body: IcePanel.DomainUpsert;
305
286
  }
306
287
  /**
307
288
  * @example
@@ -776,23 +757,19 @@ export interface TagFindRequest {
776
757
  * landscapeId: "landscapeId",
777
758
  * versionId: "versionId",
778
759
  * tagId: "tagId",
779
- * color: "blue",
780
- * groupId: "groupId",
781
- * index: 1.1,
782
- * name: "name"
760
+ * body: {
761
+ * color: "blue",
762
+ * groupId: "groupId",
763
+ * index: 1.1,
764
+ * name: "name"
765
+ * }
783
766
  * }
784
767
  */
785
768
  export interface TagUpsertRequest {
786
769
  landscapeId: string;
787
770
  versionId: string;
788
771
  tagId: string;
789
- color: IcePanel.TagColor;
790
- commit?: number;
791
- groupId: string;
792
- index: number;
793
- labels?: Record<string, string>;
794
- name: string;
795
- handleId?: string;
772
+ body: IcePanel.TagUpsert;
796
773
  }
797
774
  /**
798
775
  * @example
@@ -959,33 +936,6 @@ export interface VersionUpdateRequest {
959
936
  versionId: string;
960
937
  body: IcePanel.VersionPartial;
961
938
  }
962
- /**
963
- * @example
964
- * {}
965
- */
966
- export interface CatalogTechnologiesListRequest {
967
- filter?: IcePanel.CatalogTechnologyFilter;
968
- /** list all technologies on the platform */
969
- admin?: boolean;
970
- }
971
- /**
972
- * @example
973
- * {
974
- * url: "url"
975
- * }
976
- */
977
- export interface CatalogSuggestionInformationGetRequest {
978
- url: string;
979
- }
980
- /**
981
- * @example
982
- * {
983
- * url: "url"
984
- * }
985
- */
986
- export interface CatalogSuggestionBrandGetRequest {
987
- url: string;
988
- }
989
939
  /**
990
940
  * @example
991
941
  * {
@@ -995,15 +945,6 @@ export interface CatalogSuggestionBrandGetRequest {
995
945
  export interface CatalogTechnologyFindRequest {
996
946
  catalogTechnologyId: string;
997
947
  }
998
- /**
999
- * @example
1000
- * {
1001
- * catalogTechnologySlug: "catalogTechnologySlug"
1002
- * }
1003
- */
1004
- export interface CatalogTechnologySlugFindRequest {
1005
- catalogTechnologySlug: string;
1006
- }
1007
948
  /**
1008
949
  * @example
1009
950
  * {
@@ -1056,7 +997,9 @@ export interface CommentReplyFindRequest {
1056
997
  * versionId: "versionId",
1057
998
  * commentId: "commentId",
1058
999
  * commentReplyId: "commentReplyId",
1059
- * content: "content"
1000
+ * body: {
1001
+ * content: "content"
1002
+ * }
1060
1003
  * }
1061
1004
  */
1062
1005
  export interface CommentReplyUpsertRequest {
@@ -1064,8 +1007,7 @@ export interface CommentReplyUpsertRequest {
1064
1007
  versionId: string;
1065
1008
  commentId: string;
1066
1009
  commentReplyId: string;
1067
- content: string;
1068
- mentionedUserIds?: string[];
1010
+ body: IcePanel.CommentReplyUpsert;
1069
1011
  }
1070
1012
  /**
1071
1013
  * @example
@@ -1192,20 +1134,17 @@ export interface DiagramGroupFindRequest {
1192
1134
  * landscapeId: "landscapeId",
1193
1135
  * versionId: "versionId",
1194
1136
  * diagramGroupId: "diagramGroupId",
1195
- * modelId: "modelId",
1196
- * name: "name"
1137
+ * body: {
1138
+ * modelId: "modelId",
1139
+ * name: "name"
1140
+ * }
1197
1141
  * }
1198
1142
  */
1199
1143
  export interface DiagramGroupUpsertRequest {
1200
1144
  landscapeId: string;
1201
1145
  versionId: string;
1202
1146
  diagramGroupId: string;
1203
- commit?: number;
1204
- index?: number;
1205
- labels?: Record<string, string>;
1206
- modelId: string;
1207
- name: string;
1208
- handleId?: string;
1147
+ body: IcePanel.DiagramGroupUpsert;
1209
1148
  }
1210
1149
  /**
1211
1150
  * @example
@@ -1451,9 +1390,11 @@ export interface ModelConnectionFindRequest {
1451
1390
  * landscapeId: "landscapeId",
1452
1391
  * versionId: "versionId",
1453
1392
  * modelConnectionId: "modelConnectionId",
1454
- * name: "name",
1455
- * originId: "originId",
1456
- * targetId: "targetId"
1393
+ * body: {
1394
+ * name: "name",
1395
+ * originId: "originId",
1396
+ * targetId: "targetId"
1397
+ * }
1457
1398
  * }
1458
1399
  */
1459
1400
  export interface ModelConnectionUpsertRequest {
@@ -1463,21 +1404,7 @@ export interface ModelConnectionUpsertRequest {
1463
1404
  originConnector?: IcePanel.model.ConnectionsUpsertRequestOriginConnector;
1464
1405
  targetConnector?: IcePanel.model.ConnectionsUpsertRequestTargetConnector;
1465
1406
  updateDiagrams?: boolean;
1466
- commit?: number;
1467
- description?: string;
1468
- direction?: unknown;
1469
- labels?: Record<string, string>;
1470
- links?: unknown;
1471
- name: string;
1472
- /** Model object that initiates the connection */
1473
- originId: string;
1474
- status?: IcePanel.ModelConnectionStatus;
1475
- tagIds?: unknown;
1476
- /** Model object that receives the message */
1477
- targetId: string;
1478
- technologyIds?: unknown;
1479
- viaId?: unknown;
1480
- handleId?: string;
1407
+ body: IcePanel.ModelConnectionUpsert;
1481
1408
  }
1482
1409
  /**
1483
1410
  * @example
@@ -1508,6 +1435,22 @@ export interface ModelConnectionUpdateRequest {
1508
1435
  updateDiagrams?: boolean;
1509
1436
  body: IcePanel.ModelConnectionPartial;
1510
1437
  }
1438
+ /**
1439
+ * @example
1440
+ * {
1441
+ * landscapeId: "landscapeId",
1442
+ * versionId: "versionId",
1443
+ * modelConnectionId: "modelConnectionId",
1444
+ * type: "caption"
1445
+ * }
1446
+ */
1447
+ export interface ModelConnectionGenerateDescriptionRequest {
1448
+ landscapeId: string;
1449
+ versionId: string;
1450
+ modelConnectionId: string;
1451
+ /** Type of description to generate: "caption" for a short caption(50-70 characters), or "detailed" for a detailed description (max 2000 characters) */
1452
+ type: IcePanel.AiDescriptionType;
1453
+ }
1511
1454
  /**
1512
1455
  * @example
1513
1456
  * {
@@ -1557,35 +1500,17 @@ export interface ModelObjectFindRequest {
1557
1500
  * landscapeId: "landscapeId",
1558
1501
  * versionId: "versionId",
1559
1502
  * modelObjectId: "modelObjectId",
1560
- * name: "name",
1561
- * type: "actor"
1503
+ * body: {
1504
+ * name: "name",
1505
+ * type: "actor"
1506
+ * }
1562
1507
  * }
1563
1508
  */
1564
1509
  export interface ModelObjectUpsertRequest {
1565
1510
  landscapeId: string;
1566
1511
  versionId: string;
1567
1512
  modelObjectId: string;
1568
- /** Short summary of the object shown as the display description */
1569
- caption?: string;
1570
- commit?: number;
1571
- description?: string;
1572
- external?: boolean;
1573
- groupIds?: unknown;
1574
- icon?: IcePanel.ModelObjectIconNullable | null;
1575
- /** Generic key value store used for creating custom integrations */
1576
- labels?: Record<string, string>;
1577
- links?: unknown;
1578
- name: string;
1579
- parentId?: unknown;
1580
- status?: IcePanel.ModelObjectStatus;
1581
- tagIds?: unknown;
1582
- teamIds?: unknown;
1583
- /** Model object (+child diagram, diagram groups and flows) can only be edited by owners and admins */
1584
- teamOnlyEditing?: boolean;
1585
- technologyIds?: unknown;
1586
- type: IcePanel.ModelObjectType;
1587
- domainId?: string;
1588
- handleId?: string;
1513
+ body: IcePanel.ModelObjectUpsert;
1589
1514
  }
1590
1515
  /**
1591
1516
  * @example
@@ -1668,8 +1593,6 @@ export interface OrganizationLandscapesListRequest {
1668
1593
  */
1669
1594
  export interface OrganizationLandscapeCreateRequest extends IcePanel.LandscapeRequired {
1670
1595
  organizationId: string;
1671
- backstageEntities?: IcePanel.BackstageEntityMap;
1672
- structurizrWorkspace?: IcePanel.StructurizrWorkspace;
1673
1596
  templateId?: string;
1674
1597
  }
1675
1598
  /**
@@ -1892,21 +1815,18 @@ export interface TagGroupFindRequest {
1892
1815
  * landscapeId: "landscapeId",
1893
1816
  * versionId: "versionId",
1894
1817
  * tagGroupId: "tagGroupId",
1895
- * icon: "bug",
1896
- * index: 1.1,
1897
- * name: "name"
1818
+ * body: {
1819
+ * icon: "bug",
1820
+ * index: 1.1,
1821
+ * name: "name"
1822
+ * }
1898
1823
  * }
1899
1824
  */
1900
1825
  export interface TagGroupUpsertRequest {
1901
1826
  landscapeId: string;
1902
1827
  versionId: string;
1903
1828
  tagGroupId: string;
1904
- commit?: number;
1905
- icon: IcePanel.TagGroupIcon;
1906
- index: number;
1907
- labels?: Record<string, string>;
1908
- name: string;
1909
- handleId?: string;
1829
+ body: IcePanel.TagGroupUpsert;
1910
1830
  }
1911
1831
  /**
1912
1832
  * @example
@@ -1,11 +1,11 @@
1
1
  import type { BaseClientOptions } from "../../../../BaseClient.js";
2
- import { type NormalizedClientOptions } from "../../../../BaseClient.js";
2
+ import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
3
3
  import { TechnologiesClient } from "../resources/technologies/client/Client.js";
4
4
  export declare namespace CatalogClient {
5
5
  type Options = BaseClientOptions;
6
6
  }
7
7
  export declare class CatalogClient {
8
- protected readonly _options: NormalizedClientOptions<CatalogClient.Options>;
8
+ protected readonly _options: NormalizedClientOptionsWithAuth<CatalogClient.Options>;
9
9
  protected _technologies: TechnologiesClient | undefined;
10
10
  constructor(options?: CatalogClient.Options);
11
11
  get technologies(): TechnologiesClient;
@@ -6,7 +6,7 @@ const BaseClient_js_1 = require("../../../../BaseClient.js");
6
6
  const Client_js_1 = require("../resources/technologies/client/Client.js");
7
7
  class CatalogClient {
8
8
  constructor(options = {}) {
9
- this._options = (0, BaseClient_js_1.normalizeClientOptions)(options);
9
+ this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
10
10
  }
11
11
  get technologies() {
12
12
  var _a;
@@ -1,5 +1,5 @@
1
1
  import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
2
- import { type NormalizedClientOptions } from "../../../../../../BaseClient.js";
2
+ import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.js";
3
3
  import * as core from "../../../../../../core/index.js";
4
4
  import * as IcePanel from "../../../../../index.js";
5
5
  export declare namespace TechnologiesClient {
@@ -8,59 +8,8 @@ export declare namespace TechnologiesClient {
8
8
  }
9
9
  }
10
10
  export declare class TechnologiesClient {
11
- protected readonly _options: NormalizedClientOptions<TechnologiesClient.Options>;
11
+ protected readonly _options: NormalizedClientOptionsWithAuth<TechnologiesClient.Options>;
12
12
  constructor(options?: TechnologiesClient.Options);
13
- /**
14
- * List technologies
15
- *
16
- * @param {IcePanel.CatalogTechnologiesListRequest} request
17
- * @param {TechnologiesClient.RequestOptions} requestOptions - Request-specific configuration.
18
- *
19
- * @throws {@link IcePanel.UnauthorizedError}
20
- * @throws {@link IcePanel.ForbiddenError}
21
- * @throws {@link IcePanel.NotFoundError}
22
- * @throws {@link IcePanel.UnprocessableEntityError}
23
- * @throws {@link IcePanel.InternalServerError}
24
- *
25
- * @example
26
- * await client.catalog.technologies.list()
27
- */
28
- list(request?: IcePanel.CatalogTechnologiesListRequest, requestOptions?: TechnologiesClient.RequestOptions): core.HttpResponsePromise<IcePanel.catalog.TechnologiesListResponse>;
29
- private __list;
30
- /**
31
- * Generate suggestions for a technologies information
32
- *
33
- * @param {IcePanel.CatalogSuggestionInformationGetRequest} request
34
- * @param {TechnologiesClient.RequestOptions} requestOptions - Request-specific configuration.
35
- *
36
- * @throws {@link IcePanel.UnauthorizedError}
37
- * @throws {@link IcePanel.InternalServerError}
38
- *
39
- * @example
40
- * await client.catalog.technologies.suggestInformation({
41
- * url: "url"
42
- * })
43
- */
44
- suggestInformation(request: IcePanel.CatalogSuggestionInformationGetRequest, requestOptions?: TechnologiesClient.RequestOptions): core.HttpResponsePromise<IcePanel.catalog.TechnologiesSuggestInformationResponse>;
45
- private __suggestInformation;
46
- /**
47
- * Generate suggestions for a technologies branding
48
- *
49
- * @param {IcePanel.CatalogSuggestionBrandGetRequest} request
50
- * @param {TechnologiesClient.RequestOptions} requestOptions - Request-specific configuration.
51
- *
52
- * @throws {@link IcePanel.UnauthorizedError}
53
- * @throws {@link IcePanel.NotFoundError}
54
- * @throws {@link IcePanel.UnprocessableEntityError}
55
- * @throws {@link IcePanel.InternalServerError}
56
- *
57
- * @example
58
- * await client.catalog.technologies.suggestBrand({
59
- * url: "url"
60
- * })
61
- */
62
- suggestBrand(request: IcePanel.CatalogSuggestionBrandGetRequest, requestOptions?: TechnologiesClient.RequestOptions): core.HttpResponsePromise<IcePanel.catalog.TechnologiesSuggestBrandResponse>;
63
- private __suggestBrand;
64
13
  /**
65
14
  * Create a signed URL prefix with access to all catalog icons
66
15
  *
@@ -95,22 +44,4 @@ export declare class TechnologiesClient {
95
44
  */
96
45
  get(request: IcePanel.CatalogTechnologyFindRequest, requestOptions?: TechnologiesClient.RequestOptions): core.HttpResponsePromise<IcePanel.catalog.TechnologiesGetResponse>;
97
46
  private __get;
98
- /**
99
- * Find a technology by the slug
100
- *
101
- * @param {IcePanel.CatalogTechnologySlugFindRequest} request
102
- * @param {TechnologiesClient.RequestOptions} requestOptions - Request-specific configuration.
103
- *
104
- * @throws {@link IcePanel.UnauthorizedError}
105
- * @throws {@link IcePanel.NotFoundError}
106
- * @throws {@link IcePanel.UnprocessableEntityError}
107
- * @throws {@link IcePanel.InternalServerError}
108
- *
109
- * @example
110
- * await client.catalog.technologies.getSlug({
111
- * catalogTechnologySlug: "catalogTechnologySlug"
112
- * })
113
- */
114
- getSlug(request: IcePanel.CatalogTechnologySlugFindRequest, requestOptions?: TechnologiesClient.RequestOptions): core.HttpResponsePromise<IcePanel.catalog.TechnologiesGetSlugResponse>;
115
- private __getSlug;
116
47
  }