@seamapi/types 1.465.0 → 1.466.1

package/dist/connect.d.cts

@@ -47024,9 +47024,11 @@ declare const _default: {
                                             required: string[];
                                             type: string;
                                             'x-route-path': string;
+                                            'x-undocumented': string;
                                         };
                                         type: string;
                                         'x-property-group-key': string;
+                                        'x-undocumented': string;
                                     };
                                     thermostat_weekly_program: {
                                         description: string;
@@ -47083,6 +47085,7 @@ declare const _default: {
                                         required: string[];
                                         type: string;
                                         'x-property-group-key': string;
+                                        'x-undocumented': string;
                                     };
                                     _experimental_supported_code_from_access_codes_lengths?: never;
                                     code_constraints?: never;
@@ -47291,7 +47294,6 @@ declare const _default: {
                 'x-route-path': string;
             };
             enrollment_automation: {
-                deprecated: boolean;
                 description: string;
                 properties: {
                     created_at: {
@@ -47322,8 +47324,8 @@ declare const _default: {
                 };
                 required: string[];
                 type: string;
-                'x-deprecated': string;
                 'x-route-path': string;
+                'x-undocumented': string;
             };
             event: {
                 description: string;
@@ -51874,6 +51876,7 @@ declare const _default: {
                 required: string[];
                 type: string;
                 'x-route-path': string;
+                'x-undocumented': string;
             };
             thermostat_schedule: {
                 description: string;
@@ -81029,6 +81032,7 @@ declare const _default: {
                 'x-fern-sdk-return-value': string;
                 'x-response-key': string;
                 'x-title': string;
+                'x-undocumented': string;
             };
         };
         '/thermostats/daily_programs/delete': {
@@ -81096,6 +81100,7 @@ declare const _default: {
                 'x-fern-sdk-method-name': string;
                 'x-response-key': null;
                 'x-title': string;
+                'x-undocumented': string;
             };
             post: {
                 description: string;
@@ -81168,6 +81173,7 @@ declare const _default: {
                 'x-fern-sdk-method-name': string;
                 'x-response-key': null;
                 'x-title': string;
+                'x-undocumented': string;
             };
         };
         '/thermostats/daily_programs/update': {
@@ -81271,6 +81277,7 @@ declare const _default: {
                 'x-fern-sdk-return-value': string;
                 'x-response-key': string;
                 'x-title': string;
+                'x-undocumented': string;
             };
             post: {
                 description: string;
@@ -81372,6 +81379,7 @@ declare const _default: {
                 'x-fern-sdk-return-value': string;
                 'x-response-key': string;
                 'x-title': string;
+                'x-undocumented': string;
             };
         };
         '/thermostats/delete_climate_preset': {
@@ -84405,6 +84413,7 @@ declare const _default: {
                 'x-fern-sdk-return-value': string;
                 'x-response-key': string;
                 'x-title': string;
+                'x-undocumented': string;
             };
         };
         '/unstable_access_grants/create': {
@@ -87580,11 +87589,11 @@ declare const _default: {
                 })[];
                 summary: string;
                 tags: string[];
-                'x-deprecated': string;
                 'x-fern-sdk-group-name': string[];
                 'x-fern-sdk-method-name': string;
                 'x-response-key': null;
                 'x-title': string;
+                'x-undocumented': string;
             };
             post: {
                 description: string;
@@ -87645,11 +87654,11 @@ declare const _default: {
                 })[];
                 summary: string;
                 tags: string[];
-                'x-deprecated': string;
                 'x-fern-sdk-group-name': string[];
                 'x-fern-sdk-method-name': string;
                 'x-response-key': null;
                 'x-title': string;
+                'x-undocumented': string;
             };
         };
         '/user_identities/enrollment_automations/get': {
@@ -87716,12 +87725,12 @@ declare const _default: {
                 })[];
                 summary: string;
                 tags: string[];
-                'x-deprecated': 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;
+                'x-undocumented': string;
             };
             post: {
                 description: string;
@@ -87793,12 +87802,12 @@ declare const _default: {
                 })[];
                 summary: string;
                 tags: string[];
-                'x-deprecated': 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;
+                'x-undocumented': string;
             };
         };
         '/user_identities/enrollment_automations/launch': {
@@ -87883,12 +87892,12 @@ declare const _default: {
                 })[];
                 summary: string;
                 tags: string[];
-                'x-deprecated': 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;
+                'x-undocumented': string;
             };
         };
         '/user_identities/enrollment_automations/list': {
@@ -87958,12 +87967,12 @@ declare const _default: {
                 })[];
                 summary: string;
                 tags: string[];
-                'x-deprecated': 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;
+                'x-undocumented': string;
             };
             post: {
                 description: string;
@@ -88038,12 +88047,12 @@ declare const _default: {
                 })[];
                 summary: string;
                 tags: string[];
