@seamapi/types 1.377.0 → 1.379.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.
@@ -2941,17 +2941,19 @@ export default {
2941
2941
  {
2942
2942
  properties: {
2943
2943
  created_at: { format: 'date-time', type: 'string' },
2944
+ message: { type: 'string' },
2944
2945
  mutation_code: { enum: ['creating'], type: 'string' },
2945
2946
  },
2946
- required: ['created_at', 'mutation_code'],
2947
+ required: ['created_at', 'message', 'mutation_code'],
2947
2948
  type: 'object',
2948
2949
  },
2949
2950
  {
2950
2951
  properties: {
2951
2952
  created_at: { format: 'date-time', type: 'string' },
2953
+ message: { type: 'string' },
2952
2954
  mutation_code: { enum: ['deleting'], type: 'string' },
2953
2955
  },
2954
- required: ['created_at', 'mutation_code'],
2956
+ required: ['created_at', 'message', 'mutation_code'],
2955
2957
  type: 'object',
2956
2958
  },
2957
2959
  {
@@ -2969,6 +2971,7 @@ export default {
2969
2971
  },
2970
2972
  type: 'object',
2971
2973
  },
2974
+ message: { type: 'string' },
2972
2975
  mutation_code: {
2973
2976
  enum: ['updating_user_information'],
2974
2977
  type: 'string',
@@ -2986,7 +2989,13 @@ export default {
2986
2989
  type: 'object',
2987
2990
  },
2988
2991
  },
2989
- required: ['created_at', 'mutation_code', 'from', 'to'],
2992
+ required: [
2993
+ 'created_at',
2994
+ 'message',
2995
+ 'mutation_code',
2996
+ 'from',
2997
+ 'to',
2998
+ ],
2990
2999
  type: 'object',
2991
3000
  },
