@seamapi/types 1.1143.0 → 1.1145.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.
@@ -48995,6 +48995,49 @@ export type Routes = {
48995
48995
  custom_metadata?: {
48996
48996
  [x: string]: string | boolean | null;
48997
48997
  } | undefined;
48998
+ /** Parts of the reservation that each get their own access, for example one per room. Each sub-reservation inherits the reservation's name, times, preferred code, guest and custom metadata unless it sets its own, and must set its own location keys. A reservation with sub-reservations must not set location keys itself. Sending this list replaces the reservation's sub-reservations: any not included are removed, and an empty list removes all of them. Omitting it leaves existing sub-reservations unchanged. */
48999
+ sub_reservations?: {
49000
+ /** Your name for this access grant resource. */
49001
+ name?: string | undefined;
49002
+ /** Starting date and time for the access grant. */
49003
+ starts_at?: string | undefined;
49004
+ /** Ending date and time for the access grant. */
49005
+ ends_at?: string | undefined;
49006
+ /** Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code. */
49007
+ preferred_code?: (string | null) | undefined;
49008
+ /** Your identifier for the sub-reservation. Must be unique within its reservation. */
49009
+ sub_reservation_key: string;
49010
+ /** Set key:value pairs for filtering sub-reservations by custom criteria. Merged over the reservation's custom metadata. Set a key to `null` or to an empty string to remove that key from the custom metadata. */
49011
+ custom_metadata?: {
49012
+ [x: string]: string | boolean | null;
49013
+ } | undefined;
49014
+ /** Guest key associated with the access grant. */
49015
+ guest_key?: string | undefined;
49016
+ /** Tenant key associated with the access grant. */
49017
+ tenant_key?: string | undefined;
49018
+ /** Resident key associated with the access grant. */
49019
+ resident_key?: string | undefined;
49020
+ /** User key associated with the access grant. */
49021
+ user_key?: string | undefined;
49022
+ /** User identity key associated with the access grant. */
49023
+ user_identity_key?: string | undefined;
49024
+ /** Space keys associated with the access grant. */
49025
+ space_keys?: string[] | undefined;
49026
+ /** Property keys associated with the access grant. */
49027
+ property_keys?: string[] | undefined;
49028
+ /** Room keys associated with the access grant. */
49029
+ room_keys?: string[] | undefined;
49030
+ /** Common area keys associated with the access grant. */
49031
+ common_area_keys?: string[] | undefined;
49032
+ /** Unit keys associated with the access grant. */
49033
+ unit_keys?: string[] | undefined;
49034
+ /** Facility keys associated with the access grant. */
49035
+ facility_keys?: string[] | undefined;
49036
+ /** Building keys associated with the access grant. */
49037
+ building_keys?: string[] | undefined;
49038
+ /** Listing keys associated with the access grant. */
49039
+ listing_keys?: string[] | undefined;
49040
+ }[] | undefined;
48998
49041
  /** Guest key associated with the access grant. */
48999
49042
  guest_key?: string | undefined;
49000
49043
  /** Tenant key associated with the access grant. */
@@ -49406,6 +49449,49 @@ export type Routes = {
49406
49449
  custom_metadata?: {
49407
49450
  [x: string]: string | boolean | null;
49408
49451
  } | undefined;
49452
+ /** Parts of the reservation that each get their own access, for example one per room. Each sub-reservation inherits the reservation's name, times, preferred code, guest and custom metadata unless it sets its own, and must set its own location keys. A reservation with sub-reservations must not set location keys itself. Sending this list replaces the reservation's sub-reservations: any not included are removed, and an empty list removes all of them. Omitting it leaves existing sub-reservations unchanged. */
49453
+ sub_reservations?: {
49454
+ /** Your name for this access grant resource. */
49455
+ name?: string | undefined;
49456
+ /** Starting date and time for the access grant. */
49457
+ starts_at?: string | undefined;
49458
+ /** Ending date and time for the access grant. */
49459
+ ends_at?: string | undefined;
49460
+ /** Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code. */
49461
+ preferred_code?: (string | null) | undefined;
49462
+ /** Your identifier for the sub-reservation. Must be unique within its reservation. */
49463
+ sub_reservation_key: string;
49464
+ /** Set key:value pairs for filtering sub-reservations by custom criteria. Merged over the reservation's custom metadata. Set a key to `null` or to an empty string to remove that key from the custom metadata. */
49465
+ custom_metadata?: {
49466
+ [x: string]: string | boolean | null;
49467
+ } | undefined;
49468
+ /** Guest key associated with the access grant. */
49469
+ guest_key?: string | undefined;
49470
+ /** Tenant key associated with the access grant. */
49471
+ tenant_key?: string | undefined;
49472
+ /** Resident key associated with the access grant. */
49473
+ resident_key?: string | undefined;
49474
+ /** User key associated with the access grant. */
49475
+ user_key?: string | undefined;
49476
+ /** User identity key associated with the access grant. */
49477
+ user_identity_key?: string | undefined;
49478
+ /** Space keys associated with the access grant. */
49479
+ space_keys?: string[] | undefined;
49480
+ /** Property keys associated with the access grant. */
49481
+ property_keys?: string[] | undefined;
49482
+ /** Room keys associated with the access grant. */
49483
+ room_keys?: string[] | undefined;
49484
+ /** Common area keys associated with the access grant. */
49485
+ common_area_keys?: string[] | undefined;
49486
+ /** Unit keys associated with the access grant. */
49487
+ unit_keys?: string[] | undefined;
49488
+ /** Facility keys associated with the access grant. */
49489
+ facility_keys?: string[] | undefined;
49490
+ /** Building keys associated with the access grant. */
49491
+ building_keys?: string[] | undefined;
49492
+ /** Listing keys associated with the access grant. */
49493
+ listing_keys?: string[] | undefined;
49494
+ }[] | undefined;
49409
49495
  /** Guest key associated with the access grant. */
49410
49496
  guest_key?: string | undefined;
49411
49497
  /** Tenant key associated with the access grant. */
@@ -94906,7 +94992,9 @@ export type Routes = {
94906
94992
  } | undefined;
94907
94993
  staff_member_created?: {
94908
94994
  rule: 'staff_member_created';
94909
- config: {};
94995
+ config: {
94996
+ allow_shared_email_and_phone_across_user_identities?: boolean | undefined;
94997
+ };
94910
94998
  } | undefined;
94911
94999
  } | undefined;
94912
95000
  climate_rules?: {
@@ -95078,7 +95166,9 @@ export type Routes = {
95078
95166
  } | null) | undefined;
95079
95167
  staff_member_created?: ({
95080
95168
  rule: 'staff_member_created';
95081
- config: {};
95169
+ config: {
95170
+ allow_shared_email_and_phone_across_user_identities?: boolean | undefined;
95171
+ };
95082
95172
  } | null) | undefined;
95083
95173
  } | undefined;