-                'x-deprecated': 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;
+                'x-undocumented': string;
             };
         };
         '/user_identities/generate_instant_key': {
@@ -162006,8 +162015,7 @@ type Routes = {
         };
         formData: {};
         jsonResponse: {
-            /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/).
-             * @deprecated Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.*/
+            /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/). */
             enrollment_automation: {
                 /** ID of the enrollment automation. */
                 enrollment_automation_id: string;
@@ -162041,8 +162049,7 @@ type Routes = {
         };
         formData: {};
         jsonResponse: {
-            /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/).
-             * @deprecated Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.*/
+            /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/). */
             enrollment_automation: {
                 /** ID of the enrollment automation. */
                 enrollment_automation_id: string;

package/dist/index.cjs

@@ -249,6 +249,7 @@ var thermostat_daily_program = zod.z.object({
 }).describe(`
   ---
   route_path: /thermostats/daily_programs
+  undocumented: Unreleased.
   ---
   Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.
 `);
@@ -429,12 +430,14 @@ var thermostat_capability_properties = zod.z.object({
   thermostat_daily_programs: zod.z.array(thermostat_daily_program).optional().describe(`
           ---
           property_group_key: thermostats
+          undocumented: Unreleased.
           ---
           Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
           `),
   thermostat_weekly_program: thermostat_weekly_program.nullable().optional().describe(`
           ---
           property_group_key: thermostats
+          undocumented: Unreleased.
           ---
           Current [weekly program](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
           `),
@@ -16349,10 +16352,12 @@ var openapi_default = {
                             "created_at"
                           ],
                           type: "object",
-                          "x-route-path": "/thermostats/daily_programs"
+                          "x-route-path": "/thermostats/daily_programs",
+                          "x-undocumented": "Unreleased."
                         },
                         type: "array",
-                        "x-property-group-key": "thermostats"
+                        "x-property-group-key": "thermostats",
+                        "x-undocumented": "Unreleased."
                       },
                       thermostat_weekly_program: {
                         description: "Current [weekly program](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.",
@@ -16417,7 +16422,8 @@ var openapi_default = {
                           "created_at"
                         ],
                         type: "object",
-                        "x-property-group-key": "thermostats"
+                        "x-property-group-key": "thermostats",
+                        "x-undocumented": "Unreleased."
                       }
                     },
                     type: "object"
