@seamapi/types 1.252.1 → 1.252.2

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.
@@ -2922,8 +2922,226 @@ export interface Routes {
2922
2922
  }>;
2923
2923
  };
2924
2924
  };
2925
- '/acs/credentials/read_card': {
2926
- route: '/acs/credentials/read_card';
2925
+ '/acs/credentials/unassign': {
2926
+ route: '/acs/credentials/unassign';
2927
+ method: 'PATCH' | 'POST';
2928
+ queryParams: {};
2929
+ jsonBody: {
2930
+ acs_user_id: string;
2931
+ acs_credential_id: string;
2932
+ };
2933
+ commonParams: {};
2934
+ formData: {};
2935
+ jsonResponse: {
2936
+ acs_credential: {
2937
+ acs_credential_id: string;
2938
+ acs_user_id?: string | undefined;
2939
+ acs_credential_pool_id?: string | undefined;
2940
+ acs_system_id: string;
2941
+ parent_acs_credential_id?: string | undefined;
2942
+ display_name: string;
2943
+ code?: (string | undefined) | null;
2944
+ card_number?: (string | undefined) | null;
2945
+ is_encoded?: boolean | undefined;
2946
+ encoded_at?: (string | undefined) | null;
2947
+ access_method: 'code' | 'card' | 'mobile_key';
2948
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
2949
+ external_type_display_name?: string | undefined;
2950
+ created_at: string;
2951
+ workspace_id: string;
2952
+ starts_at?: string | undefined;
2953
+ ends_at?: string | undefined;
2954
+ errors: Array<{
2955
+ error_code: string;
2956
+ message: string;
2957
+ }>;
2958
+ warnings: Array<{
2959
+ warning_code: string;
2960
+ message: string;
2961
+ }>;
2962
+ is_multi_phone_sync_credential?: boolean | undefined;
2963
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
2964
+ latest_desired_state_synced_with_provider_at?: string | undefined;
2965
+ visionline_metadata?: {
2966
+ card_function_type: 'guest' | 'staff';
2967
+ joiner_acs_credential_ids?: string[] | undefined;
2968
+ guest_acs_entrance_ids?: string[] | undefined;
2969
+ common_acs_entrance_ids?: string[] | undefined;
2970
+ is_valid?: boolean | undefined;
2971
+ card_id?: string | undefined;
2972
+ credential_id?: string | undefined;
2973
+ } | undefined;
2974
+ is_managed: true;
2975
+ };
2976
+ };
2977
+ };
2978
+ '/acs/credentials/unmanaged/get': {
2979
+ route: '/acs/credentials/unmanaged/get';
2980
+ method: 'GET' | 'POST';
2981
+ queryParams: {};
2982
+ jsonBody: {};
2983
+ commonParams: {
2984
+ acs_credential_id: string;
2985
+ };
2986
+ formData: {};
2987
+ jsonResponse: {
2988
+ acs_credential: {
2989
+ acs_credential_id: string;
2990
+ acs_user_id?: string | undefined;
2991
+ acs_credential_pool_id?: string | undefined;
2992
+ acs_system_id: string;
2993
+ parent_acs_credential_id?: string | undefined;
2994
+ display_name: string;
2995
+ code?: (string | undefined) | null;
2996
+ card_number?: (string | undefined) | null;
2997
+ is_encoded?: boolean | undefined;
2998
+ encoded_at?: (string | undefined) | null;
2999
+ access_method: 'code' | 'card' | 'mobile_key';
3000
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
3001
+ external_type_display_name?: string | undefined;
3002
+ created_at: string;
3003
+ workspace_id: string;
3004
+ starts_at?: string | undefined;
3005
+ ends_at?: string | undefined;
3006
+ errors: Array<{
3007
+ error_code: string;
3008
+ message: string;
3009
+ }>;
3010
+ warnings: Array<{
3011
+ warning_code: string;
3012
+ message: string;
3013
+ }>;
3014
+ is_multi_phone_sync_credential?: boolean | undefined;
3015
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
3016
+ latest_desired_state_synced_with_provider_at?: string | undefined;
3017
+ visionline_metadata?: {
3018
+ card_function_type: 'guest' | 'staff';
3019
+ joiner_acs_credential_ids?: string[] | undefined;
3020
+ guest_acs_entrance_ids?: string[] | undefined;
3021
+ common_acs_entrance_ids?: string[] | undefined;
3022
+ is_valid?: boolean | undefined;
3023
+ card_id?: string | undefined;
3024
+ credential_id?: string | undefined;
3025
+ } | undefined;
3026
+ is_managed: false;
3027
+ };
3028
+ };
3029
+ };
3030
+ '/acs/credentials/unmanaged/list': {
3031
+ route: '/acs/credentials/unmanaged/list';
3032
+ method: 'GET' | 'POST';
3033
+ queryParams: {};
3034
+ jsonBody: {};
3035
+ commonParams: {
3036
+ acs_user_id: string;
3037
+ } | {
3038
+ acs_system_id: string;
3039
+ } | {
3040
+ acs_user_id: string;
3041
+ acs_system_id: string;
3042
+ } | {
3043
+ user_identity_id: string;
3044
+ };
3045
+ formData: {};
3046
+ jsonResponse: {
3047
+ acs_credentials: Array<{
3048
+ acs_credential_id: string;
3049
+ acs_user_id?: string | undefined;
3050
+ acs_credential_pool_id?: string | undefined;
3051
+ acs_system_id: string;
3052
+ parent_acs_credential_id?: string | undefined;
3053
+ display_name: string;
3054
+ code?: (string | undefined) | null;
3055
+ card_number?: (string | undefined) | null;
3056
+ is_encoded?: boolean | undefined;
3057
+ encoded_at?: (string | undefined) | null;
3058
+ access_method: 'code' | 'card' | 'mobile_key';
3059
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
3060
+ external_type_display_name?: string | undefined;
3061
+ created_at: string;
3062
+ workspace_id: string;
3063
+ starts_at?: string | undefined;
3064
+ ends_at?: string | undefined;
3065
+ errors: Array<{
3066
+ error_code: string;
3067
+ message: string;
3068
+ }>;
3069
+ warnings: Array<{
3070
+ warning_code: string;
3071
+ message: string;
3072
+ }>;
3073
+ is_multi_phone_sync_credential?: boolean | undefined;
3074
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
3075
+ latest_desired_state_synced_with_provider_at?: string | undefined;
3076
+ visionline_metadata?: {
3077
+ card_function_type: 'guest' | 'staff';
3078
+ joiner_acs_credential_ids?: string[] | undefined;
3079
+ guest_acs_entrance_ids?: string[] | undefined;
3080
+ common_acs_entrance_ids?: string[] | undefined;
3081
+ is_valid?: boolean | undefined;
3082
+ card_id?: string | undefined;
3083
+ credential_id?: string | undefined;
3084
+ } | undefined;
3085
+ is_managed: false;
3086
+ }>;
3087
+ };
3088
+ };
3089
+ '/acs/credentials/update': {
3090
+ route: '/acs/credentials/update';
3091
+ method: 'PATCH' | 'POST';
3092
+ queryParams: {};
3093
+ jsonBody: {
3094
+ acs_credential_id: string;
3095
+ code?: string | undefined;
3096
+ ends_at?: string | undefined;
3097
+ };
3098
+ commonParams: {};
3099
+ formData: {};
3100
+ jsonResponse: {
3101
+ acs_credential: {
3102
+ acs_credential_id: string;
3103
+ acs_user_id?: string | undefined;
3104
+ acs_credential_pool_id?: string | undefined;
3105
+ acs_system_id: string;
3106
+ parent_acs_credential_id?: string | undefined;
3107
+ display_name: string;
3108
+ code?: (string | undefined) | null;
3109
+ card_number?: (string | undefined) | null;
3110
+ is_encoded?: boolean | undefined;
3111
+ encoded_at?: (string | undefined) | null;
3112
+ access_method: 'code' | 'card' | 'mobile_key';
3113
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
3114
+ external_type_display_name?: string | undefined;
3115
+ created_at: string;
3116
+ workspace_id: string;
3117
+ starts_at?: string | undefined;
3118
+ ends_at?: string | undefined;
3119
+ errors: Array<{
3120
+ error_code: string;
3121
+ message: string;
3122
+ }>;
3123
+ warnings: Array<{
3124
+ warning_code: string;
3125
+ message: string;
3126
+ }>;
3127
+ is_multi_phone_sync_credential?: boolean | undefined;
3128
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
3129
+ latest_desired_state_synced_with_provider_at?: string | undefined;
3130
+ visionline_metadata?: {
3131
+ card_function_type: 'guest' | 'staff';
3132
+ joiner_acs_credential_ids?: string[] | undefined;
3133
+ guest_acs_entrance_ids?: string[] | undefined;
3134
+ common_acs_entrance_ids?: string[] | undefined;
3135
+ is_valid?: boolean | undefined;
3136
+ card_id?: string | undefined;
3137
+ credential_id?: string | undefined;
3138
+ } | undefined;
3139
+ is_managed: true;
3140
+ };
3141
+ };
3142
+ };
3143
+ '/acs/encoders/read_card': {
3144
+ route: '/acs/encoders/read_card';
2927
3145
  method: 'POST';
2928
3146
  queryParams: {};
2929
3147
  jsonBody: {};
@@ -3351,224 +3569,6 @@ export interface Routes {
3351
3569
  };
3352
3570
  };
3353
3571
  };
