@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.
@@ -20483,8 +20483,10 @@ declare const DEVICE_PROVIDERS: {
20483
20483
  readonly SENSI: "sensi";
20484
20484
  readonly KEYNEST: "keynest";
20485
20485
  readonly KORELOCK: "korelock";
20486
+ readonly KEYINCODE: "keyincode";
20486
20487
  readonly DORMAKABA_AMBIANCE: "dormakaba_ambiance";
20487
20488
  readonly ULTRALOQ: "ultraloq";
20489
+ readonly SIFELY: "sifely";
20488
20490
  readonly RING: "ring";
20489
20491
  readonly ICAL: "ical";
20490
20492
  readonly LODGIFY: "lodgify";
@@ -70103,7 +70105,7 @@ type Routes = {
70103
70105
  /** 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. */
70104
70106
  customer_key?: string | undefined;
70105
70107
  /** 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. */
70106
- 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;
70108
+ 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;
70107
70109
  /** 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. */
70108
70110
  provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors' | 'internal_beta') | undefined;
70109
70111
  /** 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). */
@@ -74609,7 +74611,7 @@ type Routes = {
74609
74611
  formData: {};
74610
74612
  jsonResponse: {
74611
74613
  device_providers: {
74612
- 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';
74614
+ 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';
74613
74615
  display_name: string;
74614
74616
  image_url: string;
74615
74617
  provider_categories: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors')[];
@@ -110430,6 +110432,10 @@ type Routes = {
110430
110432
  connected_account_id?: string | undefined;
110431
110433
  /** Filter spaces by space_key. */
110432
110434
  space_key?: string | undefined;
110435
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_id`. */
110436
+ parent_space_id?: string | undefined;
110437
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_key`. */
110438
+ parent_space_key?: string | undefined;
110433
110439
  };
110434
110440
  formData: {};
110435
110441
  jsonResponse: {
@@ -113681,6 +113687,10 @@ type Routes = {
113681
113687
  connected_account_id?: string | undefined;
113682
113688
  /** Filter spaces by space_key. */
113683
113689
  space_key?: string | undefined;
113690
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_id`. */
113691
+ parent_space_id?: string | undefined;
113692
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_key`. */
113693
+ parent_space_key?: string | undefined;
113684
113694
  /** Maximum number of records to return per page. */
113685
113695
  limit?: number;
113686
113696
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
package/dist/index.cjs CHANGED
@@ -2067,8 +2067,10 @@ var DEVICE_PROVIDERS = {
2067
2067
  SENSI: "sensi",
2068
2068
  KEYNEST: "keynest",
2069
2069
  KORELOCK: "korelock",
2070
+ KEYINCODE: "keyincode",
2070
2071
  DORMAKABA_AMBIANCE: "dormakaba_ambiance",
2071
2072
  ULTRALOQ: "ultraloq",
2073
+ SIFELY: "sifely",
2072
2074
  RING: "ring",
2073
2075
  ICAL: "ical",
2074
2076
  LODGIFY: "lodgify",
@@ -2115,6 +2117,8 @@ var PROVIDER_CATEGORY_MAP = {
2115
2117
  "ring",
2116
2118
  "first_alert",
2117
2119
  "korelock",
2120
+ "keyincode",
2121
+ "sifely",
2118
2122
  "omnitec"
2119
2123
  ],
2120
2124
  consumer_smartlocks: [
@@ -2132,7 +2136,9 @@ var PROVIDER_CATEGORY_MAP = {
2132
2136
  "tedee",
2133
2137
  "ultraloq",
2134
2138
  "dormakaba_oracode",
2135
- "korelock"
2139
+ "korelock",
2140
+ "keyincode",
2141
+ "sifely"
2136
2142
  ],
2137
2143
  beta: [],
2138
2144
  thermostats: ["ecobee", "nest", "sensi", "honeywell_resideo", "first_alert"],
@@ -22758,8 +22764,10 @@ var openapi = {
22758
22764
  "sensi",
22759
22765
  "keynest",
22760
22766
  "korelock",
22767
+ "keyincode",
22761
22768
  "dormakaba_ambiance",
22762
22769
  "ultraloq",
22770
+ "sifely",
22763
22771
  "ring",
22764
22772
  "ical",
22765
22773
  "lodgify",
@@ -54424,8 +54432,10 @@ var openapi = {
54424
54432
  "sensi",
54425
54433
  "keynest",
54426
54434
  "korelock",
54435
+ "keyincode",
54427
54436
  "dormakaba_ambiance",
54428
54437
  "ultraloq",
54438
+ "sifely",
54429
54439
  "ring",
54430
54440
  "ical",
54431
54441
  "lodgify",
@@ -76480,6 +76490,25 @@ var openapi = {
76480
76490
  description: "Filter spaces by space_key.",
76481
76491
  type: "string"
76482
76492
  }
76493
+ },
76494
+ {
76495
+ in: "query",
76496
+ name: "parent_space_id",
76497
+ schema: {
76498
+ description: "Filter spaces to only include those whose parent space has the specified `parent_space_id`.",
76499
+ format: "uuid",
76500
+ type: "string",
76501
+ "x-undocumented": "Only used internally."
76502
+ }
76503
+ },
76504
+ {
76505
+ in: "query",
76506
+ name: "parent_space_key",
76507
+ schema: {
76508
+ description: "Filter spaces to only include those whose parent space has the specified `parent_space_key`.",
76509
+ type: "string",
76510
+ "x-undocumented": "Only used internally."
76511
+ }
76483
76512
  }
76484
76513
  ],
76485
76514
  responses: {
@@ -76533,6 +76562,17 @@ var openapi = {
76533
76562
  "x-draft": "Needs review.",
76534
76563
  "x-undocumented": "Only used internally."
76535
76564
  },
76565
+ parent_space_id: {
76566
+ description: "Filter spaces to only include those whose parent space has the specified `parent_space_id`.",
76567
+ format: "uuid",
76568
+ type: "string",
76569
+ "x-undocumented": "Only used internally."
76570
+ },
76571
+ parent_space_key: {
76572
+ description: "Filter spaces to only include those whose parent space has the specified `parent_space_key`.",
76573
+ type: "string",
76574
+ "x-undocumented": "Only used internally."
76575
+ },
76536
76576
  search: {
76537
76577
  description: "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.",
76538
76578
  minLength: 1,
@@ -79084,6 +79124,25 @@ var openapi = {
79084
79124
  type: "string"
79085
79125
  }
79086
79126
  },
79127
+ {
79128
+ in: "query",
79129
+ name: "parent_space_id",
79130
+ schema: {
79131
+ description: "Filter spaces to only include those whose parent space has the specified `parent_space_id`.",
79132
+ format: "uuid",
79133
+ type: "string",
79134
+ "x-undocumented": "Only used internally."
79135
+ }
79136
+ },
79137
+ {
79138
+ in: "query",
79139
+ name: "parent_space_key",
79140
+ schema: {
79141
+ description: "Filter spaces to only include those whose parent space has the specified `parent_space_key`.",
79142
+ type: "string",
79143
+ "x-undocumented": "Only used internally."
79144
+ }
79145
+ },
79087
79146
  {
79088
79147
  in: "query",
79089
79148
  name: "limit",
@@ -79171,6 +79230,17 @@ var openapi = {
79171
79230
  nullable: true,
79172
79231
  type: "string"
79173
79232
  },
79233
+ parent_space_id: {
79234
+ description: "Filter spaces to only include those whose parent space has the specified `parent_space_id`.",
79235
+ format: "uuid",
79236
+ type: "string",
79237
+ "x-undocumented": "Only used internally."
79238
+ },
79239
+ parent_space_key: {
79240
+ description: "Filter spaces to only include those whose parent space has the specified `parent_space_key`.",
79241
+ type: "string",
79242
+ "x-undocumented": "Only used internally."
79243
+ },
79174
79244
  search: {
79175
79245
  description: "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`.",
79176
79246
  minLength: 1,