@seamapi/types 1.624.0 → 1.626.0

package/lib/seam/connect/route-types.d.ts

@@ -59571,6 +59571,95 @@ export type Routes = {
             }[];
         };
     };
+    '/seam/customer/v1/staff_members/get': {
+        route: '/seam/customer/v1/staff_members/get';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** Key of staff member to get. */
+            staff_member_key: string;
+        };
+        formData: {};
+        jsonResponse: {
+            /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
+            access_grant: {
+                /** ID of the Seam workspace associated with the Access Grant. */
+                workspace_id: string;
+                /** ID of the Access Grant. */
+                access_grant_id: string;
+                /** Unique key for the access grant within the workspace. */
+                access_grant_key?: string | undefined;
+                /** Reservation key for the access grant. */
+                reservation_key?: string | undefined;
+                /** ID of user identity to which the Access Grant gives access. */
+                user_identity_id: string;
+                /**
+                 * @deprecated Use `space_ids`.*/
+                location_ids: string[];
+                /** IDs of the spaces to which the Access Grant gives access. */
+                space_ids: string[];
+                /** Access methods that the user requested for the Access Grant. */
+                requested_access_methods: {
+                    /** Display name of the access method. */
+                    display_name: string;
+                    /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                    mode: 'code' | 'card' | 'mobile_key';
+                    /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
+                    code?: string | undefined;
+                    /** Date and time at which the requested access method was added to the Access Grant. */
+                    created_at: string;
+                    /** IDs of the access methods created for the requested access method. */
+                    created_access_method_ids: string[];
+                }[];
+                /** IDs of the access methods created for the Access Grant. */
+                access_method_ids: string[];
+                /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
+                client_session_token?: string | undefined;
+                /** Name of the Access Grant. If not provided, the display name will be computed. */
+                name: string | null;
+                /** Display name of the Access Grant. */
+                display_name: string;
+                /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
+                instant_key_url?: string | undefined;
+                /** Date and time at which the Access Grant was created. */
+                created_at: string;
+                /** Date and time at which the Access Grant starts. */
+                starts_at: string;
+                /** Date and time at which the Access Grant ends. */
+                ends_at: string | null;
+                /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                warnings: {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'being_deleted';
+                }[];
+                /** ID of the customization profile associated with the Access Grant. */
+                customization_profile_id?: string | undefined;
+            };
+            spaces: {
+                space_key: string;
+                child_space_keys?: string[] | undefined;
+            }[];
+            /** Represents a staff member for a specific customer. */
+            staff_member: {
+                /** Your unique identifier for the staff. */
+                staff_member_key: string;
+                /** Phone number associated with the user identity. */
+                phone_number?: string | undefined;
+                /** Email address associated with the user identity. */
+                email_address?: string | undefined;
+                /** Your display name for this user identity resource. */
+                name: string;
+                /** List of unique identifiers for the spaces the staff member is associated with. */
+                space_keys?: string[] | undefined;
+                user_identity_id?: string | undefined;
+            };
+        };
+    };
     '/seam/customer/v1/staff_members/list': {
         route: '/seam/customer/v1/staff_members/list';
         method: 'GET' | 'POST';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.624.0",
+  "version": "1.626.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/openapi.ts

@@ -52769,6 +52769,7 @@ export default {
         'x-fern-sdk-return-value': 'connector_sync',
         'x-response-key': 'connector_sync',
         'x-title': 'Sync Connector Data',
+        'x-undocumented': 'Only used internally.',
       },
     },
     '/seam/customer/v1/events/list': {
@@ -54733,6 +54734,7 @@ export default {
         'x-fern-sdk-return-value': 'space',
         'x-response-key': 'space',
         'x-title': 'Create a Space',
+        'x-undocumented': 'Only used internally.',
       },
     },
     '/seam/customer/v1/spaces/list': {
@@ -54802,6 +54804,7 @@ export default {
         'x-fern-sdk-return-value': 'spaces',
         'x-response-key': 'spaces',
         'x-title': 'List Spaces',
+        'x-undocumented': 'Only used internally.',
       },
       post: {
         description: 'Returns a list of all spaces.',
@@ -54866,6 +54869,198 @@ export default {
         'x-fern-sdk-return-value': 'spaces',
         'x-response-key': 'spaces',
         'x-title': 'List Spaces',
+        'x-undocumented': 'Only used internally.',
+      },
+    },
+    '/seam/customer/v1/staff_members/get': {
+      get: {
+        description: 'Returns a staff member for a specific customer.',
+        operationId: 'seamCustomerV1StaffMembersGetGet',
+        parameters: [
+          {
+            in: 'query',
+            name: 'staff_member_key',
+            required: true,
+            schema: {
+              description: 'Key of staff member to get.',
+              type: 'string',
+            },
+          },
+        ],
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    access_grant: { $ref: '#/components/schemas/access_grant' },
+                    ok: { type: 'boolean' },
+                    spaces: {
+                      items: {
+                        properties: {
+                          child_space_keys: {
+                            items: { type: 'string' },
+                            type: 'array',
+                          },
+                          space_key: { type: 'string' },
+                        },
+                        required: ['space_key'],
+                        type: 'object',
+                      },
+                      type: 'array',
+                    },
+                    staff_member: {
+                      description:
+                        'Represents a staff member for a specific customer.',
+                      properties: {
+                        email_address: {
+                          description:
+                            'Email address associated with the user identity.',
+                          type: 'string',
+                        },
+                        name: {
+                          description:
+                            'Your display name for this user identity resource.',
+                          type: 'string',
+                        },
+                        phone_number: {
+                          description:
+                            'Phone number associated with the user identity.',
+                          type: 'string',
+                        },
+                        space_keys: {
+                          description:
+                            'List of unique identifiers for the spaces the staff member is associated with.',
+                          items: { type: 'string' },
+                          type: 'array',
+                        },
+                        staff_member_key: {
+                          description: 'Your unique identifier for the staff.',
+                          type: 'string',
+                        },
+                        user_identity_id: { format: 'uuid', type: 'string' },
+                      },
+                      required: ['staff_member_key', 'name'],
+                      type: 'object',
+                      'x-route-path': '/seam/customer/v1/staff_members',
+                    },
+                  },
+                  required: ['access_grant', 'spaces', 'staff_member', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: '/seam/customer/v1/staff_members/get',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'staff_members'],
+        'x-fern-sdk-method-name': 'get',
+        'x-fern-sdk-return-value': 'staff_member',
+        'x-response-key': 'staff_member',
+        'x-title': 'Get Staff Member',
+        'x-undocumented': 'Internal endpoint for customer portals.',
+      },
+      post: {
+        description: 'Returns a staff member for a specific customer.',
+        operationId: 'seamCustomerV1StaffMembersGetPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  staff_member_key: {
+                    description: 'Key of staff member to get.',
+                    type: 'string',
+                  },
+                },
+                required: ['staff_member_key'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    access_grant: { $ref: '#/components/schemas/access_grant' },
+                    ok: { type: 'boolean' },
+                    spaces: {
+                      items: {
+                        properties: {
+                          child_space_keys: {
+                            items: { type: 'string' },
+                            type: 'array',
+                          },
+                          space_key: { type: 'string' },
+                        },
+                        required: ['space_key'],
+                        type: 'object',
+                      },
+                      type: 'array',
+                    },
+                    staff_member: {
+                      description:
+                        'Represents a staff member for a specific customer.',
+                      properties: {
+                        email_address: {
+                          description:
+                            'Email address associated with the user identity.',
+                          type: 'string',
+                        },
+                        name: {
+                          description:
+                            'Your display name for this user identity resource.',
+                          type: 'string',
+                        },
+                        phone_number: {
+                          description:
+                            'Phone number associated with the user identity.',
+                          type: 'string',
+                        },
+                        space_keys: {
+                          description:
+                            'List of unique identifiers for the spaces the staff member is associated with.',
+                          items: { type: 'string' },
+                          type: 'array',
+                        },
+                        staff_member_key: {
+                          description: 'Your unique identifier for the staff.',
+                          type: 'string',
+                        },
+                        user_identity_id: { format: 'uuid', type: 'string' },
+                      },
+                      required: ['staff_member_key', 'name'],
+                      type: 'object',
+                      'x-route-path': '/seam/customer/v1/staff_members',
+                    },
+                  },
+                  required: ['access_grant', 'spaces', 'staff_member', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: '/seam/customer/v1/staff_members/get',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'staff_members'],
+        'x-fern-sdk-method-name': 'get',
+        'x-fern-sdk-return-value': 'staff_member',
+        'x-response-key': 'staff_member',
+        'x-title': 'Get Staff Member',
+        'x-undocumented': 'Internal endpoint for customer portals.',
       },
     },
     '/seam/customer/v1/staff_members/list': {

package/src/lib/seam/connect/route-types.ts

@@ -70955,6 +70955,95 @@ export type Routes = {
       }[]
     }
   }
