@seamapi/types 1.477.0 → 1.479.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.
@@ -16903,6 +16903,48 @@ export type Routes = {
16903
16903
  /** The actual PIN code for code access methods. */
16904
16904
  code?: string | undefined;
16905
16905
  }[] | undefined;
16906
+ access_grants?: {
16907
+ /** ID of the Seam workspace associated with the Access Grant. */
16908
+ workspace_id: string;
16909
+ /** ID of the Access Grant. */
16910
+ access_grant_id: string;
16911
+ /** Unique key for the access grant within the workspace. */
16912
+ access_grant_key?: string | undefined;
16913
+ /** ID of user identity to which the Access Grant gives access. */
16914
+ user_identity_id: string;
16915
+ /**
16916
+ * @deprecated Use `space_ids`.*/
16917
+ location_ids: string[];
16918
+ /** IDs of the spaces to which the Access Grant gives access. */
16919
+ space_ids: string[];
16920
+ /** Access methods that the user requested for the Access Grant. */
16921
+ requested_access_methods: {
16922
+ /** Display name of the access method. */
16923
+ display_name: string;
16924
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
16925
+ mode: 'code' | 'card' | 'mobile_key';
16926
+ /** Date and time at which the requested access method was added to the Access Grant. */
16927
+ created_at: string;
16928
+ /** IDs of the access methods created for the requested access method. */
16929
+ created_access_method_ids: string[];
16930
+ }[];
16931
+ /** IDs of the access methods created for the Access Grant. */
16932
+ access_method_ids: string[];
16933
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
16934
+ client_session_token?: string | undefined;
16935
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
16936
+ name: string | null;
16937
+ /** Display name of the Access Grant. */
16938
+ display_name: string;
16939
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
16940
+ instant_key_url?: string | undefined;
16941
+ /** Date and time at which the Access Grant was created. */
16942
+ created_at: string;
16943
+ /** Date and time at which the Access Grant starts. */
16944
+ starts_at: string;
16945
+ /** Date and time at which the Access Grant ends. */
16946
+ ends_at: string | null;
16947
+ }[] | undefined;
16906
16948
  };
16907
16949
  };
16908
16950
  };