3354
- '/acs/credentials/unassign': {
3355
- route: '/acs/credentials/unassign';
3356
- method: 'PATCH' | 'POST';
3357
- queryParams: {};
3358
- jsonBody: {
3359
- acs_user_id: string;
3360
- acs_credential_id: string;
3361
- };
3362
- commonParams: {};
3363
- formData: {};
3364
- jsonResponse: {
3365
- acs_credential: {
3366
- acs_credential_id: string;
3367
- acs_user_id?: string | undefined;
3368
- acs_credential_pool_id?: string | undefined;
3369
- acs_system_id: string;
3370
- parent_acs_credential_id?: string | undefined;
3371
- display_name: string;
3372
- code?: (string | undefined) | null;
3373
- card_number?: (string | undefined) | null;
3374
- is_encoded?: boolean | undefined;
3375
- encoded_at?: (string | undefined) | null;
3376
- access_method: 'code' | 'card' | 'mobile_key';
3377
- external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
3378
- external_type_display_name?: string | undefined;
3379
- created_at: string;
3380
- workspace_id: string;
3381
- starts_at?: string | undefined;
3382
- ends_at?: string | undefined;
3383
- errors: Array<{
3384
- error_code: string;
3385
- message: string;
3386
- }>;
3387
- warnings: Array<{
3388
- warning_code: string;
3389
- message: string;
3390
- }>;
3391
- is_multi_phone_sync_credential?: boolean | undefined;
3392
- is_latest_desired_state_synced_with_provider?: boolean | undefined;
3393
- latest_desired_state_synced_with_provider_at?: string | undefined;
3394
- visionline_metadata?: {
3395
- card_function_type: 'guest' | 'staff';
3396
- joiner_acs_credential_ids?: string[] | undefined;
3397
- guest_acs_entrance_ids?: string[] | undefined;
3398
- common_acs_entrance_ids?: string[] | undefined;
3399
- is_valid?: boolean | undefined;
3400
- card_id?: string | undefined;
3401
- credential_id?: string | undefined;
3402
- } | undefined;
3403
- is_managed: true;
3404
- };
3405
- };
3406
- };
3407
- '/acs/credentials/unmanaged/get': {
3408
- route: '/acs/credentials/unmanaged/get';
3409
- method: 'GET' | 'POST';
3410
- queryParams: {};
3411
- jsonBody: {};
3412
- commonParams: {
3413
- acs_credential_id: string;
3414
- };
3415
- formData: {};
3416
- jsonResponse: {
3417
- acs_credential: {
3418
- acs_credential_id: string;
3419
- acs_user_id?: string | undefined;
3420
- acs_credential_pool_id?: string | undefined;
3421
- acs_system_id: string;
3422
- parent_acs_credential_id?: string | undefined;
3423
- display_name: string;
3424
- code?: (string | undefined) | null;
3425
- card_number?: (string | undefined) | null;
3426
- is_encoded?: boolean | undefined;
3427
- encoded_at?: (string | undefined) | null;
3428
- access_method: 'code' | 'card' | 'mobile_key';
3429
- external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
3430
- external_type_display_name?: string | undefined;
3431
- created_at: string;
3432
- workspace_id: string;
3433
- starts_at?: string | undefined;
3434
- ends_at?: string | undefined;
3435
- errors: Array<{
3436
- error_code: string;
3437
- message: string;
3438
- }>;
3439
- warnings: Array<{
3440
- warning_code: string;
3441
- message: string;
3442
- }>;
3443
- is_multi_phone_sync_credential?: boolean | undefined;
3444
- is_latest_desired_state_synced_with_provider?: boolean | undefined;
3445
- latest_desired_state_synced_with_provider_at?: string | undefined;
3446
- visionline_metadata?: {
3447
- card_function_type: 'guest' | 'staff';
3448
- joiner_acs_credential_ids?: string[] | undefined;
3449
- guest_acs_entrance_ids?: string[] | undefined;
3450
- common_acs_entrance_ids?: string[] | undefined;
3451
- is_valid?: boolean | undefined;
3452
- card_id?: string | undefined;
3453
- credential_id?: string | undefined;
3454
- } | undefined;
3455
- is_managed: false;
3456
- };
3457
- };
3458
- };
3459
- '/acs/credentials/unmanaged/list': {
3460
- route: '/acs/credentials/unmanaged/list';
3461
- method: 'GET' | 'POST';
3462
- queryParams: {};
3463
- jsonBody: {};
3464
- commonParams: {
3465
- acs_user_id: string;
3466
- } | {
3467
- acs_system_id: string;
3468
- } | {
3469
- acs_user_id: string;
3470
- acs_system_id: string;
3471
- } | {
3472
- user_identity_id: string;
3473
- };
3474
- formData: {};
3475
- jsonResponse: {
3476
- acs_credentials: Array<{
3477
- acs_credential_id: string;
3478
- acs_user_id?: string | undefined;
3479
- acs_credential_pool_id?: string | undefined;
3480
- acs_system_id: string;
3481
- parent_acs_credential_id?: string | undefined;
3482
- display_name: string;
3483
- code?: (string | undefined) | null;
3484
- card_number?: (string | undefined) | null;
3485
- is_encoded?: boolean | undefined;
3486
- encoded_at?: (string | undefined) | null;
3487
- access_method: 'code' | 'card' | 'mobile_key';
3488
- external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
3489
- external_type_display_name?: string | undefined;
3490
- created_at: string;
3491
- workspace_id: string;
3492
- starts_at?: string | undefined;
3493
- ends_at?: string | undefined;
3494
- errors: Array<{
3495
- error_code: string;
3496
- message: string;
3497
- }>;
3498
- warnings: Array<{
3499
- warning_code: string;
3500
- message: string;
3501
- }>;
3502
- is_multi_phone_sync_credential?: boolean | undefined;
3503
- is_latest_desired_state_synced_with_provider?: boolean | undefined;
3504
- latest_desired_state_synced_with_provider_at?: string | undefined;
3505
- visionline_metadata?: {
3506
- card_function_type: 'guest' | 'staff';
3507
- joiner_acs_credential_ids?: string[] | undefined;
3508
- guest_acs_entrance_ids?: string[] | undefined;
3509
- common_acs_entrance_ids?: string[] | undefined;
3510
- is_valid?: boolean | undefined;
3511
- card_id?: string | undefined;
3512
- credential_id?: string | undefined;
3513
- } | undefined;
3514
- is_managed: false;
3515
- }>;
3516
- };
3517
- };
3518
- '/acs/credentials/update': {
3519
- route: '/acs/credentials/update';
3520
- method: 'PATCH' | 'POST';
3521
- queryParams: {};
3522
- jsonBody: {
3523
- acs_credential_id: string;
3524
- code?: string | undefined;
3525
- ends_at?: string | undefined;
3526
- };
3527
- commonParams: {};
3528
- formData: {};
3529
- jsonResponse: {
3530
- acs_credential: {
3531
- acs_credential_id: string;
3532
- acs_user_id?: string | undefined;
3533
- acs_credential_pool_id?: string | undefined;
3534
- acs_system_id: string;
3535
- parent_acs_credential_id?: string | undefined;
3536
- display_name: string;
3537
- code?: (string | undefined) | null;
3538
- card_number?: (string | undefined) | null;
3539
- is_encoded?: boolean | undefined;
3540
- encoded_at?: (string | undefined) | null;
3541
- access_method: 'code' | 'card' | 'mobile_key';
3542
- external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
3543
- external_type_display_name?: string | undefined;
3544
- created_at: string;
3545
- workspace_id: string;
3546
- starts_at?: string | undefined;
3547
- ends_at?: string | undefined;
3548
- errors: Array<{
3549
- error_code: string;
3550
- message: string;
3551
- }>;
3552
- warnings: Array<{
3553
- warning_code: string;
3554
- message: string;
3555
- }>;
3556
- is_multi_phone_sync_credential?: boolean | undefined;
3557
- is_latest_desired_state_synced_with_provider?: boolean | undefined;
3558
- latest_desired_state_synced_with_provider_at?: string | undefined;
3559
- visionline_metadata?: {
3560
- card_function_type: 'guest' | 'staff';
3561
- joiner_acs_credential_ids?: string[] | undefined;
3562
- guest_acs_entrance_ids?: string[] | undefined;
3563
- common_acs_entrance_ids?: string[] | undefined;
3564
- is_valid?: boolean | undefined;
3565
- card_id?: string | undefined;
3566
- credential_id?: string | undefined;
3567
- } | undefined;
3568
- is_managed: true;
3569
- };
3570
- };
3571
- };
3572
3572
  '/acs/entrances/get': {
3573
3573
  route: '/acs/entrances/get';
3574
3574
  method: 'GET' | 'POST';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.252.1",
3
+ "version": "1.252.2",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -6810,68 +6810,6 @@ export default {
6810
6810
  'x-fern-sdk-return-value': 'acs_entrances',
6811
6811
  },
6812
6812
  },