@@ -16945,7 +16951,6 @@ var openapi_default = {
         "x-route-path": "/devices"
       },
       enrollment_automation: {
-        deprecated: true,
         description: "Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/).",
         properties: {
           created_at: {
@@ -16982,8 +16987,8 @@ var openapi_default = {
           "workspace_id"
         ],
         type: "object",
-        "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
-        "x-route-path": "/user_identities/enrollment_automations"
+        "x-route-path": "/user_identities/enrollment_automations",
+        "x-undocumented": "Will be removed."
       },
       event: {
         description: "Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.\n\nAs with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/latest/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.",
@@ -23836,7 +23841,8 @@ var openapi_default = {
           "created_at"
         ],
         type: "object",
-        "x-route-path": "/thermostats/daily_programs"
+        "x-route-path": "/thermostats/daily_programs",
+        "x-undocumented": "Unreleased."
       },
       thermostat_schedule: {
         description: "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.",
@@ -51098,7 +51104,8 @@ var openapi_default = {
         "x-fern-sdk-method-name": "create",
         "x-fern-sdk-return-value": "thermostat_daily_program",
         "x-response-key": "thermostat_daily_program",
-        "x-title": "Create a Thermostat Daily Program"
+        "x-title": "Create a Thermostat Daily Program",
+        "x-undocumented": "Unreleased."
       }
     },
     "/thermostats/daily_programs/delete": {
@@ -51144,7 +51151,8 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["thermostats", "daily_programs"],
         "x-fern-sdk-method-name": "delete",
         "x-response-key": null,
-        "x-title": "Delete a Thermostat Daily Program"
+        "x-title": "Delete a Thermostat Daily Program",
+        "x-undocumented": "Unreleased."
       },
       post: {
         description: "Deletes a thermostat daily program.",
@@ -51193,7 +51201,8 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["thermostats", "daily_programs"],
         "x-fern-sdk-method-name": "delete",
         "x-response-key": null,
-        "x-title": "Delete a Thermostat Daily Program"
+        "x-title": "Delete a Thermostat Daily Program",
+        "x-undocumented": "Unreleased."
       }
     },
     "/thermostats/daily_programs/update": {
@@ -51275,7 +51284,8 @@ var openapi_default = {
         "x-fern-sdk-method-name": "update",
         "x-fern-sdk-return-value": "action_attempt",
         "x-response-key": "action_attempt",
-        "x-title": "Update a Thermostat Daily Program"
+        "x-title": "Update a Thermostat Daily Program",
+        "x-undocumented": "Unreleased."
       },
       post: {
         description: "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.",
@@ -51355,7 +51365,8 @@ var openapi_default = {
         "x-fern-sdk-method-name": "update",
         "x-fern-sdk-return-value": "action_attempt",
         "x-response-key": "action_attempt",
-        "x-title": "Update a Thermostat Daily Program"
+        "x-title": "Update a Thermostat Daily Program",
+        "x-undocumented": "Unreleased."
       }
     },
     "/thermostats/delete_climate_preset": {
@@ -53857,7 +53868,8 @@ var openapi_default = {
         "x-fern-sdk-method-name": "update_weekly_program",
         "x-fern-sdk-return-value": "action_attempt",
         "x-response-key": "action_attempt",
-        "x-title": "Update the Thermostat Weekly Program"
+        "x-title": "Update the Thermostat Weekly Program",
+        "x-undocumented": "Unreleased."
       }
     },
     "/unstable_access_grants/create": {
@@ -56320,11 +56332,11 @@ var openapi_default = {
         ],
         summary: "/user_identities/enrollment_automations/delete",
         tags: ["/user_identities"],
-        "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
         "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
         "x-fern-sdk-method-name": "delete",
         "x-response-key": null,
-        "x-title": "Delete an Enrollment Automation"
+        "x-title": "Delete an Enrollment Automation",
+        "x-undocumented": "Will be removed."
       },
       post: {
         description: "Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).",
@@ -56369,11 +56381,11 @@ var openapi_default = {
         ],
         summary: "/user_identities/enrollment_automations/delete",
         tags: ["/user_identities"],
-        "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
         "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
         "x-fern-sdk-method-name": "delete",
         "x-response-key": null,
-        "x-title": "Delete an Enrollment Automation"
+        "x-title": "Delete an Enrollment Automation",
+        "x-undocumented": "Will be removed."
       }
     },
     "/user_identities/enrollment_automations/get": {
@@ -56421,12 +56433,12 @@ var openapi_default = {
         ],
         summary: "/user_identities/enrollment_automations/get",
         tags: ["/user_identities"],
-        "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
         "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
         "x-fern-sdk-method-name": "get",
         "x-fern-sdk-return-value": "enrollment_automation",
         "x-response-key": "enrollment_automation",
-        "x-title": "Get an Enrollment Automation"
+        "x-title": "Get an Enrollment Automation",
+        "x-undocumented": "Will be removed."
       },
       post: {
         description: "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system/).",
@@ -56477,12 +56489,12 @@ var openapi_default = {
         ],
         summary: "/user_identities/enrollment_automations/get",
         tags: ["/user_identities"],
-        "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
         "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
         "x-fern-sdk-method-name": "get",
         "x-fern-sdk-return-value": "enrollment_automation",
         "x-response-key": "enrollment_automation",
-        "x-title": "Get an Enrollment Automation"
+        "x-title": "Get an Enrollment Automation",
+        "x-undocumented": "Will be removed."
       }
     },
     "/user_identities/enrollment_automations/launch": {
@@ -56556,12 +56568,12 @@ var openapi_default = {
         ],
         summary: "/user_identities/enrollment_automations/launch",
         tags: ["/user_identities"],
-        "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
         "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
         "x-fern-sdk-method-name": "launch",
         "x-fern-sdk-return-value": "enrollment_automation",
         "x-response-key": "enrollment_automation",
-        "x-title": "Launch an Enrollment Automation"
+        "x-title": "Launch an Enrollment Automation",
+        "x-undocumented": "Will be removed."
       }
     },
     "/user_identities/enrollment_automations/list": {
@@ -56612,12 +56624,12 @@ var openapi_default = {
         ],
         summary: "/user_identities/enrollment_automations/list",
         tags: ["/user_identities"],
-        "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
         "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
         "x-fern-sdk-method-name": "list",
         "x-fern-sdk-return-value": "enrollment_automations",
         "x-response-key": "enrollment_automations",
-        "x-title": "List Enrollment Automations"
+        "x-title": "List Enrollment Automations",
+        "x-undocumented": "Will be removed."
       },
       post: {
         description: "Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
@@ -56671,12 +56683,12 @@ var openapi_default = {
         ],
         summary: "/user_identities/enrollment_automations/list",
         tags: ["/user_identities"],
-        "x-deprecated": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
         "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
         "x-fern-sdk-method-name": "list",
         "x-fern-sdk-return-value": "enrollment_automations",
         "x-response-key": "enrollment_automations",
-        "x-title": "List Enrollment Automations"
+        "x-title": "List Enrollment Automations",
+        "x-undocumented": "Will be removed."
       }
     },
     "/user_identities/generate_instant_key": {