@@ -75710,6 +75752,7 @@ export type Routes = {
75710
75752
  method: 'POST';
75711
75753
  queryParams: {};
75712
75754
  jsonBody: {
75755
+ name?: string | null;
75713
75756
  primary_color: string;
75714
75757
  secondary_color: string;
75715
75758
  };
@@ -75718,8 +75761,9 @@ export type Routes = {
75718
75761
  jsonResponse: {
75719
75762
  /** A customization profile. */
75720
75763
  customization_profile: {
75721
- customization_profile_id: string;
75722
75764
  workspace_id: string;
75765
+ name: string | null;
75766
+ customization_profile_id: string;
75723
75767
  created_at: string;
75724
75768
  logo_url?: string | undefined;
75725
75769
  primary_color?: string | undefined;
@@ -75739,8 +75783,9 @@ export type Routes = {
75739
75783
  jsonResponse: {
75740
75784
  /** A customization profile. */
75741
75785
  customization_profile: {
75742
- customization_profile_id: string;
75743
75786
  workspace_id: string;
75787
+ name: string | null;
75788
+ customization_profile_id: string;
75744
75789
  created_at: string;
75745
75790
  logo_url?: string | undefined;
75746
75791
  primary_color?: string | undefined;
@@ -75757,8 +75802,9 @@ export type Routes = {
75757
75802
  formData: {};
75758
75803
  jsonResponse: {
75759
75804
  customization_profiles: {
75760
- customization_profile_id: string;
75761
75805
  workspace_id: string;
75806
+ name: string | null;
75807
+ customization_profile_id: string;
75762
75808
  created_at: string;
75763
75809
  logo_url?: string | undefined;
75764
75810
  primary_color?: string | undefined;
@@ -75772,6 +75818,7 @@ export type Routes = {
75772
75818
  queryParams: {};
75773
75819
  jsonBody: {
75774
75820
  customization_profile_id: string;
75821
+ name?: (string | undefined) | null;
75775
75822
  primary_color?: string | undefined;
75776
75823
  secondary_color?: string | undefined;
75777
75824
  };
@@ -79551,6 +79598,48 @@ export type Routes = {
79551
79598
  /** The actual PIN code for code access methods. */
79552
79599
  code?: string | undefined;
79553
79600
  }[] | undefined;
79601
+ access_grants?: {
79602
+ /** ID of the Seam workspace associated with the Access Grant. */
79603
+ workspace_id: string;
79604
+ /** ID of the Access Grant. */
79605
+ access_grant_id: string;
79606
+ /** Unique key for the access grant within the workspace. */
79607
+ access_grant_key?: string | undefined;
79608
+ /** ID of user identity to which the Access Grant gives access. */
79609
+ user_identity_id: string;
79610
+ /**
79611
+ * @deprecated Use `space_ids`.*/
79612
+ location_ids: string[];
79613
+ /** IDs of the spaces to which the Access Grant gives access. */
79614
+ space_ids: string[];
79615
+ /** Access methods that the user requested for the Access Grant. */
79616
+ requested_access_methods: {
79617
+ /** Display name of the access method. */
79618
+ display_name: string;
79619
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
79620
+ mode: 'code' | 'card' | 'mobile_key';
79621
+ /** Date and time at which the requested access method was added to the Access Grant. */
79622
+ created_at: string;
79623
+ /** IDs of the access methods created for the requested access method. */
79624
+ created_access_method_ids: string[];
79625
+ }[];
79626
+ /** IDs of the access methods created for the Access Grant. */
79627
+ access_method_ids: string[];
79628
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
79629
+ client_session_token?: string | undefined;
79630
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
79631
+ name: string | null;
79632
+ /** Display name of the Access Grant. */
79633
+ display_name: string;
79634
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
79635
+ instant_key_url?: string | undefined;
79636
+ /** Date and time at which the Access Grant was created. */
79637
+ created_at: string;
79638
+ /** Date and time at which the Access Grant starts. */
79639
+ starts_at: string;
79640
+ /** Date and time at which the Access Grant ends. */
79641
+ ends_at: string | null;
79642
+ }[] | undefined;
79554
79643
  };
79555
79644
  };
79556
79645
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.477.0",
3
+ "version": "1.479.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -1,5 +1,6 @@
1
1
  import { z } from 'zod'
2
2
 
3
+ import { access_grant } from './access-grants/access-grant.js'
3
4
  import { access_method } from './access-grants/access-method.js'
4
5
  import {
5
6
  acs_access_group,
@@ -65,6 +66,7 @@ export const workspaces_batch = z
65
66
  unmanaged_devices: unmanaged_device.array().optional(),
66
67
  connect_webviews: connect_webview.array().optional(),
67
68
  access_methods: access_method.array().optional(),
69
+ access_grants: access_grant.array().optional(),
68
70
  })
69
71
  .describe('A batch of workspace resources.')
70
72
 
@@ -92,6 +94,7 @@ export const batch = z
92
94
  unmanaged_devices: unmanaged_device.array().optional(),
93
95
  connect_webviews: connect_webview.array().optional(),
94
96
  access_methods: access_method.array().optional(),
97
+ access_grants: access_grant.array().optional(),
95
98
  })
96
99
  .describe('A batch of workspace resources.')
97
100
 
@@ -1,8 +1,9 @@
1
1
  import { z } from 'zod'
2
2
 
3
3
  export const customization_profile = z.object({
4
- customization_profile_id: z.string().uuid(),
5
4
  workspace_id: z.string().uuid(),
5
+ name: z.string().nullable(),
6
+ customization_profile_id: z.string().uuid(),
6
7
  created_at: z.string().datetime(),
7
8
  logo_url: z.string().url().optional(),
8
9
  primary_color: z.string().optional(),
@@ -29150,6 +29150,10 @@ export default {
29150
29150
  batch: {
29151
29151
  description: 'A batch of workspace resources.',
29152
29152
  properties: {
29153
+ access_grants: {
29154
+ items: { $ref: '#/components/schemas/access_grant' },
29155
+ type: 'array',
29156
+ },
29153
29157
  access_methods: {
29154
29158
  items: { $ref: '#/components/schemas/access_method' },
29155
29159
  type: 'array',
@@ -29313,6 +29317,10 @@ export default {
29313
29317
  batch: {
29314
29318
  description: 'A batch of workspace resources.',
29315
29319
  properties: {
29320
+ access_grants: {
29321
+ items: { $ref: '#/components/schemas/access_grant' },
29322
+ type: 'array',
29323
+ },
29316
29324
  access_methods: {
29317
29325
  items: { $ref: '#/components/schemas/access_method' },
29318
29326
  type: 'array',
@@ -56066,6 +56074,7 @@ export default {
56066
56074
  'application/json': {
56067
56075
  schema: {
56068
56076
  properties: {
56077
+ name: { default: null, nullable: true, type: 'string' },
56069
56078
  primary_color: { type: 'string' },
56070
56079
  secondary_color: { type: 'string' },
56071
56080
  },
@@ -56090,13 +56099,15 @@ export default {
56090
56099
  type: 'string',
56091
56100
  },
56092
56101
  logo_url: { format: 'uri', type: 'string' },
56102
+ name: { nullable: true, type: 'string' },
56093
56103
  primary_color: { type: 'string' },
56094
56104
  secondary_color: { type: 'string' },
56095
56105
  workspace_id: { format: 'uuid', type: 'string' },
56096
56106
  },
56097
56107
  required: [
56098
- 'customization_profile_id',
56099
56108
  'workspace_id',
56109
+ 'name',
56110
+ 'customization_profile_id',
56100
56111
  'created_at',
56101
56112
  ],
56102
56113
  type: 'object',
@@ -56154,13 +56165,15 @@ export default {
56154
56165
  type: 'string',
56155
56166
  },
56156
56167
  logo_url: { format: 'uri', type: 'string' },
56168
+ name: { nullable: true, type: 'string' },
56157
56169
  primary_color: { type: 'string' },
56158
56170
  secondary_color: { type: 'string' },
56159
56171
  workspace_id: { format: 'uuid', type: 'string' },
56160
56172
  },
56161
56173
  required: [
56162
- 'customization_profile_id',
56163
56174
  'workspace_id',
56175
+ 'name',
56176
+ 'customization_profile_id',
56164
56177
  'created_at',
56165
56178
  ],
56166
56179
  type: 'object',
@@ -56221,13 +56234,15 @@ export default {
56221
56234
  type: 'string',
56222
56235
  },
56223
56236
  logo_url: { format: 'uri', type: 'string' },
56237
+ name: { nullable: true, type: 'string' },
56224
56238
  primary_color: { type: 'string' },
56225
56239
  secondary_color: { type: 'string' },
56226
56240
  workspace_id: { format: 'uuid', type: 'string' },
56227
56241
  },
56228
56242
  required: [
56229
- 'customization_profile_id',
56230
56243
  'workspace_id',
56244
+ 'name',
56245
+ 'customization_profile_id',
56231
56246
  'created_at',
56232
56247
  ],
56233
56248
  type: 'object',
@@ -56278,13 +56293,15 @@ export default {
56278
56293
  type: 'string',
56279
56294
  },
56280
56295
  logo_url: { format: 'uri', type: 'string' },
56296
+ name: { nullable: true, type: 'string' },
56281
56297
  primary_color: { type: 'string' },
56282
56298
  secondary_color: { type: 'string' },
56283
56299
  workspace_id: { format: 'uuid', type: 'string' },
56284
56300
  },
56285
56301
  required: [
56286
- 'customization_profile_id',
56287
56302
  'workspace_id',
56303
+ 'name',
56304
+ 'customization_profile_id',
56288
56305
  'created_at',
56289
56306
  ],
56290
56307
  type: 'object',
@@ -56335,13 +56352,15 @@ export default {
56335
56352
  type: 'string',
56336
56353
  },
56337
56354
  logo_url: { format: 'uri', type: 'string' },
56355
+ name: { nullable: true, type: 'string' },
56338
56356
  primary_color: { type: 'string' },
56339
56357
  secondary_color: { type: 'string' },
56340
56358
  workspace_id: { format: 'uuid', type: 'string' },
56341
56359
  },
56342
56360
  required: [
56343
- 'customization_profile_id',
56344
56361
  'workspace_id',
56362
+ 'name',
56363
+ 'customization_profile_id',
56345
56364
  'created_at',
56346
56365
  ],
56347
56366
  type: 'object',
@@ -56384,6 +56403,7 @@ export default {
56384
56403
  schema: {
56385
56404
  properties: {
56386
56405
  customization_profile_id: { format: 'uuid', type: 'string' },
56406
+ name: { nullable: true, type: 'string' },
56387
56407
  primary_color: { type: 'string' },
56388
56408
  secondary_color: { type: 'string' },
56389
56409
  },
@@ -56427,6 +56447,7 @@ export default {
56427
56447
  schema: {
56428
56448
  properties: {
56429
56449
  customization_profile_id: { format: 'uuid', type: 'string' },
56450
+ name: { nullable: true, type: 'string' },
56430
56451
  primary_color: { type: 'string' },
56431
56452
  secondary_color: { type: 'string' },
56432
56453
  },
@@ -56514,6 +56535,10 @@ export default {
56514
56535
  batch: {
56515
56536
  description: 'A batch of workspace resources.',
56516
56537
  properties: {
56538
+ access_grants: {
56539
+ items: { $ref: '#/components/schemas/access_grant' },
56540
+ type: 'array',
56541
+ },
56517
56542
  access_methods: {
56518
56543
  items: { $ref: '#/components/schemas/access_method' },
56519
56544
  type: 'array',
@@ -56652,6 +56677,10 @@ export default {
56652
56677
  batch: {
56653
56678
  description: 'A batch of workspace resources.',
56654
56679
  properties: {
56680
+ access_grants: {
56681
+ items: { $ref: '#/components/schemas/access_grant' },
56682
+ type: 'array',
56683
+ },
56655
56684
  access_methods: {
56656
56685
  items: { $ref: '#/components/schemas/access_method' },
56657
56686
  type: 'array',
@@ -19578,6 +19578,50 @@ export type Routes = {
19578
19578
  code?: string | undefined
19579
19579
  }[]
19580
19580
  | undefined
19581
+ access_grants?:
19582
+ | {
19583
+ /** ID of the Seam workspace associated with the Access Grant. */
19584
+ workspace_id: string
19585
+ /** ID of the Access Grant. */
19586
+ access_grant_id: string
19587
+ /** Unique key for the access grant within the workspace. */
19588
+ access_grant_key?: string | undefined
19589
+ /** ID of user identity to which the Access Grant gives access. */
19590
+ user_identity_id: string
19591
+ /**
19592
+ * @deprecated Use `space_ids`.*/
19593
+ location_ids: string[]
19594
+ /** IDs of the spaces to which the Access Grant gives access. */
19595
+ space_ids: string[]
19596
+ /** Access methods that the user requested for the Access Grant. */
19597
+ requested_access_methods: {
19598
+ /** Display name of the access method. */
19599
+ display_name: string
19600
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
19601
+ mode: 'code' | 'card' | 'mobile_key'
19602
+ /** Date and time at which the requested access method was added to the Access Grant. */
19603
+ created_at: string
19604
+ /** IDs of the access methods created for the requested access method. */
19605
+ created_access_method_ids: string[]
19606
+ }[]
19607
+ /** IDs of the access methods created for the Access Grant. */
19608
+ access_method_ids: string[]
19609
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
19610
+ client_session_token?: string | undefined
19611
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
19612
+ name: string | null
19613
+ /** Display name of the Access Grant. */
19614
+ display_name: string
19615
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
19616
+ instant_key_url?: string | undefined
19617
+ /** Date and time at which the Access Grant was created. */
19618
+ created_at: string
19619
+ /** Date and time at which the Access Grant starts. */
19620
+ starts_at: string
19621
+ /** Date and time at which the Access Grant ends. */
19622
+ ends_at: string | null
19623
+ }[]
19624
+ | undefined
19581
19625
  }
19582
19626
  }
19583
19627
  }
@@ -89855,6 +89899,7 @@ export type Routes = {
89855
89899
  method: 'POST'
89856
89900
  queryParams: {}
89857
89901
  jsonBody: {
89902
+ name?: string | null
89858
89903
  primary_color: string
89859
89904
  secondary_color: string
89860
89905
  }
@@ -89863,8 +89908,9 @@ export type Routes = {
89863
89908
  jsonResponse: {
89864
89909
  /** A customization profile. */
89865
89910
  customization_profile: {
89866
- customization_profile_id: string
89867
89911
  workspace_id: string
89912
+ name: string | null
89913
+ customization_profile_id: string
89868
89914
  created_at: string
89869
89915
  logo_url?: string | undefined
89870
89916
  primary_color?: string | undefined
@@ -89884,8 +89930,9 @@ export type Routes = {
89884
89930
  jsonResponse: {
89885
89931
  /** A customization profile. */
89886
89932
  customization_profile: {
89887
- customization_profile_id: string
89888
89933
  workspace_id: string
89934
+ name: string | null
89935
+ customization_profile_id: string
89889
89936
  created_at: string
89890
89937
  logo_url?: string | undefined
89891
89938
  primary_color?: string | undefined
@@ -89902,8 +89949,9 @@ export type Routes = {
89902
89949
  formData: {}
89903
89950
  jsonResponse: {
89904
89951
  customization_profiles: {
89905
- customization_profile_id: string
89906
89952
  workspace_id: string
89953
+ name: string | null
89954
+ customization_profile_id: string
89907
89955
  created_at: string
89908
89956
  logo_url?: string | undefined
89909
89957
  primary_color?: string | undefined
@@ -89917,6 +89965,7 @@ export type Routes = {
89917
89965
  queryParams: {}
89918
89966
  jsonBody: {
89919
89967
  customization_profile_id: string
89968
+ name?: (string | undefined) | null
89920
89969
  primary_color?: string | undefined
89921
89970
  secondary_color?: string | undefined
89922
89971
  }
@@ -94519,6 +94568,50 @@ export type Routes = {
94519
94568
  code?: string | undefined
94520
94569
  }[]
94521
94570
  | undefined
94571
+ access_grants?:
94572
+ | {
94573
+ /** ID of the Seam workspace associated with the Access Grant. */
94574
+ workspace_id: string
94575
+ /** ID of the Access Grant. */
94576
+ access_grant_id: string
94577
+ /** Unique key for the access grant within the workspace. */
94578
+ access_grant_key?: string | undefined
94579
+ /** ID of user identity to which the Access Grant gives access. */
94580
+ user_identity_id: string
94581
+ /**
94582
+ * @deprecated Use `space_ids`.*/
94583
+ location_ids: string[]
94584
+ /** IDs of the spaces to which the Access Grant gives access. */
94585
+ space_ids: string[]
94586
+ /** Access methods that the user requested for the Access Grant. */
94587
+ requested_access_methods: {
94588
+ /** Display name of the access method. */
94589
+ display_name: string
94590
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
94591
+ mode: 'code' | 'card' | 'mobile_key'
94592
+ /** Date and time at which the requested access method was added to the Access Grant. */
94593
+ created_at: string
94594
+ /** IDs of the access methods created for the requested access method. */
94595
+ created_access_method_ids: string[]
94596
+ }[]
94597
+ /** IDs of the access methods created for the Access Grant. */
94598
+ access_method_ids: string[]
94599
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
94600
+ client_session_token?: string | undefined
94601
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
94602
+ name: string | null
94603
+ /** Display name of the Access Grant. */
94604
+ display_name: string
94605
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
94606
+ instant_key_url?: string | undefined
94607
+ /** Date and time at which the Access Grant was created. */
94608
+ created_at: string
94609
+ /** Date and time at which the Access Grant starts. */
94610
+ starts_at: string
94611
+ /** Date and time at which the Access Grant ends. */
94612
+ ends_at: string | null
94613
+ }[]
94614
+ | undefined
94522
94615
  }
94523
94616
  }
94524
94617
  }