@seamapi/types 1.409.0 → 1.409.1

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.
@@ -56811,7 +56811,13 @@ export interface Routes {
56811
56811
  } | {
56812
56812
  building_block_type: 'organize_spaces';
56813
56813
  customer_key: string;
56814
- collection_key: string;
56814
+ /** Optional list of partner resources to include in the magic link. */
56815
+ partner_resources?: Array<{
56816
+ partner_resource_key: string;
56817
+ name: string;
56818
+ description?: string | undefined;
56819
+ custom_metadata?: Record<string, string> | undefined;
56820
+ }> | undefined;
56815
56821
  };
56816
56822
  formData: {};
56817
56823
  jsonResponse: {
@@ -56854,12 +56860,12 @@ export interface Routes {
56854
56860
  jsonBody: {};
56855
56861
  commonParams: {
56856
56862
  customer_key: string;
56857
- partner_resources: Array<{
56863
+ partner_resources?: Array<{
56858
56864
  partner_resource_key: string;
56859
56865
  name: string;
56860
56866
  description?: string | undefined;
56861
56867
  custom_metadata?: Record<string, string> | undefined;
56862
- }>;
56868
+ }> | undefined;
56863
56869
  };
56864
56870
  formData: {};
56865
56871
  jsonResponse: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.409.0",
3
+ "version": "1.409.1",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -13,7 +13,7 @@ export const access_grant_created_event = access_grant_event.extend({
13
13
  event_type: z.literal('access_grant.created'),
14
14
  }).describe(`
15
15
  ---
16
- route_path: /unstable_access_grants
16
+ route_path: /access_grants
17
17
  ---
18
18
  An access grant was created.
19
19
  `)
@@ -24,7 +24,7 @@ export const access_grant_deleted_event = access_grant_event.extend({
24
24
  event_type: z.literal('access_grant.deleted'),
25
25
  }).describe(`
26
26
  ---
27
- route_path: /unstable_access_grants
27
+ route_path: /access_grants
28
28
  ---
29
29
  An access grant was deleted.
30
30
  `)
@@ -38,7 +38,7 @@ export const access_grant_access_granted_to_all_doors_event =
38
38
  event_type: z.literal('access_grant.access_granted_to_all_doors'),
39
39
  }).describe(`
40
40
  ---
41
- route_path: /unstable_access_grants
41
+ route_path: /access_grants
42
42
  ---
43
43
  All access requested for an access grant was successfully granted.
44
44
  `)
@@ -60,7 +60,7 @@ export const access_grant_access_granted_to_door_event =
60
60
  acs_entrance_id,
61
61
  }).describe(`
62
62
  ---
63
- route_path: /unstable_access_grants
63
+ route_path: /access_grants
64
64
  ---
65
65
  Access requested as part of an access grant to a particular door was successfully granted.
66
66
  `)
@@ -76,7 +76,7 @@ export const access_grant_access_to_door_lost_event = access_grant_event.extend(
76
76
  },
77
77
  ).describe(`
78
78
  ---
79
- route_path: /unstable_access_grants
79
+ route_path: /access_grants
80
80
  ---
81
81
  Access to a particular door that was requested as part of an access grant was lost.
82
82
  `)
@@ -13,7 +13,7 @@ export const access_method_issued_event = access_method_event.extend({
13
13
  event_type: z.literal('access_method.issued'),
14
14
  }).describe(`
15
15
  ---
16
- route_path: /unstable_access_methods
16
+ route_path: /access_methods
17
17
  ---
18
18
  An access method was issued.
19
19
  `)
@@ -25,7 +25,7 @@ export const access_method_card_encoding_required_event =
25
25
  event_type: z.literal('access_method.card_encoding_required'),
26
26
  }).describe(`
27
27
  ---
28
- route_path: /unstable_access_methods
28
+ route_path: /access_methods
29
29
  ---
30
30
  An access method representing a physical card requires encoding.
31
31
  `)
