@seamapi/types 1.592.0 → 1.593.0

package/dist/connect.d.cts

@@ -94906,6 +94906,159 @@ declare const _default: {
                 'x-title': string;
             };
         };
+        '/seam/customer/v1/spaces/list': {
+            get: {
+                description: string;
+                operationId: string;
+                parameters: ({
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        minLength: number;
+                        type: string;
+                        format?: never;
+                        'x-draft'?: never;
+                        'x-undocumented'?: never;
+                    };
+                } | {
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        format: string;
+                        type: string;
+                        'x-draft': string;
+                        'x-undocumented': string;
+                        minLength?: never;
+                    };
+                } | {
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        type: string;
+                        minLength?: never;
+                        format?: never;
+                        'x-draft'?: never;
+                        'x-undocumented'?: never;
+                    };
+                })[];
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                        spaces: {
+                                            items: {
+                                                $ref: string;
+                                            };
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: {
+                    client_session_with_customer: never[];
+                }[];
+                summary: string;
+                tags: never[];
+                'x-draft': string;
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
+                'x-title': string;
+            };
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    connected_account_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                        'x-draft': string;
+                                        'x-undocumented': string;
+                                    };
+                                    search: {
+                                        description: string;
+                                        minLength: number;
+                                        type: string;
+                                    };
+                                    space_key: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                };
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                        spaces: {
+                                            items: {
+                                                $ref: string;
+                                            };
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: {
+                    client_session_with_customer: never[];
+                }[];
+                summary: string;
+                tags: never[];
+                'x-draft': string;
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
+                'x-title': string;
+            };
+        };
         '/seam/instant_key/v1/client_sessions/exchange_short_code': {
             post: {
                 description: string;
@@ -165671,6 +165824,45 @@ type Routes = {
             };
         };
     };
+    '/seam/customer/v1/spaces/list': {
+        route: '/seam/customer/v1/spaces/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
+            search?: string | undefined;
+            /** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
+            connected_account_id?: string | undefined;
+            /** Filter spaces by space_key. */
+            space_key?: string | undefined;
+        };
+        formData: {};
+        jsonResponse: {
+            spaces: {
+                /** ID of the space. */
+                space_id: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/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;
+                /**  */
+                parent_space_id?: string | undefined;
+                /**  */
+                parent_space_key?: string | undefined;
+            }[];
+        };
+    };
     '/seam/instant_key/v1/client_sessions/exchange_short_code': {
         route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
         method: 'POST';

package/dist/index.cjs

@@ -54476,6 +54476,135 @@ var openapi_default = {
         "x-title": "Create a Space"
       }
     },
+    "/seam/customer/v1/spaces/list": {
+      get: {
+        description: "Returns a list of all spaces.",
+        operationId: "seamCustomerV1SpacesListGet",
+        parameters: [
+          {
+            in: "query",
+            name: "search",
+            schema: {
+              description: "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.",
+              minLength: 1,
+              type: "string"
+            }
+          },
+          {
+            in: "query",
+            name: "connected_account_id",
+            schema: {
+              description: "Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.",
+              format: "uuid",
+              type: "string",
+              "x-draft": "Needs review.",
+              "x-undocumented": "Only used internally."
+            }
+          },
+          {
+            in: "query",
+            name: "space_key",
+            schema: {
+              description: "Filter spaces by space_key.",
+              type: "string"
+            }
+          }
+        ],
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    ok: { type: "boolean" },
+                    spaces: {
+                      items: { $ref: "#/components/schemas/space" },
+                      type: "array"
+                    }
+                  },
+                  required: ["spaces", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: "/seam/customer/v1/spaces/list",
+        tags: [],
+        "x-draft": "Early access.",
+        "x-fern-sdk-group-name": ["seam", "customer", "v1", "spaces"],
+        "x-fern-sdk-method-name": "list",
+        "x-fern-sdk-return-value": "spaces",
+        "x-response-key": "spaces",
+        "x-title": "List Spaces"
+      },
+      post: {
+        description: "Returns a list of all spaces.",
+        operationId: "seamCustomerV1SpacesListPost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  connected_account_id: {
+                    description: "Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.",
+                    format: "uuid",
+                    type: "string",
+                    "x-draft": "Needs review.",
+                    "x-undocumented": "Only used internally."
+                  },
+                  search: {
+                    description: "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.",
+                    minLength: 1,
+                    type: "string"
+                  },
+                  space_key: {
+                    description: "Filter spaces by space_key.",
+                    type: "string"
+                  }
+                },
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    ok: { type: "boolean" },
+                    spaces: {
+                      items: { $ref: "#/components/schemas/space" },
+                      type: "array"
+                    }
+                  },
+                  required: ["spaces", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: "/seam/customer/v1/spaces/list",
+        tags: [],
+        "x-draft": "Early access.",
+        "x-fern-sdk-group-name": ["seam", "customer", "v1", "spaces"],
+        "x-fern-sdk-method-name": "list",
+        "x-fern-sdk-return-value": "spaces",
+        "x-response-key": "spaces",
+        "x-title": "List Spaces"
+      }
+    },
     "/seam/instant_key/v1/client_sessions/exchange_short_code": {
       post: {
         description: "Exchanges a short code for a client session token. Mobile apps use this endpoint to retrieve a client session token securely using a short code obtained from an Instant Key URL.",