@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.
- package/dist/connect.cjs +265 -18
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +394 -0
- package/dist/index.cjs +265 -18
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +92 -0
- package/lib/seam/connect/models/access-grants/access-grant.js +24 -0
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +34 -0
- package/lib/seam/connect/openapi.d.ts +215 -0
- package/lib/seam/connect/openapi.js +228 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +121 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +40 -0
- package/src/lib/seam/connect/openapi.ts +249 -0
- package/src/lib/seam/connect/route-types.ts +121 -0
|
@@ -1633,6 +1633,35 @@ export default {
|
|
|
1633
1633
|
nullable: true,
|
|
1634
1634
|
type: 'string',
|
|
1635
1635
|
},
|
|
1636
|
+
errors: {
|
|
1637
|
+
description: 'Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
1638
|
+
items: {
|
|
1639
|
+
discriminator: { propertyName: 'error_code' },
|
|
1640
|
+
oneOf: [
|
|
1641
|
+
{
|
|
1642
|
+
properties: {
|
|
1643
|
+
created_at: {
|
|
1644
|
+
description: 'Date and time at which Seam created the error.',
|
|
1645
|
+
format: 'date-time',
|
|
1646
|
+
type: 'string',
|
|
1647
|
+
},
|
|
1648
|
+
error_code: {
|
|
1649
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
1650
|
+
enum: ['cannot_create_requested_access_methods'],
|
|
1651
|
+
type: 'string',
|
|
1652
|
+
},
|
|
1653
|
+
message: {
|
|
1654
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
1655
|
+
type: 'string',
|
|
1656
|
+
},
|
|
1657
|
+
},
|
|
1658
|
+
required: ['created_at', 'message', 'error_code'],
|
|
1659
|
+
type: 'object',
|
|
1660
|
+
},
|
|
1661
|
+
],
|
|
1662
|
+
},
|
|
1663
|
+
type: 'array',
|
|
1664
|
+
},
|
|
1636
1665
|
instant_key_url: {
|
|
1637
1666
|
description: 'Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. ',
|
|
1638
1667
|
format: 'uri',
|
|
@@ -1760,6 +1789,7 @@ export default {
|
|
|
1760
1789
|
'starts_at',
|
|
1761
1790
|
'ends_at',
|
|
1762
1791
|
'warnings',
|
|
1792
|
+
'errors',
|
|
1763
1793
|
],
|
|
1764
1794
|
type: 'object',
|
|
1765
1795
|
'x-draft': 'Early access.',
|
|
@@ -27141,6 +27171,41 @@ export default {
|
|
|
27141
27171
|
nullable: true,
|
|
27142
27172
|
type: 'string',
|
|
27143
27173
|
},
|
|
27174
|
+
errors: {
|
|
27175
|
+
description: 'Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
27176
|
+
items: {
|
|
27177
|
+
discriminator: { propertyName: 'error_code' },
|
|
27178
|
+
oneOf: [
|
|
27179
|
+
{
|
|
27180
|
+
properties: {
|
|
27181
|
+
created_at: {
|
|
27182
|
+
description: 'Date and time at which Seam created the error.',
|
|
27183
|
+
format: 'date-time',
|
|
27184
|
+
type: 'string',
|
|
27185
|
+
},
|
|
27186
|
+
error_code: {
|
|
27187
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
27188
|
+
enum: [
|
|
27189
|
+
'cannot_create_requested_access_methods',
|
|
27190
|
+
],
|
|
27191
|
+
type: 'string',
|
|
27192
|
+
},
|
|
27193
|
+
message: {
|
|
27194
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
27195
|
+
type: 'string',
|
|
27196
|
+
},
|
|
27197
|
+
},
|
|
27198
|
+
required: [
|
|
27199
|
+
'created_at',
|
|
27200
|
+
'message',
|
|
27201
|
+
'error_code',
|
|
27202
|
+
],
|
|
27203
|
+
type: 'object',
|
|
27204
|
+
},
|
|
27205
|
+
],
|
|
27206
|
+
},
|
|
27207
|
+
type: 'array',
|
|
27208
|
+
},
|
|
27144
27209
|
location_ids: {
|
|
27145
27210
|
deprecated: true,
|
|
27146
27211
|
items: { format: 'uuid', type: 'string' },
|
|
@@ -27266,6 +27331,7 @@ export default {
|
|
|
27266
27331
|
'starts_at',
|
|
27267
27332
|
'ends_at',
|
|
27268
27333
|
'warnings',
|
|
27334
|
+
'errors',
|
|
27269
27335
|
],
|
|
27270
27336
|
type: 'object',
|
|
27271
27337
|
'x-draft': 'Early access.',
|
|
@@ -27352,6 +27418,41 @@ export default {
|
|
|
27352
27418
|
nullable: true,
|
|
27353
27419
|
type: 'string',
|
|
27354
27420
|
},
|
|
27421
|
+
errors: {
|
|
27422
|
+
description: 'Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
27423
|
+
items: {
|
|
27424
|
+
discriminator: { propertyName: 'error_code' },
|
|
27425
|
+
oneOf: [
|
|
27426
|
+
{
|
|
27427
|
+
properties: {
|
|
27428
|
+
created_at: {
|
|
27429
|
+
description: 'Date and time at which Seam created the error.',
|
|
27430
|
+
format: 'date-time',
|
|
27431
|
+
type: 'string',
|
|
27432
|
+
},
|
|
27433
|
+
error_code: {
|
|
27434
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
27435
|
+
enum: [
|
|
27436
|
+
'cannot_create_requested_access_methods',
|
|
27437
|
+
],
|
|
27438
|
+
type: 'string',
|
|
27439
|
+
},
|
|
27440
|
+
message: {
|
|
27441
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
27442
|
+
type: 'string',
|
|
27443
|
+
},
|
|
27444
|
+
},
|
|
27445
|
+
required: [
|
|
27446
|
+
'created_at',
|
|
27447
|
+
'message',
|
|
27448
|
+
'error_code',
|
|
27449
|
+
],
|
|
27450
|
+
type: 'object',
|
|
27451
|
+
},
|
|
27452
|
+
],
|
|
27453
|
+
},
|
|
27454
|
+
type: 'array',
|
|
27455
|
+
},
|
|
27355
27456
|
location_ids: {
|
|
27356
27457
|
deprecated: true,
|
|
27357
27458
|
items: { format: 'uuid', type: 'string' },
|
|
@@ -27477,6 +27578,7 @@ export default {
|
|
|
27477
27578
|
'starts_at',
|
|
27478
27579
|
'ends_at',
|
|
27479
27580
|
'warnings',
|
|
27581
|
+
'errors',
|
|
27480
27582
|
],
|
|
27481
27583
|
type: 'object',
|
|
27482
27584
|
'x-draft': 'Early access.',
|
|
@@ -27586,6 +27688,41 @@ export default {
|
|
|
27586
27688
|
nullable: true,
|
|
27587
27689
|
type: 'string',
|
|
27588
27690
|
},
|
|
27691
|
+
errors: {
|
|
27692
|
+
description: 'Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
27693
|
+
items: {
|
|
27694
|
+
discriminator: { propertyName: 'error_code' },
|
|
27695
|
+
oneOf: [
|
|
27696
|
+
{
|
|
27697
|
+
properties: {
|
|
27698
|
+
created_at: {
|
|
27699
|
+
description: 'Date and time at which Seam created the error.',
|
|
27700
|
+
format: 'date-time',
|
|
27701
|
+
type: 'string',
|
|
27702
|
+
},
|
|
27703
|
+
error_code: {
|
|
27704
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
27705
|
+
enum: [
|
|
27706
|
+
'cannot_create_requested_access_methods',
|
|
27707
|
+
],
|
|
27708
|
+
type: 'string',
|
|
27709
|
+
},
|
|
27710
|
+
message: {
|
|
27711
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
27712
|
+
type: 'string',
|
|
27713
|
+
},
|
|
27714
|
+
},
|
|
27715
|
+
required: [
|
|
27716
|
+
'created_at',
|
|
27717
|
+
'message',
|
|
27718
|
+
'error_code',
|
|
27719
|
+
],
|
|
27720
|
+
type: 'object',
|
|
27721
|
+
},
|
|
27722
|
+
],
|
|
27723
|
+
},
|
|
27724
|
+
type: 'array',
|
|
27725
|
+
},
|
|
27589
27726
|
location_ids: {
|
|
27590
27727
|
deprecated: true,
|
|
27591
27728
|
items: { format: 'uuid', type: 'string' },
|
|
@@ -27711,6 +27848,7 @@ export default {
|
|
|
27711
27848
|
'starts_at',
|
|
27712
27849
|
'ends_at',
|
|
27713
27850
|
'warnings',
|
|
27851
|
+
'errors',
|
|
27714
27852
|
],
|
|
27715
27853
|
type: 'object',
|
|
27716
27854
|
'x-draft': 'Early access.',
|
|
@@ -27813,6 +27951,41 @@ export default {
|
|
|
27813
27951
|
nullable: true,
|
|
27814
27952
|
type: 'string',
|
|
27815
27953
|
},
|
|
27954
|
+
errors: {
|
|
27955
|
+
description: 'Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
27956
|
+
items: {
|
|
27957
|
+
discriminator: { propertyName: 'error_code' },
|
|
27958
|
+
oneOf: [
|
|
27959
|
+
{
|
|
27960
|
+
properties: {
|
|
27961
|
+
created_at: {
|
|
27962
|
+
description: 'Date and time at which Seam created the error.',
|
|
27963
|
+
format: 'date-time',
|
|
27964
|
+
type: 'string',
|
|
27965
|
+
},
|
|
27966
|
+
error_code: {
|
|
27967
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
27968
|
+
enum: [
|
|
27969
|
+
'cannot_create_requested_access_methods',
|
|
27970
|
+
],
|
|
27971
|
+
type: 'string',
|
|
27972
|
+
},
|
|
27973
|
+
message: {
|
|
27974
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
27975
|
+
type: 'string',
|
|
27976
|
+
},
|
|
27977
|
+
},
|
|
27978
|
+
required: [
|
|
27979
|
+
'created_at',
|
|
27980
|
+
'message',
|
|
27981
|
+
'error_code',
|
|
27982
|
+
],
|
|
27983
|
+
type: 'object',
|
|
27984
|
+
},
|
|
27985
|
+
],
|
|
27986
|
+
},
|
|
27987
|
+
type: 'array',
|
|
27988
|
+
},
|
|
27816
27989
|
location_ids: {
|
|
27817
27990
|
deprecated: true,
|
|
27818
27991
|
items: { format: 'uuid', type: 'string' },
|
|
@@ -27938,6 +28111,7 @@ export default {
|
|
|
27938
28111
|
'starts_at',
|
|
27939
28112
|
'ends_at',
|
|
27940
28113
|
'warnings',
|
|
28114
|
+
'errors',
|
|
27941
28115
|
],
|
|
27942
28116
|
type: 'object',
|
|
27943
28117
|
'x-draft': 'Early access.',
|
|
@@ -50640,6 +50814,60 @@ export default {
|
|
|
50640
50814
|
'x-undocumented': 'Internal endpoint for Console.',
|
|
50641
50815
|
},
|
|
50642
50816
|
},
|
|
50817
|
+
'/seam/customer/v1/customers/open_portal': {
|
|
50818
|
+
post: {
|
|
50819
|
+
description: 'Opens an existing customer portal or creates a new one if the previous portal has expired.\nReturns an error if no portal was ever created for this customer.',
|
|
50820
|
+
operationId: 'seamCustomerV1CustomersOpenPortalPost',
|
|
50821
|
+
requestBody: {
|
|
50822
|
+
content: {
|
|
50823
|
+
'application/json': {
|
|
50824
|
+
schema: {
|
|
50825
|
+
properties: {
|
|
50826
|
+
customer_key: {
|
|
50827
|
+
description: 'The customer key to open a portal for.',
|
|
50828
|
+
type: 'string',
|
|
50829
|
+
},
|
|
50830
|
+
},
|
|
50831
|
+
required: ['customer_key'],
|
|
50832
|
+
type: 'object',
|
|
50833
|
+
},
|
|
50834
|
+
},
|
|
50835
|
+
},
|
|
50836
|
+
},
|
|
50837
|
+
responses: {
|
|
50838
|
+
200: {
|
|
50839
|
+
content: {
|
|
50840
|
+
'application/json': {
|
|
50841
|
+
schema: {
|
|
50842
|
+
properties: {
|
|
50843
|
+
magic_link: { $ref: '#/components/schemas/magic_link' },
|
|
50844
|
+
ok: { type: 'boolean' },
|
|
50845
|
+
},
|
|
50846
|
+
required: ['magic_link', 'ok'],
|
|
50847
|
+
type: 'object',
|
|
50848
|
+
},
|
|
50849
|
+
},
|
|
50850
|
+
},
|
|
50851
|
+
description: 'OK',
|
|
50852
|
+
},
|
|
50853
|
+
400: { description: 'Bad Request' },
|
|
50854
|
+
401: { description: 'Unauthorized' },
|
|
50855
|
+
},
|
|
50856
|
+
security: [
|
|
50857
|
+
{ pat_with_workspace: [] },
|
|
50858
|
+
{ console_session_with_workspace: [] },
|
|
50859
|
+
{ api_key: [] },
|
|
50860
|
+
],
|
|
50861
|
+
summary: '/seam/customer/v1/customers/open_portal',
|
|
50862
|
+
tags: [],
|
|
50863
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'customers'],
|
|
50864
|
+
'x-fern-sdk-method-name': 'open_portal',
|
|
50865
|
+
'x-fern-sdk-return-value': 'magic_link',
|
|
50866
|
+
'x-response-key': 'magic_link',
|
|
50867
|
+
'x-title': 'Open Customer Portal',
|
|
50868
|
+
'x-undocumented': 'Internal endpoint for Console.',
|
|
50869
|
+
},
|
|
50870
|
+
},
|
|
50643
50871
|
'/seam/customer/v1/events/list': {
|
|
50644
50872
|
get: {
|
|
50645
50873
|
description: 'Returns a list of events for devices in a specific space. This endpoint is designed for customer portals and only supports filtering by space_id.',
|