@icepanel/sdk 0.0.42 → 0.1.0

package/README.md

@@ -9,8 +9,7 @@ The IcePanel TypeScript library provides convenient access to the IcePanel APIs
 
 - [Installation](#installation)
 - [Reference](#reference)
-- [Helpers](#helpers)
-- [Usage](#usage)
+- [Getting Started](#getting-started)
 - [Request and Response Types](#request-and-response-types)
 - [Exception Handling](#exception-handling)
 - [Advanced](#advanced)
@@ -27,29 +26,32 @@ The IcePanel TypeScript library provides convenient access to the IcePanel APIs
 ## Installation
 
 ```sh
-npm i @icepanel/sdk
+npm i -s @icepanel/sdk
 ```
 
 ## Reference
 
 A full reference for this library is available [here](https://github.com/IcePanel/icepanel-js/blob/HEAD/./reference.md).
 
-## Usage
+## Getting Started
 
 Use the following constant to specify the latest version.
 ```typescript
 import { IcePanelClient, LandscapeVersion } from "@icepanel/sdk";
 
+const landscapeId = "YOUR_LANDSCAPE_ID";
+
 const client = new IcePanelClient({
   apiKey: "YOUR_API_KEY",
   apiVersion: "v1"
 });
 await client.model.objects.list({
-  landscapeId: "YOUR_LANDSCAPE_ID",
+  landscapeId,
   versionId: LandscapeVersion.Latest
 });
 ```
 
+
 ## Request and Response Types
 
 The SDK exports all request and response types as TypeScript interfaces. Simply import them with the

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@icepanel/sdk",
-        "X-Fern-SDK-Version": "0.0.38",
-        "User-Agent": "@icepanel/sdk/0.0.38",
+        "X-Fern-SDK-Version": "0.0.43",
+        "User-Agent": "@icepanel/sdk/0.0.43",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/api/requests/requests.d.ts

@@ -110,36 +110,19 @@ export interface DiagramsListRequest {
  *     {
  *         landscapeId: "landscapeId",
  *         versionId: "versionId",
- *         index: 1.1,
- *         modelId: "modelId",
- *         name: "name",
- *         type: "app-diagram"
+ *         body: {
+ *             index: 1.1,
+ *             modelId: "modelId",
+ *             name: "name",
+ *             type: "app-diagram"
+ *         }
  *     }
  */
 export interface DiagramCreateRequest {
     landscapeId: string;
     versionId: string;
     updateViewedAt?: boolean;
-    commit?: number;
-    description?: string;
-    groupId?: string | null;
-    index: number;
-    labels?: Record<string, string>;
-    /** model object id this object belongs to */
-    modelId: string;
-    name: string;
-    parentId?: string | null;
-    pinned?: boolean;
-    pinnedAt?: string;
-    pinnedIndex?: number;
-    status?: IcePanel.DiagramStatus;
-    /** Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id. */
-    zoomOverrides?: Record<string, string | null> | null;
-    handleId?: string;
-    type: IcePanel.DiagramType;
-    comments?: Record<string, IcePanel.DiagramComment>;
-    connections?: Record<string, IcePanel.DiagramConnection>;
-    objects?: Record<string, IcePanel.DiagramObject>;
+    body: IcePanel.DiagramCreate;
 }
 /**
  * @example
@@ -161,10 +144,12 @@ export interface DiagramFindRequest {
  *         landscapeId: "landscapeId",
  *         versionId: "versionId",
  *         diagramId: "diagramId",
- *         index: 1.1,
- *         modelId: "modelId",
- *         name: "name",
- *         type: "app-diagram"
+ *         body: {
+ *             index: 1.1,
+ *             modelId: "modelId",
+ *             name: "name",
+ *             type: "app-diagram"
+ *         }
  *     }
  */
 export interface DiagramUpsertRequest {
@@ -172,26 +157,7 @@ export interface DiagramUpsertRequest {
     versionId: string;
     diagramId: string;
     updateViewedAt?: boolean;
-    commit?: number;
-    description?: string;
-    groupId?: string | null;
-    index: number;
-    labels?: Record<string, string>;
-    /** model object id this object belongs to */
-    modelId: string;
-    name: string;
-    parentId?: string | null;
-    pinned?: boolean;
-    pinnedAt?: string;
-    pinnedIndex?: number;
-    status?: IcePanel.DiagramStatus;
-    /** Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id. */
-    zoomOverrides?: Record<string, string | null> | null;
-    handleId?: string;
-    type: IcePanel.DiagramType;
-    comments?: Record<string, IcePanel.DiagramComment>;
-    connections?: Record<string, IcePanel.DiagramConnection>;
-    objects?: Record<string, IcePanel.DiagramObject>;
+    body: IcePanel.DiagramCreate;
 }
 /**
  * @example

package/dist/cjs/api/resources/diagrams/client/Client.d.ts

@@ -49,10 +49,12 @@ export declare class DiagramsClient {
      *     await client.diagrams.create({
      *         landscapeId: "landscapeId",
      *         versionId: "versionId",
-     *         index: 1.1,
-     *         modelId: "modelId",
-     *         name: "name",
-     *         type: "app-diagram"
+     *         body: {
+     *             index: 1.1,
+     *             modelId: "modelId",
+     *             name: "name",
+     *             type: "app-diagram"
+     *         }
      *     })
      */
     create(request: IcePanel.DiagramCreateRequest, requestOptions?: DiagramsClient.RequestOptions): core.HttpResponsePromise<IcePanel.DiagramsCreateResponse>;
@@ -91,10 +93,12 @@ export declare class DiagramsClient {
      *         landscapeId: "landscapeId",
      *         versionId: "versionId",
      *         diagramId: "diagramId",
-     *         index: 1.1,
-     *         modelId: "modelId",
-     *         name: "name",
-     *         type: "app-diagram"
+     *         body: {
+     *             index: 1.1,
+     *             modelId: "modelId",
+     *             name: "name",
+     *             type: "app-diagram"
+     *         }
      *     })
      */
     upsert(request: IcePanel.DiagramUpsertRequest, requestOptions?: DiagramsClient.RequestOptions): core.HttpResponsePromise<IcePanel.DiagramsUpsertResponse>;

package/dist/cjs/api/resources/diagrams/client/Client.js

@@ -157,10 +157,12 @@ class DiagramsClient {
      *     await client.diagrams.create({
      *         landscapeId: "landscapeId",
      *         versionId: "versionId",
-     *         index: 1.1,
-     *         modelId: "modelId",
-     *         name: "name",
-     *         type: "app-diagram"
+     *         body: {
+     *             index: 1.1,
+     *             modelId: "modelId",
+     *             name: "name",
+     *             type: "app-diagram"
+     *         }
      *     })
      */
     create(request, requestOptions) {
@@ -169,7 +171,7 @@ class DiagramsClient {
     __create(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { landscapeId, versionId, updateViewedAt } = request, _body = __rest(request, ["landscapeId", "versionId", "updateViewedAt"]);
+            const { landscapeId, versionId, updateViewedAt, body: _body } = request;
             const _queryParams = {};
             if (updateViewedAt != null) {
                 _queryParams.updateViewedAt = updateViewedAt.toString();
@@ -294,10 +296,12 @@ class DiagramsClient {
      *         landscapeId: "landscapeId",
      *         versionId: "versionId",
      *         diagramId: "diagramId",
-     *         index: 1.1,
-     *         modelId: "modelId",
-     *         name: "name",
-     *         type: "app-diagram"
+     *         body: {
+     *             index: 1.1,
+     *             modelId: "modelId",
+     *             name: "name",
+     *             type: "app-diagram"
+     *         }
      *     })
      */
     upsert(request, requestOptions) {
@@ -306,7 +310,7 @@ class DiagramsClient {
     __upsert(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { landscapeId, versionId, diagramId, updateViewedAt } = request, _body = __rest(request, ["landscapeId", "versionId", "diagramId", "updateViewedAt"]);
+            const { landscapeId, versionId, diagramId, updateViewedAt, body: _body } = request;
             const _queryParams = {};
             if (updateViewedAt != null) {
                 _queryParams.updateViewedAt = updateViewedAt.toString();

package/dist/cjs/api/types/types.d.ts

@@ -1999,6 +1999,28 @@ export interface Diagram {
     version: number;
     versionId: string;
 }
+export interface DiagramCreate {
+    commit?: number;
+    description?: string;
+    groupId?: string | null;
+    index: number;
+    labels?: Record<string, string>;
+    /** model object id this object belongs to */
+    modelId: string;
+    name: string;
+    parentId?: string | null;
+    pinned?: boolean;
+    pinnedAt?: string;
+    pinnedIndex?: number;
+    status?: IcePanel.DiagramStatus;
+    /** Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id. */
+    zoomOverrides?: Record<string, string | null> | null;
+    handleId?: string;
+    type: IcePanel.DiagramType;
+    comments?: Record<string, IcePanel.DiagramComment>;
+    connections?: Record<string, IcePanel.DiagramConnection>;
+    objects?: Record<string, IcePanel.DiagramObject>;
+}
 export declare const DiagramObjectShape: {
     readonly Area: "area";
     readonly Box: "box";
@@ -4402,6 +4424,7 @@ export type SearchResultData = IcePanel.ModelObject | IcePanel.ModelConnection |
 export interface SearchResult {
     data?: IcePanel.SearchResultData;
     id: string;
+    name: string;
     score: number;
     type: IcePanel.SearchIndexType;
 }

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.38";
+export declare const SDK_VERSION = "0.0.43";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.0.38";
+exports.SDK_VERSION = "0.0.43";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@icepanel/sdk",
-        "X-Fern-SDK-Version": "0.0.38",
-        "User-Agent": "@icepanel/sdk/0.0.38",
+        "X-Fern-SDK-Version": "0.0.43",
+        "User-Agent": "@icepanel/sdk/0.0.43",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/esm/api/requests/requests.d.mts

@@ -110,36 +110,19 @@ export interface DiagramsListRequest {
  *     {
  *         landscapeId: "landscapeId",
  *         versionId: "versionId",
- *         index: 1.1,
- *         modelId: "modelId",
- *         name: "name",
- *         type: "app-diagram"
+ *         body: {
+ *             index: 1.1,
+ *             modelId: "modelId",
+ *             name: "name",
+ *             type: "app-diagram"
+ *         }
  *     }
  */
 export interface DiagramCreateRequest {
     landscapeId: string;
     versionId: string;
     updateViewedAt?: boolean;
-    commit?: number;
-    description?: string;
-    groupId?: string | null;
-    index: number;
-    labels?: Record<string, string>;
-    /** model object id this object belongs to */
-    modelId: string;
-    name: string;
-    parentId?: string | null;
-    pinned?: boolean;
-    pinnedAt?: string;
-    pinnedIndex?: number;
-    status?: IcePanel.DiagramStatus;
-    /** Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id. */
-    zoomOverrides?: Record<string, string | null> | null;
-    handleId?: string;
-    type: IcePanel.DiagramType;
-    comments?: Record<string, IcePanel.DiagramComment>;
-    connections?: Record<string, IcePanel.DiagramConnection>;
-    objects?: Record<string, IcePanel.DiagramObject>;
+    body: IcePanel.DiagramCreate;
 }
 /**
  * @example
@@ -161,10 +144,12 @@ export interface DiagramFindRequest {
  *         landscapeId: "landscapeId",
  *         versionId: "versionId",
  *         diagramId: "diagramId",
- *         index: 1.1,
- *         modelId: "modelId",
- *         name: "name",
- *         type: "app-diagram"
+ *         body: {
+ *             index: 1.1,
+ *             modelId: "modelId",
+ *             name: "name",
+ *             type: "app-diagram"
+ *         }
  *     }
  */
 export interface DiagramUpsertRequest {
@@ -172,26 +157,7 @@ export interface DiagramUpsertRequest {
     versionId: string;
     diagramId: string;
     updateViewedAt?: boolean;
-    commit?: number;
-    description?: string;
-    groupId?: string | null;
-    index: number;
-    labels?: Record<string, string>;
-    /** model object id this object belongs to */
-    modelId: string;
-    name: string;
-    parentId?: string | null;
-    pinned?: boolean;
-    pinnedAt?: string;
-    pinnedIndex?: number;
-    status?: IcePanel.DiagramStatus;
-    /** Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id. */
-    zoomOverrides?: Record<string, string | null> | null;
-    handleId?: string;
-    type: IcePanel.DiagramType;
-    comments?: Record<string, IcePanel.DiagramComment>;
-    connections?: Record<string, IcePanel.DiagramConnection>;
-    objects?: Record<string, IcePanel.DiagramObject>;
+    body: IcePanel.DiagramCreate;
 }
 /**
  * @example

package/dist/esm/api/resources/diagrams/client/Client.d.mts

@@ -49,10 +49,12 @@ export declare class DiagramsClient {
      *     await client.diagrams.create({
      *         landscapeId: "landscapeId",
      *         versionId: "versionId",
-     *         index: 1.1,
-     *         modelId: "modelId",
-     *         name: "name",
-     *         type: "app-diagram"
+     *         body: {
+     *             index: 1.1,
+     *             modelId: "modelId",
+     *             name: "name",
+     *             type: "app-diagram"
+     *         }
      *     })
      */
     create(request: IcePanel.DiagramCreateRequest, requestOptions?: DiagramsClient.RequestOptions): core.HttpResponsePromise<IcePanel.DiagramsCreateResponse>;
@@ -91,10 +93,12 @@ export declare class DiagramsClient {
      *         landscapeId: "landscapeId",
      *         versionId: "versionId",
      *         diagramId: "diagramId",
-     *         index: 1.1,
-     *         modelId: "modelId",
-     *         name: "name",
-     *         type: "app-diagram"
+     *         body: {
+     *             index: 1.1,
+     *             modelId: "modelId",
+     *             name: "name",
+     *             type: "app-diagram"
+     *         }
      *     })
      */
     upsert(request: IcePanel.DiagramUpsertRequest, requestOptions?: DiagramsClient.RequestOptions): core.HttpResponsePromise<IcePanel.DiagramsUpsertResponse>;

package/dist/esm/api/resources/diagrams/client/Client.mjs

@@ -121,10 +121,12 @@ export class DiagramsClient {
      *     await client.diagrams.create({
      *         landscapeId: "landscapeId",
      *         versionId: "versionId",
-     *         index: 1.1,
-     *         modelId: "modelId",
-     *         name: "name",
-     *         type: "app-diagram"
+     *         body: {
+     *             index: 1.1,
+     *             modelId: "modelId",
+     *             name: "name",
+     *             type: "app-diagram"
+     *         }
      *     })
      */
     create(request, requestOptions) {
@@ -133,7 +135,7 @@ export class DiagramsClient {
     __create(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { landscapeId, versionId, updateViewedAt } = request, _body = __rest(request, ["landscapeId", "versionId", "updateViewedAt"]);
+            const { landscapeId, versionId, updateViewedAt, body: _body } = request;
             const _queryParams = {};
             if (updateViewedAt != null) {
                 _queryParams.updateViewedAt = updateViewedAt.toString();
@@ -258,10 +260,12 @@ export class DiagramsClient {
      *         landscapeId: "landscapeId",
      *         versionId: "versionId",
      *         diagramId: "diagramId",
-     *         index: 1.1,
-     *         modelId: "modelId",
-     *         name: "name",
-     *         type: "app-diagram"
+     *         body: {
+     *             index: 1.1,
+     *             modelId: "modelId",
+     *             name: "name",
+     *             type: "app-diagram"
+     *         }
      *     })
      */
     upsert(request, requestOptions) {
@@ -270,7 +274,7 @@ export class DiagramsClient {
     __upsert(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { landscapeId, versionId, diagramId, updateViewedAt } = request, _body = __rest(request, ["landscapeId", "versionId", "diagramId", "updateViewedAt"]);
+            const { landscapeId, versionId, diagramId, updateViewedAt, body: _body } = request;
             const _queryParams = {};
             if (updateViewedAt != null) {
                 _queryParams.updateViewedAt = updateViewedAt.toString();

package/dist/esm/api/types/types.d.mts

@@ -1999,6 +1999,28 @@ export interface Diagram {
     version: number;
     versionId: string;
 }
+export interface DiagramCreate {
+    commit?: number;
+    description?: string;
+    groupId?: string | null;
+    index: number;
+    labels?: Record<string, string>;
+    /** model object id this object belongs to */
+    modelId: string;
+    name: string;
+    parentId?: string | null;
+    pinned?: boolean;
+    pinnedAt?: string;
+    pinnedIndex?: number;
+    status?: IcePanel.DiagramStatus;
+    /** Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id. */
+    zoomOverrides?: Record<string, string | null> | null;
+    handleId?: string;
+    type: IcePanel.DiagramType;
+    comments?: Record<string, IcePanel.DiagramComment>;
+    connections?: Record<string, IcePanel.DiagramConnection>;
+    objects?: Record<string, IcePanel.DiagramObject>;
+}
 export declare const DiagramObjectShape: {
     readonly Area: "area";
     readonly Box: "box";
@@ -4402,6 +4424,7 @@ export type SearchResultData = IcePanel.ModelObject | IcePanel.ModelConnection |
 export interface SearchResult {
     data?: IcePanel.SearchResultData;
     id: string;
+    name: string;
     score: number;
     type: IcePanel.SearchIndexType;
 }

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.38";
+export declare const SDK_VERSION = "0.0.43";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.0.38";
+export const SDK_VERSION = "0.0.43";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@icepanel/sdk",
-    "version": "0.0.42",
+    "version": "0.1.0",
     "private": false,
     "repository": {
         "type": "git",

package/reference.md

@@ -398,10 +398,12 @@ await client.diagrams.list({
 await client.diagrams.create({
     landscapeId: "landscapeId",
     versionId: "versionId",
-    index: 1.1,
-    modelId: "modelId",
-    name: "name",
-    type: "app-diagram"
+    body: {
+        index: 1.1,
+        modelId: "modelId",
+        name: "name",
+        type: "app-diagram"
+    }
 });
 
 ```
@@ -508,10 +510,12 @@ await client.diagrams.upsert({
     landscapeId: "landscapeId",
     versionId: "versionId",
     diagramId: "diagramId",
-    index: 1.1,
-    modelId: "modelId",
-    name: "name",
-    type: "app-diagram"
+    body: {
+        index: 1.1,
+        modelId: "modelId",
+        name: "name",
+        type: "app-diagram"
+    }
 });
 
 ```