6813
- '/acs/credentials/read_card': {
6814
- post: {
6815
- operationId: 'acsCredentialsReadCardPost',
6816
- requestBody: {
6817
- content: {
6818
- 'application/json': {
6819
- schema: {
6820
- oneOf: [
6821
- {
6822
- properties: {
6823
- acs_system_id: { format: 'uuid', type: 'string' },
6824
- device_name: { type: 'string' },
6825
- },
6826
- required: ['acs_system_id', 'device_name'],
6827
- type: 'object',
6828
- },
6829
- {
6830
- properties: {
6831
- device_id: { format: 'uuid', type: 'string' },
6832
- },
6833
- required: ['device_id'],
6834
- type: 'object',
6835
- },
6836
- ],
6837
- },
6838
- },
6839
- },
6840
- },
6841
- responses: {
6842
- 200: {
6843
- content: {
6844
- 'application/json': {
6845
- schema: {
6846
- properties: {
6847
- action_attempt: {
6848
- $ref: '#/components/schemas/action_attempt',
6849
- },
6850
- ok: { type: 'boolean' },
6851
- },
6852
- required: ['action_attempt', 'ok'],
6853
- type: 'object',
6854
- },
6855
- },
6856
- },
6857
- description: 'OK',
6858
- },
6859
- 400: { description: 'Bad Request' },
6860
- 401: { description: 'Unauthorized' },
6861
- },
6862
- security: [
6863
- { pat_with_workspace: [] },
6864
- { console_session: [] },
6865
- { api_key: [] },
6866
- ],
6867
- summary: '/acs/credentials/read_card',
6868
- tags: ['/acs'],
6869
- 'x-fern-sdk-group-name': ['acs', 'credentials'],
6870
- 'x-fern-sdk-method-name': 'read_card',
6871
- 'x-fern-sdk-return-value': 'action_attempt',
6872
- 'x-undocumented': 'Reading a card is currently unimplemented.',
6873
- },
6874
- },
6875
6813
  '/acs/credentials/unassign': {
6876
6814
  patch: {
6877
6815
  operationId: 'acsCredentialsUnassignPatch',
@@ -7407,6 +7345,68 @@ export default {
7407
7345
  'x-fern-sdk-method-name': 'update',
7408
7346
  },
7409
7347
  },
7348
+ '/acs/encoders/read_card': {
7349
+ post: {
7350
+ operationId: 'acsEncodersReadCardPost',
7351
+ requestBody: {
7352
+ content: {
7353
+ 'application/json': {
7354
+ schema: {
7355
+ oneOf: [
7356
+ {
7357
+ properties: {
7358
+ acs_system_id: { format: 'uuid', type: 'string' },
7359
+ device_name: { type: 'string' },
7360
+ },
7361
+ required: ['acs_system_id', 'device_name'],
7362
+ type: 'object',
7363
+ },
7364
+ {
7365
+ properties: {
7366
+ device_id: { format: 'uuid', type: 'string' },
7367
+ },
7368
+ required: ['device_id'],
7369
+ type: 'object',
7370
+ },
7371
+ ],
7372
+ },
7373
+ },
7374
+ },
7375
+ },
7376
+ responses: {
7377
+ 200: {
7378
+ content: {
7379
+ 'application/json': {
7380
+ schema: {
7381
+ properties: {
7382
+ action_attempt: {
7383
+ $ref: '#/components/schemas/action_attempt',
7384
+ },
7385
+ ok: { type: 'boolean' },
7386
+ },
7387
+ required: ['action_attempt', 'ok'],
7388
+ type: 'object',
7389
+ },
7390
+ },
7391
+ },
7392
+ description: 'OK',
7393
+ },
7394
+ 400: { description: 'Bad Request' },
7395
+ 401: { description: 'Unauthorized' },
7396
+ },
7397
+ security: [
7398
+ { pat_with_workspace: [] },
7399
+ { console_session: [] },
7400
+ { api_key: [] },
7401
+ ],
7402
+ summary: '/acs/encoders/read_card',
7403
+ tags: ['/acs'],
7404
+ 'x-fern-sdk-group-name': ['acs', 'encoders'],
7405
+ 'x-fern-sdk-method-name': 'read_card',
7406
+ 'x-fern-sdk-return-value': 'action_attempt',
7407
+ 'x-undocumented': 'Reading a card is currently unimplemented.',
7408
+ },
7409
+ },
7410
7410
  '/acs/entrances/get': {
7411
7411
  post: {
7412
7412
  operationId: 'acsEntrancesGetPost',