95084
95174
  /** Climate automation rules configuration. */
@@ -95551,7 +95641,9 @@ export type Routes = {
95551
95641
  } | undefined;
95552
95642
  staff_member_created?: {
95553
95643
  rule: 'staff_member_created';
95554
- config: {};
95644
+ config: {
95645
+ allow_shared_email_and_phone_across_user_identities?: boolean | undefined;
95646
+ };
95555
95647
  } | undefined;
95556
95648
  } | undefined;
95557
95649
  climate_rules?: {
@@ -95694,7 +95786,9 @@ export type Routes = {
95694
95786
  } | null) | undefined;
95695
95787
  staff_member_created?: ({
95696
95788
  rule: 'staff_member_created';
95697
- config: {};
95789
+ config: {
95790
+ allow_shared_email_and_phone_across_user_identities?: boolean | undefined;
95791
+ };
95698
95792
  } | null) | undefined;
95699
95793
  } | undefined;
95700
95794
  /** Climate automation rules configuration. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1143.0",
3
+ "version": "1.1145.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -81,6 +81,26 @@ export const location_references = z.object({
81
81
  .describe('Listing keys associated with the access grant.'),
82
82
  })
83
83
 
84
+ export const sub_reservation_resource = base_access_grant_resource
85
+ .extend({
86
+ sub_reservation_key: z
87
+ .string()
88
+ .min(1)
89
+ .refine((val) => val === val.trim(), {
90
+ message: 'Must not have leading or trailing whitespace',
91
+ })
92
+ .describe(
93
+ 'Your identifier for the sub-reservation. Must be unique within its reservation.',
94
+ ),
95
+ custom_metadata: custom_metadata_input
96
+ .optional()
97
+ .describe(
98
+ "Set key:value pairs for filtering sub-reservations by custom criteria. Merged over the reservation's custom metadata. Set a key to `null` or to an empty string to remove that key from the custom metadata.",
99
+ ),
100
+ })
101
+ .merge(user_identity_reference)
102
+ .merge(location_references)
103
+
84
104
  export const reservation_resource = base_access_grant_resource
85
105
  .extend({
86
106
  reservation_key: z
@@ -95,6 +115,12 @@ export const reservation_resource = base_access_grant_resource
95
115
  .describe(
96
116
  'Set key:value pairs for filtering reservations by custom criteria. Set a key to `null` or to an empty string to remove that key from the custom metadata.',
97
117
  ),
118
+ sub_reservations: z
119
+ .array(sub_reservation_resource)
120
+ .optional()
121
+ .describe(
122
+ "Parts of the reservation that each get their own access, for example one per room. Each sub-reservation inherits the reservation's name, times, preferred code, guest and custom metadata unless it sets its own, and must set its own location keys. A reservation with sub-reservations must not set location keys itself. Sending this list replaces the reservation's sub-reservations: any not included are removed, and an empty list removes all of them. Omitting it leaves existing sub-reservations unchanged.",
123
+ ),
98
124
  })
99
125
  .merge(user_identity_reference)
100
126
  .merge(location_references)
@@ -53601,6 +53601,131 @@ const openapi: OpenAPISpec = {
53601
53601
  format: 'date-time',
53602
53602
  type: 'string',
53603
53603
  },
53604
+ sub_reservations: {
53605
+ description:
53606
+ "Parts of the reservation that each get their own access, for example one per room. Each sub-reservation inherits the reservation's name, times, preferred code, guest and custom metadata unless it sets its own, and must set its own location keys. A reservation with sub-reservations must not set location keys itself. Sending this list replaces the reservation's sub-reservations: any not included are removed, and an empty list removes all of them. Omitting it leaves existing sub-reservations unchanged.",
53607
+ items: {
53608
+ properties: {
53609
+ building_keys: {
53610
+ description:
53611
+ 'Building keys associated with the access grant.',
53612
+ items: { type: 'string' },
53613
+ type: 'array',
53614
+ },
53615
+ common_area_keys: {
53616
+ description:
53617
+ 'Common area keys associated with the access grant.',
53618
+ items: { type: 'string' },
53619
+ type: 'array',
53620
+ },
53621
+ custom_metadata: {
53622
+ additionalProperties: {
53623
+ nullable: true,
53624
+ oneOf: [
53625
+ { maxLength: 500, type: 'string' },
53626
+ { type: 'boolean' },
53627
+ ],
53628
+ },
53629
+ description:
53630
+ "Set key:value pairs for filtering sub-reservations by custom criteria. Merged over the reservation's custom metadata. Set a key to `null` or to an empty string to remove that key from the custom metadata.",
53631
+ type: 'object',
53632
+ },
53633
+ ends_at: {
53634
+ description:
53635
+ 'Ending date and time for the access grant.',
53636
+ format: 'date-time',
53637
+ type: 'string',
53638
+ },
53639
+ facility_keys: {
53640
+ description:
53641
+ 'Facility keys associated with the access grant.',
53642
+ items: { type: 'string' },
53643
+ type: 'array',
53644
+ },
53645
+ guest_key: {
53646
+ description:
53647
+ 'Guest key associated with the access grant.',
53648
+ type: 'string',
53649
+ },
53650
+ listing_keys: {
53651
+ description:
53652
+ 'Listing keys associated with the access grant.',
53653
+ items: { type: 'string' },
53654
+ type: 'array',
53655
+ },
53656
+ name: {
53657
+ description:
53658
+ 'Your name for this access grant resource.',
53659
+ type: 'string',
53660
+ },
53661
+ preferred_code: {
53662
+ description:
53663
+ 'Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.',
53664
+ nullable: true,
53665
+ type: 'string',
53666
+ },
53667
+ property_keys: {
53668
+ description:
53669
+ 'Property keys associated with the access grant.',
53670
+ items: { type: 'string' },
53671
+ type: 'array',
53672
+ },
53673
+ resident_key: {
53674
+ description:
53675
+ 'Resident key associated with the access grant.',
53676
+ type: 'string',
53677
+ },
53678
+ room_keys: {
53679
+ description:
53680
+ 'Room keys associated with the access grant.',
53681
+ items: { type: 'string' },
53682
+ type: 'array',
53683
+ },
53684
+ space_keys: {
53685
+ description:
53686
+ 'Space keys associated with the access grant.',
53687
+ items: { type: 'string' },
53688
+ type: 'array',
53689
+ },
53690
+ starts_at: {
53691
+ description:
53692
+ 'Starting date and time for the access grant.',
53693
+ format: 'date-time',
53694
+ type: 'string',
53695
+ },
53696
+ sub_reservation_key: {
53697
+ description:
53698
+ 'Your identifier for the sub-reservation. Must be unique within its reservation.',
53699
+ minLength: 1,
53700
+ type: 'string',
53701
+ },
53702
+ tenant_key: {
53703
+ description:
53704
+ 'Tenant key associated with the access grant.',
53705
+ type: 'string',
53706
+ },
53707
+ unit_keys: {
53708
+ description:
53709
+ 'Unit keys associated with the access grant.',
53710
+ items: { type: 'string' },
53711
+ type: 'array',
53712
+ },
53713
+ user_identity_key: {
53714
+ description:
53715
+ 'User identity key associated with the access grant.',
53716
+ type: 'string',
53717
+ },
53718
+ user_key: {
53719
+ description:
53720
+ 'User key associated with the access grant.',
53721
+ type: 'string',
53722
+ },
53723
+ },
53724
+ required: ['sub_reservation_key'],
53725
+ type: 'object',
53726
+ },
53727
+ type: 'array',
53728
+ },
53604
53729
  tenant_key: {
53605
53730
  description:
53606
53731
  'Tenant key associated with the access grant.',
@@ -54793,6 +54918,131 @@ const openapi: OpenAPISpec = {
54793
54918
  format: 'date-time',
54794
54919
  type: 'string',
54795
54920
  },
54921
+ sub_reservations: {
54922
+ description:
54923
+ "Parts of the reservation that each get their own access, for example one per room. Each sub-reservation inherits the reservation's name, times, preferred code, guest and custom metadata unless it sets its own, and must set its own location keys. A reservation with sub-reservations must not set location keys itself. Sending this list replaces the reservation's sub-reservations: any not included are removed, and an empty list removes all of them. Omitting it leaves existing sub-reservations unchanged.",
54924
+ items: {
54925
+ properties: {
54926
+ building_keys: {
54927
+ description:
54928
+ 'Building keys associated with the access grant.',
54929
+ items: { type: 'string' },
54930
+ type: 'array',
54931
+ },
54932
+ common_area_keys: {
54933
+ description:
54934
+ 'Common area keys associated with the access grant.',
54935
+ items: { type: 'string' },
54936
+ type: 'array',
54937
+ },
54938
+ custom_metadata: {
54939
+ additionalProperties: {
54940
+ nullable: true,
54941
+ oneOf: [
54942
+ { maxLength: 500, type: 'string' },
54943
+ { type: 'boolean' },
54944
+ ],
54945
+ },
54946
+ description:
54947
+ "Set key:value pairs for filtering sub-reservations by custom criteria. Merged over the reservation's custom metadata. Set a key to `null` or to an empty string to remove that key from the custom metadata.",
54948
+ type: 'object',
54949
+ },
54950
+ ends_at: {
54951
+ description:
54952
+ 'Ending date and time for the access grant.',
54953
+ format: 'date-time',
54954
+ type: 'string',
54955
+ },
54956
+ facility_keys: {
54957
+ description:
54958
+ 'Facility keys associated with the access grant.',
54959
+ items: { type: 'string' },
54960
+ type: 'array',
54961
+ },
54962
+ guest_key: {
54963
+ description:
54964
+ 'Guest key associated with the access grant.',
54965
+ type: 'string',
54966
+ },
54967
+ listing_keys: {
54968
+ description:
54969
+ 'Listing keys associated with the access grant.',
54970
+ items: { type: 'string' },
54971
+ type: 'array',
54972
+ },
54973
+ name: {
54974
+ description:
54975
+ 'Your name for this access grant resource.',
54976
+ type: 'string',
54977
+ },
54978
+ preferred_code: {
54979
+ description:
54980
+ 'Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.',
54981
+ nullable: true,
54982
+ type: 'string',
54983
+ },
54984
+ property_keys: {
54985
+ description:
54986
+ 'Property keys associated with the access grant.',
54987
+ items: { type: 'string' },
54988
+ type: 'array',
54989
+ },
54990
+ resident_key: {
54991
+ description:
54992
+ 'Resident key associated with the access grant.',
54993
+ type: 'string',
54994
+ },
54995
+ room_keys: {
54996
+ description:
54997
+ 'Room keys associated with the access grant.',
54998
+ items: { type: 'string' },
54999
+ type: 'array',
55000
+ },
55001
+ space_keys: {
55002
+ description:
55003
+ 'Space keys associated with the access grant.',
55004
+ items: { type: 'string' },
55005
+ type: 'array',
55006
+ },
55007
+ starts_at: {
55008
+ description:
55009
+ 'Starting date and time for the access grant.',
55010
+ format: 'date-time',
55011
+ type: 'string',
55012
+ },
55013
+ sub_reservation_key: {
55014
+ description:
55015
+ 'Your identifier for the sub-reservation. Must be unique within its reservation.',
55016
+ minLength: 1,
55017
+ type: 'string',
55018
+ },
55019
+ tenant_key: {
55020
+ description:
55021
+ 'Tenant key associated with the access grant.',
55022
+ type: 'string',
55023
+ },
55024
+ unit_keys: {
55025
+ description:
55026
+ 'Unit keys associated with the access grant.',
55027
+ items: { type: 'string' },
55028
+ type: 'array',
55029
+ },
55030
+ user_identity_key: {
55031
+ description:
55032
+ 'User identity key associated with the access grant.',
55033
+ type: 'string',
55034
+ },
55035
+ user_key: {
55036
+ description:
55037
+ 'User key associated with the access grant.',
55038
+ type: 'string',
55039
+ },
55040
+ },
55041
+ required: ['sub_reservation_key'],
55042
+ type: 'object',
55043
+ },
55044
+ type: 'array',
55045
+ },
54796
55046
  tenant_key: {
54797
55047
  description:
54798
55048
  'Tenant key associated with the access grant.',
@@ -64311,7 +64561,11 @@ const openapi: OpenAPISpec = {
64311
64561
  staff_member_created: {
64312
64562
  properties: {
64313
64563
  config: {
64314
- $ref: '#/components/schemas/access_code',
64564
+ properties: {
64565
+ allow_shared_email_and_phone_across_user_identities:
64566
+ { type: 'boolean' },
64567
+ },
64568
+ type: 'object',
64315
64569
  },
64316
64570
  rule: {
64317
64571
  enum: ['staff_member_created'],
@@ -64876,7 +65130,13 @@ const openapi: OpenAPISpec = {
64876
65130
  staff_member_created: {
64877
65131
  nullable: true,
64878
65132
  properties: {
64879
- config: { properties: {}, type: 'object' },
65133
+ config: {
65134
+ properties: {
65135
+ allow_shared_email_and_phone_across_user_identities:
65136
+ { type: 'boolean' },
65137
+ },
65138
+ type: 'object',
65139
+ },
64880
65140
  rule: {
64881
65141
  enum: ['staff_member_created'],
64882
65142
  type: 'string',
@@ -66391,7 +66651,11 @@ const openapi: OpenAPISpec = {
66391
66651
  staff_member_created: {
66392
66652
  properties: {
66393
66653
  config: {
66394
- $ref: '#/components/schemas/access_code',
66654
+ properties: {
66655
+ allow_shared_email_and_phone_across_user_identities:
66656
+ { type: 'boolean' },
66657
+ },
66658
+ type: 'object',
66395
66659
  },
66396
66660
  rule: {
66397
66661
  enum: ['staff_member_created'],
@@ -66885,7 +67149,13 @@ const openapi: OpenAPISpec = {
66885
67149
  staff_member_created: {
66886
67150
  nullable: true,
66887
67151
  properties: {
66888
- config: { properties: {}, type: 'object' },
67152
+ config: {
67153
+ properties: {
67154
+ allow_shared_email_and_phone_across_user_identities:
67155
+ { type: 'boolean' },
67156
+ },
67157
+ type: 'object',
67158
+ },
66889
67159
  rule: {
66890
67160
  enum: ['staff_member_created'],
66891
67161
  type: 'string',