@@ -38,7 +38,7 @@ export const access_method_revoked_event = access_method_event.extend({
38
38
  event_type: z.literal('access_method.revoked'),
39
39
  }).describe(`
40
40
  ---
41
- route_path: /unstable_access_methods
41
+ route_path: /access_methods
42
42
  ---
43
43
  An access method was revoked.
44
44
  `)
@@ -47,7 +47,7 @@ export const access_method_deleted_event = access_method_event.extend({
47
47
  event_type: z.literal('access_method.deleted'),
48
48
  }).describe(`
49
49
  ---
50
- route_path: /unstable_access_methods
50
+ route_path: /access_methods
51
51
  ---
52
52
  An access method was deleted.
53
53
  `)
@@ -40,3 +40,5 @@ export const typed_partner_resource = z.object({
40
40
  route_path: /unstable_partner/resources
41
41
  ---
42
42
  `)
43
+
44
+ export type TypedPartnerResource = z.infer<typeof typed_partner_resource>
@@ -12080,7 +12080,7 @@ export default {
12080
12080
  'event_type',
12081
12081
  ],
12082
12082
  type: 'object',
12083
- 'x-route-path': '/unstable_access_grants',
12083
+ 'x-route-path': '/access_grants',
12084
12084
  },
12085
12085
  {
12086
12086
  description: 'An access grant was deleted.',
@@ -12121,7 +12121,7 @@ export default {
12121
12121
  'event_type',
12122
12122
  ],
12123
12123
  type: 'object',
12124
- 'x-route-path': '/unstable_access_grants',
12124
+ 'x-route-path': '/access_grants',
12125
12125
  },
12126
12126
  {
12127
12127
  description:
@@ -12166,7 +12166,7 @@ export default {
12166
12166
  'event_type',
12167
12167
  ],
12168
12168
  type: 'object',
12169
- 'x-route-path': '/unstable_access_grants',
12169
+ 'x-route-path': '/access_grants',
12170
12170
  },
12171
12171
  {
12172
12172
  description:
@@ -12218,7 +12218,7 @@ export default {
12218
12218
  'acs_entrance_id',
12219
12219
  ],
12220
12220
  type: 'object',
12221
- 'x-route-path': '/unstable_access_grants',
12221
+ 'x-route-path': '/access_grants',
12222
12222
  },
12223
12223
  {
12224
12224
  description:
@@ -12270,7 +12270,7 @@ export default {
12270
12270
  'acs_entrance_id',
12271
12271
  ],
12272
12272
  type: 'object',
12273
- 'x-route-path': '/unstable_access_grants',
12273
+ 'x-route-path': '/access_grants',
12274
12274
  },
12275
12275
  {
12276
12276
  description: 'An access method was issued.',
@@ -12311,7 +12311,7 @@ export default {
12311
12311
  'event_type',
12312
12312
  ],
12313
12313
  type: 'object',
12314
- 'x-route-path': '/unstable_access_methods',
12314
+ 'x-route-path': '/access_methods',
12315
12315
  },
12316
12316
  {
12317
12317
  description: 'An access method was revoked.',
@@ -12352,7 +12352,7 @@ export default {
12352
12352
  'event_type',
12353
12353
  ],
12354
12354
  type: 'object',
12355
- 'x-route-path': '/unstable_access_methods',
12355
+ 'x-route-path': '/access_methods',
12356
12356
  },
12357
12357
  {
12358
12358
  description:
@@ -12397,7 +12397,7 @@ export default {
12397
12397
  'event_type',
12398
12398
  ],
12399
12399
  type: 'object',
12400
- 'x-route-path': '/unstable_access_methods',
12400
+ 'x-route-path': '/access_methods',
12401
12401
  },
12402
12402
  {
12403
12403
  description: 'An access method was deleted.',
@@ -12438,7 +12438,7 @@ export default {
12438
12438
  'event_type',
12439
12439
  ],
12440
12440
  type: 'object',
12441
- 'x-route-path': '/unstable_access_methods',
12441
+ 'x-route-path': '/access_methods',
12442
12442
  },
12443
12443
  {
12444
12444
  description:
@@ -22956,12 +22956,12 @@ export default {
22956
22956
  ],
22957
22957
  summary: '/access_grants/create',
22958
22958
  tags: [],
22959
+ 'x-draft': 'Early access.',
22959
22960
  'x-fern-sdk-group-name': ['access_grants'],
22960
22961
  'x-fern-sdk-method-name': 'create',
22961
22962
  'x-fern-sdk-return-value': 'access_grant',
22962
22963
  'x-response-key': 'access_grant',
22963
22964
  'x-title': 'Create an Access Grant',
22964
- 'x-undocumented': 'Unreleased.',
22965
22965
  },
22966
22966
  },
22967
22967
  '/access_grants/delete': {
@@ -23009,11 +23009,11 @@ export default {
23009
23009
  ],
23010
23010
  summary: '/access_grants/delete',
23011
23011
  tags: [],
23012
+ 'x-draft': 'Early access.',
23012
23013
  'x-fern-sdk-group-name': ['access_grants'],
23013
23014
  'x-fern-sdk-method-name': 'delete',
23014
23015
  'x-response-key': null,
23015
23016
  'x-title': 'Delete an Access Grant',
23016
- 'x-undocumented': 'Unreleased.',
23017
23017
  },
23018
23018
  },
23019
23019
  '/access_grants/get': {
@@ -23165,12 +23165,12 @@ export default {
23165
23165
  ],
23166
23166
  summary: '/access_grants/get',
23167
23167
  tags: [],
23168
+ 'x-draft': 'Early access.',
23168
23169
  'x-fern-sdk-group-name': ['access_grants'],
23169
23170
  'x-fern-sdk-method-name': 'get',
23170
23171
  'x-fern-sdk-return-value': 'access_grant',
23171
23172
  'x-response-key': 'access_grant',
23172
23173
  'x-title': 'Get an Access Grant',
23173
- 'x-undocumented': 'Unreleased.',
23174
23174
  },
23175
23175
  },
23176
23176
  '/access_grants/list': {
@@ -23349,12 +23349,12 @@ export default {
23349
23349
  ],
23350
23350
  summary: '/access_grants/list',
23351
23351
  tags: [],
23352
+ 'x-draft': 'Early access.',
23352
23353
  'x-fern-sdk-group-name': ['access_grants'],
23353
23354
  'x-fern-sdk-method-name': 'list',
23354
23355
  'x-fern-sdk-return-value': 'access_grants',
23355
23356
  'x-response-key': 'access_grants',
23356
23357
  'x-title': 'List Access Grants',
23357
- 'x-undocumented': 'Unreleased.',
23358
23358
  },
23359
23359
  },
23360
23360
  '/access_methods/delete': {
@@ -23401,11 +23401,11 @@ export default {
23401
23401
  ],
23402
23402
  summary: '/access_methods/delete',
23403
23403
  tags: [],
23404
+ 'x-draft': 'Early access.',
23404
23405
  'x-fern-sdk-group-name': ['access_methods'],
23405
23406
  'x-fern-sdk-method-name': 'delete',
23406
23407
  'x-response-key': null,
23407
23408
  'x-title': 'Delete an Access Method',
23408
- 'x-undocumented': 'Unreleased.',
23409
23409
  },
23410
23410
  },
23411
23411
  '/access_methods/get': {
@@ -23511,12 +23511,12 @@ export default {
23511
23511
  ],
23512
23512
  summary: '/access_methods/get',
23513
23513
  tags: [],
23514
+ 'x-draft': 'Early access.',
23514
23515
  'x-fern-sdk-group-name': ['access_methods'],
23515
23516
  'x-fern-sdk-method-name': 'get',
23516
23517
  'x-fern-sdk-return-value': 'access_method',
23517
23518
  'x-response-key': 'access_method',
23518
23519
  'x-title': 'Get an Access Method',
23519
- 'x-undocumented': 'Unreleased.',
23520
23520
  },
23521
23521
  },
23522
23522
  '/access_methods/list': {
@@ -23627,12 +23627,12 @@ export default {
23627
23627
  ],
23628
23628
  summary: '/access_methods/list',
23629
23629
  tags: [],
23630
+ 'x-draft': 'Early access.',
23630
23631
  'x-fern-sdk-group-name': ['access_methods'],
23631
23632
  'x-fern-sdk-method-name': 'list',
23632
23633
  'x-fern-sdk-return-value': 'access_methods',
23633
23634
  'x-response-key': 'access_methods',
23634
23635
  'x-title': 'List Access Methods',
23635
- 'x-undocumented': 'Unreleased.',
23636
23636
  },
23637
23637
  },
23638
23638
  '/acs/access_groups/add_user': {
@@ -34433,6 +34433,7 @@ export default {
34433
34433
  ],
34434
34434
  summary: '/spaces/add_acs_entrances',
34435
34435
  tags: [],
34436
+ 'x-draft': 'Early access.',
34436
34437
  'x-fern-sdk-group-name': ['spaces'],
34437
34438
  'x-fern-sdk-method-name': 'add_acs_entrances',
34438
34439
  'x-response-key': null,
@@ -34482,6 +34483,7 @@ export default {
34482
34483
  ],
34483
34484
  summary: '/spaces/add_acs_entrances',
34484
34485
  tags: [],
34486
+ 'x-draft': 'Early access.',
34485
34487
  'x-fern-ignore': true,
34486
34488
  'x-response-key': null,
34487
34489
  'x-title': 'Add ACS Entrances',
@@ -34532,6 +34534,7 @@ export default {
34532
34534
  ],
34533
34535
  summary: '/spaces/add_devices',
34534
34536
  tags: [],
34537
+ 'x-draft': 'Early access.',
34535
34538
  'x-fern-sdk-group-name': ['spaces'],
34536
34539
  'x-fern-sdk-method-name': 'add_devices',
34537
34540
  'x-response-key': null,
@@ -34581,6 +34584,7 @@ export default {
34581
34584
  ],
34582
34585
  summary: '/spaces/add_devices',
34583
34586
  tags: [],
34587
+ 'x-draft': 'Early access.',
34584
34588
  'x-fern-ignore': true,
34585
34589
  'x-response-key': null,
34586
34590
  'x-title': 'Add Space Devices',
@@ -34637,6 +34641,7 @@ export default {
34637
34641
  ],
34638
34642
  summary: '/spaces/create',
34639
34643
  tags: [],
34644
+ 'x-draft': 'Early access.',
34640
34645
  'x-fern-sdk-group-name': ['spaces'],
34641
34646
  'x-fern-sdk-method-name': 'create',
34642
34647
  'x-fern-sdk-return-value': 'space',
@@ -34769,6 +34774,7 @@ export default {
34769
34774
  ],
34770
34775
  summary: '/spaces/list',
34771
34776
  tags: [],
34777
+ 'x-draft': 'Early access.',
34772
34778
  'x-fern-ignore': true,
34773
34779
  'x-response-key': 'spaces',
34774
34780
  'x-title': 'List Spaces',
@@ -34805,6 +34811,7 @@ export default {
34805
34811
  ],
34806
34812
  summary: '/spaces/list',
34807
34813
  tags: [],
34814
+ 'x-draft': 'Early access.',
34808
34815
  'x-fern-sdk-group-name': ['spaces'],
34809
34816
  'x-fern-sdk-method-name': 'list',
34810
34817
  'x-fern-sdk-return-value': 'spaces',
@@ -34856,6 +34863,7 @@ export default {
34856
34863
  ],
34857
34864
  summary: '/spaces/remove_acs_entrances',
34858
34865
  tags: [],
34866
+ 'x-draft': 'Early access.',
34859
34867
  'x-fern-sdk-group-name': ['spaces'],
34860
34868
  'x-fern-sdk-method-name': 'remove_acs_entrances',
34861
34869
  'x-response-key': null,
@@ -34906,6 +34914,7 @@ export default {
34906
34914
  ],
34907
34915
  summary: '/spaces/remove_devices',
34908
34916
  tags: [],
34917
+ 'x-draft': 'Early access.',
34909
34918
  'x-fern-sdk-group-name': ['spaces'],
34910
34919
  'x-fern-sdk-method-name': 'remove_devices',
34911
34920
  'x-response-key': null,
@@ -34956,6 +34965,7 @@ export default {
34956
34965
  ],
34957
34966
  summary: '/spaces/update',
34958
34967
  tags: [],
34968
+ 'x-draft': 'Early access.',
34959
34969
  'x-fern-ignore': true,
34960
34970
  'x-response-key': 'space',
34961
34971
  'x-title': 'Update Space',
@@ -35003,6 +35013,7 @@ export default {
35003
35013
  ],
35004
35014
  summary: '/spaces/update',
35005
35015
  tags: [],
35016
+ 'x-draft': 'Early access.',
35006
35017
  'x-fern-sdk-group-name': ['spaces'],
35007
35018
  'x-fern-sdk-method-name': 'update',
35008
35019
  'x-fern-sdk-return-value': 'space',
@@ -39654,14 +39665,29 @@ export default {
39654
39665
  enum: ['organize_spaces'],
39655
39666
  type: 'string',
39656
39667
  },
39657
- collection_key: { type: 'string' },
39658
39668
  customer_key: { type: 'string' },
39669
+ partner_resources: {
39670
+ description:
39671
+ 'Optional list of partner resources to include in the magic link.',
39672
+ items: {
39673
+ properties: {
39674
+ custom_metadata: {
39675
+ additionalProperties: { type: 'string' },
39676
+ type: 'object',
39677
+ },
39678
+ description: { type: 'string' },
39679
+ name: { type: 'string' },
39680
+ partner_resource_key: { type: 'string' },
39681
+ },
39682
+ required: ['partner_resource_key', 'name'],
39683
+ type: 'object',
39684
+ 'x-route-path': '/unstable_partner/resources',
39685
+ 'x-undocumented': 'Unreleased.',
39686
+ },
39687
+ type: 'array',
39688
+ },
39659
39689
  },
39660
- required: [
39661
- 'building_block_type',
39662
- 'customer_key',
39663
- 'collection_key',
39664
- ],
39690
+ required: ['building_block_type', 'customer_key'],
39665
39691
  type: 'object',
39666
39692
  },
39667
39693
  ],
@@ -39780,11 +39806,10 @@ export default {
39780
39806
  'x-route-path': '/unstable_partner/resources',
39781
39807
  'x-undocumented': 'Unreleased.',
39782
39808
  },
39783
- minItems: 1,
39784
39809
  type: 'array',
39785
39810
  },
39786
39811
  },
39787
- required: ['customer_key', 'partner_resources'],
39812
+ required: ['customer_key'],
39788
39813
  type: 'object',
39789
39814
  },
39790
39815
  },
@@ -66778,7 +66778,15 @@ export interface Routes {
66778
66778
  | {
66779
66779
  building_block_type: 'organize_spaces'
66780
66780
  customer_key: string
66781
- collection_key: string
66781
+ /** Optional list of partner resources to include in the magic link. */
66782
+ partner_resources?:
66783
+ | Array<{
66784
+ partner_resource_key: string
66785
+ name: string
66786
+ description?: string | undefined
66787
+ custom_metadata?: Record<string, string> | undefined
66788
+ }>
66789
+ | undefined
66782
66790
  }
66783
66791
  formData: {}
66784
66792
  jsonResponse: {
@@ -66827,12 +66835,14 @@ export interface Routes {
66827
66835
  jsonBody: {}
66828
66836
  commonParams: {
66829
66837
  customer_key: string
66830
- partner_resources: Array<{
66831
- partner_resource_key: string
66832
- name: string
66833
- description?: string | undefined
66834
- custom_metadata?: Record<string, string> | undefined
66835
- }>
66838
+ partner_resources?:
66839
+ | Array<{
66840
+ partner_resource_key: string
66841
+ name: string
66842
+ description?: string | undefined
66843
+ custom_metadata?: Record<string, string> | undefined
66844
+ }>
66845
+ | undefined
66836
66846
  }
66837
66847
  formData: {}
66838
66848
  jsonResponse: {