@seamapi/types 1.694.0 → 1.696.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.
@@ -11439,6 +11439,15 @@ export type Routes = {
11439
11439
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11440
11440
  warning_code: 'being_deleted'
11441
11441
  }[]
11442
+ /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
11443
+ errors: {
11444
+ /** Date and time at which Seam created the error. */
11445
+ created_at: string
11446
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11447
+ message: string
11448
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
11449
+ error_code: 'cannot_create_requested_access_methods'
11450
+ }[]
11442
11451
  /** ID of the customization profile associated with the Access Grant. */
11443
11452
  customization_profile_id?: string | undefined
11444
11453
  }
@@ -11529,6 +11538,15 @@ export type Routes = {
11529
11538
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11530
11539
  warning_code: 'being_deleted'
11531
11540
  }[]
11541
+ /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
11542
+ errors: {
11543
+ /** Date and time at which Seam created the error. */
11544
+ created_at: string
11545
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11546
+ message: string
11547
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
11548
+ error_code: 'cannot_create_requested_access_methods'
11549
+ }[]
11532
11550
  /** ID of the customization profile associated with the Access Grant. */
11533
11551
  customization_profile_id?: string | undefined
11534
11552
  }
@@ -13845,6 +13863,15 @@ export type Routes = {
13845
13863
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13846
13864
  warning_code: 'being_deleted'
13847
13865
  }[]
13866
+ /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
13867
+ errors: {
13868
+ /** Date and time at which Seam created the error. */
13869
+ created_at: string
13870
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13871
+ message: string
13872
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13873
+ error_code: 'cannot_create_requested_access_methods'
13874
+ }[]
13848
13875
  /** ID of the customization profile associated with the Access Grant. */
13849
13876
  customization_profile_id?: string | undefined
13850
13877
  }[]
@@ -13924,6 +13951,15 @@ export type Routes = {
13924
13951
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13925
13952
  warning_code: 'being_deleted'
13926
13953
  }[]
13954
+ /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
13955
+ errors: {
13956
+ /** Date and time at which Seam created the error. */
13957
+ created_at: string
13958
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13959
+ message: string
13960
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13961
+ error_code: 'cannot_create_requested_access_methods'
13962
+ }[]
13927
13963
  /** ID of the customization profile associated with the Access Grant. */
13928
13964
  customization_profile_id?: string | undefined
13929
13965
  }
@@ -13988,6 +14024,15 @@ export type Routes = {
13988
14024
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13989
14025
  warning_code: 'being_deleted'
13990
14026
  }[]
14027
+ /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
14028
+ errors: {
14029
+ /** Date and time at which Seam created the error. */
14030
+ created_at: string
14031
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
14032
+ message: string
14033
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
14034
+ error_code: 'cannot_create_requested_access_methods'
14035
+ }[]
13991
14036
  /** ID of user identity to which the Access Grant gives access. */
13992
14037
  user_identity_id?: string | undefined
13993
14038
  }
@@ -14057,6 +14102,15 @@ export type Routes = {
14057
14102
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
14058
14103
  warning_code: 'being_deleted'
14059
14104
  }[]
14105
+ /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
14106
+ errors: {
14107
+ /** Date and time at which Seam created the error. */
14108
+ created_at: string
14109
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
14110
+ message: string
14111
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
14112
+ error_code: 'cannot_create_requested_access_methods'
14113
+ }[]
14060
14114
  /** ID of user identity to which the Access Grant gives access. */
14061
14115
  user_identity_id?: string | undefined
14062
14116
  }[]
@@ -17476,6 +17530,15 @@ export type Routes = {
17476
17530
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17477
17531
  warning_code: 'being_deleted'
17478
17532
  }[]
17533
+ /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
17534
+ errors: {
17535
+ /** Date and time at which Seam created the error. */
17536
+ created_at: string
17537
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
17538
+ message: string
17539
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
17540
+ error_code: 'cannot_create_requested_access_methods'
17541
+ }[]
17479
17542
  /** ID of the customization profile associated with the Access Grant. */
17480
17543
  customization_profile_id?: string | undefined
17481
17544
  }[]
@@ -62687,6 +62750,15 @@ export type Routes = {
62687
62750
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
62688
62751
  warning_code: 'being_deleted'
62689
62752
  }[]
62753
+ /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
62754
+ errors: {
62755
+ /** Date and time at which Seam created the error. */
62756
+ created_at: string
62757
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
62758
+ message: string
62759
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
62760
+ error_code: 'cannot_create_requested_access_methods'
62761
+ }[]
62690
62762
  /** ID of the customization profile associated with the Access Grant. */
62691
62763
  customization_profile_id?: string | undefined
62692
62764
  }[]
@@ -63238,6 +63310,37 @@ export type Routes = {
63238
63310
  }
63239
63311
  maxDuration: undefined
63240
63312
  }
63313
+ '/seam/customer/v1/customers/open_portal': {
63314
+ route: '/seam/customer/v1/customers/open_portal'
63315
+ method: 'POST'
63316
+ queryParams: {}
63317
+ jsonBody: {}
63318
+ commonParams: {
63319
+ /** The customer key to open a portal for. */
63320
+ customer_key: string
63321
+ }
63322
+ formData: {}
63323
+ jsonResponse: {
63324
+ /** Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
63325
+
63326
+ With Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.
63327
+
63328
+ Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control. */
63329
+ magic_link: {
63330
+ /** URL for the magic link. */
63331
+ url: string
63332
+ /** Customer key for the magic link. */
63333
+ customer_key: string
63334
+ /** Date and time at which the magic link expires. */
63335
+ expires_at: string
63336
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the magic link. */
63337
+ workspace_id: string
63338
+ /** Date and time at which the magic link was created. */
63339
+ created_at: string
63340
+ }
63341
+ }
63342
+ maxDuration: undefined
63343
+ }
63241
63344
  '/seam/customer/v1/events/list': {
63242
63345
  route: '/seam/customer/v1/events/list'
63243
63346
  method: 'GET' | 'POST'
@@ -66181,6 +66284,15 @@ export type Routes = {
66181
66284
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66182
66285
  warning_code: 'being_deleted'
66183
66286
  }[]
66287
+ /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
66288
+ errors: {
66289
+ /** Date and time at which Seam created the error. */
66290
+ created_at: string
66291
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
66292
+ message: string
66293
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66294
+ error_code: 'cannot_create_requested_access_methods'
66295
+ }[]
66184
66296
  /** ID of the customization profile associated with the Access Grant. */
66185
66297
  customization_profile_id?: string | undefined
66186
66298
  }
@@ -97362,6 +97474,15 @@ export type Routes = {
97362
97474
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97363
97475
  warning_code: 'being_deleted'
97364
97476
  }[]
97477
+ /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
97478
+ errors: {
97479
+ /** Date and time at which Seam created the error. */
97480
+ created_at: string
97481
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97482
+ message: string
97483
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
97484
+ error_code: 'cannot_create_requested_access_methods'
97485
+ }[]
97365
97486
  /** ID of the customization profile associated with the Access Grant. */
97366
97487
  customization_profile_id?: string | undefined
97367
97488
  }[]