@seamapi/types 1.896.0 → 1.897.0

package/dist/connect.d.cts

@@ -104563,6 +104563,168 @@ type Routes = {
         };
         maxDuration: undefined;
     };
+    '/seam/console/v1/sites/create': {
+        route: '/seam/console/v1/sites/create';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            /** Name of the site that you want to create. */
+            name: string;
+            /** Unique key for the site within the workspace. */
+            site_key?: string | undefined;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            /** Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient. */
+            site: {
+                /** ID of the space. */
+                space_id: string;
+                /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */
+                workspace_id: string;
+                /** Unique key for the space within the workspace. */
+                space_key?: string | undefined;
+                /** Name of the space. */
+                name: string;
+                /** Display name for the space. */
+                display_name: string;
+                /** Date and time at which the space was created. */
+                created_at: string;
+                /** Number of devices in the space. */
+                device_count: number;
+                /** Number of entrances in the space. */
+                acs_entrance_count: number;
+                /** Customer key associated with the space. */
+                customer_key?: string | undefined;
+                /** Reservation/stay-related defaults for the space. */
+                customer_data?: {
+                    /** IANA time zone for the space, e.g. America/Los_Angeles. */
+                    time_zone?: (string | null) | undefined;
+                    /** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
+                    default_checkin_time?: (string | null) | undefined;
+                    /** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
+                    default_checkout_time?: (string | null) | undefined;
+                } | undefined;
+                /**  */
+                parent_space_id?: string | undefined;
+                /**  */
+                parent_space_key?: string | undefined;
+            };
+        };
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/sites/delete': {
+        route: '/seam/console/v1/sites/delete';
+        method: 'DELETE' | 'POST';
+        queryParams: {};
+        jsonBody: {
+            /** ID of the site that you want to delete. */
+            site_id: string;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/sites/list': {
+        route: '/seam/console/v1/sites/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** String for which to search. Filters sites to those with a partial match on `name` or `site_key`. */
+            search?: string | undefined;
+        };
+        formData: {};
+        jsonResponse: {
+            sites: {
+                /** ID of the space. */
+                space_id: string;
+                /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */
+                workspace_id: string;
+                /** Unique key for the space within the workspace. */
+                space_key?: string | undefined;
+                /** Name of the space. */
+                name: string;
+                /** Display name for the space. */
+                display_name: string;
+                /** Date and time at which the space was created. */
+                created_at: string;
+                /** Number of devices in the space. */
+                device_count: number;
+                /** Number of entrances in the space. */
+                acs_entrance_count: number;
+                /** Customer key associated with the space. */
+                customer_key?: string | undefined;
+                /** Reservation/stay-related defaults for the space. */
+                customer_data?: {
+                    /** IANA time zone for the space, e.g. America/Los_Angeles. */
+                    time_zone?: (string | null) | undefined;
+                    /** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
+                    default_checkin_time?: (string | null) | undefined;
+                    /** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
+                    default_checkout_time?: (string | null) | undefined;
+                } | undefined;
+                /**  */
+                parent_space_id?: string | undefined;
+                /**  */
+                parent_space_key?: string | undefined;
+            }[];
+        };
+        maxDuration: undefined;
+    };
+    '/seam/console/v1/sites/update': {
+        route: '/seam/console/v1/sites/update';
+        method: 'POST' | 'PATCH';
+        queryParams: {};
+        jsonBody: {
+            /** ID of the site that you want to update. */
+            site_id: string;
+            /** New name for the site. */
+            name?: string | undefined;
+            /** New unique key for the site within the workspace. */
+            site_key?: string | undefined;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            /** Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient. */
+            site: {
+                /** ID of the space. */
+                space_id: string;
+                /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */
+                workspace_id: string;
+                /** Unique key for the space within the workspace. */
+                space_key?: string | undefined;
+                /** Name of the space. */
+                name: string;
+                /** Display name for the space. */
+                display_name: string;
+                /** Date and time at which the space was created. */
+                created_at: string;
+                /** Number of devices in the space. */
+                device_count: number;
+                /** Number of entrances in the space. */
+                acs_entrance_count: number;
+                /** Customer key associated with the space. */
+                customer_key?: string | undefined;
+                /** Reservation/stay-related defaults for the space. */
+                customer_data?: {
+                    /** IANA time zone for the space, e.g. America/Los_Angeles. */
+                    time_zone?: (string | null) | undefined;
+                    /** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
+                    default_checkin_time?: (string | null) | undefined;
+                    /** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
+                    default_checkout_time?: (string | null) | undefined;
+                } | undefined;
+                /**  */
+                parent_space_id?: string | undefined;
+                /**  */
+                parent_space_key?: string | undefined;
+            };
+        };
+        maxDuration: undefined;
+    };
     '/seam/console/v1/timelines/get': {
         route: '/seam/console/v1/timelines/get';
         method: 'GET' | 'POST';

package/dist/index.cjs

@@ -67078,6 +67078,395 @@ var openapi = {
         "x-undocumented": "Internal endpoint for Console"
       }
     },
+    "/seam/console/v1/sites/create": {
+      post: {
+        description: "Creates a new site, a top-level space in the property hierarchy.",
+        operationId: "seamConsoleV1SitesCreatePost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  name: {
+                    description: "Name of the site that you want to create.",
+                    type: "string"
+                  },
+                  site_key: {
+                    description: "Unique key for the site within the workspace.",
+                    type: "string"
+                  }
+                },
+                required: ["name"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    ok: { type: "boolean" },
+                    site: { $ref: "#/components/schemas/space" }
+                  },
+                  required: ["site", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] }
+        ],
+        summary: "/seam/console/v1/sites/create",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "console", "v1", "sites"],
+        "x-fern-sdk-method-name": "create",
+        "x-fern-sdk-return-value": "site",
+        "x-response-key": "site",
+        "x-title": "Create a Site",
+        "x-undocumented": "Internal endpoint for Console"
+      }
+    },
+    "/seam/console/v1/sites/delete": {
+      delete: {
+        description: "Deletes a site.",
+        operationId: "seamConsoleV1SitesDeleteDelete",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  site_id: {
+                    description: "ID of the site that you want to delete.",
+                    format: "uuid",
+                    type: "string"
+                  }
+                },
+                required: ["site_id"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: { ok: { type: "boolean" } },
+                  required: ["ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] }
+        ],
+        summary: "/seam/console/v1/sites/delete",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "console", "v1", "sites"],
+        "x-fern-sdk-method-name": "delete",
+        "x-response-key": null,
+        "x-title": "Delete a Site",
+        "x-undocumented": "Internal endpoint for Console"
+      },
+      post: {
+        description: "Deletes a site.",
+        operationId: "seamConsoleV1SitesDeletePost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  site_id: {
+                    description: "ID of the site that you want to delete.",
+                    format: "uuid",
+                    type: "string"
+                  }
+                },
+                required: ["site_id"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: { ok: { type: "boolean" } },
+                  required: ["ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] }
+        ],
+        summary: "/seam/console/v1/sites/delete",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "console", "v1", "sites"],
+        "x-fern-sdk-method-name": "delete",
+        "x-response-key": null,
+        "x-title": "Delete a Site",
+        "x-undocumented": "Internal endpoint for Console"
+      }
+    },
+    "/seam/console/v1/sites/list": {
+      get: {
+        description: "Lists sites (top-level spaces) in the workspace.",
+        operationId: "seamConsoleV1SitesListGet",
+        parameters: [
+          {
+            in: "query",
+            name: "search",
+            schema: {
+              description: "String for which to search. Filters sites to those with a partial match on `name` or `site_key`.",
+              minLength: 1,
+              type: "string"
+            }
+          }
+        ],
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    ok: { type: "boolean" },
+                    sites: {
+                      items: { $ref: "#/components/schemas/space" },
+                      type: "array"
+                    }
+                  },
+                  required: ["sites", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] }
+        ],
+        summary: "/seam/console/v1/sites/list",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "console", "v1", "sites"],
+        "x-fern-sdk-method-name": "list",
+        "x-fern-sdk-return-value": "sites",
+        "x-response-key": "sites",
+        "x-title": "List Sites",
+        "x-undocumented": "Internal endpoint for Console"
+      },
+      post: {
+        description: "Lists sites (top-level spaces) in the workspace.",
+        operationId: "seamConsoleV1SitesListPost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  search: {
+                    description: "String for which to search. Filters sites to those with a partial match on `name` or `site_key`.",
+                    minLength: 1,
+                    type: "string"
+                  }
+                },
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    ok: { type: "boolean" },
+                    sites: {
+                      items: { $ref: "#/components/schemas/space" },
+                      type: "array"
+                    }
+                  },
+                  required: ["sites", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] }
+        ],
+        summary: "/seam/console/v1/sites/list",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "console", "v1", "sites"],
+        "x-fern-sdk-method-name": "list",
+        "x-fern-sdk-return-value": "sites",
+        "x-response-key": "sites",
+        "x-title": "List Sites",
+        "x-undocumented": "Internal endpoint for Console"
+      }
+    },
+    "/seam/console/v1/sites/update": {
+      patch: {
+        description: "Updates an existing site.",
+        operationId: "seamConsoleV1SitesUpdatePatch",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  name: {
+                    description: "New name for the site.",
+                    type: "string"
+                  },
+                  site_id: {
+                    description: "ID of the site that you want to update.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  site_key: {
+                    description: "New unique key for the site within the workspace.",
+                    type: "string"
+                  }
+                },
+                required: ["site_id"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    ok: { type: "boolean" },
+                    site: { $ref: "#/components/schemas/space" }
+                  },
+                  required: ["site", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] }
+        ],
+        summary: "/seam/console/v1/sites/update",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "console", "v1", "sites"],
+        "x-fern-sdk-method-name": "update",
+        "x-fern-sdk-return-value": "site",
+        "x-response-key": "site",
+        "x-title": "Update a Site",
+        "x-undocumented": "Internal endpoint for Console"
+      },
+      post: {
+        description: "Updates an existing site.",
+        operationId: "seamConsoleV1SitesUpdatePost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  name: {
+                    description: "New name for the site.",
+                    type: "string"
+                  },
+                  site_id: {
+                    description: "ID of the site that you want to update.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  site_key: {
+                    description: "New unique key for the site within the workspace.",
+                    type: "string"
+                  }
+                },
+                required: ["site_id"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    ok: { type: "boolean" },
+                    site: { $ref: "#/components/schemas/space" }
+                  },
+                  required: ["site", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] }
+        ],
+        summary: "/seam/console/v1/sites/update",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "console", "v1", "sites"],
+        "x-fern-sdk-method-name": "update",
+        "x-fern-sdk-return-value": "site",
+        "x-response-key": "site",
+        "x-title": "Update a Site",
+        "x-undocumented": "Internal endpoint for Console"
+      }
+    },
     "/seam/console/v1/timelines/get": {
       get: {
         description: "Returns timeline entries for a resource and its child resources, grouped by entry groups.",