@seamapi/types 1.1001.0 → 1.1003.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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1001.0",
3
+ "version": "1.1003.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -44527,6 +44527,87 @@ const openapi: OpenAPISpec = {
44527
44527
  description:
44528
44528
  'Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
44529
44529
  operationId: 'acsCredentialsListGet',
44530
+ parameters: [
44531
+ {
44532
+ in: 'query',
44533
+ name: 'acs_user_id',
44534
+ schema: {
44535
+ description:
44536
+ 'ID of the access system user for which you want to retrieve all credentials.',
44537
+ format: 'uuid',
44538
+ type: 'string',
44539
+ },
44540
+ },
44541
+ {
44542
+ in: 'query',
44543
+ name: 'acs_system_id',
44544
+ schema: {
44545
+ description:
44546
+ 'ID of the access system for which you want to retrieve all credentials.',
44547
+ format: 'uuid',
44548
+ type: 'string',
44549
+ },
44550
+ },
44551
+ {
44552
+ in: 'query',
44553
+ name: 'user_identity_id',
44554
+ schema: {
44555
+ description:
44556
+ 'ID of the user identity for which you want to retrieve all credentials.',
44557
+ format: 'uuid',
44558
+ type: 'string',
44559
+ },
44560
+ },
44561
+ {
44562
+ in: 'query',
44563
+ name: 'limit',
44564
+ schema: {
44565
+ default: 500,
44566
+ description: 'Number of credentials to return.',
44567
+ format: 'float',
44568
+ type: 'number',
44569
+ },
44570
+ },
44571
+ {
44572
+ in: 'query',
44573
+ name: 'created_before',
44574
+ schema: {
44575
+ description:
44576
+ 'Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.',
44577
+ format: 'date-time',
44578
+ type: 'string',
44579
+ },
44580
+ },
44581
+ {
44582
+ in: 'query',
44583
+ name: 'is_multi_phone_sync_credential',
44584
+ schema: {
44585
+ description:
44586
+ 'Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.',
44587
+ type: 'boolean',
44588
+ },
44589
+ },
44590
+ {
44591
+ in: 'query',
44592
+ name: 'search',
44593
+ schema: {
44594
+ description:
44595
+ 'String for which to search. Filters returned credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`.',
44596
+ minLength: 1,
44597
+ type: 'string',
44598
+ },
44599
+ },
44600
+ {
44601
+ in: 'query',
44602
+ name: 'page_cursor',
44603
+ schema: {
44604
+ description:
44605
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
44606
+ nullable: true,
44607
+ type: 'string',
44608
+ },
44609
+ },
44610
+ ],
44530
44611
  responses: {
44531
44612
  '200': {
44532
44613
  content: {
@@ -44573,101 +44654,56 @@ const openapi: OpenAPISpec = {
44573
44654
  content: {
44574
44655
  'application/json': {
44575
44656
  schema: {
44576
- allOf: [
44577
- {
44578
- oneOf: [
44579
- {
44580
- properties: {
44581
- acs_user_id: {
44582
- description:
44583
- 'ID of the access system user for which you want to retrieve all credentials.',
44584
- format: 'uuid',
44585
- type: 'string',
44586
- },
44587
- },
44588
- required: ['acs_user_id'],
44589
- type: 'object',
44590
- },
44591
- {
44592
- properties: {
44593
- acs_system_id: {
44594
- description:
44595
- 'ID of the access system for which you want to retrieve all credentials.',
44596
- format: 'uuid',
44597
- type: 'string',
44598
- },
44599
- },
44600
- required: ['acs_system_id'],
44601
- type: 'object',
44602
- },
44603
- {
44604
- properties: {
44605
- acs_system_id: {
44606
- description:
44607
- 'ID of the access system for which you want to retrieve all credentials.',
44608
- format: 'uuid',
44609
- type: 'string',
44610
- },
44611
- acs_user_id: {
44612
- description:
44613
- 'ID of the access system user for which you want to retrieve all credentials.',
44614
- format: 'uuid',
44615
- type: 'string',
44616
- },
44617
- },
44618
- required: ['acs_user_id', 'acs_system_id'],
44619
- type: 'object',
44620
- },
44621
- {
44622
- properties: {
44623
- user_identity_id: {
44624
- description:
44625
- 'ID of the user identity for which you want to retrieve all credentials.',
44626
- format: 'uuid',
44627
- type: 'string',
44628
- },
44629
- },
44630
- required: ['user_identity_id'],
44631
- type: 'object',
44632
- },
44633
- { properties: {}, type: 'object' },
44634
- ],
44657
+ properties: {
44658
+ acs_system_id: {
44659
+ description:
44660
+ 'ID of the access system for which you want to retrieve all credentials.',
44661
+ format: 'uuid',
44662
+ type: 'string',
44635
44663
  },
44636
- {
44637
- properties: {
44638
- created_before: {
44639
- description:
44640
- 'Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.',
44641
- format: 'date-time',
44642
- type: 'string',
44643
- },
44644
- is_multi_phone_sync_credential: {
44645
- description:
44646
- 'Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.',
44647
- type: 'boolean',
44648
- },
44649
- limit: {
44650
- default: 500,
44651
- description: 'Number of credentials to return.',
44652
- format: 'float',
44653
- type: 'number',
44654
- },
44655
- page_cursor: {
44656
- description:
44657
- "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
44658
- nullable: true,
44659
- type: 'string',
44660
- },
44661
- search: {
44662
- description:
44663
- 'String for which to search. Filters returned credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`.',
44664
- minLength: 1,
44665
- type: 'string',
44666
- },
44667
- },
44668
- type: 'object',
44664
+ acs_user_id: {
44665
+ description:
44666
+ 'ID of the access system user for which you want to retrieve all credentials.',
44667
+ format: 'uuid',
44668
+ type: 'string',
44669
44669
  },
44670
- ],
44670
+ created_before: {
44671
+ description:
44672
+ 'Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.',
44673
+ format: 'date-time',
44674
+ type: 'string',
44675
+ },
44676
+ is_multi_phone_sync_credential: {
44677
+ description:
44678
+ 'Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.',
44679
+ type: 'boolean',
44680
+ },
44681
+ limit: {
44682
+ default: 500,
44683
+ description: 'Number of credentials to return.',
44684
+ format: 'float',
44685
+ type: 'number',
44686
+ },
44687
+ page_cursor: {
44688
+ description:
44689
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
44690
+ nullable: true,
44691
+ type: 'string',
44692
+ },
44693
+ search: {
44694
+ description:
44695
+ 'String for which to search. Filters returned credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`.',
44696
+ minLength: 1,
44697
+ type: 'string',
44698
+ },
44699
+ user_identity_id: {
44700
+ description:
44701
+ 'ID of the user identity for which you want to retrieve all credentials.',
44702
+ format: 'uuid',
44703
+ type: 'string',
44704
+ },
44705
+ },
44706
+ type: 'object',
44671
44707
  },
44672
44708
  },
44673
44709
  },
@@ -45076,6 +45112,48 @@ const openapi: OpenAPISpec = {
45076
45112
  description:
45077
45113
  'Returns a list of all unmanaged [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
45078
45114
  operationId: 'acsCredentialsUnmanagedListGet',
45115
+ parameters: [
45116
+ {
45117
+ in: 'query',
45118
+ name: 'acs_user_id',
45119
+ schema: {
45120
+ description:
45121
+ 'ID of the access system user for which you want to retrieve all credentials.',
45122
+ format: 'uuid',
45123
+ type: 'string',
45124
+ },
45125
+ },
45126
+ {
45127
+ in: 'query',
45128
+ name: 'acs_system_id',
45129
+ schema: {
45130
+ description:
45131
+ 'ID of the access system for which you want to retrieve all credentials.',
45132
+ format: 'uuid',
45133
+ type: 'string',
45134
+ },
45135
+ },
45136
+ {
45137
+ in: 'query',
45138
+ name: 'user_identity_id',
45139
+ schema: {
45140
+ description:
45141
+ 'ID of the user identity for which you want to retrieve all credentials.',
45142
+ format: 'uuid',
45143
+ type: 'string',
45144
+ },
45145
+ },
45146
+ {
45147
+ in: 'query',
45148
+ name: 'search',
45149
+ schema: {
45150
+ description:
45151
+ 'String for which to search. Filters returned credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`.',
45152
+ minLength: 1,
45153
+ type: 'string',
45154
+ },
45155
+ },
45156
+ ],
45079
45157
  responses: {
45080
45158
  '200': {
45081
45159
  content: {
@@ -45122,85 +45200,33 @@ const openapi: OpenAPISpec = {
45122
45200
  content: {
45123
45201
  'application/json': {
45124
45202
  schema: {
45125
- allOf: [
45126
- {
45127
- oneOf: [
45128
- {
45129
- description:
45130
- 'ID of the access system user for which you want to list unmanaged credentials.',
45131
- properties: {
45132
- acs_user_id: {
45133
- description:
45134
- 'ID of the access system user for which you want to retrieve all credentials.',
45135
- format: 'uuid',
45136
- type: 'string',
45137
- },
45138
- },
45139
- required: ['acs_user_id'],
45140
- type: 'object',
45141
- },
45142
- {
45143
- description:
45144
- 'ID of the access system for which you want to list unmanaged credentials.',
45145
- properties: {
45146
- acs_system_id: {
45147
- description:
45148
- 'ID of the access system for which you want to retrieve all credentials.',
45149
- format: 'uuid',
45150
- type: 'string',
45151
- },
45152
- },
45153
- required: ['acs_system_id'],
45154
- type: 'object',
45155
- },
45156
- {
45157
- description:
45158
- 'ID of the access system and ID of the access system user for which you want to list unmanaged credentials.',
45159
- properties: {
45160
- acs_system_id: {
45161
- description:
45162
- 'ID of the access system for which you want to retrieve all credentials.',
45163
- format: 'uuid',
45164
- type: 'string',
45165
- },
45166
- acs_user_id: {
45167
- description:
45168
- 'ID of the access system user for which you want to retrieve all credentials.',
45169
- format: 'uuid',
45170
- type: 'string',
45171
- },
45172
- },
45173
- required: ['acs_user_id', 'acs_system_id'],
45174
- type: 'object',
45175
- },
45176
- {
45177
- description:
45178
- 'ID of the user identity for which you want to list unmanaged credentials.',
45179
- properties: {
45180
- user_identity_id: {
45181
- description:
45182
- 'ID of the user identity for which you want to retrieve all credentials.',
45183
- format: 'uuid',
45184
- type: 'string',
45185
- },
45186
- },
45187
- required: ['user_identity_id'],
45188
- type: 'object',
45189
- },
45190
- ],
45203
+ properties: {
45204
+ acs_system_id: {
45205
+ description:
45206
+ 'ID of the access system for which you want to retrieve all credentials.',
45207
+ format: 'uuid',
45208
+ type: 'string',
45191
45209
  },
45192
- {
45193
- properties: {
45194
- search: {
45195
- description:
45196
- 'String for which to search. Filters returned credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`.',
45197
- minLength: 1,
45198
- type: 'string',
45199
- },
45200
- },
45201
- type: 'object',
45210
+ acs_user_id: {
45211
+ description:
45212
+ 'ID of the access system user for which you want to retrieve all credentials.',
45213
+ format: 'uuid',
45214
+ type: 'string',
45202
45215
  },
45203
- ],
45216
+ search: {
45217
+ description:
45218
+ 'String for which to search. Filters returned credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`.',
45219
+ minLength: 1,
45220
+ type: 'string',
45221
+ },
45222
+ user_identity_id: {
45223
+ description:
45224
+ 'ID of the user identity for which you want to retrieve all credentials.',
45225
+ format: 'uuid',
45226
+ type: 'string',
45227
+ },
45228
+ },
45229
+ type: 'object',
45204
45230
  },
45205
45231
  },
45206
45232
  },
@@ -45560,6 +45586,57 @@ const openapi: OpenAPISpec = {
45560
45586
  description:
45561
45587
  'Returns a list of all [encoders](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
45562
45588
  operationId: 'acsEncodersListGet',
45589
+ parameters: [
45590
+ {
45591
+ in: 'query',
45592
+ name: 'acs_system_id',
45593
+ schema: {
45594
+ description:
45595
+ 'ID of the access system for which you want to retrieve all encoders.',
45596
+ format: 'uuid',
45597
+ type: 'string',
45598
+ },
45599
+ },
45600
+ {
45601
+ in: 'query',
45602
+ name: 'acs_system_ids',
45603
+ schema: {
45604
+ description:
45605
+ 'IDs of the access systems for which you want to retrieve all encoders.',
45606
+ items: { format: 'uuid', type: 'string' },
45607
+ type: 'array',
45608
+ },
45609
+ },
45610
+ {
45611
+ in: 'query',
45612
+ name: 'acs_encoder_ids',
45613
+ schema: {
45614
+ description: 'IDs of the encoders that you want to retrieve.',
45615
+ items: { format: 'uuid', type: 'string' },
45616
+ type: 'array',
45617
+ },
45618
+ },
45619
+ {
45620
+ in: 'query',
45621
+ name: 'limit',
45622
+ schema: {
45623
+ default: 500,
45624
+ description: 'Number of encoders to return.',
45625
+ format: 'float',
45626
+ type: 'number',
45627
+ },
45628
+ },
45629
+ {
45630
+ in: 'query',
45631
+ name: 'page_cursor',
45632
+ schema: {
45633
+ description:
45634
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
45635
+ nullable: true,
45636
+ type: 'string',
45637
+ },
45638
+ },
45639
+ ],
45563
45640
  responses: {
45564
45641
  '200': {
45565
45642
  content: {
@@ -45607,65 +45684,39 @@ const openapi: OpenAPISpec = {
45607
45684
  content: {
45608
45685
  'application/json': {
45609
45686
  schema: {
45610
- allOf: [
45611
- {
45612
- oneOf: [
45613
- {
45614
- properties: {
45615
- acs_system_id: {
45616
- description:
45617
- 'ID of the access system for which you want to retrieve all encoders.',
45618
- format: 'uuid',
45619
- type: 'string',
45620
- },
45621
- },
45622
- required: ['acs_system_id'],
45623
- type: 'object',
45624
- },
45625
- {
45626
- properties: {
45627
- acs_system_ids: {
45628
- description:
45629
- 'IDs of the access systems for which you want to retrieve all encoders.',
45630
- items: { format: 'uuid', type: 'string' },
45631
- type: 'array',
45632
- },
45633
- },
45634
- required: ['acs_system_ids'],
45635
- type: 'object',
45636
- },
45637
- {
45638
- properties: {
45639
- acs_encoder_ids: {
45640
- description:
45641
- 'IDs of the encoders that you want to retrieve.',
45642
- items: { format: 'uuid', type: 'string' },
45643
- type: 'array',
45644
- },
45645
- },
45646
- required: ['acs_encoder_ids'],
45647
- type: 'object',
45648
- },
45649
- ],
45687
+ properties: {
45688
+ acs_encoder_ids: {
45689
+ description:
45690
+ 'IDs of the encoders that you want to retrieve.',
45691
+ items: { format: 'uuid', type: 'string' },
45692
+ type: 'array',
45650
45693
  },
45651
- {
45652
- properties: {
45653
- limit: {
45654
- default: 500,
45655
- description: 'Number of encoders to return.',
45656
- format: 'float',
45657
- type: 'number',
45658
- },
45659
- page_cursor: {
45660
- description:
45661
- "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
45662
- nullable: true,
45663
- type: 'string',
45664
- },
45665
- },
45666
- type: 'object',
45694
+ acs_system_id: {
45695
+ description:
45696
+ 'ID of the access system for which you want to retrieve all encoders.',
45697
+ format: 'uuid',
45698
+ type: 'string',
45667
45699
  },
45668
- ],
45700
+ acs_system_ids: {
45701
+ description:
45702
+ 'IDs of the access systems for which you want to retrieve all encoders.',
45703
+ items: { format: 'uuid', type: 'string' },
45704
+ type: 'array',
45705
+ },
45706
+ limit: {
45707
+ default: 500,
45708
+ description: 'Number of encoders to return.',
45709
+ format: 'float',
45710
+ type: 'number',
45711
+ },
45712
+ page_cursor: {
45713
+ description:
45714
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
45715
+ nullable: true,
45716
+ type: 'string',
45717
+ },
45718
+ },
45719
+ type: 'object',
45669
45720
  },
45670
45721
  },
45671
45722
  },
@@ -59072,12 +59123,7 @@ const openapi: OpenAPISpec = {
59072
59123
  schema: {
59073
59124
  description:
59074
59125
  'Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.',
59075
- items: {
59076
- oneOf: [
59077
- { type: 'string' },
59078
- { format: 'date-time', type: 'string' },
59079
- ],
59080
- },
59126
+ items: { type: 'string' },
59081
59127
  maxItems: 2,
59082
59128
  minItems: 2,
59083
59129
  type: 'array',
@@ -59678,12 +59724,7 @@ const openapi: OpenAPISpec = {
59678
59724
  between: {
59679
59725
  description:
59680
59726
  'Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.',
59681
- items: {
59682
- oneOf: [
59683
- { type: 'string' },
59684
- { format: 'date-time', type: 'string' },
59685
- ],
59686
- },
59727
+ items: { type: 'string' },
59687
59728
  maxItems: 2,
59688
59729
  minItems: 2,
59689
59730
  type: 'array',
@@ -72124,12 +72165,7 @@ const openapi: OpenAPISpec = {
72124
72165
  schema: {
72125
72166
  description:
72126
72167
  'Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.',
72127
- items: {
72128
- oneOf: [
72129
- { type: 'string' },
72130
- { format: 'date-time', type: 'string' },
72131
- ],
72132
- },
72168
+ items: { type: 'string' },
72133
72169
  maxItems: 2,
72134
72170
  minItems: 2,
72135
72171
  type: 'array',
@@ -72437,12 +72473,7 @@ const openapi: OpenAPISpec = {
72437
72473
  between: {
72438
72474
  description:
72439
72475
  'Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.',
72440
- items: {
72441
- oneOf: [
72442
- { type: 'string' },
72443
- { format: 'date-time', type: 'string' },
72444
- ],
72445
- },
72476
+ items: { type: 'string' },
72446
72477
  maxItems: 2,
72447
72478
  minItems: 2,
72448
72479
  type: 'array',
@@ -75157,12 +75188,7 @@ const openapi: OpenAPISpec = {
75157
75188
  schema: {
75158
75189
  description:
75159
75190
  'Lower and upper timestamps to filter reservations whose time range overlaps with the given interval.',
75160
- items: {
75161
- oneOf: [
75162
- { type: 'string' },
75163
- { format: 'date-time', type: 'string' },
75164
- ],
75165
- },
75191
+ items: { type: 'string' },
75166
75192
  maxItems: 2,
75167
75193
  minItems: 2,
75168
75194
  type: 'array',
@@ -75433,12 +75459,7 @@ const openapi: OpenAPISpec = {
75433
75459
  between: {
75434
75460
  description:
75435
75461
  'Lower and upper timestamps to filter reservations whose time range overlaps with the given interval.',
75436
- items: {
75437
- oneOf: [
75438
- { type: 'string' },
75439
- { format: 'date-time', type: 'string' },
75440
- ],
75441
- },
75462
+ items: { type: 'string' },
75442
75463
  maxItems: 2,
75443
75464
  minItems: 2,
75444
75465
  type: 'array',