@seamapi/types 1.889.0 → 1.891.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.
@@ -40153,7 +40153,7 @@ export type Routes = {
40153
40153
  /** 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. */
40154
40154
  customer_key?: string | undefined;
40155
40155
  /** 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. */
40156
- 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' | 'dormakaba_ambiance' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
40156
+ 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' | 'sifely' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
40157
40157
  /** 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. */
40158
40158
  provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors' | 'internal_beta') | undefined;
40159
40159
  /** 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). */
@@ -44659,7 +44659,7 @@ export type Routes = {
44659
44659
  formData: {};
44660
44660
  jsonResponse: {
44661
44661
  device_providers: {
44662
- 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' | 'dormakaba_ambiance' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec';
44662
+ 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' | 'sifely' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec';
44663
44663
  display_name: string;
44664
44664
  image_url: string;
44665
44665
  provider_categories: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors')[];
@@ -80480,6 +80480,10 @@ export type Routes = {
80480
80480
  connected_account_id?: string | undefined;
80481
80481
  /** Filter spaces by space_key. */
80482
80482
  space_key?: string | undefined;
80483
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_id`. */
80484
+ parent_space_id?: string | undefined;
80485
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_key`. */
80486
+ parent_space_key?: string | undefined;
80483
80487
  };
80484
80488
  formData: {};
80485
80489
  jsonResponse: {
@@ -83731,6 +83735,10 @@ export type Routes = {
83731
83735
  connected_account_id?: string | undefined;
83732
83736
  /** Filter spaces by space_key. */
83733
83737
  space_key?: string | undefined;
83738
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_id`. */
83739
+ parent_space_id?: string | undefined;
83740
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_key`. */
83741
+ parent_space_key?: string | undefined;
83734
83742
  /** Maximum number of records to return per page. */
83735
83743
  limit?: number;
83736
83744
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.889.0",
3
+ "version": "1.891.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -51,8 +51,10 @@ export const DEVICE_PROVIDERS = {
51
51
  SENSI: 'sensi',
52
52
  KEYNEST: 'keynest',
53
53
  KORELOCK: 'korelock',
54
+ KEYINCODE: 'keyincode',
54
55
  DORMAKABA_AMBIANCE: 'dormakaba_ambiance',
55
56
  ULTRALOQ: 'ultraloq',
57
+ SIFELY: 'sifely',
56
58
  RING: 'ring',
57
59
  ICAL: 'ical',
58
60
  LODGIFY: 'lodgify',
@@ -109,6 +111,8 @@ export const PROVIDER_CATEGORY_MAP = {
109
111
  'ring',
110
112
  'first_alert',
111
113
  'korelock',
114
+ 'keyincode',
115
+ 'sifely',
112
116
  'omnitec',
113
117
  ],
114
118
 
@@ -128,6 +132,8 @@ export const PROVIDER_CATEGORY_MAP = {
128
132
  'ultraloq',
129
133
  'dormakaba_oracode',
130
134
  'korelock',
135
+ 'keyincode',
136
+ 'sifely',
131
137
  ],
132
138
 
133
139
  beta: [],
@@ -17430,8 +17430,10 @@ const openapi: OpenAPISpec = {
17430
17430
  'sensi',
17431
17431
  'keynest',
17432
17432
  'korelock',
17433
+ 'keyincode',
17433
17434
  'dormakaba_ambiance',
17434
17435
  'ultraloq',
17436
+ 'sifely',
17435
17437
  'ring',
17436
17438
  'ical',
17437
17439
  'lodgify',
@@ -52044,8 +52046,10 @@ const openapi: OpenAPISpec = {
52044
52046
  'sensi',
52045
52047
  'keynest',
52046
52048
  'korelock',
52049
+ 'keyincode',
52047
52050
  'dormakaba_ambiance',
52048
52051
  'ultraloq',
52052
+ 'sifely',
52049
52053
  'ring',
52050
52054
  'ical',
52051
52055
  'lodgify',
@@ -75121,6 +75125,27 @@ const openapi: OpenAPISpec = {
75121
75125
  type: 'string',
75122
75126
  },
75123
75127
  },
75128
+ {
75129
+ in: 'query',
75130
+ name: 'parent_space_id',
75131
+ schema: {
75132
+ description:
75133
+ 'Filter spaces to only include those whose parent space has the specified `parent_space_id`.',
75134
+ format: 'uuid',
75135
+ type: 'string',
75136
+ 'x-undocumented': 'Only used internally.',
75137
+ },
75138
+ },
75139
+ {
75140
+ in: 'query',
75141
+ name: 'parent_space_key',
75142
+ schema: {
75143
+ description:
75144
+ 'Filter spaces to only include those whose parent space has the specified `parent_space_key`.',
75145
+ type: 'string',
75146
+ 'x-undocumented': 'Only used internally.',
75147
+ },
75148
+ },
75124
75149
  ],
75125
75150
  responses: {
75126
75151
  200: {
@@ -75174,6 +75199,19 @@ const openapi: OpenAPISpec = {
75174
75199
  'x-draft': 'Needs review.',
75175
75200
  'x-undocumented': 'Only used internally.',
75176
75201
  },
75202
+ parent_space_id: {
75203
+ description:
75204
+ 'Filter spaces to only include those whose parent space has the specified `parent_space_id`.',
75205
+ format: 'uuid',
75206
+ type: 'string',
75207
+ 'x-undocumented': 'Only used internally.',
75208
+ },
75209
+ parent_space_key: {
75210
+ description:
75211
+ 'Filter spaces to only include those whose parent space has the specified `parent_space_key`.',
75212
+ type: 'string',
75213
+ 'x-undocumented': 'Only used internally.',
75214
+ },
75177
75215
  search: {
75178
75216
  description:
75179
75217
  'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
@@ -77809,6 +77847,27 @@ const openapi: OpenAPISpec = {
77809
77847
  type: 'string',
77810
77848
  },
77811
77849
  },
77850
+ {
77851
+ in: 'query',
77852
+ name: 'parent_space_id',
77853
+ schema: {
77854
+ description:
77855
+ 'Filter spaces to only include those whose parent space has the specified `parent_space_id`.',
77856
+ format: 'uuid',
77857
+ type: 'string',
77858
+ 'x-undocumented': 'Only used internally.',
77859
+ },
77860
+ },
77861
+ {
77862
+ in: 'query',
77863
+ name: 'parent_space_key',
77864
+ schema: {
77865
+ description:
77866
+ 'Filter spaces to only include those whose parent space has the specified `parent_space_key`.',
77867
+ type: 'string',
77868
+ 'x-undocumented': 'Only used internally.',
77869
+ },
77870
+ },
77812
77871
  {
77813
77872
  in: 'query',
77814
77873
  name: 'limit',
@@ -77901,6 +77960,19 @@ const openapi: OpenAPISpec = {
77901
77960
  nullable: true,
77902
77961
  type: 'string',
77903
77962
  },
77963
+ parent_space_id: {
77964
+ description:
77965
+ 'Filter spaces to only include those whose parent space has the specified `parent_space_id`.',
77966
+ format: 'uuid',
77967
+ type: 'string',
77968
+ 'x-undocumented': 'Only used internally.',
77969
+ },
77970
+ parent_space_key: {
77971
+ description:
77972
+ 'Filter spaces to only include those whose parent space has the specified `parent_space_key`.',
77973
+ type: 'string',
77974
+ 'x-undocumented': 'Only used internally.',
77975
+ },
77904
77976
  search: {
77905
77977
  description:
77906
77978
  'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`.',
@@ -46524,8 +46524,10 @@ export type Routes = {
46524
46524
  | 'sensi'
46525
46525
  | 'keynest'
46526
46526
  | 'korelock'
46527
+ | 'keyincode'
46527
46528
  | 'dormakaba_ambiance'
46528
46529
  | 'ultraloq'
46530
+ | 'sifely'
46529
46531
  | 'ring'
46530
46532
  | 'ical'
46531
46533
  | 'lodgify'
@@ -52183,8 +52185,10 @@ export type Routes = {
52183
52185
  | 'sensi'
52184
52186
  | 'keynest'
52185
52187
  | 'korelock'
52188
+ | 'keyincode'
52186
52189
  | 'dormakaba_ambiance'
52187
52190
  | 'ultraloq'
52191
+ | 'sifely'
52188
52192
  | 'ring'
52189
52193
  | 'ical'
52190
52194
  | 'lodgify'
@@ -96143,6 +96147,10 @@ export type Routes = {
96143
96147
  connected_account_id?: string | undefined
96144
96148
  /** Filter spaces by space_key. */
96145
96149
  space_key?: string | undefined
96150
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_id`. */
96151
+ parent_space_id?: string | undefined
96152
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_key`. */
96153
+ parent_space_key?: string | undefined
96146
96154
  }
96147
96155
  formData: {}
96148
96156
  jsonResponse: {
@@ -100037,6 +100045,10 @@ export type Routes = {
100037
100045
  connected_account_id?: string | undefined
100038
100046
  /** Filter spaces by space_key. */
100039
100047
  space_key?: string | undefined
100048
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_id`. */
100049
+ parent_space_id?: string | undefined
100050
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_key`. */
100051
+ parent_space_key?: string | undefined
100040
100052
  /** Maximum number of records to return per page. */
100041
100053
  limit?: number
100042
100054
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */