@seamapi/types 1.517.0 → 1.519.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.
@@ -11780,6 +11780,8 @@ export type Routes = {
11780
11780
  queryParams: {};
11781
11781
  jsonBody: {};
11782
11782
  commonParams: {
11783
+ /** Customer key for which you want to list access grants. */
11784
+ customer_key?: string | undefined;
11783
11785
  /** ID of user identity by which you want to filter the list of Access Grants. */
11784
11786
  user_identity_id?: string | undefined;
11785
11787
  /** ID of the access system by which you want to filter the list of Access Grants. */
@@ -36780,6 +36782,8 @@ export type Routes = {
36780
36782
  queryParams: {};
36781
36783
  jsonBody: {};
36782
36784
  commonParams: {
36785
+ /** Customer key for which you want to list events. */
36786
+ customer_key?: string | undefined;
36783
36787
  /** Offset for the events that you want to list. */
36784
36788
  unstable_offset?: number | undefined;
36785
36789
  /** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. */
@@ -36810,8 +36814,6 @@ export type Routes = {
36810
36814
  limit?: number;
36811
36815
  /** IDs of the events that you want to list. */
36812
36816
  event_ids?: string[] | undefined;
36813
- /** IDs of the customers for which you want to list events. */
36814
- customer_ids?: string[] | undefined;
36815
36817
  };
36816
36818
  formData: {};
36817
36819
  jsonResponse: {
@@ -55494,7 +55496,7 @@ export type Routes = {
55494
55496
  automation_run_id: string;
55495
55497
  workspace_id: string;
55496
55498
  automation_id: string;
55497
- partner_resource_id: string;
55499
+ partner_resource_id: string | null;
55498
55500
  automation_result?: {
55499
55501
  success: boolean;
55500
55502
  rule: 'reservation_created' | 'reservation_time_updated' | 'reservation_deleted';
@@ -59721,6 +59723,8 @@ export type Routes = {
59721
59723
  queryParams: {};
59722
59724
  jsonBody: {};
59723
59725
  commonParams: {
59726
+ /** Customer key for which you want to list spaces. */
59727
+ customer_key?: string | undefined;
59724
59728
  /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
59725
59729
  search?: string | undefined;
59726
59730
  /** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
@@ -78728,7 +78732,10 @@ export type Routes = {
78728
78732
  method: 'POST' | 'GET';
78729
78733
  queryParams: {};
78730
78734
  jsonBody: {};
78731
- commonParams: {};
78735
+ commonParams: {
78736
+ /** Customer key for which you want to list customization profiles. */
78737
+ customer_key?: string | undefined;
78738
+ };
78732
78739
  formData: {};
78733
78740
  jsonResponse: {
78734
78741
  customization_profiles: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.517.0",
3
+ "version": "1.519.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -28527,6 +28527,15 @@ export default {
28527
28527
  description: 'Gets an Access Grant.',
28528
28528
  operationId: 'accessGrantsListGet',
28529
28529
  parameters: [
28530
+ {
28531
+ in: 'query',
28532
+ name: 'customer_key',
28533
+ schema: {
28534
+ description:
28535
+ 'Customer key for which you want to list access grants.',
28536
+ type: 'string',
28537
+ },
28538
+ },
28530
28539
  {
28531
28540
  in: 'query',
28532
28541
  name: 'user_identity_id',
@@ -28647,6 +28656,11 @@ export default {
28647
28656
  format: 'uuid',
28648
28657
  type: 'string',
28649
28658
  },
28659
+ customer_key: {
28660
+ description:
28661
+ 'Customer key for which you want to list access grants.',
28662
+ type: 'string',
28663
+ },
28650
28664
  location_id: {
28651
28665
  deprecated: true,
28652
28666
  format: 'uuid',
@@ -42758,6 +42772,14 @@ export default {
42758
42772
  'Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://docs.seam.co/latest/developer-tools/webhooks), but it enables you to filter or see events that already took place.',
42759
42773
  operationId: 'eventsListGet',
42760
42774
  parameters: [
42775
+ {
42776
+ in: 'query',
42777
+ name: 'customer_key',
42778
+ schema: {
42779
+ description: 'Customer key for which you want to list events.',
42780
+ type: 'string',
42781
+ },
42782
+ },
42761
42783
  {
42762
42784
  in: 'query',
42763
42785
  name: 'unstable_offset',
@@ -43095,16 +43117,6 @@ export default {
43095
43117
  type: 'array',
43096
43118
  },
43097
43119
  },
43098
- {
43099
- in: 'query',
43100
- name: 'customer_ids',
43101
- schema: {
43102
- description:
43103
- 'IDs of the customers for which you want to list events.',
43104
- items: { format: 'uuid', type: 'string' },
43105
- type: 'array',
43106
- },
43107
- },
43108
43120
  ],
43109
43121
  responses: {
43110
43122
  200: {
@@ -43201,11 +43213,10 @@ export default {
43201
43213
  format: 'uuid',
43202
43214
  type: 'string',
43203
43215
  },
43204
- customer_ids: {
43216
+ customer_key: {
43205
43217
  description:
43206
- 'IDs of the customers for which you want to list events.',
43207
- items: { format: 'uuid', type: 'string' },
43208
- type: 'array',
43218
+ 'Customer key for which you want to list events.',
43219
+ type: 'string',
43209
43220
  },
43210
43221
  device_id: {
43211
43222
  description:
@@ -47713,6 +47724,7 @@ export default {
47713
47724
  created_at: { type: 'string' },
47714
47725
  partner_resource_id: {
47715
47726
  format: 'uuid',
47727
+ nullable: true,
47716
47728
  type: 'string',
47717
47729
  },
47718
47730
  workspace_id: { format: 'uuid', type: 'string' },
@@ -47868,6 +47880,7 @@ export default {
47868
47880
  created_at: { type: 'string' },
47869
47881
  partner_resource_id: {
47870
47882
  format: 'uuid',
47883
+ nullable: true,
47871
47884
  type: 'string',
47872
47885
  },
47873
47886
  workspace_id: { format: 'uuid', type: 'string' },
@@ -50530,6 +50543,14 @@ export default {
50530
50543
  description: 'Returns a list of all spaces.',
50531
50544
  operationId: 'spacesListGet',
50532
50545
  parameters: [
50546
+ {
50547
+ in: 'query',
50548
+ name: 'customer_key',
50549
+ schema: {
50550
+ description: 'Customer key for which you want to list spaces.',
50551
+ type: 'string',
50552
+ },
50553
+ },
50533
50554
  {
50534
50555
  in: 'query',
50535
50556
  name: 'search',
@@ -50614,6 +50635,11 @@ export default {
50614
50635
  'x-draft': 'Needs review.',
50615
50636
  'x-undocumented': 'Only used internally.',
50616
50637
  },
50638
+ customer_key: {
50639
+ description:
50640
+ 'Customer key for which you want to list spaces.',
50641
+ type: 'string',
50642
+ },
50617
50643
  search: {
50618
50644
  description:
50619
50645
  'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
@@ -57330,6 +57356,17 @@ export default {
57330
57356
  get: {
57331
57357
  description: 'Retrieves the customization profile for the workspace.',
57332
57358
  operationId: 'workspacesCustomizationProfilesListGet',
57359
+ parameters: [
57360
+ {
57361
+ in: 'query',
57362
+ name: 'customer_key',
57363
+ schema: {
57364
+ description:
57365
+ 'Customer key for which you want to list customization profiles.',
57366
+ type: 'string',
57367
+ },
57368
+ },
57369
+ ],
57333
57370
  responses: {
57334
57371
  200: {
57335
57372
  content: {
@@ -57372,6 +57409,22 @@ export default {
57372
57409
  post: {
57373
57410
  description: 'Retrieves the customization profile for the workspace.',
57374
57411
  operationId: 'workspacesCustomizationProfilesListPost',
57412
+ requestBody: {
57413
+ content: {
57414
+ 'application/json': {
57415
+ schema: {
57416
+ properties: {
57417
+ customer_key: {
57418
+ description:
57419
+ 'Customer key for which you want to list customization profiles.',
57420
+ type: 'string',
57421
+ },
57422
+ },
57423
+ type: 'object',
57424
+ },
57425
+ },
57426
+ },
57427
+ },
57375
57428
  responses: {
57376
57429
  200: {
57377
57430
  content: {
@@ -13485,6 +13485,8 @@ export type Routes = {
13485
13485
  queryParams: {}
13486
13486
  jsonBody: {}
13487
13487
  commonParams: {
13488
+ /** Customer key for which you want to list access grants. */
13489
+ customer_key?: string | undefined
13488
13490
  /** ID of user identity by which you want to filter the list of Access Grants. */
13489
13491
  user_identity_id?: string | undefined
13490
13492
  /** ID of the access system by which you want to filter the list of Access Grants. */
@@ -43318,6 +43320,8 @@ export type Routes = {
43318
43320
  queryParams: {}
43319
43321
  jsonBody: {}
43320
43322
  commonParams: {
43323
+ /** Customer key for which you want to list events. */
43324
+ customer_key?: string | undefined
43321
43325
  /** Offset for the events that you want to list. */
43322
43326
  unstable_offset?: number | undefined
43323
43327
  /** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. */
@@ -43534,8 +43538,6 @@ export type Routes = {
43534
43538
  limit?: number
43535
43539
  /** IDs of the events that you want to list. */
43536
43540
  event_ids?: string[] | undefined
43537
- /** IDs of the customers for which you want to list events. */
43538
- customer_ids?: string[] | undefined
43539
43541
  }
43540
43542
  formData: {}
43541
43543
  jsonResponse: {
@@ -65866,7 +65868,7 @@ export type Routes = {
65866
65868
  automation_run_id: string
65867
65869
  workspace_id: string
65868
65870
  automation_id: string
65869
- partner_resource_id: string
65871
+ partner_resource_id: string | null
65870
65872
  automation_result?:
65871
65873
  | {
65872
65874
  success: boolean
@@ -71192,6 +71194,8 @@ export type Routes = {
71192
71194
  queryParams: {}
71193
71195
  jsonBody: {}
71194
71196
  commonParams: {
71197
+ /** Customer key for which you want to list spaces. */
71198
+ customer_key?: string | undefined
71195
71199
  /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
71196
71200
  search?: string | undefined
71197
71201
  /** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
@@ -93584,7 +93588,10 @@ export type Routes = {
93584
93588
  method: 'POST' | 'GET'
93585
93589
  queryParams: {}
93586
93590
  jsonBody: {}
93587
- commonParams: {}
93591
+ commonParams: {
93592
+ /** Customer key for which you want to list customization profiles. */
93593
+ customer_key?: string | undefined
93594
+ }
93588
93595
  formData: {}
93589
93596
  jsonResponse: {
93590
93597
  customization_profiles: {