@seamapi/types 1.661.0 → 1.663.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.
@@ -15868,6 +15868,8 @@ export type Routes = {
15868
15868
  connected_account_id: string;
15869
15869
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
15870
15870
  salto_space_metadata?: {
15871
+ /** User ID in the Salto Space access system. */
15872
+ user_id?: string | undefined;
15871
15873
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
15872
15874
  audit_openings?: boolean | undefined;
15873
15875
  } | undefined;
@@ -21556,6 +21558,8 @@ export type Routes = {
21556
21558
  connected_account_id: string;
21557
21559
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
21558
21560
  salto_space_metadata?: {
21561
+ /** User ID in the Salto Space access system. */
21562
+ user_id?: string | undefined;
21559
21563
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
21560
21564
  audit_openings?: boolean | undefined;
21561
21565
  } | undefined;
@@ -21818,6 +21822,8 @@ export type Routes = {
21818
21822
  connected_account_id: string;
21819
21823
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
21820
21824
  salto_space_metadata?: {
21825
+ /** User ID in the Salto Space access system. */
21826
+ user_id?: string | undefined;
21821
21827
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
21822
21828
  audit_openings?: boolean | undefined;
21823
21829
  } | undefined;
@@ -22068,6 +22074,8 @@ export type Routes = {
22068
22074
  connected_account_id: string;
22069
22075
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
22070
22076
  salto_space_metadata?: {
22077
+ /** User ID in the Salto Space access system. */
22078
+ user_id?: string | undefined;
22071
22079
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
22072
22080
  audit_openings?: boolean | undefined;
22073
22081
  } | undefined;
@@ -22506,6 +22514,8 @@ export type Routes = {
22506
22514
  connected_account_id: string;
22507
22515
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
22508
22516
  salto_space_metadata?: {
22517
+ /** User ID in the Salto Space access system. */
22518
+ user_id?: string | undefined;
22509
22519
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
22510
22520
  audit_openings?: boolean | undefined;
22511
22521
  } | undefined;
@@ -22750,6 +22760,8 @@ export type Routes = {
22750
22760
  connected_account_id: string;
22751
22761
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
22752
22762
  salto_space_metadata?: {
22763
+ /** User ID in the Salto Space access system. */
22764
+ user_id?: string | undefined;
22753
22765
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
22754
22766
  audit_openings?: boolean | undefined;
22755
22767
  } | undefined;
@@ -54557,6 +54569,37 @@ export type Routes = {
54557
54569
  };
54558
54570
  maxDuration: undefined;
54559
54571
  };
54572
+ '/seam/customer/v1/spaces/list_reservations': {
54573
+ route: '/seam/customer/v1/spaces/list_reservations';
54574
+ method: 'GET' | 'POST';
54575
+ queryParams: {};
54576
+ jsonBody: {};
54577
+ commonParams: {
54578
+ /** Filter reservations by issued status. */
54579
+ issued_status?: ('issued' | 'pending') | undefined;
54580
+ /** Filter reservations by space key. */
54581
+ space_key: string;
54582
+ };
54583
+ formData: {};
54584
+ jsonResponse: {
54585
+ reservations: {
54586
+ reservation_id: string;
54587
+ reservation_key: string;
54588
+ name: string | null;
54589
+ starts_at: string | null;
54590
+ ends_at: string | null;
54591
+ created_at: string;
54592
+ guest_name: string | null;
54593
+ has_issued_access: boolean;
54594
+ access_methods: {
54595
+ access_method_id: string;
54596
+ mode: string;
54597
+ is_issued: boolean;
54598
+ }[];
54599
+ }[];
54600
+ };
54601
+ maxDuration: undefined;
54602
+ };
54560
54603
  '/seam/customer/v1/staff_members/get': {
54561
54604
  route: '/seam/customer/v1/staff_members/get';
54562
54605
  method: 'GET' | 'POST';
@@ -76249,6 +76292,8 @@ export type Routes = {
76249
76292
  connected_account_id: string;
76250
76293
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
76251
76294
  salto_space_metadata?: {
76295
+ /** User ID in the Salto Space access system. */
76296
+ user_id?: string | undefined;
76252
76297
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
76253
76298
  audit_openings?: boolean | undefined;
76254
76299
  } | undefined;
@@ -78531,6 +78576,8 @@ export type Routes = {
78531
78576
  connected_account_id: string;
78532
78577
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
78533
78578
  salto_space_metadata?: {
78579
+ /** User ID in the Salto Space access system. */
78580
+ user_id?: string | undefined;
78534
78581
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
78535
78582
  audit_openings?: boolean | undefined;
78536
78583
  } | undefined;
@@ -80088,6 +80135,8 @@ export type Routes = {
80088
80135
  connected_account_id: string;
80089
80136
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
80090
80137
  salto_space_metadata?: {
80138
+ /** User ID in the Salto Space access system. */
80139
+ user_id?: string | undefined;
80091
80140
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
80092
80141
  audit_openings?: boolean | undefined;
80093
80142
  } | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.661.0",
3
+ "version": "1.663.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -35,13 +35,14 @@ export type AcsEntranceSaltoSpaceMetadata = z.infer<
35
35
 
36
36
  export const acs_user_salto_space_metadata = z
37
37
  .object({
38
+ user_id: z.string().describe('User ID in the Salto Space access system.'),
38
39
  audit_openings: z
39
40
  .boolean()
40
- .optional()
41
41
  .describe(
42
42
  'Indicates whether AuditOpenings is enabled for the user in the Salto Space access system.',
43
43
  ),
44
44
  })
45
+ .partial()
45
46
  .describe(
46
47
  'Salto Space-specific metadata associated with the access system user.',
47
48
  )
@@ -4167,6 +4167,10 @@ export default {
4167
4167
  'Indicates whether AuditOpenings is enabled for the user in the Salto Space access system.',
4168
4168
  type: 'boolean',
4169
4169
  },
4170
+ user_id: {
4171
+ description: 'User ID in the Salto Space access system.',
4172
+ type: 'string',
4173
+ },
4170
4174
  },
4171
4175
  type: 'object',
4172
4176
  },
@@ -24327,6 +24331,10 @@ export default {
24327
24331
  'Indicates whether AuditOpenings is enabled for the user in the Salto Space access system.',
24328
24332
  type: 'boolean',
24329
24333
  },
24334
+ user_id: {
24335
+ description: 'User ID in the Salto Space access system.',
24336
+ type: 'string',
24337
+ },
24330
24338
  },
24331
24339
  type: 'object',
24332
24340
  },
@@ -55604,6 +55612,198 @@ export default {
55604
55612
  'x-undocumented': 'Only used internally.',
55605
55613
  },
55606
55614
  },
55615
+ '/seam/customer/v1/spaces/list_reservations': {
55616
+ get: {
55617
+ description:
55618
+ 'Returns a list of existing reservations for a specific space.\nIf issued_status is "issued", only reservations that have access methods issued will be returned.\nIf issued_status is "pending", only reservations that do not have access methods issued will be returned.\nIf issued_status is not provided, only reservations that do not have access methods issued will be returned.',
55619
+ operationId: 'seamCustomerV1SpacesListReservationsGet',
55620
+ parameters: [
55621
+ {
55622
+ in: 'query',
55623
+ name: 'issued_status',
55624
+ required: false,
55625
+ schema: {
55626
+ default: 'pending',
55627
+ description: 'Filter reservations by issued status.',
55628
+ enum: ['issued', 'pending'],
55629
+ type: 'string',
55630
+ },
55631
+ },
55632
+ {
55633
+ in: 'query',
55634
+ name: 'space_key',
55635
+ required: true,
55636
+ schema: {
55637
+ description: 'Filter reservations by space key.',
55638
+ type: 'string',
55639
+ },
55640
+ },
55641
+ ],
55642
+ responses: {
55643
+ 200: {
55644
+ content: {
55645
+ 'application/json': {
55646
+ schema: {
55647
+ properties: {
55648
+ ok: { type: 'boolean' },
55649
+ reservations: {
55650
+ items: {
55651
+ properties: {
55652
+ access_methods: {
55653
+ items: {
55654
+ $ref: '#/components/schemas/access_method',
55655
+ },
55656
+ type: 'array',
55657
+ },
55658
+ created_at: { format: 'date-time', type: 'string' },
55659
+ ends_at: {
55660
+ format: 'date-time',
55661
+ nullable: true,
55662
+ type: 'string',
55663
+ },
55664
+ guest_name: { nullable: true, type: 'string' },
55665
+ has_issued_access: { type: 'boolean' },
55666
+ name: { nullable: true, type: 'string' },
55667
+ reservation_id: { format: 'uuid', type: 'string' },
55668
+ reservation_key: { type: 'string' },
55669
+ starts_at: {
55670
+ format: 'date-time',
55671
+ nullable: true,
55672
+ type: 'string',
55673
+ },
55674
+ },
55675
+ required: [
55676
+ 'reservation_id',
55677
+ 'reservation_key',
55678
+ 'name',
55679
+ 'starts_at',
55680
+ 'ends_at',
55681
+ 'created_at',
55682
+ 'guest_name',
55683
+ 'has_issued_access',
55684
+ 'access_methods',
55685
+ ],
55686
+ type: 'object',
55687
+ },
55688
+ type: 'array',
55689
+ },
55690
+ },
55691
+ required: ['reservations', 'ok'],
55692
+ type: 'object',
55693
+ },
55694
+ },
55695
+ },
55696
+ description: 'OK',
55697
+ },
55698
+ 400: { description: 'Bad Request' },
55699
+ 401: { description: 'Unauthorized' },
55700
+ },
55701
+ security: [{ client_session_with_customer: [] }],
55702
+ summary: '/seam/customer/v1/spaces/list_reservations',
55703
+ tags: [],
55704
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'spaces'],
55705
+ 'x-fern-sdk-method-name': 'list_reservations',
55706
+ 'x-fern-sdk-return-value': 'reservations',
55707
+ 'x-response-key': 'reservations',
55708
+ 'x-title': 'List Reservations for Space',
55709
+ 'x-undocumented': 'Internal endpoint for customer portals.',
55710
+ },
55711
+ post: {
55712
+ description:
55713
+ 'Returns a list of existing reservations for a specific space.\nIf issued_status is "issued", only reservations that have access methods issued will be returned.\nIf issued_status is "pending", only reservations that do not have access methods issued will be returned.\nIf issued_status is not provided, only reservations that do not have access methods issued will be returned.',
55714
+ operationId: 'seamCustomerV1SpacesListReservationsPost',
55715
+ requestBody: {
55716
+ content: {
55717
+ 'application/json': {
55718
+ schema: {
55719
+ properties: {
55720
+ issued_status: {
55721
+ default: 'pending',
55722
+ description: 'Filter reservations by issued status.',
55723
+ enum: ['issued', 'pending'],
55724
+ type: 'string',
55725
+ },
55726
+ space_key: {
55727
+ description: 'Filter reservations by space key.',
55728
+ type: 'string',
55729
+ },
55730
+ },
55731
+ required: ['space_key'],
55732
+ type: 'object',
55733
+ },
55734
+ },
55735
+ },
55736
+ },
55737
+ responses: {
55738
+ 200: {
55739
+ content: {
55740
+ 'application/json': {
55741
+ schema: {
55742
+ properties: {
55743
+ ok: { type: 'boolean' },
55744
+ reservations: {
55745
+ items: {
55746
+ properties: {
55747
+ access_methods: {
55748
+ items: {
55749
+ $ref: '#/components/schemas/access_method',
55750
+ },
55751
+ type: 'array',
55752
+ },
55753
+ created_at: { format: 'date-time', type: 'string' },
55754
+ ends_at: {
55755
+ format: 'date-time',
55756
+ nullable: true,
55757
+ type: 'string',
55758
+ },
55759
+ guest_name: { nullable: true, type: 'string' },
55760
+ has_issued_access: { type: 'boolean' },
55761
+ name: { nullable: true, type: 'string' },
55762
+ reservation_id: { format: 'uuid', type: 'string' },
55763
+ reservation_key: { type: 'string' },
55764
+ starts_at: {
55765
+ format: 'date-time',
55766
+ nullable: true,
55767
+ type: 'string',
55768
+ },
55769
+ },
55770
+ required: [
55771
+ 'reservation_id',
55772
+ 'reservation_key',
55773
+ 'name',
55774
+ 'starts_at',
55775
+ 'ends_at',
55776
+ 'created_at',
55777
+ 'guest_name',
55778
+ 'has_issued_access',
55779
+ 'access_methods',
55780
+ ],
55781
+ type: 'object',
55782
+ },
55783
+ type: 'array',
55784
+ },
55785
+ },
55786
+ required: ['reservations', 'ok'],
55787
+ type: 'object',
55788
+ },
55789
+ },
55790
+ },
55791
+ description: 'OK',
55792
+ },
55793
+ 400: { description: 'Bad Request' },
55794
+ 401: { description: 'Unauthorized' },
55795
+ },
55796
+ security: [{ client_session_with_customer: [] }],
55797
+ summary: '/seam/customer/v1/spaces/list_reservations',
55798
+ tags: [],
55799
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'spaces'],
55800
+ 'x-fern-sdk-method-name': 'list_reservations',
55801
+ 'x-fern-sdk-return-value': 'reservations',
55802
+ 'x-response-key': 'reservations',
55803
+ 'x-title': 'List Reservations for Space',
55804
+ 'x-undocumented': 'Internal endpoint for customer portals.',
55805
+ },
55806
+ },
55607
55807
  '/seam/customer/v1/staff_members/get': {
55608
55808
  get: {
55609
55809
  description: 'Returns a staff member for a specific customer.',
@@ -18331,6 +18331,8 @@ export type Routes = {
18331
18331
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
18332
18332
  salto_space_metadata?:
18333
18333
  | {
18334
+ /** User ID in the Salto Space access system. */
18335
+ user_id?: string | undefined
18334
18336
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
18335
18337
  audit_openings?: boolean | undefined
18336
18338
  }
@@ -25012,6 +25014,8 @@ export type Routes = {
25012
25014
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
25013
25015
  salto_space_metadata?:
25014
25016
  | {
25017
+ /** User ID in the Salto Space access system. */
25018
+ user_id?: string | undefined
25015
25019
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
25016
25020
  audit_openings?: boolean | undefined
25017
25021
  }
@@ -25310,6 +25314,8 @@ export type Routes = {
25310
25314
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
25311
25315
  salto_space_metadata?:
25312
25316
  | {
25317
+ /** User ID in the Salto Space access system. */
25318
+ user_id?: string | undefined
25313
25319
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
25314
25320
  audit_openings?: boolean | undefined
25315
25321
  }
@@ -25596,6 +25602,8 @@ export type Routes = {
25596
25602
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
25597
25603
  salto_space_metadata?:
25598
25604
  | {
25605
+ /** User ID in the Salto Space access system. */
25606
+ user_id?: string | undefined
25599
25607
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
25600
25608
  audit_openings?: boolean | undefined
25601
25609
  }
@@ -26097,6 +26105,8 @@ export type Routes = {
26097
26105
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
26098
26106
  salto_space_metadata?:
26099
26107
  | {
26108
+ /** User ID in the Salto Space access system. */
26109
+ user_id?: string | undefined
26100
26110
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
26101
26111
  audit_openings?: boolean | undefined
26102
26112
  }
@@ -26377,6 +26387,8 @@ export type Routes = {
26377
26387
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
26378
26388
  salto_space_metadata?:
26379
26389
  | {
26390
+ /** User ID in the Salto Space access system. */
26391
+ user_id?: string | undefined
26380
26392
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
26381
26393
  audit_openings?: boolean | undefined
26382
26394
  }
@@ -64976,6 +64988,37 @@ export type Routes = {
64976
64988
  }
64977
64989
  maxDuration: undefined
64978
64990
  }
64991
+ '/seam/customer/v1/spaces/list_reservations': {
64992
+ route: '/seam/customer/v1/spaces/list_reservations'
64993
+ method: 'GET' | 'POST'
64994
+ queryParams: {}
64995
+ jsonBody: {}
64996
+ commonParams: {
64997
+ /** Filter reservations by issued status. */
64998
+ issued_status?: ('issued' | 'pending') | undefined
64999
+ /** Filter reservations by space key. */
65000
+ space_key: string
65001
+ }
65002
+ formData: {}
65003
+ jsonResponse: {
65004
+ reservations: {
65005
+ reservation_id: string
65006
+ reservation_key: string
65007
+ name: string | null
65008
+ starts_at: string | null
65009
+ ends_at: string | null
65010
+ created_at: string
65011
+ guest_name: string | null
65012
+ has_issued_access: boolean
65013
+ access_methods: {
65014
+ access_method_id: string
65015
+ mode: string
65016
+ is_issued: boolean
65017
+ }[]
65018
+ }[]
65019
+ }
65020
+ maxDuration: undefined
65021
+ }
64979
65022
  '/seam/customer/v1/staff_members/get': {
64980
65023
  route: '/seam/customer/v1/staff_members/get'
64981
65024
  method: 'GET' | 'POST'
@@ -90692,6 +90735,8 @@ export type Routes = {
90692
90735
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
90693
90736
  salto_space_metadata?:
90694
90737
  | {
90738
+ /** User ID in the Salto Space access system. */
90739
+ user_id?: string | undefined
90695
90740
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
90696
90741
  audit_openings?: boolean | undefined
90697
90742
  }
@@ -93465,6 +93510,8 @@ export type Routes = {
93465
93510
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
93466
93511
  salto_space_metadata?:
93467
93512
  | {
93513
+ /** User ID in the Salto Space access system. */
93514
+ user_id?: string | undefined
93468
93515
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
93469
93516
  audit_openings?: boolean | undefined
93470
93517
  }
@@ -95298,6 +95345,8 @@ export type Routes = {
95298
95345
  /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
95299
95346
  salto_space_metadata?:
95300
95347
  | {
95348
+ /** User ID in the Salto Space access system. */
95349
+ user_id?: string | undefined
95301
95350
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
95302
95351
  audit_openings?: boolean | undefined
95303
95352
  }