@seamapi/types 1.1091.0 → 1.1093.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.
@@ -43580,8 +43580,8 @@ export type Routes = {
43580
43580
  starts_at?: string | undefined;
43581
43581
  /** Ending date and time for the access grant. */
43582
43582
  ends_at?: string | undefined;
43583
- /** Preferred PIN code to use when creating access for this reservation. */
43584
- preferred_code?: string | undefined;
43583
+ /** 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. */
43584
+ preferred_code?: (string | null) | undefined;
43585
43585
  /** Your unique identifier for the reservation. */
43586
43586
  reservation_key: string;
43587
43587
  /** 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. */
@@ -43623,8 +43623,8 @@ export type Routes = {
43623
43623
  starts_at?: string | undefined;
43624
43624
  /** Ending date and time for the access grant. */
43625
43625
  ends_at?: string | undefined;
43626
- /** Preferred PIN code to use when creating access for this reservation. */
43627
- preferred_code?: string | undefined;
43626
+ /** 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. */
43627
+ preferred_code?: (string | null) | undefined;
43628
43628
  /** Your unique identifier for the booking. */
43629
43629
  booking_key: string;
43630
43630
  /** Guest key associated with the access grant. */
@@ -43662,8 +43662,8 @@ export type Routes = {
43662
43662
  starts_at?: string | undefined;
43663
43663
  /** Ending date and time for the access grant. */
43664
43664
  ends_at?: string | undefined;
43665
- /** Preferred PIN code to use when creating access for this reservation. */
43666
- preferred_code?: string | undefined;
43665
+ /** 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. */
43666
+ preferred_code?: (string | null) | undefined;
43667
43667
  /** Your unique identifier for the access grant. */
43668
43668
  access_grant_key: string;
43669
43669
  /** Guest key associated with the access grant. */
@@ -43987,8 +43987,8 @@ export type Routes = {
43987
43987
  starts_at?: string | undefined;
43988
43988
  /** Ending date and time for the access grant. */
43989
43989
  ends_at?: string | undefined;
43990
- /** Preferred PIN code to use when creating access for this reservation. */
43991
- preferred_code?: string | undefined;
43990
+ /** 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. */
43991
+ preferred_code?: (string | null) | undefined;
43992
43992
  /** Your unique identifier for the reservation. */
43993
43993
  reservation_key: string;
43994
43994
  /** 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. */
@@ -44030,8 +44030,8 @@ export type Routes = {
44030
44030
  starts_at?: string | undefined;
44031
44031
  /** Ending date and time for the access grant. */
44032
44032
  ends_at?: string | undefined;
44033
- /** Preferred PIN code to use when creating access for this reservation. */
44034
- preferred_code?: string | undefined;
44033
+ /** 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. */
44034
+ preferred_code?: (string | null) | undefined;
44035
44035
  /** Your unique identifier for the booking. */
44036
44036
  booking_key: string;
44037
44037
  /** Guest key associated with the access grant. */
@@ -44069,8 +44069,8 @@ export type Routes = {
44069
44069
  starts_at?: string | undefined;
44070
44070
  /** Ending date and time for the access grant. */
44071
44071
  ends_at?: string | undefined;
44072
- /** Preferred PIN code to use when creating access for this reservation. */
44073
- preferred_code?: string | undefined;
44072
+ /** 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. */
44073
+ preferred_code?: (string | null) | undefined;
44074
44074
  /** Your unique identifier for the access grant. */
44075
44075
  access_grant_key: string;
44076
44076
  /** Guest key associated with the access grant. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1091.0",
3
+ "version": "1.1093.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -155,7 +155,7 @@ const insufficient_permissions = common_acs_system_error.extend({
155
155
  ---
156
156
  resource_type: acs_system
157
157
  ---
158
- Indicates that Seam's integration user does not have sufficient permissions on the provider's system backing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems). Access cannot be managed until permissions are restored. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
158
+ Indicates that the provider's system backing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems) is not letting Seam act on it, so access cannot be managed until this is resolved. The error message says which of two causes applies. Either Seam's integration user does not have sufficient permissions on the provider's system, or has been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. Or the provider account or site does not have a valid subscription with the provider: set up or renew that subscription with the provider.
159
159
  `)
160
160
 
161
161
  const acs_system_error = z
@@ -16,9 +16,10 @@ const base_access_grant_resource = z.object({
16
16
  .describe('Ending date and time for the access grant.'),
17
17
  preferred_code: z
18
18
  .string()
19
+ .nullable()
19
20
  .optional()
20
21
  .describe(
21
- 'Preferred PIN code to use when creating access for this reservation.',
22
+ '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.',
22
23
  ),
23
24
  })
24
25
 
@@ -311,7 +311,7 @@ const insufficient_permissions = common_device_error.extend({
311
311
  ---
312
312
  resource_type: connected_account
313
313
  ---
314
- Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
314
+ Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.
315
315
  `)
316
316
 
317
317
  export const device_error = z
@@ -588,7 +588,7 @@ const openapi: OpenAPISpec = {
588
588
  },
589
589
  {
590
590
  description:
591
- "Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.",
591
+ "Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.",
592
592
  properties: {
593
593
  created_at: {
594
594
  description:
@@ -4856,7 +4856,7 @@ const openapi: OpenAPISpec = {
4856
4856
  },
4857
4857
  {
4858
4858
  description:
4859
- "Indicates that Seam's integration user does not have sufficient permissions on the provider's system backing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems). Access cannot be managed until permissions are restored. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.",
4859
+ "Indicates that the provider's system backing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems) is not letting Seam act on it, so access cannot be managed until this is resolved. The error message says which of two causes applies. Either Seam's integration user does not have sufficient permissions on the provider's system, or has been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. Or the provider account or site does not have a valid subscription with the provider: set up or renew that subscription with the provider.",
4860
4860
  properties: {
4861
4861
  created_at: {
4862
4862
  description:
@@ -14043,7 +14043,7 @@ const openapi: OpenAPISpec = {
14043
14043
  },
14044
14044
  {
14045
14045
  description:
14046
- "Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.",
14046
+ "Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.",
14047
14047
  properties: {
14048
14048
  created_at: {
14049
14049
  description:
@@ -32489,7 +32489,7 @@ const openapi: OpenAPISpec = {
32489
32489
  },
32490
32490
  {
32491
32491
  description:
32492
- "Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.",
32492
+ "Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.",
32493
32493
  properties: {
32494
32494
  created_at: {
32495
32495
  description:
@@ -36758,7 +36758,7 @@ const openapi: OpenAPISpec = {
36758
36758
  },
36759
36759
  {
36760
36760
  description:
36761
- "Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.",
36761
+ "Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.",
36762
36762
  properties: {
36763
36763
  created_at: {
36764
36764
  description:
@@ -48792,7 +48792,8 @@ const openapi: OpenAPISpec = {
48792
48792
  },
48793
48793
  preferred_code: {
48794
48794
  description:
48795
- 'Preferred PIN code to use when creating access for this reservation.',
48795
+ '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.',
48796
+ nullable: true,
48796
48797
  type: 'string',
48797
48798
  },
48798
48799
  property_keys: {
@@ -48903,7 +48904,8 @@ const openapi: OpenAPISpec = {
48903
48904
  },
48904
48905
  preferred_code: {
48905
48906
  description:
48906
- 'Preferred PIN code to use when creating access for this reservation.',
48907
+ '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.',
48908
+ nullable: true,
48907
48909
  type: 'string',
48908
48910
  },
48909
48911
  property_keys: {
@@ -49202,7 +49204,8 @@ const openapi: OpenAPISpec = {
49202
49204
  },
49203
49205
  preferred_code: {
49204
49206
  description:
49205
- 'Preferred PIN code to use when creating access for this reservation.',
49207
+ '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.',
49208
+ nullable: true,
49206
49209
  type: 'string',
49207
49210
  },
49208
49211
  property_keys: {
@@ -49969,7 +49972,8 @@ const openapi: OpenAPISpec = {
49969
49972
  },
49970
49973
  preferred_code: {
49971
49974
  description:
49972
- 'Preferred PIN code to use when creating access for this reservation.',
49975
+ '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.',
49976
+ nullable: true,
49973
49977
  type: 'string',
49974
49978
  },
49975
49979
  property_keys: {
@@ -50080,7 +50084,8 @@ const openapi: OpenAPISpec = {
50080
50084
  },
50081
50085
  preferred_code: {
50082
50086
  description:
50083
- 'Preferred PIN code to use when creating access for this reservation.',
50087
+ '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.',
50088
+ nullable: true,
50084
50089
  type: 'string',
50085
50090
  },
50086
50091
  property_keys: {
@@ -50375,7 +50380,8 @@ const openapi: OpenAPISpec = {
50375
50380
  },
50376
50381
  preferred_code: {
50377
50382
  description:
50378
- 'Preferred PIN code to use when creating access for this reservation.',
50383
+ '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.',
50384
+ nullable: true,
50379
50385
  type: 'string',
50380
50386
  },
50381
50387
  property_keys: {
@@ -51091,8 +51091,8 @@ export type Routes = {
51091
51091
  starts_at?: string | undefined
51092
51092
  /** Ending date and time for the access grant. */
51093
51093
  ends_at?: string | undefined
51094
- /** Preferred PIN code to use when creating access for this reservation. */
51095
- preferred_code?: string | undefined
51094
+ /** 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. */
51095
+ preferred_code?: (string | null) | undefined
51096
51096
  /** Your unique identifier for the reservation. */
51097
51097
  reservation_key: string
51098
51098
  /** 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. */
@@ -51138,8 +51138,8 @@ export type Routes = {
51138
51138
  starts_at?: string | undefined
51139
51139
  /** Ending date and time for the access grant. */
51140
51140
  ends_at?: string | undefined
51141
- /** Preferred PIN code to use when creating access for this reservation. */
51142
- preferred_code?: string | undefined
51141
+ /** 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. */
51142
+ preferred_code?: (string | null) | undefined
51143
51143
  /** Your unique identifier for the booking. */
51144
51144
  booking_key: string
51145
51145
  /** Guest key associated with the access grant. */
@@ -51179,8 +51179,8 @@ export type Routes = {
51179
51179
  starts_at?: string | undefined
51180
51180
  /** Ending date and time for the access grant. */
51181
51181
  ends_at?: string | undefined
51182
- /** Preferred PIN code to use when creating access for this reservation. */
51183
- preferred_code?: string | undefined
51182
+ /** 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. */
51183
+ preferred_code?: (string | null) | undefined
51184
51184
  /** Your unique identifier for the access grant. */
51185
51185
  access_grant_key: string
51186
51186
  /** Guest key associated with the access grant. */
@@ -51545,8 +51545,8 @@ export type Routes = {
51545
51545
  starts_at?: string | undefined
51546
51546
  /** Ending date and time for the access grant. */
51547
51547
  ends_at?: string | undefined
51548
- /** Preferred PIN code to use when creating access for this reservation. */
51549
- preferred_code?: string | undefined
51548
+ /** 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. */
51549
+ preferred_code?: (string | null) | undefined
51550
51550
  /** Your unique identifier for the reservation. */
51551
51551
  reservation_key: string
51552
51552
  /** 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. */
@@ -51592,8 +51592,8 @@ export type Routes = {
51592
51592
  starts_at?: string | undefined
51593
51593
  /** Ending date and time for the access grant. */
51594
51594
  ends_at?: string | undefined
51595
- /** Preferred PIN code to use when creating access for this reservation. */
51596
- preferred_code?: string | undefined
51595
+ /** 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. */
51596
+ preferred_code?: (string | null) | undefined
51597
51597
  /** Your unique identifier for the booking. */
51598
51598
  booking_key: string
51599
51599
  /** Guest key associated with the access grant. */
@@ -51633,8 +51633,8 @@ export type Routes = {
51633
51633
  starts_at?: string | undefined
51634
51634
  /** Ending date and time for the access grant. */
51635
51635
  ends_at?: string | undefined
51636
- /** Preferred PIN code to use when creating access for this reservation. */
51637
- preferred_code?: string | undefined
51636
+ /** 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. */
51637
+ preferred_code?: (string | null) | undefined
51638
51638
  /** Your unique identifier for the access grant. */
51639
51639
  access_grant_key: string
51640
51640
  /** Guest key associated with the access grant. */