@seamapi/types 1.1146.0 → 1.1148.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.
|
@@ -58243,6 +58243,74 @@ const openapi = {
|
|
|
58243
58243
|
'x-undocumented': 'Internal endpoint for Console',
|
|
58244
58244
|
},
|
|
58245
58245
|
},
|
|
58246
|
+
'/seam/console/v1/workspace/get_summary': {
|
|
58247
|
+
get: {
|
|
58248
|
+
description: 'Returns the device and access code counts shown on the Console home page.',
|
|
58249
|
+
operationId: 'seamConsoleV1WorkspaceGetSummaryGet',
|
|
58250
|
+
parameters: [
|
|
58251
|
+
{
|
|
58252
|
+
in: 'query',
|
|
58253
|
+
name: 'customer_key',
|
|
58254
|
+
schema: {
|
|
58255
|
+
description: 'Customer key for which you want to summarize the workspace.',
|
|
58256
|
+
minLength: 1,
|
|
58257
|
+
type: 'string',
|
|
58258
|
+
},
|
|
58259
|
+
},
|
|
58260
|
+
],
|
|
58261
|
+
responses: {
|
|
58262
|
+
'200': {
|
|
58263
|
+
content: {
|
|
58264
|
+
'application/json': {
|
|
58265
|
+
schema: {
|
|
58266
|
+
properties: {
|
|
58267
|
+
ok: { type: 'boolean' },
|
|
58268
|
+
workspace_summary: {
|
|
58269
|
+
properties: {
|
|
58270
|
+
access_code_delivery_7d: {
|
|
58271
|
+
properties: {
|
|
58272
|
+
delivered_count: { type: 'integer' },
|
|
58273
|
+
failed_count: { type: 'integer' },
|
|
58274
|
+
},
|
|
58275
|
+
required: ['delivered_count', 'failed_count'],
|
|
58276
|
+
type: 'object',
|
|
58277
|
+
},
|
|
58278
|
+
active_access_code_count: { type: 'integer' },
|
|
58279
|
+
device_count: { type: 'integer' },
|
|
58280
|
+
devices_needing_attention_count: { type: 'integer' },
|
|
58281
|
+
online_device_count: { type: 'integer' },
|
|
58282
|
+
},
|
|
58283
|
+
required: [
|
|
58284
|
+
'device_count',
|
|
58285
|
+
'online_device_count',
|
|
58286
|
+
'devices_needing_attention_count',
|
|
58287
|
+
'active_access_code_count',
|
|
58288
|
+
'access_code_delivery_7d',
|
|
58289
|
+
],
|
|
58290
|
+
type: 'object',
|
|
58291
|
+
},
|
|
58292
|
+
},
|
|
58293
|
+
required: ['workspace_summary', 'ok'],
|
|
58294
|
+
type: 'object',
|
|
58295
|
+
},
|
|
58296
|
+
},
|
|
58297
|
+
},
|
|
58298
|
+
description: 'OK',
|
|
58299
|
+
},
|
|
58300
|
+
'400': { description: 'Bad Request' },
|
|
58301
|
+
'401': { description: 'Unauthorized' },
|
|
58302
|
+
},
|
|
58303
|
+
security: [{ console_session_with_workspace: [] }],
|
|
58304
|
+
summary: '/seam/console/v1/workspace/get_summary',
|
|
58305
|
+
tags: [],
|
|
58306
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'workspace'],
|
|
58307
|
+
'x-fern-sdk-method-name': 'get_summary',
|
|
58308
|
+
'x-fern-sdk-return-value': 'workspace_summary',
|
|
58309
|
+
'x-response-key': 'workspace_summary',
|
|
58310
|
+
'x-title': 'Get Workspace Summary',
|
|
58311
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
58312
|
+
},
|
|
58313
|
+
},
|
|
58246
58314
|
'/seam/customer/v1/access_grants/list': {
|
|
58247
58315
|
get: {
|
|
58248
58316
|
description: 'Gets an Access Grant.',
|
|
@@ -63560,6 +63628,17 @@ const openapi = {
|
|
|
63560
63628
|
type: 'object',
|
|
63561
63629
|
},
|
|
63562
63630
|
name: { nullable: true, type: 'string' },
|
|
63631
|
+
parent_reservation_id: {
|
|
63632
|
+
description: 'ID of the parent reservation when this reservation is a sub-reservation, one part of a larger reservation that holds its own access. Null otherwise.',
|
|
63633
|
+
format: 'uuid',
|
|
63634
|
+
nullable: true,
|
|
63635
|
+
type: 'string',
|
|
63636
|
+
},
|
|
63637
|
+
parent_reservation_key: {
|
|
63638
|
+
description: 'Key of the parent reservation when this reservation is a sub-reservation. Its `reservation_key` is then `<parent_reservation_key>::<sub-reservation key>`. Null otherwise.',
|
|
63639
|
+
nullable: true,
|
|
63640
|
+
type: 'string',
|
|
63641
|
+
},
|
|
63563
63642
|
reservation_id: { format: 'uuid', type: 'string' },
|
|
63564
63643
|
reservation_key: { type: 'string' },
|
|
63565
63644
|
spaces: {
|
|
@@ -63583,6 +63662,70 @@ const openapi = {
|
|
|
63583
63662
|
nullable: true,
|
|
63584
63663
|
type: 'string',
|
|
63585
63664
|
},
|
|
63665
|
+
sub_reservations: {
|
|
63666
|
+
description: "Parts of the reservation that each hold their own access, for example one per room. When present, the reservation's spaces are the union of its sub-reservations' spaces.",
|
|
63667
|
+
items: {
|
|
63668
|
+
properties: {
|
|
63669
|
+
access_grant_id: {
|
|
63670
|
+
format: 'uuid',
|
|
63671
|
+
nullable: true,
|
|
63672
|
+
type: 'string',
|
|
63673
|
+
},
|
|
63674
|
+
access_methods: {
|
|
63675
|
+
items: {
|
|
63676
|
+
$ref: '#/components/schemas/access_method',
|
|
63677
|
+
},
|
|
63678
|
+
type: 'array',
|
|
63679
|
+
},
|
|
63680
|
+
ends_at: {
|
|
63681
|
+
format: 'date-time',
|
|
63682
|
+
nullable: true,
|
|
63683
|
+
type: 'string',
|
|
63684
|
+
},
|
|
63685
|
+
is_resource_syncing: { type: 'boolean' },
|
|
63686
|
+
name: { nullable: true, type: 'string' },
|
|
63687
|
+
spaces: {
|
|
63688
|
+
items: {
|
|
63689
|
+
properties: {
|
|
63690
|
+
name: { nullable: true, type: 'string' },
|
|
63691
|
+
space_id: {
|
|
63692
|
+
format: 'uuid',
|
|
63693
|
+
nullable: true,
|
|
63694
|
+
type: 'string',
|
|
63695
|
+
},
|
|
63696
|
+
space_key: { type: 'string' },
|
|
63697
|
+
},
|
|
63698
|
+
required: ['space_id', 'space_key', 'name'],
|
|
63699
|
+
type: 'object',
|
|
63700
|
+
},
|
|
63701
|
+
type: 'array',
|
|
63702
|
+
},
|
|
63703
|
+
starts_at: {
|
|
63704
|
+
format: 'date-time',
|
|
63705
|
+
nullable: true,
|
|
63706
|
+
type: 'string',
|
|
63707
|
+
},
|
|
63708
|
+
sub_reservation_id: {
|
|
63709
|
+
format: 'uuid',
|
|
63710
|
+
type: 'string',
|
|
63711
|
+
},
|
|
63712
|
+
sub_reservation_key: { type: 'string' },
|
|
63713
|
+
},
|
|
63714
|
+
required: [
|
|
63715
|
+
'sub_reservation_id',
|
|
63716
|
+
'sub_reservation_key',
|
|
63717
|
+
'name',
|
|
63718
|
+
'starts_at',
|
|
63719
|
+
'ends_at',
|
|
63720
|
+
'is_resource_syncing',
|
|
63721
|
+
'access_grant_id',
|
|
63722
|
+
'spaces',
|
|
63723
|
+
'access_methods',
|
|
63724
|
+
],
|
|
63725
|
+
type: 'object',
|
|
63726
|
+
},
|
|
63727
|
+
type: 'array',
|
|
63728
|
+
},
|
|
63586
63729
|
},
|
|
63587
63730
|
required: [
|
|
63588
63731
|
'reservation_id',
|
|
@@ -63599,6 +63742,9 @@ const openapi = {
|
|
|
63599
63742
|
'access_methods',
|
|
63600
63743
|
'connected_account_id',
|
|
63601
63744
|
'last_automation_result',
|
|
63745
|
+
'parent_reservation_id',
|
|
63746
|
+
'parent_reservation_key',
|
|
63747
|
+
'sub_reservations',
|
|
63602
63748
|
],
|
|
63603
63749
|
type: 'object',
|
|
63604
63750
|
},
|
|
@@ -63905,6 +64051,70 @@ const openapi = {
|
|
|
63905
64051
|
nullable: true,
|
|
63906
64052
|
type: 'string',
|
|
63907
64053
|
},
|
|
64054
|
+
sub_reservations: {
|
|
64055
|
+
description: "Parts of the reservation that each hold their own access, for example one per room. When present, the reservation's spaces are the union of its sub-reservations' spaces.",
|
|
64056
|
+
items: {
|
|
64057
|
+
properties: {
|
|
64058
|
+
access_grant_id: {
|
|
64059
|
+
format: 'uuid',
|
|
64060
|
+
nullable: true,
|
|
64061
|
+
type: 'string',
|
|
64062
|
+
},
|
|
64063
|
+
access_methods: {
|
|
64064
|
+
items: {
|
|
64065
|
+
$ref: '#/components/schemas/access_method',
|
|
64066
|
+
},
|
|
64067
|
+
type: 'array',
|
|
64068
|
+
},
|
|
64069
|
+
ends_at: {
|
|
64070
|
+
format: 'date-time',
|
|
64071
|
+
nullable: true,
|
|
64072
|
+
type: 'string',
|
|
64073
|
+
},
|
|
64074
|
+
is_resource_syncing: { type: 'boolean' },
|
|
64075
|
+
name: { nullable: true, type: 'string' },
|
|
64076
|
+
spaces: {
|
|
64077
|
+
items: {
|
|
64078
|
+
properties: {
|
|
64079
|
+
name: { nullable: true, type: 'string' },
|
|
64080
|
+
space_id: {
|
|
64081
|
+
format: 'uuid',
|
|
64082
|
+
nullable: true,
|
|
64083
|
+
type: 'string',
|
|
64084
|
+
},
|
|
64085
|
+
space_key: { type: 'string' },
|
|
64086
|
+
},
|
|
64087
|
+
required: ['space_id', 'space_key', 'name'],
|
|
64088
|
+
type: 'object',
|
|
64089
|
+
},
|
|
64090
|
+
type: 'array',
|
|
64091
|
+
},
|
|
64092
|
+
starts_at: {
|
|
64093
|
+
format: 'date-time',
|
|
64094
|
+
nullable: true,
|
|
64095
|
+
type: 'string',
|
|
64096
|
+
},
|
|
64097
|
+
sub_reservation_id: {
|
|
64098
|
+
format: 'uuid',
|
|
64099
|
+
type: 'string',
|
|
64100
|
+
},
|
|
64101
|
+
sub_reservation_key: { type: 'string' },
|
|
64102
|
+
},
|
|
64103
|
+
required: [
|
|
64104
|
+
'sub_reservation_id',
|
|
64105
|
+
'sub_reservation_key',
|
|
64106
|
+
'name',
|
|
64107
|
+
'starts_at',
|
|
64108
|
+
'ends_at',
|
|
64109
|
+
'is_resource_syncing',
|
|
64110
|
+
'access_grant_id',
|
|
64111
|
+
'spaces',
|
|
64112
|
+
'access_methods',
|
|
64113
|
+
],
|
|
64114
|
+
type: 'object',
|
|
64115
|
+
},
|
|
64116
|
+
type: 'array',
|
|
64117
|
+
},
|
|
63908
64118
|
warnings: {
|
|
63909
64119
|
items: {
|
|
63910
64120
|
properties: {
|
|
@@ -63940,6 +64150,7 @@ const openapi = {
|
|
|
63940
64150
|
'spaces',
|
|
63941
64151
|
'connected_account_id',
|
|
63942
64152
|
'last_automation_result',
|
|
64153
|
+
'sub_reservations',
|
|
63943
64154
|
],
|
|
63944
64155
|
type: 'object',
|
|
63945
64156
|
},
|
|
@@ -64664,6 +64875,17 @@ const openapi = {
|
|
|
64664
64875
|
type: 'object',
|
|
64665
64876
|
},
|
|
64666
64877
|
name: { nullable: true, type: 'string' },
|
|
64878
|
+
parent_reservation_id: {
|
|
64879
|
+
description: 'ID of the parent reservation when this reservation is a sub-reservation, one part of a larger reservation that holds its own access. Null otherwise.',
|
|
64880
|
+
format: 'uuid',
|
|
64881
|
+
nullable: true,
|
|
64882
|
+
type: 'string',
|
|
64883
|
+
},
|
|
64884
|
+
parent_reservation_key: {
|
|
64885
|
+
description: 'Key of the parent reservation when this reservation is a sub-reservation. Its `reservation_key` is then `<parent_reservation_key>::<sub-reservation key>`. Null otherwise.',
|
|
64886
|
+
nullable: true,
|
|
64887
|
+
type: 'string',
|
|
64888
|
+
},
|
|
64667
64889
|
reservation_id: { format: 'uuid', type: 'string' },
|
|
64668
64890
|
reservation_key: { type: 'string' },
|
|
64669
64891
|
starts_at: {
|
|
@@ -64683,6 +64905,8 @@ const openapi = {
|
|
|
64683
64905
|
'has_issued_access',
|
|
64684
64906
|
'access_methods',
|
|
64685
64907
|
'last_automation_result',
|
|
64908
|
+
'parent_reservation_id',
|
|
64909
|
+
'parent_reservation_key',
|
|
64686
64910
|
],
|
|
64687
64911
|
type: 'object',
|
|
64688
64912
|
},
|