@seamapi/types 1.893.0 → 1.895.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.
@@ -40292,7 +40292,7 @@ export type Routes = {
40292
40292
  /** Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error. */
40293
40293
  customer_key?: string | undefined;
40294
40294
  /** Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/api/devices/list_device_providers) with no filters. */
40295
- accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'dusaw' | 'sifely' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
40295
+ accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
40296
40296
  /** Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/api/devices/list_device_providers) with the desired `provider_category` filter. */
40297
40297
  provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors' | 'internal_beta') | undefined;
40298
40298
  /** Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). */
@@ -44874,7 +44874,7 @@ export type Routes = {
44874
44874
  formData: {};
44875
44875
  jsonResponse: {
44876
44876
  device_providers: {
44877
- device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'dusaw' | 'sifely' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec';
44877
+ device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec';
44878
44878
  display_name: string;
44879
44879
  image_url: string;
44880
44880
  provider_categories: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors')[];
@@ -46128,6 +46128,17 @@ export type Routes = {
46128
46128
  [x: string]: string | boolean;
46129
46129
  } | undefined;
46130
46130
  event_type: 'access_code.changed';
46131
+ /** List of properties that changed on the access code. */
46132
+ changed_properties?: {
46133
+ /** Name of the property that changed (e.g. `code`). */
46134
+ property: string;
46135
+ /** Previous value of the property, or null if not set. */
46136
+ previous_value: string | null;
46137
+ /** New value of the property, or null if cleared. */
46138
+ new_value: string | null;
46139
+ }[] | undefined;
46140
+ /** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
46141
+ change_reason?: string | undefined;
46131
46142
  } | {
46132
46143
  /** ID of the event. */
46133
46144
  event_id: string;
@@ -48974,6 +48985,17 @@ export type Routes = {
48974
48985
  [x: string]: string | boolean;
48975
48986
  } | undefined;
48976
48987
  event_type: 'access_code.changed';
48988
+ /** List of properties that changed on the access code. */
48989
+ changed_properties?: {
48990
+ /** Name of the property that changed (e.g. `code`). */
48991
+ property: string;
48992
+ /** Previous value of the property, or null if not set. */
48993
+ previous_value: string | null;
48994
+ /** New value of the property, or null if cleared. */
48995
+ new_value: string | null;
48996
+ }[] | undefined;
48997
+ /** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
48998
+ change_reason?: string | undefined;
48977
48999
  } | {
48978
49000
  /** ID of the event. */
48979
49001
  event_id: string;
@@ -77263,6 +77285,17 @@ export type Routes = {
77263
77285
  [x: string]: string | boolean;
77264
77286
  } | undefined;
77265
77287
  event_type: 'access_code.changed';
77288
+ /** List of properties that changed on the access code. */
77289
+ changed_properties?: {
77290
+ /** Name of the property that changed (e.g. `code`). */
77291
+ property: string;
77292
+ /** Previous value of the property, or null if not set. */
77293
+ previous_value: string | null;
77294
+ /** New value of the property, or null if cleared. */
77295
+ new_value: string | null;
77296
+ }[] | undefined;
77297
+ /** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
77298
+ change_reason?: string | undefined;
77266
77299
  } | {
77267
77300
  /** ID of the event. */
77268
77301
  event_id: string;
@@ -113787,6 +113820,17 @@ export type Routes = {
113787
113820
  [x: string]: string | boolean;
113788
113821
  } | undefined;
113789
113822
  event_type: 'access_code.changed';
113823
+ /** List of properties that changed on the access code. */
113824
+ changed_properties?: {
113825
+ /** Name of the property that changed (e.g. `code`). */
113826
+ property: string;
113827
+ /** Previous value of the property, or null if not set. */
113828
+ previous_value: string | null;
113829
+ /** New value of the property, or null if cleared. */
113830
+ new_value: string | null;
113831
+ }[] | undefined;
113832
+ /** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
113833
+ change_reason?: string | undefined;
113790
113834
  } | {
113791
113835
  /** ID of the event. */
113792
113836
  event_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.893.0",
3
+ "version": "1.895.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -56,6 +56,7 @@ export const DEVICE_PROVIDERS = {
56
56
  ULTRALOQ: 'ultraloq',
57
57
  DUSAW: 'dusaw',
58
58
  SIFELY: 'sifely',
59
+ THIRTY_THREE_LOCK: 'thirty_three_lock',
59
60
  RING: 'ring',
60
61
  ICAL: 'ical',
61
62
  LODGIFY: 'lodgify',
@@ -116,6 +117,7 @@ export const PROVIDER_CATEGORY_MAP = {
116
117
  'sifely',
117
118
  'omnitec',
118
119
  'dusaw',
120
+ 'thirty_three_lock',
119
121
  ],
120
122
 
121
123
  consumer_smartlocks: [
@@ -137,6 +139,7 @@ export const PROVIDER_CATEGORY_MAP = {
137
139
  'dusaw',
138
140
  'keyincode',
139
141
  'sifely',
142
+ 'thirty_three_lock',
140
143
  ],
141
144
 
142
145
  beta: [],
@@ -67,6 +67,30 @@ export type AccessCodeCreatedEvent = z.infer<typeof access_code_created_event>
67
67
 
68
68
  export const access_code_changed_event = access_code_event.extend({
69
69
  event_type: z.literal('access_code.changed'),
70
+ changed_properties: z
71
+ .array(
72
+ z.object({
73
+ property: z
74
+ .string()
75
+ .describe('Name of the property that changed (e.g. `code`).'),
76
+ previous_value: z
77
+ .string()
78
+ .nullable()
79
+ .describe('Previous value of the property, or null if not set.'),
80
+ new_value: z
81
+ .string()
82
+ .nullable()
83
+ .describe('New value of the property, or null if cleared.'),
84
+ }),
85
+ )
86
+ .optional()
87
+ .describe('List of properties that changed on the access code.'),
88
+ change_reason: z
89
+ .string()
90
+ .optional()
91
+ .describe(
92
+ 'Human-readable reason for the change (e.g. `ongoing code auto-renewed`).',
93
+ ),
70
94
  }).describe(`
71
95
  ---
72
96
  route_path: /access_codes
@@ -17565,6 +17565,7 @@ const openapi: OpenAPISpec = {
17565
17565
  'ultraloq',
17566
17566
  'dusaw',
17567
17567
  'sifely',
17568
+ 'thirty_three_lock',
17568
17569
  'ring',
17569
17570
  'ical',
17570
17571
  'lodgify',
@@ -17735,6 +17736,39 @@ const openapi: OpenAPISpec = {
17735
17736
  format: 'uuid',
17736
17737
  type: 'string',
17737
17738
  },
17739
+ change_reason: {
17740
+ description:
17741
+ 'Human-readable reason for the change (e.g. `ongoing code auto-renewed`).',
17742
+ type: 'string',
17743
+ },
17744
+ changed_properties: {
17745
+ description:
17746
+ 'List of properties that changed on the access code.',
17747
+ items: {
17748
+ properties: {
17749
+ new_value: {
17750
+ description:
17751
+ 'New value of the property, or null if cleared.',
17752
+ nullable: true,
17753
+ type: 'string',
17754
+ },
17755
+ previous_value: {
17756
+ description:
17757
+ 'Previous value of the property, or null if not set.',
17758
+ nullable: true,
17759
+ type: 'string',
17760
+ },
17761
+ property: {
17762
+ description:
17763
+ 'Name of the property that changed (e.g. `code`).',
17764
+ type: 'string',
17765
+ },
17766
+ },
17767
+ required: ['property', 'previous_value', 'new_value'],
17768
+ type: 'object',
17769
+ },
17770
+ type: 'array',
17771
+ },
17738
17772
  connected_account_custom_metadata: {
17739
17773
  additionalProperties: {
17740
17774
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
@@ -52252,6 +52286,7 @@ const openapi: OpenAPISpec = {
52252
52286
  'ultraloq',
52253
52287
  'dusaw',
52254
52288
  'sifely',
52289
+ 'thirty_three_lock',
52255
52290
  'ring',
52256
52291
  'ical',
52257
52292
  'lodgify',
@@ -46681,6 +46681,7 @@ export type Routes = {
46681
46681
  | 'ultraloq'
46682
46682
  | 'dusaw'
46683
46683
  | 'sifely'
46684
+ | 'thirty_three_lock'
46684
46685
  | 'ring'
46685
46686
  | 'ical'
46686
46687
  | 'lodgify'
@@ -52427,6 +52428,7 @@ export type Routes = {
52427
52428
  | 'ultraloq'
52428
52429
  | 'dusaw'
52429
52430
  | 'sifely'
52431
+ | 'thirty_three_lock'
52430
52432
  | 'ring'
52431
52433
  | 'ical'
52432
52434
  | 'lodgify'
@@ -55403,6 +55405,19 @@ export type Routes = {
55403
55405
  }
55404
55406
  | undefined
55405
55407
  event_type: 'access_code.changed'
55408
+ /** List of properties that changed on the access code. */
55409
+ changed_properties?:
55410
+ | {
55411
+ /** Name of the property that changed (e.g. `code`). */
55412
+ property: string
55413
+ /** Previous value of the property, or null if not set. */
55414
+ previous_value: string | null
55415
+ /** New value of the property, or null if cleared. */
55416
+ new_value: string | null
55417
+ }[]
55418
+ | undefined
55419
+ /** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
55420
+ change_reason?: string | undefined
55406
55421
  }
55407
55422
  | {
55408
55423
  /** ID of the event. */
@@ -58823,6 +58838,19 @@ export type Routes = {
58823
58838
  }
58824
58839
  | undefined
58825
58840
  event_type: 'access_code.changed'
58841
+ /** List of properties that changed on the access code. */
58842
+ changed_properties?:
58843
+ | {
58844
+ /** Name of the property that changed (e.g. `code`). */
58845
+ property: string
58846
+ /** Previous value of the property, or null if not set. */
58847
+ previous_value: string | null
58848
+ /** New value of the property, or null if cleared. */
58849
+ new_value: string | null
58850
+ }[]
58851
+ | undefined
58852
+ /** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
58853
+ change_reason?: string | undefined
58826
58854
  }
58827
58855
  | {
58828
58856
  /** ID of the event. */
@@ -92498,6 +92526,19 @@ export type Routes = {
92498
92526
  }
92499
92527
  | undefined
92500
92528
  event_type: 'access_code.changed'
92529
+ /** List of properties that changed on the access code. */
92530
+ changed_properties?:
92531
+ | {
92532
+ /** Name of the property that changed (e.g. `code`). */
92533
+ property: string
92534
+ /** Previous value of the property, or null if not set. */
92535
+ previous_value: string | null
92536
+ /** New value of the property, or null if cleared. */
92537
+ new_value: string | null
92538
+ }[]
92539
+ | undefined
92540
+ /** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
92541
+ change_reason?: string | undefined
92501
92542
  }
92502
92543
  | {
92503
92544
  /** ID of the event. */
@@ -135557,6 +135598,19 @@ export type Routes = {
135557
135598
  }
135558
135599
  | undefined
135559
135600
  event_type: 'access_code.changed'
135601
+ /** List of properties that changed on the access code. */
135602
+ changed_properties?:
135603
+ | {
135604
+ /** Name of the property that changed (e.g. `code`). */
135605
+ property: string
135606
+ /** Previous value of the property, or null if not set. */
135607
+ previous_value: string | null
135608
+ /** New value of the property, or null if cleared. */
135609
+ new_value: string | null
135610
+ }[]
135611
+ | undefined
135612
+ /** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
135613
+ change_reason?: string | undefined
135560
135614
  }
135561
135615
  | {
135562
135616
  /** ID of the event. */