@seamapi/types 1.48.0 → 1.50.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.
Files changed (39) hide show
  1. package/dist/connect.cjs +333 -38
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +477 -17
  4. package/lib/seam/connect/openapi.d.ts +269 -3
  5. package/lib/seam/connect/openapi.js +332 -37
  6. package/lib/seam/connect/openapi.js.map +1 -1
  7. package/lib/seam/connect/route-types.d.ts +208 -14
  8. package/lib/seam/connect/unstable/model-types.d.ts +1 -1
  9. package/lib/seam/connect/unstable/models/access-codes/managed-access-code.js +81 -21
  10. package/lib/seam/connect/unstable/models/access-codes/managed-access-code.js.map +1 -1
  11. package/lib/seam/connect/unstable/models/acs/credential.d.ts +7 -4
  12. package/lib/seam/connect/unstable/models/acs/credential.js +2 -1
  13. package/lib/seam/connect/unstable/models/acs/credential.js.map +1 -1
  14. package/lib/seam/connect/unstable/models/acs/credential_pool.d.ts +29 -0
  15. package/lib/seam/connect/unstable/models/acs/credential_pool.js +12 -0
  16. package/lib/seam/connect/unstable/models/acs/credential_pool.js.map +1 -0
  17. package/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.d.ts +21 -0
  18. package/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.js +9 -0
  19. package/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.js.map +1 -0
  20. package/lib/seam/connect/unstable/models/acs/index.d.ts +2 -0
  21. package/lib/seam/connect/unstable/models/acs/index.js +2 -0
  22. package/lib/seam/connect/unstable/models/acs/index.js.map +1 -1
  23. package/lib/seam/connect/unstable/models/devices/managed-device.d.ts +14 -14
  24. package/lib/seam/connect/unstable/models/devices/managed-device.js +1 -1
  25. package/lib/seam/connect/unstable/models/devices/managed-device.js.map +1 -1
  26. package/lib/seam/connect/unstable/schemas.d.ts +1 -1
  27. package/lib/seam/connect/unstable/schemas.js +1 -1
  28. package/lib/seam/connect/unstable/schemas.js.map +1 -1
  29. package/package.json +1 -1
  30. package/src/lib/seam/connect/openapi.ts +357 -37
  31. package/src/lib/seam/connect/route-types.ts +208 -14
  32. package/src/lib/seam/connect/unstable/model-types.ts +2 -0
  33. package/src/lib/seam/connect/unstable/models/access-codes/managed-access-code.ts +113 -21
  34. package/src/lib/seam/connect/unstable/models/acs/credential.ts +2 -1
  35. package/src/lib/seam/connect/unstable/models/acs/credential_pool.ts +19 -0
  36. package/src/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.ts +13 -0
  37. package/src/lib/seam/connect/unstable/models/acs/index.ts +2 -0
  38. package/src/lib/seam/connect/unstable/models/devices/managed-device.ts +1 -1
  39. package/src/lib/seam/connect/unstable/schemas.ts +3 -0