2992
3001
  {
@@ -2995,22 +3004,20 @@ export default {
2995
3004
  from: {
2996
3005
  properties: {
2997
3006
  ends_at: {
2998
- description:
2999
- "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
3000
3007
  format: 'date-time',
3001
3008
  nullable: true,
3002
3009
  type: 'string',
3003
3010
  },
3004
3011
  starts_at: {
3005
- description:
3006
- "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
3007
3012
  format: 'date-time',
3013
+ nullable: true,
3008
3014
  type: 'string',
3009
3015
  },
3010
3016
  },
3011
3017
  required: ['starts_at', 'ends_at'],
3012
3018
  type: 'object',
3013
3019
  },
3020
+ message: { type: 'string' },
3014
3021
  mutation_code: {
3015
3022
  enum: ['updating_access_schedule'],
3016
3023
  type: 'string',
@@ -3018,16 +3025,13 @@ export default {
3018
3025
  to: {
3019
3026
  properties: {
3020
3027
  ends_at: {
3021
- description:
3022
- "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
3023
3028
  format: 'date-time',
3024
3029
  nullable: true,
3025
3030
  type: 'string',
3026
3031
  },
3027
3032
  starts_at: {
3028
- description:
3029
- "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
3030
3033
  format: 'date-time',
3034
+ nullable: true,
3031
3035
  type: 'string',
3032
3036
  },
3033
3037
  },
@@ -3035,7 +3039,13 @@ export default {
3035
3039
  type: 'object',
3036
3040
  },
3037
3041
  },
3038
- required: ['created_at', 'mutation_code', 'from', 'to'],
3042
+ required: [
3043
+ 'created_at',
3044
+ 'message',
3045
+ 'mutation_code',
3046
+ 'from',
3047
+ 'to',
3048
+ ],
3039
3049
  type: 'object',
3040
3050
  },
3041
3051
  {
@@ -3046,6 +3056,7 @@ export default {
3046
3056
  required: ['is_suspended'],
3047
3057
  type: 'object',
3048
3058
  },
3059
+ message: { type: 'string' },
3049
3060
  mutation_code: {
3050
3061
  enum: ['updating_suspension_state'],
3051
3062
  type: 'string',
@@ -3056,7 +3067,13 @@ export default {
3056
3067
  type: 'object',
3057
3068
  },
3058
3069
  },
3059
- required: ['created_at', 'mutation_code', 'from', 'to'],
3070
+ required: [
3071
+ 'created_at',
3072
+ 'message',
3073
+ 'mutation_code',
3074
+ 'from',
3075
+ 'to',
3076
+ ],
3060
3077
  type: 'object',
3061
3078
  },
3062
3079
  {
@@ -3073,6 +3090,7 @@ export default {
3073
3090
  required: ['acs_access_group_id'],
3074
3091
  type: 'object',
3075
3092
  },
3093
+ message: { type: 'string' },
3076
3094
  mutation_code: {
3077
3095
  enum: ['updating_group_membership'],
3078
3096
  type: 'string',
@@ -3089,7 +3107,13 @@ export default {
3089
3107
  type: 'object',
3090
3108
  },
3091
3109
  },
3092
- required: ['created_at', 'mutation_code', 'from', 'to'],
3110
+ required: [
3111
+ 'created_at',
3112
+ 'message',
3113
+ 'mutation_code',
3114
+ 'from',
3115
+ 'to',
3116
+ ],
3093
3117
  type: 'object',
3094
3118
  },
3095
3119
  ],
@@ -16031,17 +16055,19 @@ export default {
16031
16055
  {
16032
16056
  properties: {
16033
16057
  created_at: { format: 'date-time', type: 'string' },
16058
+ message: { type: 'string' },
16034
16059
  mutation_code: { enum: ['creating'], type: 'string' },
16035
16060
  },
16036
- required: ['created_at', 'mutation_code'],
16061
+ required: ['created_at', 'message', 'mutation_code'],
16037
16062
  type: 'object',
16038
16063
  },
16039
16064
  {
16040
16065
  properties: {
16041
16066
  created_at: { format: 'date-time', type: 'string' },
16067
+ message: { type: 'string' },
16042
16068
  mutation_code: { enum: ['deleting'], type: 'string' },
16043
16069
  },
16044
- required: ['created_at', 'mutation_code'],
16070
+ required: ['created_at', 'message', 'mutation_code'],
16045
16071
  type: 'object',
16046
16072
  },
16047
16073
  {
@@ -16059,6 +16085,7 @@ export default {
16059
16085
  },
16060
16086
  type: 'object',
16061
16087
  },
16088
+ message: { type: 'string' },
16062
16089
  mutation_code: {
16063
16090
  enum: ['updating_user_information'],
16064
16091
  type: 'string',
@@ -16076,7 +16103,13 @@ export default {
16076
16103
  type: 'object',
16077
16104
  },
16078
16105
  },
16079
- required: ['created_at', 'mutation_code', 'from', 'to'],
16106
+ required: [
16107
+ 'created_at',
16108
+ 'message',
16109
+ 'mutation_code',
16110
+ 'from',
16111
+ 'to',
16112
+ ],
16080
16113
  type: 'object',
16081
16114
  },
16082
16115
  {
@@ -16085,22 +16118,20 @@ export default {
16085
16118
  from: {
16086
16119
  properties: {
16087
16120
  ends_at: {
16088
- description:
16089
- "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
16090
16121
  format: 'date-time',
16091
16122
  nullable: true,
16092
16123
  type: 'string',
16093
16124
  },
16094
16125
  starts_at: {
16095
- description:
16096
- "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
16097
16126
  format: 'date-time',
16127
+ nullable: true,
16098
16128
  type: 'string',
16099
16129
  },
16100
16130
  },
16101
16131
  required: ['starts_at', 'ends_at'],
16102
16132
  type: 'object',
16103
16133
  },
16134
+ message: { type: 'string' },
16104
16135
  mutation_code: {
16105
16136
  enum: ['updating_access_schedule'],
16106
16137
  type: 'string',
@@ -16108,16 +16139,13 @@ export default {
16108
16139
  to: {
16109
16140
  properties: {
16110
16141
  ends_at: {
16111
- description:
16112
- "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
16113
16142
  format: 'date-time',
16114
16143
  nullable: true,
16115
16144
  type: 'string',
16116
16145
  },
16117
16146
  starts_at: {
16118
- description:
16119
- "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
16120
16147
  format: 'date-time',
16148
+ nullable: true,
16121
16149
  type: 'string',
16122
16150
  },
16123
16151
  },
@@ -16125,7 +16153,13 @@ export default {
16125
16153
  type: 'object',
16126
16154
  },
16127
16155
  },
16128
- required: ['created_at', 'mutation_code', 'from', 'to'],
16156
+ required: [
16157
+ 'created_at',
16158
+ 'message',
16159
+ 'mutation_code',
16160
+ 'from',
16161
+ 'to',
16162
+ ],
16129
16163
  type: 'object',
16130
16164
  },
16131
16165
  {
@@ -16136,6 +16170,7 @@ export default {
16136
16170
  required: ['is_suspended'],
16137
16171
  type: 'object',
16138
16172
  },
16173
+ message: { type: 'string' },
16139
16174
  mutation_code: {
16140
16175
  enum: ['updating_suspension_state'],
16141
16176
  type: 'string',
@@ -16146,7 +16181,13 @@ export default {
16146
16181
  type: 'object',
16147
16182
  },
16148
16183
  },
16149
- required: ['created_at', 'mutation_code', 'from', 'to'],
16184
+ required: [
16185
+ 'created_at',
16186
+ 'message',
16187
+ 'mutation_code',
16188
+ 'from',
16189
+ 'to',
16190
+ ],
16150
16191
  type: 'object',
16151
16192
  },
16152
16193
  {
@@ -16163,6 +16204,7 @@ export default {
16163
16204
  required: ['acs_access_group_id'],
16164
16205
  type: 'object',
16165
16206
  },
16207
+ message: { type: 'string' },
16166
16208
  mutation_code: {
16167
16209
  enum: ['updating_group_membership'],
16168
16210
  type: 'string',
@@ -16179,7 +16221,13 @@ export default {
16179
16221
  type: 'object',
16180
16222
  },
16181
16223
  },
16182
- required: ['created_at', 'mutation_code', 'from', 'to'],
16224
+ required: [
16225
+ 'created_at',
16226
+ 'message',
16227
+ 'mutation_code',
16228
+ 'from',
16229
+ 'to',
16230
+ ],
16183
16231
  type: 'object',
16184
16232
  },
16185
16233
  ],
@@ -20975,6 +21023,61 @@ export default {
20975
21023
  'x-title': 'Encode a Credential',
20976
21024
  },
20977
21025
  },
21026
+ '/acs/encoders/get': {
21027
+ post: {
21028
+ description:
21029
+ 'Returns a specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
21030
+ operationId: 'acsEncodersGetPost',
21031
+ requestBody: {
21032
+ content: {
21033
+ 'application/json': {
21034
+ schema: {
21035
+ properties: {
21036
+ acs_encoder_id: {
21037
+ description: 'ID of the desired encoder.',
21038
+ format: 'uuid',
21039
+ type: 'string',
21040
+ },
21041
+ },
21042
+ required: ['acs_encoder_id'],
21043
+ type: 'object',
21044
+ },
21045
+ },
21046
+ },
21047
+ },
21048
+ responses: {
21049
+ 200: {
21050
+ content: {
21051
+ 'application/json': {
21052
+ schema: {
21053
+ properties: {
21054
+ acs_encoder: { $ref: '#/components/schemas/acs_encoder' },
21055
+ ok: { type: 'boolean' },
21056
+ },
21057
+ required: ['acs_encoder', 'ok'],
21058
+ type: 'object',
21059
+ },
21060
+ },
21061
+ },
21062
+ description: 'OK',
21063
+ },
21064
+ 400: { description: 'Bad Request' },
21065
+ 401: { description: 'Unauthorized' },
21066
+ },
21067
+ security: [
21068
+ { pat_with_workspace: [] },
21069
+ { console_session_with_workspace: [] },
21070
+ { api_key: [] },
21071
+ ],
21072
+ summary: '/acs/encoders/get',
21073
+ tags: ['/acs'],
21074
+ 'x-fern-sdk-group-name': ['acs', 'encoders'],
21075
+ 'x-fern-sdk-method-name': 'get',
21076
+ 'x-fern-sdk-return-value': 'acs_encoder',
21077
+ 'x-response-key': 'acs_encoder',
21078
+ 'x-title': 'Get an Encoder',
21079
+ },
21080
+ },
20978
21081
  '/acs/encoders/list': {
20979
21082
  post: {
20980
21083
  description:
@@ -27075,11 +27178,13 @@ export default {
27075
27178
  can_tailscale_proxy_reach_bridge: {
27076
27179
  description:
27077
27180
  'Tailscale proxy cannot reach the bridge',
27181
+ nullable: true,
27078
27182
  type: 'boolean',
27079
27183
  },
27080
27184
  can_tailscale_proxy_reach_tailscale_network: {
27081
27185
  description:
27082
27186
  'Tailscale proxy cannot reach the Tailscale network',
27187
+ nullable: true,
27083
27188
  type: 'boolean',
27084
27189
  },
27085
27190
  created_at: {
@@ -27095,16 +27200,19 @@ export default {
27095
27200
  is_bridge_socks_server_healthy: {
27096
27201
  description:
27097
27202
  "Bridge's SOCKS server is unhealthy",
27203
+ nullable: true,
27098
27204
  type: 'boolean',
27099
27205
  },
27100
27206
  is_tailscale_proxy_reachable: {
27101
27207
  description:
27102
27208
  'Seam cannot reach the tailscale proxy',
27209
+ nullable: true,
27103
27210
  type: 'boolean',
27104
27211
  },
27105
27212
  is_tailscale_proxy_socks_server_healthy: {
27106
27213
  description:
27107
27214
  "Tailscale proxy's SOCKS server is unhealthy",
27215
+ nullable: true,
27108
27216
  type: 'boolean',
27109
27217
  },
27110
27218
  message: { type: 'string' },
@@ -27242,11 +27350,13 @@ export default {
27242
27350
  can_tailscale_proxy_reach_bridge: {
27243
27351
  description:
27244
27352
  'Tailscale proxy cannot reach the bridge',
27353
+ nullable: true,
27245
27354
  type: 'boolean',
27246
27355
  },
27247
27356
  can_tailscale_proxy_reach_tailscale_network: {
27248
27357
  description:
27249
27358
  'Tailscale proxy cannot reach the Tailscale network',
27359
+ nullable: true,
27250
27360
  type: 'boolean',
27251
27361
  },
27252
27362
  created_at: {
@@ -27262,16 +27372,19 @@ export default {
27262
27372
  is_bridge_socks_server_healthy: {
27263
27373
  description:
27264
27374
  "Bridge's SOCKS server is unhealthy",
27375
+ nullable: true,
27265
27376
  type: 'boolean',
27266
27377
  },
27267
27378
  is_tailscale_proxy_reachable: {
27268
27379
  description:
27269
27380
  'Seam cannot reach the tailscale proxy',
27381
+ nullable: true,
27270
27382
  type: 'boolean',
27271
27383
  },
27272
27384
  is_tailscale_proxy_socks_server_healthy: {
27273
27385
  description:
27274
27386
  "Tailscale proxy's SOCKS server is unhealthy",
27387
+ nullable: true,
27275
27388
  type: 'boolean',
27276
27389
  },
27277
27390
  message: { type: 'string' },
@@ -27400,11 +27513,13 @@ export default {
27400
27513
  can_tailscale_proxy_reach_bridge: {
27401
27514
  description:
27402
27515
  'Tailscale proxy cannot reach the bridge',
27516
+ nullable: true,
27403
27517
  type: 'boolean',
27404
27518
  },
27405
27519
  can_tailscale_proxy_reach_tailscale_network: {
27406
27520
  description:
27407
27521
  'Tailscale proxy cannot reach the Tailscale network',
27522
+ nullable: true,
27408
27523
  type: 'boolean',
27409
27524
  },
27410
27525
  created_at: {
@@ -27420,16 +27535,19 @@ export default {
27420
27535
  is_bridge_socks_server_healthy: {
27421
27536
  description:
27422
27537
  "Bridge's SOCKS server is unhealthy",
27538
+ nullable: true,
27423
27539
  type: 'boolean',
27424
27540
  },
27425
27541
  is_tailscale_proxy_reachable: {
27426
27542
  description:
27427
27543
  'Seam cannot reach the tailscale proxy',
27544
+ nullable: true,
27428
27545
  type: 'boolean',
27429
27546
  },
27430
27547
  is_tailscale_proxy_socks_server_healthy: {
27431
27548
  description:
27432
27549
  "Tailscale proxy's SOCKS server is unhealthy",
27550
+ nullable: true,
27433
27551
  type: 'boolean',
27434
27552
  },
27435
27553
  message: { type: 'string' },
@@ -27568,11 +27686,13 @@ export default {
27568
27686
  can_tailscale_proxy_reach_bridge: {
27569
27687
  description:
27570
27688
  'Tailscale proxy cannot reach the bridge',
27689
+ nullable: true,
27571
27690
  type: 'boolean',
27572
27691
  },
27573
27692
  can_tailscale_proxy_reach_tailscale_network: {
27574
27693
  description:
27575
27694
  'Tailscale proxy cannot reach the Tailscale network',
27695
+ nullable: true,
27576
27696
  type: 'boolean',
27577
27697
  },
27578
27698
  created_at: {
@@ -27588,16 +27708,19 @@ export default {
27588
27708
  is_bridge_socks_server_healthy: {
27589
27709
  description:
27590
27710
  "Bridge's SOCKS server is unhealthy",
27711
+ nullable: true,
27591
27712
  type: 'boolean',
27592
27713
  },
27593
27714
  is_tailscale_proxy_reachable: {
27594
27715
  description:
27595
27716
  'Seam cannot reach the tailscale proxy',
27717
+ nullable: true,
27596
27718
  type: 'boolean',
27597
27719
  },
27598
27720
  is_tailscale_proxy_socks_server_healthy: {
27599
27721
  description:
27600
27722
  "Tailscale proxy's SOCKS server is unhealthy",
27723
+ nullable: true,
27601
27724
  type: 'boolean',
27602
27725
  },
27603
27726
  message: { type: 'string' },