@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.
@@ -92411,6 +92411,30 @@ export type Routes = {
92411
92411
  };
92412
92412
  maxDuration: undefined;
92413
92413
  };
92414
+ '/seam/console/v1/workspace/get_summary': {
92415
+ route: '/seam/console/v1/workspace/get_summary';
92416
+ method: 'GET' | 'POST';
92417
+ queryParams: {};
92418
+ jsonBody: {};
92419
+ commonParams: {
92420
+ /** Customer key for which you want to summarize the workspace. */
92421
+ customer_key?: string | undefined;
92422
+ };
92423
+ formData: {};
92424
+ jsonResponse: {
92425
+ workspace_summary: {
92426
+ device_count: number;
92427
+ online_device_count: number;
92428
+ devices_needing_attention_count: number;
92429
+ active_access_code_count: number;
92430
+ access_code_delivery_7d: {
92431
+ delivered_count: number;
92432
+ failed_count: number;
92433
+ };
92434
+ };
92435
+ };
92436
+ maxDuration: undefined;
92437
+ };
92414
92438
  '/seam/customer/v1/access_grants/list': {
92415
92439
  route: '/seam/customer/v1/access_grants/list';
92416
92440
  method: 'GET' | 'POST';
@@ -100021,6 +100045,30 @@ export type Routes = {
100021
100045
  message?: string | undefined;
100022
100046
  created_at: string;
100023
100047
  } | null;
100048
+ /** 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. */
100049
+ parent_reservation_id: string | null;
100050
+ /** 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. */
100051
+ parent_reservation_key: string | null;
100052
+ /** 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. */
100053
+ sub_reservations: {
100054
+ sub_reservation_id: string;
100055
+ sub_reservation_key: string;
100056
+ name: string | null;
100057
+ starts_at: string | null;
100058
+ ends_at: string | null;
100059
+ is_resource_syncing: boolean;
100060
+ access_grant_id: string | null;
100061
+ spaces: {
100062
+ space_id: string | null;
100063
+ space_key: string;
100064
+ name: string | null;
100065
+ }[];
100066
+ access_methods: {
100067
+ access_method_id: string;
100068
+ mode: string;
100069
+ is_issued: boolean;
100070
+ }[];
100071
+ }[];
100024
100072
  };
100025
100073
  };
100026
100074
  maxDuration: undefined;
@@ -100110,6 +100158,26 @@ export type Routes = {
100110
100158
  message?: string | undefined;
100111
100159
  created_at: string;
100112
100160
  } | null;
100161
+ /** 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. */
100162
+ sub_reservations: {
100163
+ sub_reservation_id: string;
100164
+ sub_reservation_key: string;
100165
+ name: string | null;
100166
+ starts_at: string | null;
100167
+ ends_at: string | null;
100168
+ is_resource_syncing: boolean;
100169
+ access_grant_id: string | null;
100170
+ spaces: {
100171
+ space_id: string | null;
100172
+ space_key: string;
100173
+ name: string | null;
100174
+ }[];
100175
+ access_methods: {
100176
+ access_method_id: string;
100177
+ mode: string;
100178
+ is_issued: boolean;
100179
+ }[];
100180
+ }[];
100113
100181
  }[];
100114
100182
  /** Information about the current page of results. */
100115
100183
  pagination: {
@@ -100657,6 +100725,10 @@ export type Routes = {
100657
100725
  message?: string | undefined;
100658
100726
  created_at: string;
100659
100727
  } | null;
100728
+ /** 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. */
100729
+ parent_reservation_id: string | null;
100730
+ /** 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. */
100731
+ parent_reservation_key: string | null;
100660
100732
  }[];
100661
100733
  };
100662
100734
  maxDuration: undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1146.0",
3
+ "version": "1.1148.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -63913,6 +63913,76 @@ const openapi: OpenAPISpec = {
63913
63913
  'x-undocumented': 'Internal endpoint for Console',
63914
63914
  },
63915
63915
  },