+  '/seam/customer/v1/staff_members/get': {
+    route: '/seam/customer/v1/staff_members/get'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** Key of staff member to get. */
+      staff_member_key: string
+    }
+    formData: {}
+    jsonResponse: {
+      /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
+      access_grant: {
+        /** ID of the Seam workspace associated with the Access Grant. */
+        workspace_id: string
+        /** ID of the Access Grant. */
+        access_grant_id: string
+        /** Unique key for the access grant within the workspace. */
+        access_grant_key?: string | undefined
+        /** Reservation key for the access grant. */
+        reservation_key?: string | undefined
+        /** ID of user identity to which the Access Grant gives access. */
+        user_identity_id: string
+        /**
+         * @deprecated Use `space_ids`.*/
+        location_ids: string[]
+        /** IDs of the spaces to which the Access Grant gives access. */
+        space_ids: string[]
+        /** Access methods that the user requested for the Access Grant. */
+        requested_access_methods: {
+          /** Display name of the access method. */
+          display_name: string
+          /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+          mode: 'code' | 'card' | 'mobile_key'
+          /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
+          code?: string | undefined
+          /** Date and time at which the requested access method was added to the Access Grant. */
+          created_at: string
+          /** IDs of the access methods created for the requested access method. */
+          created_access_method_ids: string[]
+        }[]
+        /** IDs of the access methods created for the Access Grant. */
+        access_method_ids: string[]
+        /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
+        client_session_token?: string | undefined
+        /** Name of the Access Grant. If not provided, the display name will be computed. */
+        name: string | null
+        /** Display name of the Access Grant. */
+        display_name: string
+        /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
+        instant_key_url?: string | undefined
+        /** Date and time at which the Access Grant was created. */
+        created_at: string
+        /** Date and time at which the Access Grant starts. */
+        starts_at: string
+        /** Date and time at which the Access Grant ends. */
+        ends_at: string | null
+        /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+        warnings: {
+          /** Date and time at which Seam created the warning. */
+          created_at: string
+          /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+          warning_code: 'being_deleted'
+        }[]
+        /** ID of the customization profile associated with the Access Grant. */
+        customization_profile_id?: string | undefined
+      }
+      spaces: {
+        space_key: string
+        child_space_keys?: string[] | undefined
+      }[]
+      /** Represents a staff member for a specific customer. */
+      staff_member: {
+        /** Your unique identifier for the staff. */
+        staff_member_key: string
+        /** Phone number associated with the user identity. */
+        phone_number?: string | undefined
+        /** Email address associated with the user identity. */
+        email_address?: string | undefined
+        /** Your display name for this user identity resource. */
+        name: string
+        /** List of unique identifiers for the spaces the staff member is associated with. */
+        space_keys?: string[] | undefined
+        user_identity_id?: string | undefined
+      }
+    }
+  }
   '/seam/customer/v1/staff_members/list': {
     route: '/seam/customer/v1/staff_members/list'
     method: 'GET' | 'POST'