@1password/sdk 0.0.0-credential-broker-dev-preview

package/dist/types.d.ts

@@ -0,0 +1,972 @@
+export type ErrorMessage = string;
+/** The lifecycle state of an access request. */
+export declare enum AccessRequestState {
+    /** The request is awaiting a decision. */
+    Pending = "pending",
+    /** The request was approved and credentials were granted. */
+    Resolved = "resolved",
+    /** The request was denied by the user. */
+    Denied = "denied",
+    /** The request could not be processed. */
+    Failed = "failed"
+}
+/** The credential types an access request entry can ask for. */
+export declare enum AccessRequestEntryType {
+    /** A login credential (username / password / TOTP). */
+    Login = "login"
+}
+/** Type-specific parameters for a requested credential. */
+export interface AccessRequestEntryParameters {
+    /** The website the requester needs to sign in to. */
+    website?: string;
+}
+/** A requested credential within a created access request. */
+export interface AccessRequestEntry {
+    /**
+     * The SDK-minted identifier used to correlate this entry with a
+     * [`ResolvedAccessRequestEntry`] in the request status.
+     */
+    id: string;
+    /** The credential type requested. */
+    type: AccessRequestEntryType;
+    /** Type-specific request parameters. */
+    parameters: AccessRequestEntryParameters;
+    /** Why this specific credential is needed, shown in the consent prompt. */
+    reason?: string;
+    /**
+     * Soft ranking signal used to order the candidate logins offered to the
+     * user.
+     */
+    keywords?: string[];
+}
+/** A server-managed access request. */
+export interface AccessRequest {
+    /**
+     * The canonical resource path.
+     * Format: `accounts/{account}/credential-broker-access-requests/{id}`
+     */
+    path: string;
+    /**
+     * The client-generated identifier of the request. Pass to
+     * `credentialBroker.accessRequests.getStatus` to poll the request status.
+     */
+    id: string;
+    /**
+     * The canonical AEP resource path of the identity for which
+     * credential access is requested.
+     */
+    identity: string;
+    /** The current lifecycle state. */
+    state: AccessRequestState;
+    /** The time the request was created. */
+    createdAt: Date;
+    /**
+     * What the requester is trying to accomplish, shown to the user above
+     * the individual entries.
+     */
+    goal?: string;
+    /**
+     * The requested entries as created, each carrying its SDK-minted id.
+     * Correlate against [`ResolvedAccessRequestEntry::entry_id`] in the
+     * request status.
+     */
+    entries: AccessRequestEntry[];
+}
+/** A single credential need within an access request. */
+export interface AccessRequestEntryCreateParams {
+    /** The credential type requested. */
+    type: AccessRequestEntryType;
+    /** Type-specific request parameters. */
+    parameters: AccessRequestEntryParameters;
+    /** Why this specific credential is needed, shown in the consent prompt. */
+    reason?: string;
+    /**
+     * Soft ranking signal used to order the candidate logins offered to the
+     * user.
+     */
+    keywords?: string[];
+}
+/** The parameters for creating an access request. */
+export interface AccessRequestCreateParams {
+    /**
+     * What the requester is trying to accomplish, shown to the user above
+     * the individual entries.
+     */
+    goal?: string;
+    /**
+     * The requested credentials, in presentation order. Must contain
+     * between 1 and 5 entries.
+     */
+    entries: AccessRequestEntryCreateParams[];
+}
+/**
+ * A reference to a 1Password Credential Broker configuration.
+ *
+ * Passed to a `client.credential_broker.<kind>.read` call to fetch a
+ * credential. The `reference` string has the form:
+ *
+ * ```text
+ * //api.1password.com/credential-broker/accounts/<account>/capability/<name>/configurations/<id>
+ * ```
+ */
+export interface CredentialReference {
+    /** The reference path. */
+    reference: string;
+}
+/** A credential granted in response to a requested entry. */
+export interface ResolvedAccessRequestEntry {
+    /**
+     * The requested entry satisfied by this credential, if any. When
+     * missing, this credential was additionally chosen during
+     * resolution on top of the requested credentials.
+     */
+    entryId?: string;
+    /**
+     * The credential-broker reference to fetch the credential with
+     * (e.g. via `credentialBroker.logins.read`).
+     */
+    reference: CredentialReference;
+}
+/** The non-sensitive status of an access request. */
+export interface AccessRequestStatus {
+    /** The current lifecycle state. */
+    state: AccessRequestState;
+    /** The credentials granted when the request is resolved. */
+    resolved: ResolvedAccessRequestEntry[];
+}
+/** Additional attributes for OTP fields. */
+export interface AddressFieldDetails {
+    /** The street address */
+    street: string;
+    /** The city */
+    city: string;
+    /** The country */
+    country: string;
+    /** The ZIP code */
+    zip: string;
+    /** The state */
+    state: string;
+}
+export interface DocumentCreateParams {
+    /** The name of the file */
+    name: string;
+    /** The content of the file */
+    content: Uint8Array;
+}
+/** A 1Password Environment. */
+export interface Environment {
+    /** The Environment's UUID. */
+    id: string;
+    /** The Environment's name. */
+    name: string;
+    /** The content version number */
+    contentVersion: number;
+    /** The secrets count. */
+    secrets: number;
+    /** The UTC date and time the environment was created */
+    createdAt: Date;
+    /** The UTC date and time the environment was last updated */
+    updatedAt: Date;
+}
+/**
+ * One environment variable resolved by the credential broker.
+ *
+ * Shared between the Environments API (`GetVariablesResponse`) and the
+ * Credential Broker API (`EnvironmentCredential`, gated on
+ * `brokered-access`), since both surfaces read from the same credential
+ * broker enclave endpoint.
+ */
+export interface EnvironmentVariable {
+    /** An environment variable's name */
+    name: string;
+    /** An environment variable's value */
+    value: string;
+    /** An environment variable's masked state */
+    masked: boolean;
+}
+/**
+ * An environment credential brokered by 1Password: a bundle of
+ * environment variables.
+ *
+ * Returned by
+ * [`EnvironmentVariables::read`](crate::client::EnvironmentVariables::read).
+ */
+export interface EnvironmentCredential {
+    /** The environment variables in the bundle. */
+    variables: EnvironmentVariable[];
+}
+/** A single secret from a 1Password Environment. */
+export interface EnvironmentSecret {
+    /** The secret's name. */
+    name: string;
+    /** The secret's value. */
+    value: string;
+    /** Whether the secret's value is concealed. */
+    concealed: boolean;
+}
+export interface FileAttributes {
+    /** The name of the file */
+    name: string;
+    /** The ID of the file retrieved from the server */
+    id: string;
+    /** The size of the file in bytes */
+    size: number;
+}
+export interface FileCreateParams {
+    /** The name of the file */
+    name: string;
+    /** The content of the file */
+    content: Uint8Array;
+    /** The section id where the file should be stored */
+    sectionId: string;
+    /** The field id where the file should be stored */
+    fieldId: string;
+}
+/**
+ * For future use, if we want to return more information about the generated password.
+ * Currently, it only returns the password itself.
+ */
+export interface GeneratePasswordResponse {
+    /** The generated password. */
+    password: string;
+}
+/** Response containing the full set of environment variables from an Environment. */
+export interface GetVariablesResponse {
+    /** List of environment variables. */
+    variables: EnvironmentVariable[];
+}
+export declare enum GroupType {
+    /**
+     * The owners group, which gives the following permissions:
+     * - Do everything the Admin group can do
+     * - See every vault other than the personal vaults
+     * - Change people's names
+     * - See billing
+     * - Change billing
+     * - Make other people owners
+     * - Delete a person
+     */
+    Owners = "owners",
+    /**
+     * The administrators group, which gives the following permissions:
+     * - Perform recovery
+     * - Create new vaults
+     * - Invite new members
+     * - See vault metadata, including the vault name and who has access.
+     * - Make other people admins
+     */
+    Administrators = "administrators",
+    /**
+     * The recovery group. It contains recovery keysets, and is added to every vault to allow for recovery.
+     *
+     * No one is added to this.
+     */
+    Recovery = "recovery",
+    /**
+     * The external account managers group or EAM is a mandatory group for managed accounts that has
+     * same permissions as the owners.
+     */
+    ExternalAccountManagers = "externalAccountManagers",
+    /** Members of a team that a user is on. */
+    TeamMembers = "teamMembers",
+    /** A custom, user defined group. */
+    UserDefined = "userDefined",
+    /** Support for new or renamed group types */
+    Unsupported = "unsupported"
+}
+export declare enum GroupState {
+    /** This group is active */
+    Active = "active",
+    /** This group has been deleted */
+    Deleted = "deleted",
+    /** This group is in an unknown state */
+    Unsupported = "unsupported"
+}
+export declare enum VaultAccessorType {
+    User = "user",
+    Group = "group",
+    Broker = "broker"
+}
+/** Represents the vault access information. */
+export interface VaultAccess {
+    /** The vault's UUID. */
+    vaultUuid: string;
+    /** The vault's accessor type. */
+    accessorType: VaultAccessorType;
+    /** The vault's accessor UUID. */
+    accessorUuid: string;
+    /** The permissions granted to this vault */
+    permissions: number;
+}
+export interface Group {
+    id: string;
+    title: string;
+    description: string;
+    groupType: GroupType;
+    state: GroupState;
+    vaultAccess?: VaultAccess[];
+}
+/**
+ * Represents a group's access to a 1Password vault.
+ * This is used for granting permissions
+ */
+export interface GroupAccess {
+    /** The group's ID */
+    groupId: string;
+    /** The group's set of permissions for the vault */
+    permissions: number;
+}
+export interface GroupGetParams {
+    vaultPermissions?: boolean;
+}
+/** Represents a group's access to a 1Password vault. */
+export interface GroupVaultAccess {
+    /** The vault's ID */
+    vaultId: string;
+    /** The group's ID */
+    groupId: string;
+    /** The group's set of permissions for the vault */
+    permissions: number;
+}
+export declare enum ItemCategory {
+    Login = "Login",
+    SecureNote = "SecureNote",
+    CreditCard = "CreditCard",
+    CryptoWallet = "CryptoWallet",
+    Identity = "Identity",
+    Password = "Password",
+    Document = "Document",
+    ApiCredentials = "ApiCredentials",
+    BankAccount = "BankAccount",
+    Database = "Database",
+    DriverLicense = "DriverLicense",
+    Email = "Email",
+    MedicalRecord = "MedicalRecord",
+    Membership = "Membership",
+    OutdoorLicense = "OutdoorLicense",
+    Passport = "Passport",
+    Rewards = "Rewards",
+    Router = "Router",
+    Server = "Server",
+    SshKey = "SshKey",
+    SocialSecurityNumber = "SocialSecurityNumber",
+    SoftwareLicense = "SoftwareLicense",
+    Person = "Person",
+    Unsupported = "Unsupported"
+}
+export declare enum ItemFieldType {
+    Text = "Text",
+    Concealed = "Concealed",
+    CreditCardType = "CreditCardType",
+    CreditCardNumber = "CreditCardNumber",
+    Phone = "Phone",
+    Url = "Url",
+    Totp = "Totp",
+    Email = "Email",
+    Reference = "Reference",
+    SshKey = "SshKey",
+    Menu = "Menu",
+    MonthYear = "MonthYear",
+    Address = "Address",
+    Date = "Date",
+    Unsupported = "Unsupported"
+}
+/** Field type-specific attributes. */
+export type ItemFieldDetails = 
+/** The computed OTP code and other details */
+{
+    type: "Otp";
+    content: OtpFieldDetails;
+}
+/** Computed SSH Key attributes */
+ | {
+    type: "SshKey";
+    content?: SshKeyAttributes;
+}
+/** Address components */
+ | {
+    type: "Address";
+    content?: AddressFieldDetails;
+};
+/** Represents a field within an item. */
+export interface ItemField {
+    /** The field's ID */
+    id: string;
+    /** The field's title */
+    title: string;
+    /** The ID of the section containing the field. Built-in fields such as usernames and passwords don't require a section. */
+    sectionId?: string;
+    /** The field's type */
+    fieldType: ItemFieldType;
+    /** The string representation of the field's value */
+    value: string;
+    /** Field type-specific attributes. */
+    details?: ItemFieldDetails;
+}
+/** A section groups together multiple fields in an item. */
+export interface ItemSection {
+    /** The section's unique ID */
+    id: string;
+    /** The section's title */
+    title: string;
+}
+/**
+ * Controls the auto-fill behavior of a website.
+ *
+ *
+ * For more information, visit <https://support.1password.com/autofill-behavior/>
+ */
+export declare enum AutofillBehavior {
+    /** Auto-fill any page that’s part of the website, including subdomains */
+    AnywhereOnWebsite = "AnywhereOnWebsite",
+    /** Auto-fill only if the domain (hostname and port) is an exact match. */
+    ExactDomain = "ExactDomain",
+    /** Never auto-fill on this website */
+    Never = "Never"
+}
+export interface Website {
+    /** The website URL */
+    url: string;
+    /** The label of the website, e.g. 'website', 'sign-in address' */
+    label: string;
+    /**
+     * The auto-fill behavior of the website
+     *
+     * For more information, visit <https://support.1password.com/autofill-behavior/>
+     */
+    autofillBehavior: AutofillBehavior;
+}
+export interface ItemFile {
+    /** the attributes of the file */
+    attributes: FileAttributes;
+    /** the section id where the file should be stored */
+    sectionId: string;
+    /** the field id where the file should be stored */
+    fieldId: string;
+}
+/** Represents an active 1Password item. */
+export interface Item {
+    /** The item's ID */
+    id: string;
+    /** The item's title */
+    title: string;
+    /** The item's category */
+    category: ItemCategory;
+    /** The ID of the vault where the item is saved */
+    vaultId: string;
+    /** The item's fields */
+    fields: ItemField[];
+    /** The item's sections */
+    sections: ItemSection[];
+    /** The notes of the item */
+    notes: string;
+    /** The item's tags */
+    tags: string[];
+    /** The websites used for autofilling for items of the Login and Password categories. */
+    websites: Website[];
+    /** The item's version */
+    version: number;
+    /** The item's file fields */
+    files: ItemFile[];
+    /** The document file for the Document item category */
+    document?: FileAttributes;
+    /** The time the item was created at */
+    createdAt: Date;
+    /** The time the item was updated at */
+    updatedAt: Date;
+}
+export interface ItemCreateParams {
+    /** The item's category */
+    category: ItemCategory;
+    /** The ID of the vault where the item is saved */
+    vaultId: string;
+    /** The item's title */
+    title: string;
+    /** The item's fields */
+    fields?: ItemField[];
+    /** The item's sections */
+    sections?: ItemSection[];
+    /** The item's notes */
+    notes?: string;
+    /** The item's tags */
+    tags?: string[];
+    /** The websites used for autofilling for items of the Login and Password categories. */
+    websites?: Website[];
+    /** The item's files stored as fields */
+    files?: FileCreateParams[];
+    /** The document file for the Document item type. Empty when the item isn't of Document type. */
+    document?: DocumentCreateParams;
+}
+/** Represents the state of an item in the SDK. */
+export declare enum ItemState {
+    /** The item is active */
+    Active = "active",
+    /** The item is archived meaning it's hidden from regular view and stored in the archive. */
+    Archived = "archived"
+}
+/** Represents a decrypted 1Password item overview. */
+export interface ItemOverview {
+    /** The item's ID */
+    id: string;
+    /** The item's title */
+    title: string;
+    /** The item's category */
+    category: ItemCategory;
+    /** The ID of the vault where the item is saved */
+    vaultId: string;
+    /** The websites used for autofilling for items of the Login and Password categories. */
+    websites: Website[];
+    /** The item tags */
+    tags: string[];
+    /** The time the item was created at */
+    createdAt: Date;
+    /** The time the item was updated at */
+    updatedAt: Date;
+    /** Indicates the state of the item */
+    state: ItemState;
+}
+/** The valid duration options for sharing an item */
+export declare enum ItemShareDuration {
+    /** The share will expire in one hour */
+    OneHour = "OneHour",
+    /** The share will expire in one day */
+    OneDay = "OneDay",
+    /** The share will expire in seven days */
+    SevenDays = "SevenDays",
+    /** The share will expire in fourteen days */
+    FourteenDays = "FourteenDays",
+    /** The share will expire in thirty days */
+    ThirtyDays = "ThirtyDays"
+}
+/** The allowed types of item sharing, enforced by account policy */
+export declare enum AllowedType {
+    /** Allows creating share links with specific recipients */
+    Authenticated = "Authenticated",
+    /** Allows creating public share links */
+    Public = "Public"
+}
+/** The allowed recipient types of item sharing, enforced by account policy */
+export declare enum AllowedRecipientType {
+    /** Recipients can be specified by email address */
+    Email = "Email",
+    /** Recipients can be specified by domain */
+    Domain = "Domain"
+}
+/** The file sharing policy */
+export interface ItemShareFiles {
+    /** Whether files can be included in item shares */
+    allowed: boolean;
+    /** The maximum encrypted size (in bytes) an included file can be */
+    maxSize: number;
+    /** The allowed types of item sharing - either "Authenticated" (share to specific users) or "Public" (share to anyone with a link) */
+    allowedTypes?: AllowedType[];
+    /** The allowed recipient types of item sharing - either "Email" or "Domain" */
+    allowedRecipientTypes?: AllowedRecipientType[];
+    /** The maximum duration that an item can be shared for */
+    maxExpiry?: ItemShareDuration;
+    /** The default duration that an item is shared for */
+    defaultExpiry?: ItemShareDuration;
+    /** The maximum number of times an item can be viewed. A null value means unlimited views */
+    maxViews?: number;
+}
+/**
+ * The account policy for sharing items, set by your account owner/admin
+ * This policy is enforced server-side when sharing items
+ */
+export interface ItemShareAccountPolicy {
+    /** The maximum duration that an item can be shared for */
+    maxExpiry: ItemShareDuration;
+    /** The default duration that an item is shared for */
+    defaultExpiry: ItemShareDuration;
+    /** The maximum number of times an item can be viewed. A null value means unlimited views */
+    maxViews?: number;
+    /** The allowed types of item sharing - either "Authenticated" (share to specific users) or "Public" (share to anyone with a link) */
+    allowedTypes: AllowedType[];
+    /** The allowed recipient types of item sharing - either "Email" or "Domain" */
+    allowedRecipientTypes: AllowedRecipientType[];
+    /** The file sharing policy */
+    files: ItemShareFiles;
+}
+/** The validated recipient of an item share */
+export type ValidRecipient = 
+/** This exact email address */
+{
+    type: "Email";
+    parameters: {
+        email: string;
+    };
+}
+/** Anyone with an email address from the specified domain */
+ | {
+    type: "Domain";
+    parameters: {
+        domain: string;
+    };
+};
+/**
+ * The configuration options for sharing an item
+ * These must respect the account policy on item sharing
+ */
+export interface ItemShareParams {
+    /** Emails or domains of the item share recipients. If not provided, everyone with the share link will have access */
+    recipients?: ValidRecipient[];
+    /** The duration of the share in seconds. If not provided, defaults to the account policy's default expiry */
+    expireAfter?: ItemShareDuration;
+    /** Whether the item can only be viewed once per recipient */
+    oneTimeOnly: boolean;
+}
+export interface Response<T, E> {
+    content?: T;
+    error?: E;
+}
+export type ItemUpdateFailureReason = 
+/** Item update operation failed due to bad user input. */
+{
+    type: "itemValidationError";
+    message: ErrorMessage;
+}
+/** Item update operation is forbidden, permission issue. Make sure you have the correct permissions to update items in this vault. */
+ | {
+    type: "itemStatusPermissionError";
+    message?: undefined;
+}
+/** Item update operation failed due to incorrect version. */
+ | {
+    type: "itemStatusIncorrectItemVersion";
+    message?: undefined;
+}
+/** Item update operation failed because a file reference didn't match a known file. */
+ | {
+    type: "itemStatusFileNotFound";
+    message?: undefined;
+}
+/** Item update request is too big to be sent to the server. */
+ | {
+    type: "itemStatusTooBig";
+    message?: undefined;
+}
+/** The item was not found */
+ | {
+    type: "itemNotFound";
+    message?: undefined;
+}
+/** Item update operation experienced an internal error. */
+ | {
+    type: "internal";
+    message: ErrorMessage;
+};
+export interface ItemsDeleteAllResponse {
+    individualResponses: Record<string, Response<undefined, ItemUpdateFailureReason>>;
+}
+export type ItemsGetAllError = {
+    type: "itemNotFound";
+    message?: undefined;
+} | {
+    type: "internal";
+    message: ErrorMessage;
+};
+export interface ItemsGetAllResponse {
+    individualResponses: Response<Item, ItemsGetAllError>[];
+}
+export interface ItemsUpdateAllResponse {
+    individualResponses: Response<Item, ItemUpdateFailureReason>[];
+}
+/**
+ * A login credential brokered by 1Password.
+ * Fields are none when the corresponding item field doesn't exist.
+ *
+ * Returned by
+ * [`Logins::read`](crate::client::Logins::read).
+ */
+export interface LoginCredential {
+    /** The login's username. */
+    username?: string;
+    /** The login's password. */
+    password?: string;
+    /** Current one-time-password code, if the login has a TOTP field. */
+    totp?: string;
+}
+/**
+ * Non-secret details for a brokered login.
+ *
+ * Returned by
+ * [`Login::get_details`](crate::client::Login::get_details).
+ */
+export interface LoginDetails {
+    /** Website URLs associated with the login. */
+    websites: string[];
+}
+/** Additional attributes for OTP fields. */
+export interface OtpFieldDetails {
+    /** The OTP code, if successfully computed */
+    code?: string;
+    /** The error message, if the OTP code could not be computed */
+    errorMessage?: string;
+}
+export interface ResolvedReference {
+    secret: string;
+    itemId: string;
+    vaultId: string;
+}
+export type ResolveReferenceError = 
+/** Error parsing the secret reference */
+{
+    type: "parsing";
+    message: ErrorMessage;
+}
+/** The specified reference cannot be found within the item */
+ | {
+    type: "fieldNotFound";
+    message?: undefined;
+}
+/** No vault matched the secret reference query */
+ | {
+    type: "vaultNotFound";
+    message?: undefined;
+}
+/** More than one vault matched the secret reference query */
+ | {
+    type: "tooManyVaults";
+    message?: undefined;
+}
+/** No item matched the secret reference query */
+ | {
+    type: "itemNotFound";
+    message?: undefined;
+}
+/** More than one item matched the secret reference query */
+ | {
+    type: "tooManyItems";
+    message?: undefined;
+}
+/** More than one field matched the provided secret reference */
+ | {
+    type: "tooManyMatchingFields";
+    message?: undefined;
+}
+/** No section found within the item for the provided identifier */
+ | {
+    type: "noMatchingSections";
+    message?: undefined;
+}
+/** Incompatiable TOTP query parameters */
+ | {
+    type: "incompatibleTOTPQueryParameterField";
+    message?: undefined;
+}
+/** The totp was not able to be generated */
+ | {
+    type: "unableToGenerateTotpCode";
+    message: ErrorMessage;
+}
+/** Couldn't find attributes specific to an SSH Key field */
+ | {
+    type: "sSHKeyMetadataNotFound";
+    message?: undefined;
+}
+/** Currently only support text files */
+ | {
+    type: "unsupportedFileFormat";
+    message?: undefined;
+}
+/** Trying to convert a non-private key to a private key format */
+ | {
+    type: "incompatibleSshKeyQueryParameterField";
+    message?: undefined;
+}
+/** Unable to properly parse a private key string to convert to an internal Private Key type */
+ | {
+    type: "unableToParsePrivateKey";
+    message?: undefined;
+}
+/** Unable to format a private key to OpenSSH format */
+ | {
+    type: "unableToFormatPrivateKeyToOpenSsh";
+    message?: undefined;
+}
+/** Other type */
+ | {
+    type: "other";
+    message?: undefined;
+};
+export interface ResolveAllResponse {
+    individualResponses: Record<string, Response<ResolvedReference, ResolveReferenceError>>;
+}
+export interface SshKeyAttributes {
+    /** The public part of the SSH Key */
+    publicKey: string;
+    /** The fingerprint of the SSH Key */
+    fingerprint: string;
+    /** The key type ("Ed25519" or "RSA, {length}-bit") */
+    keyType: string;
+}
+/** Represents the vault type. */
+export declare enum VaultType {
+    Personal = "personal",
+    Everyone = "everyone",
+    Transfer = "transfer",
+    UserCreated = "userCreated",
+    Unsupported = "unsupported"
+}
+/** Represents regular vault information together with the vault's access information. */
+export interface Vault {
+    /** The vault's ID. */
+    id: string;
+    /** The vault's title. */
+    title: string;
+    /** The description of the vault. */
+    description: string;
+    /** The type of the vault. */
+    vaultType: VaultType;
+    /** The number of active items within the vault. */
+    activeItemCount: number;
+    /** The content version number of the vault. It gets incremented whenever the state of the vault's contents changes (e.g. items from within the vault get created or updated). */
+    contentVersion: number;
+    /** The attribute version number of the vault. It gets incremented whenever vault presentation information changes, such as its name or icon. */
+    attributeVersion: number;
+    /** The access information associated with the vault. */
+    access?: VaultAccess[];
+}
+export interface VaultCreateParams {
+    title: string;
+    description?: string;
+    allowAdminsAccess?: boolean;
+}
+/** Represents the possible query parameters used for retrieving extra information about a vault. */
+export interface VaultGetParams {
+    /** The vault's accessor params. */
+    accessors?: boolean;
+}
+export interface VaultListParams {
+    decryptDetails?: boolean;
+}
+/** Holds information about a 1Password Vault. */
+export interface VaultOverview {
+    /** The vault's ID. */
+    id: string;
+    /** The vault's title. */
+    title: string;
+    /** The description of this vault. */
+    description: string;
+    /** The type of the vault. */
+    vaultType: VaultType;
+    /** The number of active items within the vault. */
+    activeItemCount: number;
+    /** The content version number of the vault. It gets incremented whenever the state of the vault's contents changes (e.g. items from within the vault get created or updated). */
+    contentVersion: number;
+    /** The attribute version number of the vault. It gets incremented whenever vault presentation information changes, such as its name or icon. */
+    attributeVersion: number;
+    /** The time the vault was created at */
+    createdAt: Date;
+    /** The time the vault was updated at */
+    updatedAt: Date;
+}
+export interface VaultUpdateParams {
+    title?: string;
+    description?: string;
+}
+export type ItemListFilter = {
+    type: "ByState";
+    content: {
+        active: boolean;
+        archived: boolean;
+    };
+};
+export type PasswordRecipe = {
+    type: "Memorable";
+    parameters: {
+        /** The type of separator between chunks. */
+        separatorType: SeparatorType;
+        /** Uppercase one randomly selected chunk. */
+        capitalize: boolean;
+        /** The type of word list used. */
+        wordListType: WordListType;
+        /** The number of "words" (words or syllables). */
+        wordCount: number;
+    };
+} | {
+    type: "Pin";
+    parameters: {
+        /** Number of digits in the PIN. */
+        length: number;
+    };
+} | {
+    type: "Random";
+    parameters: {
+        /** Include at least one digit in the password. */
+        includeDigits: boolean;
+        /** Include at least one symbol in the password. */
+        includeSymbols: boolean;
+        /** The length of the password. */
+        length: number;
+    };
+};
+export declare enum SeparatorType {
+    /**
+     * Randomly selected digits.
+     * E.g, "`correct4horse0battery1staple`"
+     */
+    Digits = "digits",
+    /**
+     * Randomly selected digits and symbols.
+     * This is useful to get word-based passwords to meet complexity requirements
+     * E.g, "`correct4horse-battery1staple`"
+     */
+    DigitsAndSymbols = "digitsAndSymbols",
+    /**
+     * Spaces, like the original Diceware.
+     * Great for mobile keyboards, not so great when people can overhear you type the password.
+     * E.g, "`correct horse battery staple`"
+     */
+    Spaces = "spaces",
+    /**
+     * Hyphens "`-`".
+     * E.g, "`correct-horse-battery-staple`"
+     */
+    Hyphens = "hyphens",
+    /**
+     * "`_`".
+     * E.g, "`correct_horse_battery_staple`"
+     */
+    Underscores = "underscores",
+    /**
+     * Period (full stop) "`.`".
+     * E.g, "`correct.horse.battery.staple`"
+     */
+    Periods = "periods",
+    /**
+     * Comma "`,`".
+     * E.g, "`correct,horse,battery,staple`"
+     */
+    Commas = "commas"
+}
+export declare enum WordListType {
+    /** Agile wordlist */
+    FullWords = "fullWords",
+    /** English-like syllables */
+    Syllables = "syllables",
+    /** Three (random) letter "words" */
+    ThreeLetters = "threeLetters"
+}
+export declare const ARCHIVE_ITEMS: number;
+export declare const CREATE_ITEMS: number;
+export declare const DELETE_ITEMS: number;
+export declare const EXPORT_ITEMS: number;
+export declare const IMPORT_ITEMS: number;
+export declare const MANAGE_VAULT: number;
+export declare const NO_ACCESS: number;
+export declare const PRINT_ITEMS: number;
+export declare const READ_ITEMS: number;
+export declare const RECOVER_VAULT: number;
+export declare const REVEAL_ITEM_PASSWORD: number;
+export declare const SEND_ITEMS: number;
+export declare const UPDATE_ITEMS: number;
+export declare const UPDATE_ITEM_HISTORY: number;
+/**
+ * Custom JSON reviver and replacer functions for dynamic data transformation
+ * ReviverFunc is used during JSON parsing to detect and transform specific data structures
+ * ReplacerFunc is used during JSON serialization to modify certain values before stringifying.
+ * These functions allow for flexible encoding and decoding of data, ensuring that complex types are properly handled when converting between TS objects and JSON
+ */
+export declare const ReviverFunc: (key: string, value: unknown) => unknown;
+export declare const ReplacerFunc: (key: string, value: unknown) => unknown;