@seamapi/types 1.301.0 → 1.302.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/dist/connect.cjs +77 -0
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +199 -0
- package/lib/seam/connect/openapi.d.ts +91 -0
- package/lib/seam/connect/openapi.js +77 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +108 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +83 -0
- package/src/lib/seam/connect/route-types.ts +123 -0
package/dist/connect.d.cts
CHANGED
|
@@ -20468,6 +20468,97 @@ declare const _default: {
|
|
|
20468
20468
|
'x-title': string;
|
|
20469
20469
|
};
|
|
20470
20470
|
};
|
|
20471
|
+
'/acs/credentials/create_offline_code': {
|
|
20472
|
+
post: {
|
|
20473
|
+
description: string;
|
|
20474
|
+
operationId: string;
|
|
20475
|
+
requestBody: {
|
|
20476
|
+
content: {
|
|
20477
|
+
'application/json': {
|
|
20478
|
+
schema: {
|
|
20479
|
+
properties: {
|
|
20480
|
+
acs_user_id: {
|
|
20481
|
+
description: string;
|
|
20482
|
+
format: string;
|
|
20483
|
+
type: string;
|
|
20484
|
+
};
|
|
20485
|
+
allowed_acs_entrance_id: {
|
|
20486
|
+
description: string;
|
|
20487
|
+
format: string;
|
|
20488
|
+
type: string;
|
|
20489
|
+
};
|
|
20490
|
+
ends_at: {
|
|
20491
|
+
description: string;
|
|
20492
|
+
format: string;
|
|
20493
|
+
type: string;
|
|
20494
|
+
};
|
|
20495
|
+
is_one_time_use: {
|
|
20496
|
+
default: boolean;
|
|
20497
|
+
description: string;
|
|
20498
|
+
type: string;
|
|
20499
|
+
};
|
|
20500
|
+
starts_at: {
|
|
20501
|
+
description: string;
|
|
20502
|
+
format: string;
|
|
20503
|
+
type: string;
|
|
20504
|
+
};
|
|
20505
|
+
};
|
|
20506
|
+
required: string[];
|
|
20507
|
+
type: string;
|
|
20508
|
+
};
|
|
20509
|
+
};
|
|
20510
|
+
};
|
|
20511
|
+
};
|
|
20512
|
+
responses: {
|
|
20513
|
+
200: {
|
|
20514
|
+
content: {
|
|
20515
|
+
'application/json': {
|
|
20516
|
+
schema: {
|
|
20517
|
+
properties: {
|
|
20518
|
+
acs_credential: {
|
|
20519
|
+
$ref: string;
|
|
20520
|
+
};
|
|
20521
|
+
ok: {
|
|
20522
|
+
type: string;
|
|
20523
|
+
};
|
|
20524
|
+
};
|
|
20525
|
+
required: string[];
|
|
20526
|
+
type: string;
|
|
20527
|
+
};
|
|
20528
|
+
};
|
|
20529
|
+
};
|
|
20530
|
+
description: string;
|
|
20531
|
+
};
|
|
20532
|
+
400: {
|
|
20533
|
+
description: string;
|
|
20534
|
+
};
|
|
20535
|
+
401: {
|
|
20536
|
+
description: string;
|
|
20537
|
+
};
|
|
20538
|
+
};
|
|
20539
|
+
security: ({
|
|
20540
|
+
pat_with_workspace: never[];
|
|
20541
|
+
console_session?: never;
|
|
20542
|
+
api_key?: never;
|
|
20543
|
+
} | {
|
|
20544
|
+
console_session: never[];
|
|
20545
|
+
pat_with_workspace?: never;
|
|
20546
|
+
api_key?: never;
|
|
20547
|
+
} | {
|
|
20548
|
+
api_key: never[];
|
|
20549
|
+
pat_with_workspace?: never;
|
|
20550
|
+
console_session?: never;
|
|
20551
|
+
})[];
|
|
20552
|
+
summary: string;
|
|
20553
|
+
tags: string[];
|
|
20554
|
+
'x-fern-sdk-group-name': string[];
|
|
20555
|
+
'x-fern-sdk-method-name': string;
|
|
20556
|
+
'x-fern-sdk-return-value': string;
|
|
20557
|
+
'x-response-key': string;
|
|
20558
|
+
'x-title': string;
|
|
20559
|
+
'x-undocumented': string;
|
|
20560
|
+
};
|
|
20561
|
+
};
|
|
20471
20562
|
'/acs/credentials/delete': {
|
|
20472
20563
|
post: {
|
|
20473
20564
|
description: string;
|
|
@@ -37698,6 +37789,114 @@ interface Routes {
|
|
|
37698
37789
|
};
|
|
37699
37790
|
};
|
|
37700
37791
|
};
|
|
37792
|
+
'/acs/credentials/create_offline_code': {
|
|
37793
|
+
route: '/acs/credentials/create_offline_code';
|
|
37794
|
+
method: 'POST';
|
|
37795
|
+
queryParams: {};
|
|
37796
|
+
jsonBody: {};
|
|
37797
|
+
commonParams: {
|
|
37798
|
+
/** ID of the ACS user to whom the new credential belongs. */
|
|
37799
|
+
acs_user_id: string;
|
|
37800
|
+
/** IDs of the [`acs_entrance`s](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access. */
|
|
37801
|
+
allowed_acs_entrance_id?: string | undefined;
|
|
37802
|
+
/** Indicates whether the code is one-time-use or reusable. */
|
|
37803
|
+
is_one_time_use?: boolean;
|
|
37804
|
+
/** Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
37805
|
+
starts_at?: string | undefined;
|
|
37806
|
+
/** Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
37807
|
+
ends_at?: string | undefined;
|
|
37808
|
+
};
|
|
37809
|
+
formData: {};
|
|
37810
|
+
jsonResponse: {
|
|
37811
|
+
/** Means by which a user gains access at an entrance.
|
|
37812
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
37813
|
+
acs_credential: {
|
|
37814
|
+
/** ID of the credential. */
|
|
37815
|
+
acs_credential_id: string;
|
|
37816
|
+
/** ID of the ACS user to whom the credential belongs. */
|
|
37817
|
+
acs_user_id?: string | undefined;
|
|
37818
|
+
acs_credential_pool_id?: string | undefined;
|
|
37819
|
+
/** ID of the access control system that contains the credential. */
|
|
37820
|
+
acs_system_id: string;
|
|
37821
|
+
/** ID of the parent credential. */
|
|
37822
|
+
parent_acs_credential_id?: string | undefined;
|
|
37823
|
+
/** Display name that corresponds to the credential type. */
|
|
37824
|
+
display_name: string;
|
|
37825
|
+
/** Access (PIN) code for the credential. */
|
|
37826
|
+
code?: (string | undefined) | null;
|
|
37827
|
+
card_number?: (string | undefined) | null;
|
|
37828
|
+
is_issued?: boolean | undefined;
|
|
37829
|
+
issued_at?: (string | undefined) | null;
|
|
37830
|
+
/** Access method for the credential. Supported values: `code`, `card`, `mobile_key`. */
|
|
37831
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
37832
|
+
/** Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
37833
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
37834
|
+
/** Display name that corresponds to the brand-specific terminology for the credential type. */
|
|
37835
|
+
external_type_display_name?: string | undefined;
|
|
37836
|
+
/** Date and time at which the credential was created. */
|
|
37837
|
+
created_at: string;
|
|
37838
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential. */
|
|
37839
|
+
workspace_id: string;
|
|
37840
|
+
/** Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
37841
|
+
starts_at?: string | undefined;
|
|
37842
|
+
/** Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
37843
|
+
ends_at?: string | undefined;
|
|
37844
|
+
/** Errors associated with the `acs_credential`. */
|
|
37845
|
+
errors: Array<{
|
|
37846
|
+
error_code: string;
|
|
37847
|
+
message: string;
|
|
37848
|
+
}>;
|
|
37849
|
+
/** Warnings associated with the `acs_credential`. */
|
|
37850
|
+
warnings: Array<{
|
|
37851
|
+
/** Date and time at which Seam created the warning. */
|
|
37852
|
+
created_at: string;
|
|
37853
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
37854
|
+
message: string;
|
|
37855
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
37856
|
+
warning_code: 'waiting_to_be_issued';
|
|
37857
|
+
} | {
|
|
37858
|
+
/** Date and time at which Seam created the warning. */
|
|
37859
|
+
created_at: string;
|
|
37860
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
37861
|
+
message: string;
|
|
37862
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
37863
|
+
warning_code: 'schedule_externally_modified';
|
|
37864
|
+
} | {
|
|
37865
|
+
/** Date and time at which Seam created the warning. */
|
|
37866
|
+
created_at: string;
|
|
37867
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
37868
|
+
message: string;
|
|
37869
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
37870
|
+
warning_code: 'schedule_modified';
|
|
37871
|
+
} | {
|
|
37872
|
+
/** Date and time at which Seam created the warning. */
|
|
37873
|
+
created_at: string;
|
|
37874
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
37875
|
+
message: string;
|
|
37876
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
37877
|
+
warning_code: 'being_deleted';
|
|
37878
|
+
}>;
|
|
37879
|
+
/** Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
37880
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
37881
|
+
/** Indicates whether the latest state of the credential has been synced from Seam to the provider. */
|
|
37882
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
37883
|
+
/** Date and time at which the state of the credential was most recently synced from Seam to the provider. */
|
|
37884
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
37885
|
+
/** Visionline-specific metadata for the credential. */
|
|
37886
|
+
visionline_metadata?: {
|
|
37887
|
+
card_function_type: 'guest' | 'staff';
|
|
37888
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
37889
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
37890
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
37891
|
+
is_valid?: boolean | undefined;
|
|
37892
|
+
auto_join?: boolean | undefined;
|
|
37893
|
+
card_id?: string | undefined;
|
|
37894
|
+
credential_id?: string | undefined;
|
|
37895
|
+
} | undefined;
|
|
37896
|
+
is_managed: true;
|
|
37897
|
+
};
|
|
37898
|
+
};
|
|
37899
|
+
};
|
|
37701
37900
|
'/acs/credentials/delete': {
|
|
37702
37901
|
route: '/acs/credentials/delete';
|
|
37703
37902
|
method: 'DELETE' | 'POST';
|
|
@@ -8012,6 +8012,97 @@ declare const _default: {
|
|
|
8012
8012
|
'x-title': string;
|
|
8013
8013
|
};
|
|
8014
8014
|
};
|
|
8015
|
+
'/acs/credentials/create_offline_code': {
|
|
8016
|
+
post: {
|
|
8017
|
+
description: string;
|
|
8018
|
+
operationId: string;
|
|
8019
|
+
requestBody: {
|
|
8020
|
+
content: {
|
|
8021
|
+
'application/json': {
|
|
8022
|
+
schema: {
|
|
8023
|
+
properties: {
|
|
8024
|
+
acs_user_id: {
|
|
8025
|
+
description: string;
|
|
8026
|
+
format: string;
|
|
8027
|
+
type: string;
|
|
8028
|
+
};
|
|
8029
|
+
allowed_acs_entrance_id: {
|
|
8030
|
+
description: string;
|
|
8031
|
+
format: string;
|
|
8032
|
+
type: string;
|
|
8033
|
+
};
|
|
8034
|
+
ends_at: {
|
|
8035
|
+
description: string;
|
|
8036
|
+
format: string;
|
|
8037
|
+
type: string;
|
|
8038
|
+
};
|
|
8039
|
+
is_one_time_use: {
|
|
8040
|
+
default: boolean;
|
|
8041
|
+
description: string;
|
|
8042
|
+
type: string;
|
|
8043
|
+
};
|
|
8044
|
+
starts_at: {
|
|
8045
|
+
description: string;
|
|
8046
|
+
format: string;
|
|
8047
|
+
type: string;
|
|
8048
|
+
};
|
|
8049
|
+
};
|
|
8050
|
+
required: string[];
|
|
8051
|
+
type: string;
|
|
8052
|
+
};
|
|
8053
|
+
};
|
|
8054
|
+
};
|
|
8055
|
+
};
|
|
8056
|
+
responses: {
|
|
8057
|
+
200: {
|
|
8058
|
+
content: {
|
|
8059
|
+
'application/json': {
|
|
8060
|
+
schema: {
|
|
8061
|
+
properties: {
|
|
8062
|
+
acs_credential: {
|
|
8063
|
+
$ref: string;
|
|
8064
|
+
};
|
|
8065
|
+
ok: {
|
|
8066
|
+
type: string;
|
|
8067
|
+
};
|
|
8068
|
+
};
|
|
8069
|
+
required: string[];
|
|
8070
|
+
type: string;
|
|
8071
|
+
};
|
|
8072
|
+
};
|
|
8073
|
+
};
|
|
8074
|
+
description: string;
|
|
8075
|
+
};
|
|
8076
|
+
400: {
|
|
8077
|
+
description: string;
|
|
8078
|
+
};
|
|
8079
|
+
401: {
|
|
8080
|
+
description: string;
|
|
8081
|
+
};
|
|
8082
|
+
};
|
|
8083
|
+
security: ({
|
|
8084
|
+
pat_with_workspace: never[];
|
|
8085
|
+
console_session?: never;
|
|
8086
|
+
api_key?: never;
|
|
8087
|
+
} | {
|
|
8088
|
+
console_session: never[];
|
|
8089
|
+
pat_with_workspace?: never;
|
|
8090
|
+
api_key?: never;
|
|
8091
|
+
} | {
|
|
8092
|
+
api_key: never[];
|
|
8093
|
+
pat_with_workspace?: never;
|
|
8094
|
+
console_session?: never;
|
|
8095
|
+
})[];
|
|
8096
|
+
summary: string;
|
|
8097
|
+
tags: string[];
|
|
8098
|
+
'x-fern-sdk-group-name': string[];
|
|
8099
|
+
'x-fern-sdk-method-name': string;
|
|
8100
|
+
'x-fern-sdk-return-value': string;
|
|
8101
|
+
'x-response-key': string;
|
|
8102
|
+
'x-title': string;
|
|
8103
|
+
'x-undocumented': string;
|
|
8104
|
+
};
|
|
8105
|
+
};
|
|
8015
8106
|
'/acs/credentials/delete': {
|
|
8016
8107
|
post: {
|
|
8017
8108
|
description: string;
|
|
@@ -8563,6 +8563,83 @@ export default {
|
|
|
8563
8563
|
'x-title': 'Create a Credential for an ACS User',
|
|
8564
8564
|
},
|
|
8565
8565
|
},
|
|
8566
|
+
'/acs/credentials/create_offline_code': {
|
|
8567
|
+
post: {
|
|
8568
|
+
description: 'Creates a new offline [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
8569
|
+
operationId: 'acsCredentialsCreateOfflineCodePost',
|
|
8570
|
+
requestBody: {
|
|
8571
|
+
content: {
|
|
8572
|
+
'application/json': {
|
|
8573
|
+
schema: {
|
|
8574
|
+
properties: {
|
|
8575
|
+
acs_user_id: {
|
|
8576
|
+
description: 'ID of the ACS user to whom the new credential belongs.',
|
|
8577
|
+
format: 'uuid',
|
|
8578
|
+
type: 'string',
|
|
8579
|
+
},
|
|
8580
|
+
allowed_acs_entrance_id: {
|
|
8581
|
+
description: 'IDs of the [`acs_entrance`s](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access.',
|
|
8582
|
+
format: 'uuid',
|
|
8583
|
+
type: 'string',
|
|
8584
|
+
},
|
|
8585
|
+
ends_at: {
|
|
8586
|
+
description: 'Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
8587
|
+
format: 'date-time',
|
|
8588
|
+
type: 'string',
|
|
8589
|
+
},
|
|
8590
|
+
is_one_time_use: {
|
|
8591
|
+
default: false,
|
|
8592
|
+
description: 'Indicates whether the code is one-time-use or reusable.',
|
|
8593
|
+
type: 'boolean',
|
|
8594
|
+
},
|
|
8595
|
+
starts_at: {
|
|
8596
|
+
description: 'Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
8597
|
+
format: 'date-time',
|
|
8598
|
+
type: 'string',
|
|
8599
|
+
},
|
|
8600
|
+
},
|
|
8601
|
+
required: ['acs_user_id'],
|
|
8602
|
+
type: 'object',
|
|
8603
|
+
},
|
|
8604
|
+
},
|
|
8605
|
+
},
|
|
8606
|
+
},
|
|
8607
|
+
responses: {
|
|
8608
|
+
200: {
|
|
8609
|
+
content: {
|
|
8610
|
+
'application/json': {
|
|
8611
|
+
schema: {
|
|
8612
|
+
properties: {
|
|
8613
|
+
acs_credential: {
|
|
8614
|
+
$ref: '#/components/schemas/acs_credential',
|
|
8615
|
+
},
|
|
8616
|
+
ok: { type: 'boolean' },
|
|
8617
|
+
},
|
|
8618
|
+
required: ['acs_credential', 'ok'],
|
|
8619
|
+
type: 'object',
|
|
8620
|
+
},
|
|
8621
|
+
},
|
|
8622
|
+
},
|
|
8623
|
+
description: 'OK',
|
|
8624
|
+
},
|
|
8625
|
+
400: { description: 'Bad Request' },
|
|
8626
|
+
401: { description: 'Unauthorized' },
|
|
8627
|
+
},
|
|
8628
|
+
security: [
|
|
8629
|
+
{ pat_with_workspace: [] },
|
|
8630
|
+
{ console_session: [] },
|
|
8631
|
+
{ api_key: [] },
|
|
8632
|
+
],
|
|
8633
|
+
summary: '/acs/credentials/create_offline_code',
|
|
8634
|
+
tags: ['/acs'],
|
|
8635
|
+
'x-fern-sdk-group-name': ['acs', 'credentials'],
|
|
8636
|
+
'x-fern-sdk-method-name': 'create_offline_code',
|
|
8637
|
+
'x-fern-sdk-return-value': 'acs_credential',
|
|
8638
|
+
'x-response-key': 'acs_credential',
|
|
8639
|
+
'x-title': 'Create an Offline Credential for an ACS User',
|
|
8640
|
+
'x-undocumented': 'Unreleased.',
|
|
8641
|
+
},
|
|
8642
|
+
},
|
|
8566
8643
|
'/acs/credentials/delete': {
|
|
8567
8644
|
post: {
|
|
8568
8645
|
description: 'Deletes a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|