@seamapi/types 1.605.0 → 1.606.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -39632,6 +39632,27 @@ type ConnectedAccount = z.infer<typeof connected_account>;
39632
39632
  declare const custom_metadata: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
39633
39633
  type CustomMetadata = z.output<typeof custom_metadata>;
39634
39634
 
39635
+ declare const staff_member_resource: z.ZodObject<{
39636
+ name: z.ZodString;
39637
+ email_address: z.ZodOptional<z.ZodString>;
39638
+ phone_number: z.ZodOptional<z.ZodString>;
39639
+ } & {
39640
+ staff_member_key: z.ZodString;
39641
+ site_keys: z.ZodArray<z.ZodString, "many">;
39642
+ }, "strip", z.ZodTypeAny, {
39643
+ name: string;
39644
+ staff_member_key: string;
39645
+ site_keys: string[];
39646
+ email_address?: string | undefined;
39647
+ phone_number?: string | undefined;
39648
+ }, {
39649
+ name: string;
39650
+ staff_member_key: string;
39651
+ site_keys: string[];
39652
+ email_address?: string | undefined;
39653
+ phone_number?: string | undefined;
39654
+ }>;
39655
+
39635
39656
  declare const customization_profile: z.ZodObject<{
39636
39657
  workspace_id: z.ZodString;
39637
39658
  name: z.ZodNullable<z.ZodString>;
@@ -51479,6 +51500,7 @@ declare const schemas_magic_link: typeof magic_link;
51479
51500
  declare const schemas_noise_threshold: typeof noise_threshold;
51480
51501
  declare const schemas_pagination: typeof pagination;
51481
51502
  declare const schemas_seam_event: typeof seam_event;
51503
+ declare const schemas_staff_member_resource: typeof staff_member_resource;
51482
51504
  declare const schemas_thermostat_daily_program: typeof thermostat_daily_program;
51483
51505
  declare const schemas_thermostat_schedule: typeof thermostat_schedule;
51484
51506
  declare const schemas_thermostat_weekly_program: typeof thermostat_weekly_program;
@@ -51491,7 +51513,7 @@ declare const schemas_user_identity: typeof user_identity;
51491
51513
  declare const schemas_webhook: typeof webhook;
51492
51514
  declare const schemas_workspace: typeof workspace;
51493
51515
  declare namespace schemas {
51494
- export { schemas_access_code as access_code, schemas_acs_access_group as acs_access_group, schemas_acs_credential as acs_credential, schemas_acs_encoder as acs_encoder, schemas_acs_entrance as acs_entrance, schemas_acs_system as acs_system, schemas_acs_user as acs_user, schemas_action_attempt as action_attempt, schemas_batch as batch, schemas_bridge as bridge, schemas_bridge_client_session as bridge_client_session, schemas_building_block_type as building_block_type, schemas_client_session as client_session, schemas_common_failed_action_attempt as common_failed_action_attempt, schemas_common_pending_action_attempt as common_pending_action_attempt, schemas_common_succeeded_action_attempt as common_succeeded_action_attempt, schemas_connect_webview as connect_webview, schemas_connected_account as connected_account, schemas_custom_metadata as custom_metadata, schemas_customization_profile as customization_profile, schemas_device as device, schemas_device_provider as device_provider, schemas_instant_key as instant_key, schemas_magic_link as magic_link, schemas_noise_threshold as noise_threshold, schemas_pagination as pagination, schemas_seam_event as seam_event, schemas_thermostat_daily_program as thermostat_daily_program, schemas_thermostat_schedule as thermostat_schedule, schemas_thermostat_weekly_program as thermostat_weekly_program, schemas_unmanaged_access_code as unmanaged_access_code, schemas_unmanaged_acs_access_group as unmanaged_acs_access_group, schemas_unmanaged_acs_credential as unmanaged_acs_credential, schemas_unmanaged_acs_user as unmanaged_acs_user, schemas_unmanaged_device as unmanaged_device, schemas_user_identity as user_identity, schemas_webhook as webhook, schemas_workspace as workspace };
51516
+ export { schemas_access_code as access_code, schemas_acs_access_group as acs_access_group, schemas_acs_credential as acs_credential, schemas_acs_encoder as acs_encoder, schemas_acs_entrance as acs_entrance, schemas_acs_system as acs_system, schemas_acs_user as acs_user, schemas_action_attempt as action_attempt, schemas_batch as batch, schemas_bridge as bridge, schemas_bridge_client_session as bridge_client_session, schemas_building_block_type as building_block_type, schemas_client_session as client_session, schemas_common_failed_action_attempt as common_failed_action_attempt, schemas_common_pending_action_attempt as common_pending_action_attempt, schemas_common_succeeded_action_attempt as common_succeeded_action_attempt, schemas_connect_webview as connect_webview, schemas_connected_account as connected_account, schemas_custom_metadata as custom_metadata, schemas_customization_profile as customization_profile, schemas_device as device, schemas_device_provider as device_provider, schemas_instant_key as instant_key, schemas_magic_link as magic_link, schemas_noise_threshold as noise_threshold, schemas_pagination as pagination, schemas_seam_event as seam_event, schemas_staff_member_resource as staff_member_resource, schemas_thermostat_daily_program as thermostat_daily_program, schemas_thermostat_schedule as thermostat_schedule, schemas_thermostat_weekly_program as thermostat_weekly_program, schemas_unmanaged_access_code as unmanaged_access_code, schemas_unmanaged_acs_access_group as unmanaged_acs_access_group, schemas_unmanaged_acs_credential as unmanaged_acs_credential, schemas_unmanaged_acs_user as unmanaged_acs_user, schemas_unmanaged_device as unmanaged_device, schemas_user_identity as user_identity, schemas_webhook as webhook, schemas_workspace as workspace };
51495
51517
  }
51496
51518
 
51497
51519
  declare const _default: {
@@ -63706,6 +63728,37 @@ declare const _default: {
63706
63728
  'x-draft': string;
63707
63729
  'x-route-path': string;
63708
63730
  };
63731
+ staff_member: {
63732
+ description: string;
63733
+ properties: {
63734
+ email_address: {
63735
+ description: string;
63736
+ type: string;
63737
+ };
63738
+ name: {
63739
+ description: string;
63740
+ type: string;
63741
+ };
63742
+ phone_number: {
63743
+ description: string;
63744
+ type: string;
63745
+ };
63746
+ site_keys: {
63747
+ description: string;
63748
+ items: {
63749
+ type: string;
63750
+ };
63751
+ type: string;
63752
+ };
63753
+ staff_member_key: {
63754
+ description: string;
63755
+ type: string;
63756
+ };
63757
+ };
63758
+ required: string[];
63759
+ type: string;
63760
+ 'x-route-path': string;
63761
+ };
63709
63762
  thermostat_daily_program: {
63710
63763
  description: string;
63711
63764
  properties: {
@@ -84093,6 +84146,41 @@ declare const _default: {
84093
84146
  };
84094
84147
  type: string;
84095
84148
  };
84149
+ staff_members: {
84150
+ description: string;
84151
+ items: {
84152
+ description: string;
84153
+ properties: {
84154
+ email_address: {
84155
+ description: string;
84156
+ type: string;
84157
+ };
84158
+ name: {
84159
+ description: string;
84160
+ type: string;
84161
+ };
84162
+ phone_number: {
84163
+ description: string;
84164
+ type: string;
84165
+ };
84166
+ site_keys: {
84167
+ description: string;
84168
+ items: {
84169
+ type: string;
84170
+ };
84171
+ type: string;
84172
+ };
84173
+ staff_member_key: {
84174
+ description: string;
84175
+ type: string;
84176
+ };
84177
+ };
84178
+ required: string[];
84179
+ type: string;
84180
+ 'x-route-path': string;
84181
+ };
84182
+ type: string;
84183
+ };
84096
84184
  tenants: {
84097
84185
  description: string;
84098
84186
  items: {
@@ -85055,6 +85143,41 @@ declare const _default: {
85055
85143
  };
85056
85144
  type: string;
85057
85145
  };
85146
+ staff_members: {
85147
+ description: string;
85148
+ items: {
85149
+ description: string;
85150
+ properties: {
85151
+ email_address: {
85152
+ description: string;
85153
+ type: string;
85154
+ };
85155
+ name: {
85156
+ description: string;
85157
+ type: string;
85158
+ };
85159
+ phone_number: {
85160
+ description: string;
85161
+ type: string;
85162
+ };
85163
+ site_keys: {
85164
+ description: string;
85165
+ items: {
85166
+ type: string;
85167
+ };
85168
+ type: string;
85169
+ };
85170
+ staff_member_key: {
85171
+ description: string;
85172
+ type: string;
85173
+ };
85174
+ };
85175
+ required: string[];
85176
+ type: string;
85177
+ 'x-route-path': string;
85178
+ };
85179
+ type: string;
85180
+ };
85058
85181
  tenants: {
85059
85182
  description: string;
85060
85183
  items: {
@@ -96020,6 +96143,190 @@ declare const _default: {
96020
96143
  'x-title': string;
96021
96144
  };
96022
96145
  };
96146
+ '/seam/customer/v1/staff_members/list': {
96147
+ get: {
96148
+ description: string;
96149
+ operationId: string;
96150
+ parameters: ({
96151
+ in: string;
96152
+ name: string;
96153
+ schema: {
96154
+ description: string;
96155
+ type: string;
96156
+ format?: never;
96157
+ default?: never;
96158
+ exclusiveMinimum?: never;
96159
+ minimum?: never;
96160
+ nullable?: never;
96161
+ };
96162
+ } | {
96163
+ in: string;
96164
+ name: string;
96165
+ schema: {
96166
+ description: string;
96167
+ format: string;
96168
+ type: string;
96169
+ default?: never;
96170
+ exclusiveMinimum?: never;
96171
+ minimum?: never;
96172
+ nullable?: never;
96173
+ };
96174
+ } | {
96175
+ in: string;
96176
+ name: string;
96177
+ schema: {
96178
+ default: number;
96179
+ description: string;
96180
+ exclusiveMinimum: boolean;
96181
+ minimum: number;
96182
+ type: string;
96183
+ format?: never;
96184
+ nullable?: never;
96185
+ };
96186
+ } | {
96187
+ in: string;
96188
+ name: string;
96189
+ schema: {
96190
+ description: string;
96191
+ nullable: boolean;
96192
+ type: string;
96193
+ format?: never;
96194
+ default?: never;
96195
+ exclusiveMinimum?: never;
96196
+ minimum?: never;
96197
+ };
96198
+ })[];
96199
+ responses: {
96200
+ 200: {
96201
+ content: {
96202
+ 'application/json': {
96203
+ schema: {
96204
+ properties: {
96205
+ ok: {
96206
+ type: string;
96207
+ };
96208
+ pagination: {
96209
+ $ref: string;
96210
+ };
96211
+ staff_members: {
96212
+ items: {
96213
+ $ref: string;
96214
+ };
96215
+ type: string;
96216
+ };
96217
+ };
96218
+ required: string[];
96219
+ type: string;
96220
+ };
96221
+ };
96222
+ };
96223
+ description: string;
96224
+ };
96225
+ 400: {
96226
+ description: string;
96227
+ };
96228
+ 401: {
96229
+ description: string;
96230
+ };
96231
+ };
96232
+ security: {
96233
+ client_session_with_customer: never[];
96234
+ }[];
96235
+ summary: string;
96236
+ tags: never[];
96237
+ 'x-fern-sdk-group-name': string[];
96238
+ 'x-fern-sdk-method-name': string;
96239
+ 'x-fern-sdk-return-value': string;
96240
+ 'x-response-key': string;
96241
+ 'x-title': string;
96242
+ 'x-undocumented': string;
96243
+ };
96244
+ post: {
96245
+ description: string;
96246
+ operationId: string;
96247
+ requestBody: {
96248
+ content: {
96249
+ 'application/json': {
96250
+ schema: {
96251
+ properties: {
96252
+ created_before: {
96253
+ description: string;
96254
+ format: string;
96255
+ type: string;
96256
+ };
96257
+ limit: {
96258
+ default: number;
96259
+ description: string;
96260
+ exclusiveMinimum: boolean;
96261
+ minimum: number;
96262
+ type: string;
96263
+ };
96264
+ page_cursor: {
96265
+ description: string;
96266
+ nullable: boolean;
96267
+ type: string;
96268
+ };
96269
+ space_id: {
96270
+ description: string;
96271
+ format: string;
96272
+ type: string;
96273
+ };
96274
+ space_key: {
96275
+ description: string;
96276
+ type: string;
96277
+ };
96278
+ };
96279
+ type: string;
96280
+ };
96281
+ };
96282
+ };
96283
+ };
96284
+ responses: {
96285
+ 200: {
96286
+ content: {
96287
+ 'application/json': {
96288
+ schema: {
96289
+ properties: {
96290
+ ok: {
96291
+ type: string;
96292
+ };
96293
+ pagination: {
96294
+ $ref: string;
96295
+ };
96296
+ staff_members: {
96297
+ items: {
96298
+ $ref: string;
96299
+ };
96300
+ type: string;
96301
+ };
96302
+ };
96303
+ required: string[];
96304
+ type: string;
96305
+ };
96306
+ };
96307
+ };
96308
+ description: string;
96309
+ };
96310
+ 400: {
96311
+ description: string;
96312
+ };
96313
+ 401: {
96314
+ description: string;
96315
+ };
96316
+ };
96317
+ security: {
96318
+ client_session_with_customer: never[];
96319
+ }[];
96320
+ summary: string;
96321
+ tags: never[];
96322
+ 'x-fern-sdk-group-name': string[];
96323
+ 'x-fern-sdk-method-name': string;
96324
+ 'x-fern-sdk-return-value': string;
96325
+ 'x-response-key': string;
96326
+ 'x-title': string;
96327
+ 'x-undocumented': string;
96328
+ };
96329
+ };
96023
96330
  '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
96024
96331
  post: {
96025
96332
  description: string;
@@ -140295,6 +140602,19 @@ type Routes = {
140295
140602
  /** Your unique identifier for the user identity. */
140296
140603
  user_identity_key: string;
140297
140604
  }[] | undefined;
140605
+ /** List of staff members. */
140606
+ staff_members?: {
140607
+ /** Your display name for this user identity resource. */
140608
+ name: string;
140609
+ /** Email address associated with the user identity. */
140610
+ email_address?: string | undefined;
140611
+ /** Phone number associated with the user identity. */
140612
+ phone_number?: string | undefined;
140613
+ /** Your unique identifier for the staff. */
140614
+ staff_member_key: string;
140615
+ /** List of unique identifiers for the sites the staff member is associated with. */
140616
+ site_keys: string[];
140617
+ }[] | undefined;
140298
140618
  /** List of reservations. */
140299
140619
  reservations?: {
140300
140620
  /** Your name for this access grant resource. */
@@ -140620,6 +140940,19 @@ type Routes = {
140620
140940
  /** Your unique identifier for the user identity. */
140621
140941
  user_identity_key: string;
140622
140942
  }[] | undefined;
140943
+ /** List of staff members. */
140944
+ staff_members?: {
140945
+ /** Your display name for this user identity resource. */
140946
+ name: string;
140947
+ /** Email address associated with the user identity. */
140948
+ email_address?: string | undefined;
140949
+ /** Phone number associated with the user identity. */
140950
+ phone_number?: string | undefined;
140951
+ /** Your unique identifier for the staff. */
140952
+ staff_member_key: string;
140953
+ /** List of unique identifiers for the sites the staff member is associated with. */
140954
+ site_keys: string[];
140955
+ }[] | undefined;
140623
140956
  /** List of reservations. */
140624
140957
  reservations?: {
140625
140958
  /** Your name for this access grant resource. */
@@ -167645,6 +167978,48 @@ type Routes = {
167645
167978
  }[];
167646
167979
  };
167647
167980
  };
167981
+ '/seam/customer/v1/staff_members/list': {
167982
+ route: '/seam/customer/v1/staff_members/list';
167983
+ method: 'GET' | 'POST';
167984
+ queryParams: {};
167985
+ jsonBody: {};
167986
+ commonParams: {
167987
+ /** Filter staff members by space key. */
167988
+ space_key?: string | undefined;
167989
+ /** Filter staff members by space ID (UUID). */
167990
+ space_id?: string | undefined;
167991
+ /** Maximum number of records to return per page. */
167992
+ limit?: number;
167993
+ /** Timestamp by which to limit returned staff members. Returns staff members created before this timestamp. */
167994
+ created_before?: Date | undefined;
167995
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
167996
+ page_cursor?: ((string | undefined) | null) | undefined;
167997
+ };
167998
+ formData: {};
167999
+ jsonResponse: {
168000
+ staff_members: {
168001
+ /** Your display name for this user identity resource. */
168002
+ name: string;
168003
+ /** Email address associated with the user identity. */
168004
+ email_address?: string | undefined;
168005
+ /** Phone number associated with the user identity. */
168006
+ phone_number?: string | undefined;
168007
+ /** Your unique identifier for the staff. */
168008
+ staff_member_key: string;
168009
+ /** List of unique identifiers for the sites the staff member is associated with. */
168010
+ site_keys: string[];
168011
+ }[];
168012
+ /** Information about the current page of results. */
168013
+ pagination: {
168014
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
168015
+ next_page_cursor: string | null;
168016
+ /** Indicates whether there is another page of results after this one. */
168017
+ has_next_page: boolean;
168018
+ /** URL to get the next page of results. */
168019
+ next_page_url: string | null;
168020
+ };
168021
+ };
168022
+ };
167648
168023
  '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
167649
168024
  route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]';
167650
168025
  method: 'POST';