@seamapi/types 1.726.0 → 1.727.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 +20 -6
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +113 -2
- package/dist/index.cjs +20 -6
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/openapi.d.ts +12 -0
- package/lib/seam/connect/openapi.js +14 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +101 -2
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +14 -0
- package/src/lib/seam/connect/route-types.ts +110 -0
package/dist/connect.d.cts
CHANGED
|
@@ -81293,6 +81293,12 @@ declare const _default: {
|
|
|
81293
81293
|
batch: {
|
|
81294
81294
|
description: string;
|
|
81295
81295
|
properties: {
|
|
81296
|
+
access_methods: {
|
|
81297
|
+
items: {
|
|
81298
|
+
$ref: string;
|
|
81299
|
+
};
|
|
81300
|
+
type: string;
|
|
81301
|
+
};
|
|
81296
81302
|
acs_access_groups: {
|
|
81297
81303
|
items: {
|
|
81298
81304
|
$ref: string;
|
|
@@ -81432,6 +81438,12 @@ declare const _default: {
|
|
|
81432
81438
|
batch: {
|
|
81433
81439
|
description: string;
|
|
81434
81440
|
properties: {
|
|
81441
|
+
access_methods: {
|
|
81442
|
+
items: {
|
|
81443
|
+
$ref: string;
|
|
81444
|
+
};
|
|
81445
|
+
type: string;
|
|
81446
|
+
};
|
|
81435
81447
|
acs_access_groups: {
|
|
81436
81448
|
items: {
|
|
81437
81449
|
$ref: string;
|
|
@@ -137819,8 +137831,8 @@ type Routes = {
|
|
|
137819
137831
|
access_grant_ids?: string[] | undefined;
|
|
137820
137832
|
/** Keys of the access grants that you want to get along with their related resources. */
|
|
137821
137833
|
access_grant_keys?: string[] | undefined;
|
|
137822
|
-
include?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identities' | 'acs_access_groups')[] | undefined;
|
|
137823
|
-
exclude?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identities' | 'acs_access_groups')[] | undefined;
|
|
137834
|
+
include?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identities' | 'acs_access_groups' | 'access_methods')[] | undefined;
|
|
137835
|
+
exclude?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identities' | 'acs_access_groups' | 'access_methods')[] | undefined;
|
|
137824
137836
|
};
|
|
137825
137837
|
formData: {};
|
|
137826
137838
|
jsonResponse: {
|
|
@@ -139611,6 +139623,105 @@ type Routes = {
|
|
|
139611
139623
|
})[];
|
|
139612
139624
|
is_managed: true;
|
|
139613
139625
|
}[] | undefined;
|
|
139626
|
+
access_methods?: {
|
|
139627
|
+
/** ID of the Seam workspace associated with the access method. */
|
|
139628
|
+
workspace_id: string;
|
|
139629
|
+
/** ID of the access method. */
|
|
139630
|
+
access_method_id: string;
|
|
139631
|
+
/** Display name of the access method. */
|
|
139632
|
+
display_name: string;
|
|
139633
|
+
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
139634
|
+
mode: 'code' | 'card' | 'mobile_key';
|
|
139635
|
+
/** Date and time at which the access method was created. */
|
|
139636
|
+
created_at: string;
|
|
139637
|
+
/** Date and time at which the access method was issued. */
|
|
139638
|
+
issued_at: string | null;
|
|
139639
|
+
/** Indicates whether the access method has been issued. */
|
|
139640
|
+
is_issued: boolean;
|
|
139641
|
+
/** URL of the Instant Key for mobile key access methods. */
|
|
139642
|
+
instant_key_url?: string | undefined;
|
|
139643
|
+
/** Token of the client session associated with the access method. */
|
|
139644
|
+
client_session_token?: string | undefined;
|
|
139645
|
+
/** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
|
|
139646
|
+
is_encoding_required?: boolean | undefined;
|
|
139647
|
+
/** The actual PIN code for code access methods. */
|
|
139648
|
+
code?: (string | null) | undefined;
|
|
139649
|
+
/** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
|
|
139650
|
+
warnings: ({
|
|
139651
|
+
/** Date and time at which Seam created the warning. */
|
|
139652
|
+
created_at: string;
|
|
139653
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
139654
|
+
message: string;
|
|
139655
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
139656
|
+
warning_code: 'being_deleted';
|
|
139657
|
+
} | {
|
|
139658
|
+
/** Date and time at which Seam created the warning. */
|
|
139659
|
+
created_at: string;
|
|
139660
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
139661
|
+
message: string;
|
|
139662
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
139663
|
+
warning_code: 'updating_access_times';
|
|
139664
|
+
})[];
|
|
139665
|
+
/** Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress. */
|
|
139666
|
+
pending_mutations: ({
|
|
139667
|
+
/** Date and time at which the mutation was created. */
|
|
139668
|
+
created_at: string;
|
|
139669
|
+
/** Detailed description of the mutation. */
|
|
139670
|
+
message: string;
|
|
139671
|
+
/** Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices. */
|
|
139672
|
+
mutation_code: 'provisioning_access';
|
|
139673
|
+
/** Previous device configuration. */
|
|
139674
|
+
from: {
|
|
139675
|
+
/** Previous device IDs where access was provisioned. */
|
|
139676
|
+
device_ids: string[];
|
|
139677
|
+
};
|
|
139678
|
+
/** New device configuration. */
|
|
139679
|
+
to: {
|
|
139680
|
+
/** New device IDs where access is being provisioned. */
|
|
139681
|
+
device_ids: string[];
|
|
139682
|
+
};
|
|
139683
|
+
} | {
|
|
139684
|
+
/** Date and time at which the mutation was created. */
|
|
139685
|
+
created_at: string;
|
|
139686
|
+
/** Detailed description of the mutation. */
|
|
139687
|
+
message: string;
|
|
139688
|
+
/** Mutation code to indicate that Seam is in the process of revoking access for this access method from devices. */
|
|
139689
|
+
mutation_code: 'revoking_access';
|
|
139690
|
+
/** Previous device configuration. */
|
|
139691
|
+
from: {
|
|
139692
|
+
/** Previous device IDs where access existed. */
|
|
139693
|
+
device_ids: string[];
|
|
139694
|
+
};
|
|
139695
|
+
/** New device configuration. */
|
|
139696
|
+
to: {
|
|
139697
|
+
/** New device IDs where access should remain. */
|
|
139698
|
+
device_ids: string[];
|
|
139699
|
+
};
|
|
139700
|
+
} | {
|
|
139701
|
+
/** Date and time at which the mutation was created. */
|
|
139702
|
+
created_at: string;
|
|
139703
|
+
/** Detailed description of the mutation. */
|
|
139704
|
+
message: string;
|
|
139705
|
+
/** Mutation code to indicate that Seam is in the process of updating the access times for this access method. */
|
|
139706
|
+
mutation_code: 'updating_access_times';
|
|
139707
|
+
/** Previous access time configuration. */
|
|
139708
|
+
from: {
|
|
139709
|
+
/** Previous start time for access. */
|
|
139710
|
+
starts_at: string | null;
|
|
139711
|
+
/** Previous end time for access. */
|
|
139712
|
+
ends_at: string | null;
|
|
139713
|
+
};
|
|
139714
|
+
/** New access time configuration. */
|
|
139715
|
+
to: {
|
|
139716
|
+
/** New start time for access. */
|
|
139717
|
+
starts_at: string | null;
|
|
139718
|
+
/** New end time for access. */
|
|
139719
|
+
ends_at: string | null;
|
|
139720
|
+
};
|
|
139721
|
+
})[];
|
|
139722
|
+
/** ID of the customization profile associated with the access method. */
|
|
139723
|
+
customization_profile_id?: string | undefined;
|
|
139724
|
+
}[] | undefined;
|
|
139614
139725
|
};
|
|
139615
139726
|
};
|
|
139616
139727
|
maxDuration: undefined;
|
package/dist/index.cjs
CHANGED
|
@@ -36048,7 +36048,8 @@ var openapi_default = {
|
|
|
36048
36048
|
"connected_accounts",
|
|
36049
36049
|
"acs_systems",
|
|
36050
36050
|
"user_identities",
|
|
36051
|
-
"acs_access_groups"
|
|
36051
|
+
"acs_access_groups",
|
|
36052
|
+
"access_methods"
|
|
36052
36053
|
],
|
|
36053
36054
|
type: "string"
|
|
36054
36055
|
},
|
|
@@ -36067,7 +36068,8 @@ var openapi_default = {
|
|
|
36067
36068
|
"connected_accounts",
|
|
36068
36069
|
"acs_systems",
|
|
36069
36070
|
"user_identities",
|
|
36070
|
-
"acs_access_groups"
|
|
36071
|
+
"acs_access_groups",
|
|
36072
|
+
"access_methods"
|
|
36071
36073
|
],
|
|
36072
36074
|
type: "string"
|
|
36073
36075
|
},
|
|
@@ -36084,6 +36086,10 @@ var openapi_default = {
|
|
|
36084
36086
|
batch: {
|
|
36085
36087
|
description: "A batch of workspace resources.",
|
|
36086
36088
|
properties: {
|
|
36089
|
+
access_methods: {
|
|
36090
|
+
items: { $ref: "#/components/schemas/access_method" },
|
|
36091
|
+
type: "array"
|
|
36092
|
+
},
|
|
36087
36093
|
acs_access_groups: {
|
|
36088
36094
|
items: {
|
|
36089
36095
|
$ref: "#/components/schemas/acs_access_group"
|
|
@@ -36146,7 +36152,8 @@ var openapi_default = {
|
|
|
36146
36152
|
"connected_accounts",
|
|
36147
36153
|
"acs_systems",
|
|
36148
36154
|
"user_identities",
|
|
36149
|
-
"acs_access_groups"
|
|
36155
|
+
"acs_access_groups",
|
|
36156
|
+
"access_methods"
|
|
36150
36157
|
],
|
|
36151
36158
|
"x-draft": "Early access.",
|
|
36152
36159
|
"x-fern-sdk-group-name": ["access_grants"],
|
|
@@ -36182,7 +36189,8 @@ var openapi_default = {
|
|
|
36182
36189
|
"connected_accounts",
|
|
36183
36190
|
"acs_systems",
|
|
36184
36191
|
"user_identities",
|
|
36185
|
-
"acs_access_groups"
|
|
36192
|
+
"acs_access_groups",
|
|
36193
|
+
"access_methods"
|
|
36186
36194
|
],
|
|
36187
36195
|
type: "string"
|
|
36188
36196
|
},
|
|
@@ -36197,7 +36205,8 @@ var openapi_default = {
|
|
|
36197
36205
|
"connected_accounts",
|
|
36198
36206
|
"acs_systems",
|
|
36199
36207
|
"user_identities",
|
|
36200
|
-
"acs_access_groups"
|
|
36208
|
+
"acs_access_groups",
|
|
36209
|
+
"access_methods"
|
|
36201
36210
|
],
|
|
36202
36211
|
type: "string"
|
|
36203
36212
|
},
|
|
@@ -36218,6 +36227,10 @@ var openapi_default = {
|
|
|
36218
36227
|
batch: {
|
|
36219
36228
|
description: "A batch of workspace resources.",
|
|
36220
36229
|
properties: {
|
|
36230
|
+
access_methods: {
|
|
36231
|
+
items: { $ref: "#/components/schemas/access_method" },
|
|
36232
|
+
type: "array"
|
|
36233
|
+
},
|
|
36221
36234
|
acs_access_groups: {
|
|
36222
36235
|
items: {
|
|
36223
36236
|
$ref: "#/components/schemas/acs_access_group"
|
|
@@ -36280,7 +36293,8 @@ var openapi_default = {
|
|
|
36280
36293
|
"connected_accounts",
|
|
36281
36294
|
"acs_systems",
|
|
36282
36295
|
"user_identities",
|
|
36283
|
-
"acs_access_groups"
|
|
36296
|
+
"acs_access_groups",
|
|
36297
|
+
"access_methods"
|
|
36284
36298
|
],
|
|
36285
36299
|
"x-draft": "Early access.",
|
|
36286
36300
|
"x-fern-sdk-group-name": ["access_grants"],
|