63916
+ '/seam/console/v1/workspace/get_summary': {
63917
+ get: {
63918
+ description:
63919
+ 'Returns the device and access code counts shown on the Console home page.',
63920
+ operationId: 'seamConsoleV1WorkspaceGetSummaryGet',
63921
+ parameters: [
63922
+ {
63923
+ in: 'query',
63924
+ name: 'customer_key',
63925
+ schema: {
63926
+ description:
63927
+ 'Customer key for which you want to summarize the workspace.',
63928
+ minLength: 1,
63929
+ type: 'string',
63930
+ },
63931
+ },
63932
+ ],
63933
+ responses: {
63934
+ '200': {
63935
+ content: {
63936
+ 'application/json': {
63937
+ schema: {
63938
+ properties: {
63939
+ ok: { type: 'boolean' },
63940
+ workspace_summary: {
63941
+ properties: {
63942
+ access_code_delivery_7d: {
63943
+ properties: {
63944
+ delivered_count: { type: 'integer' },
63945
+ failed_count: { type: 'integer' },
63946
+ },
63947
+ required: ['delivered_count', 'failed_count'],
63948
+ type: 'object',
63949
+ },
63950
+ active_access_code_count: { type: 'integer' },
63951
+ device_count: { type: 'integer' },
63952
+ devices_needing_attention_count: { type: 'integer' },
63953
+ online_device_count: { type: 'integer' },
63954
+ },
63955
+ required: [
63956
+ 'device_count',
63957
+ 'online_device_count',
63958
+ 'devices_needing_attention_count',
63959
+ 'active_access_code_count',
63960
+ 'access_code_delivery_7d',
63961
+ ],
63962
+ type: 'object',
63963
+ },
63964
+ },
63965
+ required: ['workspace_summary', 'ok'],
63966
+ type: 'object',
63967
+ },
63968
+ },
63969
+ },
63970
+ description: 'OK',
63971
+ },
63972
+ '400': { description: 'Bad Request' },
63973
+ '401': { description: 'Unauthorized' },
63974
+ },
63975
+ security: [{ console_session_with_workspace: [] }],
63976
+ summary: '/seam/console/v1/workspace/get_summary',
63977
+ tags: [],
63978
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'workspace'],
63979
+ 'x-fern-sdk-method-name': 'get_summary',
63980
+ 'x-fern-sdk-return-value': 'workspace_summary',
63981
+ 'x-response-key': 'workspace_summary',
63982
+ 'x-title': 'Get Workspace Summary',
63983
+ 'x-undocumented': 'Internal endpoint for Console',
63984
+ },
63985
+ },
63916
63986
  '/seam/customer/v1/access_grants/list': {
63917
63987
  get: {
63918
63988
  description: 'Gets an Access Grant.',
@@ -69432,6 +69502,19 @@ const openapi: OpenAPISpec = {
69432
69502
  type: 'object',
69433
69503
  },
69434
69504
  name: { nullable: true, type: 'string' },
69505
+ parent_reservation_id: {
69506
+ description:
69507
+ '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.',
69508
+ format: 'uuid',
69509
+ nullable: true,
69510
+ type: 'string',
69511
+ },
69512
+ parent_reservation_key: {
69513
+ description:
69514
+ '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.',
69515
+ nullable: true,
69516
+ type: 'string',
69517
+ },
69435
69518
  reservation_id: { format: 'uuid', type: 'string' },
69436
69519
  reservation_key: { type: 'string' },
69437
69520
  spaces: {
@@ -69455,6 +69538,71 @@ const openapi: OpenAPISpec = {
69455
69538
  nullable: true,
69456
69539
  type: 'string',
69457
69540
  },
69541
+ sub_reservations: {
69542
+ description:
69543
+ "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.",
69544
+ items: {
69545
+ properties: {
69546
+ access_grant_id: {
69547
+ format: 'uuid',
69548
+ nullable: true,
69549
+ type: 'string',
69550
+ },
69551
+ access_methods: {
69552
+ items: {
69553
+ $ref: '#/components/schemas/access_method',
69554
+ },
69555
+ type: 'array',
69556
+ },
69557
+ ends_at: {
69558
+ format: 'date-time',
69559
+ nullable: true,
69560
+ type: 'string',
69561
+ },
69562
+ is_resource_syncing: { type: 'boolean' },
69563
+ name: { nullable: true, type: 'string' },
69564
+ spaces: {
69565
+ items: {
69566
+ properties: {
69567
+ name: { nullable: true, type: 'string' },
69568
+ space_id: {
69569
+ format: 'uuid',
69570
+ nullable: true,
69571
+ type: 'string',
69572
+ },
69573
+ space_key: { type: 'string' },
69574
+ },
69575
+ required: ['space_id', 'space_key', 'name'],
69576
+ type: 'object',
69577
+ },
69578
+ type: 'array',
69579
+ },
69580
+ starts_at: {
69581
+ format: 'date-time',
69582
+ nullable: true,
69583
+ type: 'string',
69584
+ },
69585
+ sub_reservation_id: {
69586
+ format: 'uuid',
69587
+ type: 'string',
69588
+ },
69589
+ sub_reservation_key: { type: 'string' },
69590
+ },
69591
+ required: [
69592
+ 'sub_reservation_id',
69593
+ 'sub_reservation_key',
69594
+ 'name',
69595
+ 'starts_at',
69596
+ 'ends_at',
69597
+ 'is_resource_syncing',
69598
+ 'access_grant_id',
69599
+ 'spaces',
69600
+ 'access_methods',
69601
+ ],
69602
+ type: 'object',
69603
+ },
69604
+ type: 'array',
69605
+ },
69458
69606
  },
69459
69607
  required: [
69460
69608
  'reservation_id',
@@ -69471,6 +69619,9 @@ const openapi: OpenAPISpec = {
69471
69619
  'access_methods',
69472
69620
  'connected_account_id',
69473
69621
  'last_automation_result',
69622
+ 'parent_reservation_id',
69623
+ 'parent_reservation_key',
69624
+ 'sub_reservations',
69474
69625
  ],
69475
69626
  type: 'object',
69476
69627
  },
@@ -69785,6 +69936,71 @@ const openapi: OpenAPISpec = {
69785
69936
  nullable: true,
69786
69937
  type: 'string',
69787
69938
  },
69939
+ sub_reservations: {
69940
+ description:
69941
+ "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.",
69942
+ items: {
69943
+ properties: {
69944
+ access_grant_id: {
69945
+ format: 'uuid',
69946
+ nullable: true,
69947
+ type: 'string',
69948
+ },
69949
+ access_methods: {
69950
+ items: {
69951
+ $ref: '#/components/schemas/access_method',
69952
+ },
69953
+ type: 'array',
69954
+ },
69955
+ ends_at: {
69956
+ format: 'date-time',
69957
+ nullable: true,
69958
+ type: 'string',
69959
+ },
69960
+ is_resource_syncing: { type: 'boolean' },
69961
+ name: { nullable: true, type: 'string' },
69962
+ spaces: {
69963
+ items: {
69964
+ properties: {
69965
+ name: { nullable: true, type: 'string' },
69966
+ space_id: {
69967
+ format: 'uuid',
69968
+ nullable: true,
69969
+ type: 'string',
69970
+ },
69971
+ space_key: { type: 'string' },
69972
+ },
69973
+ required: ['space_id', 'space_key', 'name'],
69974
+ type: 'object',
69975
+ },
69976
+ type: 'array',
69977
+ },
69978
+ starts_at: {
69979
+ format: 'date-time',
69980
+ nullable: true,
69981
+ type: 'string',
69982
+ },
69983
+ sub_reservation_id: {
69984
+ format: 'uuid',
69985
+ type: 'string',
69986
+ },
69987
+ sub_reservation_key: { type: 'string' },
69988
+ },
69989
+ required: [
69990
+ 'sub_reservation_id',
69991
+ 'sub_reservation_key',
69992
+ 'name',
69993
+ 'starts_at',
69994
+ 'ends_at',
69995
+ 'is_resource_syncing',
69996
+ 'access_grant_id',
69997
+ 'spaces',
69998
+ 'access_methods',
69999
+ ],
70000
+ type: 'object',
70001
+ },
70002
+ type: 'array',
70003
+ },
69788
70004
  warnings: {
69789
70005
  items: {
69790
70006
  properties: {
@@ -69820,6 +70036,7 @@ const openapi: OpenAPISpec = {
69820
70036
  'spaces',
69821
70037
  'connected_account_id',
69822
70038
  'last_automation_result',
70039
+ 'sub_reservations',
69823
70040
  ],
69824
70041
  type: 'object',
69825
70042
  },
@@ -70581,6 +70798,19 @@ const openapi: OpenAPISpec = {
70581
70798
  type: 'object',
70582
70799
  },
70583
70800
  name: { nullable: true, type: 'string' },
70801
+ parent_reservation_id: {
70802
+ description:
70803
+ '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.',
70804
+ format: 'uuid',
70805
+ nullable: true,
70806
+ type: 'string',
70807
+ },
70808
+ parent_reservation_key: {
70809
+ description:
70810
+ '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.',
70811
+ nullable: true,
70812
+ type: 'string',
70813
+ },
70584
70814
  reservation_id: { format: 'uuid', type: 'string' },
70585
70815
  reservation_key: { type: 'string' },
70586
70816
  starts_at: {
@@ -70600,6 +70830,8 @@ const openapi: OpenAPISpec = {
70600
70830
  'has_issued_access',
70601
70831
  'access_methods',
70602
70832
  'last_automation_result',
70833
+ 'parent_reservation_id',
70834
+ 'parent_reservation_key',
70603
70835
  ],
70604
70836
  type: 'object',
70605
70837
  },
@@ -110211,6 +110211,30 @@ export type Routes = {
110211
110211
  }
110212
110212
  maxDuration: undefined
110213
110213
  }
110214
+ '/seam/console/v1/workspace/get_summary': {
110215
+ route: '/seam/console/v1/workspace/get_summary'
110216
+ method: 'GET' | 'POST'
110217
+ queryParams: {}
110218
+ jsonBody: {}
110219
+ commonParams: {
110220
+ /** Customer key for which you want to summarize the workspace. */
110221
+ customer_key?: string | undefined
110222
+ }
110223
+ formData: {}
110224
+ jsonResponse: {
110225
+ workspace_summary: {
110226
+ device_count: number
110227
+ online_device_count: number
110228
+ devices_needing_attention_count: number
110229
+ active_access_code_count: number
110230
+ access_code_delivery_7d: {
110231
+ delivered_count: number
110232
+ failed_count: number
110233
+ }
110234
+ }
110235
+ }
110236
+ maxDuration: undefined
110237
+ }
110214
110238
  '/seam/customer/v1/access_grants/list': {
110215
110239
  route: '/seam/customer/v1/access_grants/list'
110216
110240
  method: 'GET' | 'POST'
@@ -119270,6 +119294,30 @@ export type Routes = {
119270
119294
  message?: string | undefined
119271
119295
  created_at: string
119272
119296
  } | null
119297
+ /** 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. */
119298
+ parent_reservation_id: string | null
119299
+ /** 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. */
119300
+ parent_reservation_key: string | null
119301
+ /** 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. */
119302
+ sub_reservations: {
119303
+ sub_reservation_id: string
119304
+ sub_reservation_key: string
119305
+ name: string | null
119306
+ starts_at: string | null
119307
+ ends_at: string | null
119308
+ is_resource_syncing: boolean
119309
+ access_grant_id: string | null
119310
+ spaces: {
119311
+ space_id: string | null
119312
+ space_key: string
119313
+ name: string | null
119314
+ }[]
119315
+ access_methods: {
119316
+ access_method_id: string
119317
+ mode: string
119318
+ is_issued: boolean
119319
+ }[]
119320
+ }[]
119273
119321
  }
119274
119322
  }
119275
119323
  maxDuration: undefined
@@ -119359,6 +119407,26 @@ export type Routes = {
119359
119407
  message?: string | undefined
119360
119408
  created_at: string
119361
119409
  } | null
119410
+ /** 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. */
119411
+ sub_reservations: {
119412
+ sub_reservation_id: string
119413
+ sub_reservation_key: string
119414
+ name: string | null
119415
+ starts_at: string | null
119416
+ ends_at: string | null
119417
+ is_resource_syncing: boolean
119418
+ access_grant_id: string | null
119419
+ spaces: {
119420
+ space_id: string | null
119421
+ space_key: string
119422
+ name: string | null
119423
+ }[]
119424
+ access_methods: {
119425
+ access_method_id: string
119426
+ mode: string
119427
+ is_issued: boolean
119428
+ }[]
119429
+ }[]
119362
119430
  }[]
119363
119431
  /** Information about the current page of results. */
119364
119432
  pagination: {
@@ -119967,6 +120035,10 @@ export type Routes = {
119967
120035
  message?: string | undefined
119968
120036
  created_at: string
119969
120037
  } | null
120038
+ /** 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. */
120039
+ parent_reservation_id: string | null
120040
+ /** 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. */
120041
+ parent_reservation_key: string | null
119970
120042
  }[]
119971
120043
  }
119972
120044
  maxDuration: undefined