@seamapi/types 1.1173.0 → 1.1175.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.
@@ -47853,7 +47853,7 @@ export type Routes = {
47853
47853
  /** 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. */
47854
47854
  customer_key?: string | undefined;
47855
47855
  /** 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://www.seam.co/docs/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://www.seam.co/docs/api/devices/list_device_providers) with no filters. */
47856
- accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | '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' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos' | 'yale_access' | 'hid_cm' | 'google_nest' | 'slack')[] | undefined;
47856
+ accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'yale_access' | 'yale_home' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | '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' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos' | 'hid_cm' | 'google_nest' | 'slack')[] | undefined;
47857
47857
  /** Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with the desired `provider_category` filter. */
47858
47858
  provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors' | 'internal_beta') | undefined;
47859
47859
  /** Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a Connect Webview](https://www.seam.co/docs/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://www.seam.co/docs/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://www.seam.co/docs/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://www.seam.co/docs/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. */
@@ -53164,7 +53164,7 @@ export type Routes = {
53164
53164
  jsonResponse: {
53165
53165
  device_providers: {
53166
53166
  /** Name of the device provider. */
53167
- device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | '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' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos';
53167
+ device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'yale_access' | 'yale_home' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | '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' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos';
53168
53168
  /** Display name for the device provider. */
53169
53169
  display_name: string;
53170
53170
  /** Image URL for the device provider. */
@@ -91585,8 +91585,17 @@ export type Routes = {
91585
91585
  period_started_at: string;
91586
91586
  period_ends_at: string;
91587
91587
  package_tokens: number;
91588
- used_tokens: number;
91588
+ package_remaining_tokens: number;
91589
+ allowance_tokens: number;
91590
+ carried_tokens: number;
91591
+ carried_remaining_tokens: number;
91592
+ carried_credit_grants: {
91593
+ tokens: number;
91594
+ remaining_tokens: number;
91595
+ expires_at: string;
91596
+ }[];
91589
91597
  remaining_tokens: number;
91598
+ used_tokens: number;
91590
91599
  extra_tokens: number;
91591
91600
  extra_cents_per_token: number;
91592
91601
  estimated_extra_cents: number;
@@ -91822,6 +91831,18 @@ export type Routes = {
91822
91831
  period_started_at: string;
91823
91832
  period_ends_at: string;
91824
91833
  package_credits: number | null;
91834
+ allowance: {
91835
+ package_remaining_tokens: number;
91836
+ allowance_tokens: number;
91837
+ carried_tokens: number;
91838
+ carried_remaining_tokens: number;
91839
+ carried_credit_grants: {
91840
+ tokens: number;
91841
+ remaining_tokens: number;
91842
+ expires_at: string;
91843
+ }[];
91844
+ remaining_tokens: number;
91845
+ } | null;
91825
91846
  used_credits: number | null;
91826
91847
  by_workspace: {
91827
91848
  workspace_id: string | null;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1173.0",
3
+ "version": "1.1175.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -15,6 +15,8 @@ export const DEVICE_PROVIDERS = {
15
15
  SCHLAGE: 'schlage',
16
16
  SMARTTHINGS: 'smartthings',
17
17
  YALE: 'yale',
18
+ YALE_ACCESS: 'yale_access',
19
+ YALE_HOME: 'yale_home',
18
20
  GENIE: 'genie',
19
21
  DOORKING: 'doorking',
20
22
  SALTO: 'salto',
@@ -20786,6 +20786,8 @@ const openapi: OpenAPISpec = {
20786
20786
  'schlage',
20787
20787
  'smartthings',
20788
20788
  'yale',
20789
+ 'yale_access',
20790
+ 'yale_home',
20789
20791
  'genie',
20790
20792
  'doorking',
20791
20793
  'salto',
@@ -51953,6 +51955,8 @@ const openapi: OpenAPISpec = {
51953
51955
  'schlage',
51954
51956
  'smartthings',
51955
51957
  'yale',
51958
+ 'yale_access',
51959
+ 'yale_home',
51956
51960
  'genie',
51957
51961
  'doorking',
51958
51962
  'salto',
@@ -52013,7 +52017,6 @@ const openapi: OpenAPISpec = {
52013
52017
  'aqara',
52014
52018
  'eufy',
52015
52019
  'sonos',
52016
- 'yale_access',
52017
52020
  'hid_cm',
52018
52021
  'google_nest',
52019
52022
  'slack',
@@ -61958,6 +61961,10 @@ const openapi: OpenAPISpec = {
61958
61961
  usage: {
61959
61962
  nullable: true,
61960
61963
  properties: {
61964
+ allowance_tokens: {
61965
+ format: 'float',
61966
+ type: 'number',
61967
+ },
61961
61968
  as_of: { format: 'date-time', type: 'string' },
61962
61969
  breakdown: {
61963
61970
  items: {
@@ -61982,6 +61989,33 @@ const openapi: OpenAPISpec = {
61982
61989
  },
61983
61990
  type: 'array',
61984
61991
  },
61992
+ carried_credit_grants: {
61993
+ items: {
61994
+ properties: {
61995
+ expires_at: {
61996
+ format: 'date-time',
61997
+ type: 'string',
61998
+ },
61999
+ remaining_tokens: {
62000
+ format: 'float',
62001
+ type: 'number',
62002
+ },
62003
+ tokens: { format: 'float', type: 'number' },
62004
+ },
62005
+ required: [
62006
+ 'tokens',
62007
+ 'remaining_tokens',
62008
+ 'expires_at',
62009
+ ],
62010
+ type: 'object',
62011
+ },
62012
+ type: 'array',
62013
+ },
62014
+ carried_remaining_tokens: {
62015
+ format: 'float',
62016
+ type: 'number',
62017
+ },
62018
+ carried_tokens: { format: 'float', type: 'number' },
61985
62019
  connectivity: {
61986
62020
  items: {
61987
62021
  properties: {
@@ -62012,6 +62046,10 @@ const openapi: OpenAPISpec = {
62012
62046
  type: 'number',
62013
62047
  },
62014
62048
  extra_tokens: { format: 'float', type: 'number' },
62049
+ package_remaining_tokens: {
62050
+ format: 'float',
62051
+ type: 'number',
62052
+ },
62015
62053
  package_tokens: { format: 'float', type: 'number' },
62016
62054
  percent_used: { format: 'float', type: 'number' },
62017
62055
  period_ends_at: {
@@ -62033,8 +62071,13 @@ const openapi: OpenAPISpec = {
62033
62071
  'period_started_at',
62034
62072
  'period_ends_at',
62035
62073
  'package_tokens',
62036
- 'used_tokens',
62074
+ 'package_remaining_tokens',
62075
+ 'allowance_tokens',
62076
+ 'carried_tokens',
62077
+ 'carried_remaining_tokens',
62078
+ 'carried_credit_grants',
62037
62079
  'remaining_tokens',
62080
+ 'used_tokens',
62038
62081
  'extra_tokens',
62039
62082
  'extra_cents_per_token',
62040
62083
  'estimated_extra_cents',
@@ -62926,6 +62969,59 @@ const openapi: OpenAPISpec = {
62926
62969
  ok: { type: 'boolean' },
62927
62970
  usage: {
62928
62971
  properties: {
62972
+ allowance: {
62973
+ nullable: true,
62974
+ properties: {
62975
+ allowance_tokens: {
62976
+ format: 'float',
62977
+ type: 'number',
62978
+ },
62979
+ carried_credit_grants: {
62980
+ items: {
62981
+ properties: {
62982
+ expires_at: {
62983
+ format: 'date-time',
62984
+ type: 'string',
62985
+ },
62986
+ remaining_tokens: {
62987
+ format: 'float',
62988
+ type: 'number',
62989
+ },
62990
+ tokens: { format: 'float', type: 'number' },
62991
+ },
62992
+ required: [
62993
+ 'tokens',
62994
+ 'remaining_tokens',
62995
+ 'expires_at',
62996
+ ],
62997
+ type: 'object',
62998
+ },
62999
+ type: 'array',
63000
+ },
63001
+ carried_remaining_tokens: {
63002
+ format: 'float',
63003
+ type: 'number',
63004
+ },
63005
+ carried_tokens: { format: 'float', type: 'number' },
63006
+ package_remaining_tokens: {
63007
+ format: 'float',
63008
+ type: 'number',
63009
+ },
63010
+ remaining_tokens: {
63011
+ format: 'float',
63012
+ type: 'number',
63013
+ },
63014
+ },
63015
+ required: [
63016
+ 'package_remaining_tokens',
63017
+ 'allowance_tokens',
63018
+ 'carried_tokens',
63019
+ 'carried_remaining_tokens',
63020
+ 'carried_credit_grants',
63021
+ 'remaining_tokens',
63022
+ ],
63023
+ type: 'object',
63024
+ },
62929
63025
  as_of: { format: 'date-time', type: 'string' },
62930
63026
  by_category: {
62931
63027
  items: {
@@ -63094,6 +63190,7 @@ const openapi: OpenAPISpec = {
63094
63190
  'period_started_at',
63095
63191
  'period_ends_at',
63096
63192
  'package_credits',
63193
+ 'allowance',
63097
63194
  'used_credits',
63098
63195
  'by_workspace',
63099
63196
  'by_category',
@@ -55694,6 +55694,8 @@ export type Routes = {
55694
55694
  | 'schlage'
55695
55695
  | 'smartthings'
55696
55696
  | 'yale'
55697
+ | 'yale_access'
55698
+ | 'yale_home'
55697
55699
  | 'genie'
55698
55700
  | 'doorking'
55699
55701
  | 'salto'
@@ -55754,7 +55756,6 @@ export type Routes = {
55754
55756
  | 'aqara'
55755
55757
  | 'eufy'
55756
55758
  | 'sonos'
55757
- | 'yale_access'
55758
55759
  | 'hid_cm'
55759
55760
  | 'google_nest'
55760
55761
  | 'slack'
@@ -62528,6 +62529,8 @@ export type Routes = {
62528
62529
  | 'schlage'
62529
62530
  | 'smartthings'
62530
62531
  | 'yale'
62532
+ | 'yale_access'
62533
+ | 'yale_home'
62531
62534
  | 'genie'
62532
62535
  | 'doorking'
62533
62536
  | 'salto'
@@ -109480,8 +109483,17 @@ export type Routes = {
109480
109483
  period_started_at: string
109481
109484
  period_ends_at: string
109482
109485
  package_tokens: number
109483
- used_tokens: number
109486
+ package_remaining_tokens: number
109487
+ allowance_tokens: number
109488
+ carried_tokens: number
109489
+ carried_remaining_tokens: number
109490
+ carried_credit_grants: {
109491
+ tokens: number
109492
+ remaining_tokens: number
109493
+ expires_at: string
109494
+ }[]
109484
109495
  remaining_tokens: number
109496
+ used_tokens: number
109485
109497
  extra_tokens: number
109486
109498
  extra_cents_per_token: number
109487
109499
  estimated_extra_cents: number
@@ -109718,6 +109730,18 @@ export type Routes = {
109718
109730
  period_started_at: string
109719
109731
  period_ends_at: string
109720
109732
  package_credits: number | null
109733
+ allowance: {
109734
+ package_remaining_tokens: number
109735
+ allowance_tokens: number
109736
+ carried_tokens: number
109737
+ carried_remaining_tokens: number
109738
+ carried_credit_grants: {
109739
+ tokens: number
109740
+ remaining_tokens: number
109741
+ expires_at: string
109742
+ }[]
109743
+ remaining_tokens: number
109744
+ } | null
109721
109745
  used_credits: number | null
109722
109746
  by_workspace:
109723
109747
  | {