@@ -3,34 +3,105 @@ export default {
3
3
  schemas: {
4
4
  access_code: {
5
5
  properties: {
6
- access_code_id: { format: 'uuid', type: 'string' },
7
- code: { nullable: true, type: 'string' },
8
- common_code_key: { nullable: true, type: 'string' },
9
- created_at: { format: 'date-time', type: 'string' },
10
- device_id: { format: 'uuid', type: 'string' },
11
- ends_at: { format: 'date-time', nullable: true, type: 'string' },
12
- errors: { nullable: true },
13
- is_backup: { type: 'boolean' },
14
- is_backup_access_code_available: { type: 'boolean' },
15
- is_external_modification_allowed: { type: 'boolean' },
16
- is_managed: { enum: [true], type: 'boolean' },
17
- is_offline_access_code: { type: 'boolean' },
18
- is_one_time_use: { type: 'boolean' },
19
- is_scheduled_on_device: { type: 'boolean' },
20
- is_waiting_for_code_assignment: { type: 'boolean' },
21
- name: { nullable: true, type: 'string' },
6
+ access_code_id: {
7
+ description: 'Unique identifier for the access code.',
8
+ format: 'uuid',
9
+ type: 'string',
10
+ },
11
+ code: {
12
+ description: 'Code used for access. Typically, a numeric or alphanumeric string.',
13
+ nullable: true,
14
+ type: 'string',
15
+ },
16
+ common_code_key: {
17
+ description: 'Unique identifier for a group of access codes that share the same code.',
18
+ nullable: true,
19
+ type: 'string',
20
+ },
21
+ created_at: {
22
+ description: 'Date and time at which the access code was created.',
23
+ format: 'date-time',
24
+ type: 'string',
25
+ },
26
+ device_id: {
27
+ description: 'Unique identifier for the device associated with the access code.',
28
+ format: 'uuid',
29
+ type: 'string',
30
+ },
31
+ ends_at: {
32
+ description: 'Date and time after which the time-bound access code becomes inactive.',
33
+ format: 'date-time',
34
+ nullable: true,
35
+ type: 'string',
36
+ },
37
+ errors: {
38
+ description: 'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
39
+ nullable: true,
40
+ },
41
+ is_backup: {
42
+ description: 'Indicates whether the access code is a backup code.',
43
+ type: 'boolean',
44
+ },
45
+ is_backup_access_code_available: {
46
+ description: 'Indicates whether a backup access code is available for use if the primary access code is lost or compromised.',
47
+ type: 'boolean',
48
+ },
49
+ is_external_modification_allowed: {
50
+ description: 'Indicates whether changes to the access code from external sources are permitted.',
51
+ type: 'boolean',
52
+ },
53
+ is_managed: {
54
+ description: 'Indicates whether Seam manages the access code.',
55
+ enum: [true],
56
+ type: 'boolean',
57
+ },
58
+ is_offline_access_code: {
59
+ description: 'Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.',
60
+ type: 'boolean',
61
+ },
62
+ is_one_time_use: {
63
+ description: 'Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.',
64
+ type: 'boolean',
65
+ },
66
+ is_scheduled_on_device: {
67
+ description: 'Indicates whether the code is set on the device according to a preconfigured schedule.',
68
+ type: 'boolean',
69
+ },
70
+ is_waiting_for_code_assignment: {
71
+ description: 'Indicates whether the access code is waiting for a code assignment.',
72
+ type: 'boolean',
73
+ },
74
+ name: {
75
+ description: 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
76
+ nullable: true,
77
+ type: 'string',
78
+ },
22
79
  pulled_backup_access_code_id: {
80
+ description: 'Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.',
23
81
  format: 'uuid',
24
82
  nullable: true,
25
83
  type: 'string',
26
84
  },
27
- starts_at: { format: 'date-time', nullable: true, type: 'string' },
85
+ starts_at: {
86
+ description: 'Date and time at which the time-bound access code becomes active.',
87
+ format: 'date-time',
88
+ nullable: true,
89
+ type: 'string',
90
+ },
28
91
  status: {
92
+ description: '\n Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.\n ',
29
93
  enum: ['setting', 'set', 'unset', 'removing', 'unknown'],
30
94
  type: 'string',
31
95
  },
32
- type: { enum: ['time_bound', 'ongoing'], type: 'string' },
33
- warnings: { nullable: true },
96
+ type: {
97
+ description: 'Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.',
98
+ enum: ['time_bound', 'ongoing'],
99
+ type: 'string',
100
+ },
101
+ warnings: {
102
+ description: 'Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.',
103
+ nullable: true,
104
+ },
34
105
  },
35
106
  required: [
36
107
  'common_code_key',
@@ -503,11 +574,11 @@ export default {
503
574
  manufacturer: { type: 'string' },
504
575
  model: {
505
576
  properties: {
506
- access_codes_supported: { type: 'boolean' },
507
577
  accessory_keypad_supported: { type: 'boolean' },
508
578
  display_name: { type: 'string' },
509
579
  manufacturer_display_name: { type: 'string' },
510
580
  offline_access_codes_supported: { type: 'boolean' },
581
+ online_access_codes_supported: { type: 'boolean' },
511
582
  },
512
583
  required: ['display_name', 'manufacturer_display_name'],
513
584
  type: 'object',
@@ -1437,18 +1508,58 @@ export default {
1437
1508
  },
1438
1509
  unmanaged_access_code: {
1439
1510
  properties: {
1440
- access_code_id: { format: 'uuid', type: 'string' },
1441
- code: { nullable: true, type: 'string' },
1442
- created_at: { format: 'date-time', type: 'string' },
1443
- device_id: { format: 'uuid', type: 'string' },
1444
- ends_at: { format: 'date-time', nullable: true, type: 'string' },
1445
- errors: { nullable: true },
1511
+ access_code_id: {
1512
+ description: 'Unique identifier for the access code.',
1513
+ format: 'uuid',
1514
+ type: 'string',
1515
+ },
1516
+ code: {
1517
+ description: 'Code used for access. Typically, a numeric or alphanumeric string.',
1518
+ nullable: true,
1519
+ type: 'string',
1520
+ },
1521
+ created_at: {
1522
+ description: 'Date and time at which the access code was created.',
1523
+ format: 'date-time',
1524
+ type: 'string',
1525
+ },
1526
+ device_id: {
1527
+ description: 'Unique identifier for the device associated with the access code.',
1528
+ format: 'uuid',
1529
+ type: 'string',
1530
+ },
1531
+ ends_at: {
1532
+ description: 'Date and time after which the time-bound access code becomes inactive.',
1533
+ format: 'date-time',
1534
+ nullable: true,
1535
+ type: 'string',
1536
+ },
1537
+ errors: {
1538
+ description: 'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
1539
+ nullable: true,
1540
+ },
1446
1541
  is_managed: { enum: [false], type: 'boolean' },
1447
- name: { nullable: true, type: 'string' },
1448
- starts_at: { format: 'date-time', nullable: true, type: 'string' },
1542
+ name: {
1543
+ description: 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
1544
+ nullable: true,
1545
+ type: 'string',
1546
+ },
1547
+ starts_at: {
1548
+ description: 'Date and time at which the time-bound access code becomes active.',
1549
+ format: 'date-time',
1550
+ nullable: true,
1551
+ type: 'string',
1552
+ },
1449
1553
  status: { enum: ['set'], type: 'string' },
1450
- type: { enum: ['time_bound', 'ongoing'], type: 'string' },
1451
- warnings: { nullable: true },
1554
+ type: {
1555
+ description: 'Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.',
1556
+ enum: ['time_bound', 'ongoing'],
1557
+ type: 'string',
1558
+ },
1559
+ warnings: {
1560
+ description: 'Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.',
1561
+ nullable: true,
1562
+ },
1452
1563
  },
1453
1564
  required: [
1454
1565
  'type',
@@ -3014,6 +3125,162 @@ export default {
3014
3125
  'x-fern-sdk-method-name': 'remove_user',
3015
3126
  },
3016
3127
  },
3128
+ '/acs/credential_pools/list': {
3129
+ post: {
3130
+ operationId: 'acsCredentialPoolsListPost',
3131
+ requestBody: {
3132
+ content: {
3133
+ 'application/json': {
3134
+ schema: {
3135
+ properties: {
3136
+ acs_system_id: { format: 'uuid', type: 'string' },
3137
+ },
3138
+ required: ['acs_system_id'],
3139
+ type: 'object',
3140
+ },
3141
+ },
3142
+ },
3143
+ },
3144
+ responses: {
3145
+ 200: {
3146
+ content: {
3147
+ 'application/json': {
3148
+ schema: {
3149
+ properties: {
3150
+ acs_credential_pools: {
3151
+ items: {
3152
+ properties: {
3153
+ acs_credential_pool_id: {
3154
+ format: 'uuid',
3155
+ type: 'string',
3156
+ },
3157
+ acs_system_id: { format: 'uuid', type: 'string' },
3158
+ created_at: { format: 'date-time', type: 'string' },
3159
+ display_name: { minLength: 1, type: 'string' },
3160
+ external_type: {
3161
+ enum: ['hid_part_number'],
3162
+ type: 'string',
3163
+ },
3164
+ external_type_display_name: { type: 'string' },
3165
+ workspace_id: { format: 'uuid', type: 'string' },
3166
+ },
3167
+ required: [
3168
+ 'acs_credential_pool_id',
3169
+ 'acs_system_id',
3170
+ 'display_name',
3171
+ 'external_type',
3172
+ 'external_type_display_name',
3173
+ 'created_at',
3174
+ 'workspace_id',
3175
+ ],
3176
+ type: 'object',
3177
+ },
3178
+ type: 'array',
3179
+ },
3180
+ ok: { type: 'boolean' },
3181
+ },
3182
+ required: ['acs_credential_pools', 'ok'],
3183
+ type: 'object',
3184
+ },
3185
+ },
3186
+ },
3187
+ description: 'OK',
3188
+ },
3189
+ 400: { description: 'Bad Request' },
3190
+ 401: { description: 'Unauthorized' },
3191
+ },
3192
+ security: [
3193
+ { access_token: [], seam_workspace: [] },
3194
+ { seam_client_session_token: [] },
3195
+ { client_session_token: [] },
3196
+ ],
3197
+ summary: '/acs/credential_pools/list',
3198
+ tags: [],
3199
+ 'x-fern-sdk-group-name': ['acs', 'credential_pools'],
3200
+ 'x-fern-sdk-method-name': 'list',
3201
+ },
3202
+ },
3203
+ '/acs/credential_provisioning_automations/launch': {
3204
+ post: {
3205
+ operationId: 'acsCredentialProvisioningAutomationsLaunchPost',
3206
+ requestBody: {
3207
+ content: {
3208
+ 'application/json': {
3209
+ schema: {
3210
+ properties: {
3211
+ acs_credential_pool_id: { format: 'uuid', type: 'string' },
3212
+ create_credential_manager_user: { type: 'boolean' },
3213
+ credential_manager_acs_system_id: {
3214
+ format: 'uuid',
3215
+ type: 'string',
3216
+ },
3217
+ credential_manager_acs_user_id: {
3218
+ format: 'uuid',
3219
+ type: 'string',
3220
+ },
3221
+ user_identity_id: { format: 'uuid', type: 'string' },
3222
+ },
3223
+ required: [
3224
+ 'user_identity_id',
3225
+ 'credential_manager_acs_system_id',
3226
+ ],
3227
+ type: 'object',
3228
+ },
3229
+ },
3230
+ },
3231
+ },
3232
+ responses: {
3233
+ 200: {
3234
+ content: {
3235
+ 'application/json': {
3236
+ schema: {
3237
+ properties: {
3238
+ acs_credential_provisioning_automation: {
3239
+ properties: {
3240
+ acs_credential_provisioning_automation_id: {
3241
+ format: 'uuid',
3242
+ type: 'string',
3243
+ },
3244
+ created_at: { format: 'date-time', type: 'string' },
3245
+ credential_manager_acs_system_id: {
3246
+ format: 'uuid',
3247
+ type: 'string',
3248
+ },
3249
+ user_identity_id: { format: 'uuid', type: 'string' },
3250
+ workspace_id: { format: 'uuid', type: 'string' },
3251
+ },
3252
+ required: [
3253
+ 'acs_credential_provisioning_automation_id',
3254
+ 'credential_manager_acs_system_id',
3255
+ 'user_identity_id',
3256
+ 'created_at',
3257
+ 'workspace_id',
3258
+ ],
3259
+ type: 'object',
3260
+ },
3261
+ ok: { type: 'boolean' },
3262
+ },
3263
+ required: ['acs_credential_provisioning_automation', 'ok'],
3264
+ type: 'object',
3265
+ },
3266
+ },
3267
+ },
3268
+ description: 'OK',
3269
+ },
3270
+ 400: { description: 'Bad Request' },
3271
+ 401: { description: 'Unauthorized' },
3272
+ },
3273
+ security: [
3274
+ { access_token: [], seam_workspace: [] },
3275
+ { seam_client_session_token: [] },
3276
+ { client_session_token: [] },
3277
+ ],
3278
+ summary: '/acs/credential_provisioning_automations/launch',
3279
+ tags: [],
3280
+ 'x-fern-sdk-group-name': ['acs', 'credential_provisioning_automations'],
3281
+ 'x-fern-sdk-method-name': 'launch',
3282
+ },
3283
+ },
3017
3284
  '/acs/credentials/assign': {
3018
3285
  patch: {
3019
3286
  operationId: 'acsCredentialsAssignPatch',
@@ -3040,6 +3307,10 @@ export default {
3040
3307
  acs_credential: {
3041
3308
  properties: {
3042
3309
  acs_credential_id: { format: 'uuid', type: 'string' },
3310
+ acs_credential_pool_id: {
3311
+ format: 'uuid',
3312
+ type: 'string',
3313
+ },
3043
3314
  acs_system_id: { format: 'uuid', type: 'string' },
3044
3315
  acs_user_id: { format: 'uuid', type: 'string' },
3045
3316
  code: { nullable: true, type: 'string' },
@@ -3049,7 +3320,7 @@ export default {
3049
3320
  enum: [
3050
3321
  'pti_card',
3051
3322
  'brivo_credential',
3052
- 'hid_cm_credential',
3323
+ 'hid_credential',
3053
3324
  ],
3054
3325
  type: 'string',
3055
3326
  },
@@ -3114,6 +3385,10 @@ export default {
3114
3385
  acs_credential: {
3115
3386
  properties: {
3116
3387
  acs_credential_id: { format: 'uuid', type: 'string' },
3388
+ acs_credential_pool_id: {
3389
+ format: 'uuid',
3390
+ type: 'string',
3391
+ },
3117
3392
  acs_system_id: { format: 'uuid', type: 'string' },
3118
3393
  acs_user_id: { format: 'uuid', type: 'string' },
3119
3394
  code: { nullable: true, type: 'string' },
@@ -3123,7 +3398,7 @@ export default {
3123
3398
  enum: [
3124
3399
  'pti_card',
3125
3400
  'brivo_credential',
3126
- 'hid_cm_credential',
3401
+ 'hid_credential',
3127
3402
  ],
3128
3403
  type: 'string',
3129
3404
  },
@@ -3191,6 +3466,10 @@ export default {
3191
3466
  acs_credential: {
3192
3467
  properties: {
3193
3468
  acs_credential_id: { format: 'uuid', type: 'string' },
3469
+ acs_credential_pool_id: {
3470
+ format: 'uuid',
3471
+ type: 'string',
3472
+ },
3194
3473
  acs_system_id: { format: 'uuid', type: 'string' },
3195
3474
  acs_user_id: { format: 'uuid', type: 'string' },
3196
3475
  code: { nullable: true, type: 'string' },
@@ -3200,7 +3479,7 @@ export default {
3200
3479
  enum: [
3201
3480
  'pti_card',
3202
3481
  'brivo_credential',
3203
- 'hid_cm_credential',
3482
+ 'hid_credential',
3204
3483
  ],
3205
3484
  type: 'string',
3206
3485
  },
@@ -3310,6 +3589,10 @@ export default {
3310
3589
  acs_credential: {
3311
3590
  properties: {
3312
3591
  acs_credential_id: { format: 'uuid', type: 'string' },
3592
+ acs_credential_pool_id: {
3593
+ format: 'uuid',
3594
+ type: 'string',
3595
+ },
3313
3596
  acs_system_id: { format: 'uuid', type: 'string' },
3314
3597
  acs_user_id: { format: 'uuid', type: 'string' },
3315
3598
  code: { nullable: true, type: 'string' },
@@ -3319,7 +3602,7 @@ export default {
3319
3602
  enum: [
3320
3603
  'pti_card',
3321
3604
  'brivo_credential',
3322
- 'hid_cm_credential',
3605
+ 'hid_credential',
3323
3606
  ],
3324
3607
  type: 'string',
3325
3608
  },
@@ -3406,6 +3689,10 @@ export default {
3406
3689
  items: {
3407
3690
  properties: {
3408
3691
  acs_credential_id: { format: 'uuid', type: 'string' },
3692
+ acs_credential_pool_id: {
3693
+ format: 'uuid',
3694
+ type: 'string',
3695
+ },
3409
3696
  acs_system_id: { format: 'uuid', type: 'string' },
3410
3697
  acs_user_id: { format: 'uuid', type: 'string' },
3411
3698
  code: { nullable: true, type: 'string' },
@@ -3415,7 +3702,7 @@ export default {
3415
3702
  enum: [
3416
3703
  'pti_card',
3417
3704
  'brivo_credential',
3418
- 'hid_cm_credential',
3705
+ 'hid_credential',
3419
3706
  ],
3420
3707
  type: 'string',
3421
3708
  },
@@ -3485,6 +3772,10 @@ export default {
3485
3772
  acs_credential: {
3486
3773
  properties: {
3487
3774
  acs_credential_id: { format: 'uuid', type: 'string' },
3775
+ acs_credential_pool_id: {
3776
+ format: 'uuid',
3777
+ type: 'string',
3778
+ },
3488
3779
  acs_system_id: { format: 'uuid', type: 'string' },
3489
3780
  acs_user_id: { format: 'uuid', type: 'string' },
3490
3781
  code: { nullable: true, type: 'string' },
@@ -3494,7 +3785,7 @@ export default {
3494
3785
  enum: [
3495
3786
  'pti_card',
3496
3787
  'brivo_credential',
3497
- 'hid_cm_credential',
3788
+ 'hid_credential',
3498
3789
  ],
3499
3790
  type: 'string',
3500
3791
  },
@@ -3559,6 +3850,10 @@ export default {
3559
3850
  acs_credential: {
3560
3851
  properties: {
3561
3852
  acs_credential_id: { format: 'uuid', type: 'string' },
3853
+ acs_credential_pool_id: {
3854
+ format: 'uuid',
3855
+ type: 'string',
3856
+ },
3562
3857
  acs_system_id: { format: 'uuid', type: 'string' },
3563
3858
  acs_user_id: { format: 'uuid', type: 'string' },
3564
3859
  code: { nullable: true, type: 'string' },
@@ -3568,7 +3863,7 @@ export default {
3568
3863
  enum: [
3569
3864
  'pti_card',
3570
3865
  'brivo_credential',
3571
- 'hid_cm_credential',
3866
+ 'hid_credential',
3572
3867
  ],
3573
3868
  type: 'string',
3574
3869
  },