@seamapi/http 2.1.0 → 2.3.0

package/lib/routes/access-codes/unmanaged/unmanaged.js

@@ -0,0 +1,155 @@
+/*
+ * Automatically generated by codegen/smith.ts.
+ * Do not edit this file or add other files to this directory.
+ */
+import { getAuthHeadersForClientSessionToken, warnOnInsecureuserIdentifierKey, } from '../../../auth.js';
+import { createClient } from '../../../client.js';
+import { seamApiLtsVersion } from '../../../lts-version.js';
+import { isSeamHttpOptionsWithApiKey, isSeamHttpOptionsWithClient, isSeamHttpOptionsWithClientSessionToken, isSeamHttpOptionsWithConsoleSessionToken, isSeamHttpOptionsWithPersonalAccessToken, SeamHttpInvalidOptionsError, } from '../../../options.js';
+import { limitToSeamHttpRequestOptions, parseOptions, } from '../../../parse-options.js';
+import { SeamHttpClientSessions } from '../../../routes/client-sessions/index.js';
+import { SeamHttpRequest } from '../../../seam-http-request.js';
+import { SeamPaginator } from '../../../seam-paginator.js';
+export class SeamHttpAccessCodesUnmanaged {
+    client;
+    defaults;
+    ltsVersion = seamApiLtsVersion;
+    static ltsVersion = seamApiLtsVersion;
+    constructor(apiKeyOrOptions = {}) {
+        const options = parseOptions(apiKeyOrOptions);
+        this.client = 'client' in options ? options.client : createClient(options);
+        this.defaults = limitToSeamHttpRequestOptions(options);
+    }
+    static fromClient(client, options = {}) {
+        const constructorOptions = { ...options, client };
+        if (!isSeamHttpOptionsWithClient(constructorOptions)) {
+            throw new SeamHttpInvalidOptionsError('Missing client');
+        }
+        return new SeamHttpAccessCodesUnmanaged(constructorOptions);
+    }
+    static fromApiKey(apiKey, options = {}) {
+        const constructorOptions = { ...options, apiKey };
+        if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+            throw new SeamHttpInvalidOptionsError('Missing apiKey');
+        }
+        return new SeamHttpAccessCodesUnmanaged(constructorOptions);
+    }
+    static fromClientSessionToken(clientSessionToken, options = {}) {
+        const constructorOptions = { ...options, clientSessionToken };
+        if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+            throw new SeamHttpInvalidOptionsError('Missing clientSessionToken');
+        }
+        return new SeamHttpAccessCodesUnmanaged(constructorOptions);
+    }
+    static async fromPublishableKey(publishableKey, userIdentifierKey, options = {}) {
+        warnOnInsecureuserIdentifierKey(userIdentifierKey);
+        const clientOptions = parseOptions({ ...options, publishableKey });
+        if (isSeamHttpOptionsWithClient(clientOptions)) {
+            throw new SeamHttpInvalidOptionsError('The client option cannot be used with SeamHttpAccessCodesUnmanaged.fromPublishableKey');
+        }
+        const client = createClient(clientOptions);
+        const clientSessions = SeamHttpClientSessions.fromClient(client);
+        const { token } = await clientSessions.getOrCreate({
+            user_identifier_key: userIdentifierKey,
+        });
+        return SeamHttpAccessCodesUnmanaged.fromClientSessionToken(token, options);
+    }
+    static fromConsoleSessionToken(consoleSessionToken, workspaceId, options = {}) {
+        const constructorOptions = { ...options, consoleSessionToken, workspaceId };
+        if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) {
+            throw new SeamHttpInvalidOptionsError('Missing consoleSessionToken or workspaceId');
+        }
+        return new SeamHttpAccessCodesUnmanaged(constructorOptions);
+    }
+    static fromPersonalAccessToken(personalAccessToken, workspaceId, options = {}) {
+        const constructorOptions = { ...options, personalAccessToken, workspaceId };
+        if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+            throw new SeamHttpInvalidOptionsError('Missing personalAccessToken or workspaceId');
+        }
+        return new SeamHttpAccessCodesUnmanaged(constructorOptions);
+    }
+    createPaginator(request) {
+        return new SeamPaginator(this, request);
+    }
+    async updateClientSessionToken(clientSessionToken) {
+        const { headers } = this.client.defaults;
+        const authHeaders = getAuthHeadersForClientSessionToken({
+            clientSessionToken,
+        });
+        for (const key of Object.keys(authHeaders)) {
+            if (headers[key] == null) {
+                throw new Error('Cannot update a clientSessionToken on a client created without a clientSessionToken');
+            }
+        }
+        this.client.defaults.headers = { ...headers, ...authHeaders };
+        const clientSessions = SeamHttpClientSessions.fromClient(this.client);
+        await clientSessions.get();
+    }
+    /**
+     * Converts an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+     *
+     * An unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.
+     *
+     * Note that not all device providers support converting an unmanaged access code to a managed access code.
+     */
+    convertToManaged(parameters, options = {}) {
+        return new SeamHttpRequest(this, {
+            pathname: '/access_codes/unmanaged/convert_to_managed',
+            method: 'PATCH',
+            body: parameters,
+            responseKey: undefined,
+            options,
+        });
+    }
+    /**
+     * Deletes an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+     */
+    delete(parameters, options = {}) {
+        return new SeamHttpRequest(this, {
+            pathname: '/access_codes/unmanaged/delete',
+            method: 'POST',
+            body: parameters,
+            responseKey: undefined,
+            options,
+        });
+    }
+    /**
+     * Returns a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+     *
+     * You must specify either `access_code_id` or both `device_id` and `code`.
+     */
+    get(parameters, options = {}) {
+        return new SeamHttpRequest(this, {
+            pathname: '/access_codes/unmanaged/get',
+            method: 'POST',
+            body: parameters,
+            responseKey: 'access_code',
+            options,
+        });
+    }
+    /**
+     * Returns a list of all [unmanaged access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+     */
+    list(parameters, options = {}) {
+        return new SeamHttpRequest(this, {
+            pathname: '/access_codes/unmanaged/list',
+            method: 'POST',
+            body: parameters,
+            responseKey: 'access_codes',
+            options,
+        });
+    }
+    /**
+     * Updates a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+     */
+    update(parameters, options = {}) {
+        return new SeamHttpRequest(this, {
+            pathname: '/access_codes/unmanaged/update',
+            method: 'PATCH',
+            body: parameters,
+            responseKey: undefined,
+            options,
+        });
+    }
+}
+//# sourceMappingURL=unmanaged.js.map

package/lib/routes/access-codes/unmanaged/unmanaged.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unmanaged.js","sourceRoot":"","sources":["../../../../src/lib/routes/access-codes/unmanaged/unmanaged.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,mCAAmC,EACnC,+BAA+B,GAChC,MAAM,aAAa,CAAA;AACpB,OAAO,EAAe,YAAY,EAAE,MAAM,eAAe,CAAA;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,uCAAuC,EACvC,wCAAwC,EACxC,wCAAwC,EAExC,2BAA2B,GAQ5B,MAAM,gBAAgB,CAAA;AACvB,OAAO,EACL,6BAA6B,EAC7B,YAAY,GACb,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAC5E,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAErD,MAAM,OAAO,4BAA4B;IACvC,MAAM,CAAQ;IACL,QAAQ,CAAkC;IAC1C,UAAU,GAAG,iBAAiB,CAAA;IACvC,MAAM,CAAC,UAAU,GAAG,iBAAiB,CAAA;IAErC,YAAY,kBAA4C,EAAE;QACxD,MAAM,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,CAAA;QAC7C,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;QAC1E,IAAI,CAAC,QAAQ,GAAG,6BAA6B,CAAC,OAAO,CAAC,CAAA;IACxD,CAAC;IAED,MAAM,CAAC,UAAU,CACf,MAA2C,EAC3C,UAAqD,EAAE;QAEvD,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAA;QACjD,IAAI,CAAC,2BAA2B,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,2BAA2B,CAAC,gBAAgB,CAAC,CAAA;QACzD,CAAC;QACD,OAAO,IAAI,4BAA4B,CAAC,kBAAkB,CAAC,CAAA;IAC7D,CAAC;IAED,MAAM,CAAC,UAAU,CACf,MAA2C,EAC3C,UAAqD,EAAE;QAEvD,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAA;QACjD,IAAI,CAAC,2BAA2B,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,2BAA2B,CAAC,gBAAgB,CAAC,CAAA;QACzD,CAAC;QACD,OAAO,IAAI,4BAA4B,CAAC,kBAAkB,CAAC,CAAA;IAC7D,CAAC;IAED,MAAM,CAAC,sBAAsB,CAC3B,kBAA+E,EAC/E,UAGI,EAAE;QAEN,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,kBAAkB,EAAE,CAAA;QAC7D,IAAI,CAAC,uCAAuC,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACjE,MAAM,IAAI,2BAA2B,CAAC,4BAA4B,CAAC,CAAA;QACrE,CAAC;QACD,OAAO,IAAI,4BAA4B,CAAC,kBAAkB,CAAC,CAAA;IAC7D,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAC7B,cAAsB,EACtB,iBAAyB,EACzB,UAA6C,EAAE;QAE/C,+BAA+B,CAAC,iBAAiB,CAAC,CAAA;QAClD,MAAM,aAAa,GAAG,YAAY,CAAC,EAAE,GAAG,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;QAClE,IAAI,2BAA2B,CAAC,aAAa,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,2BAA2B,CACnC,uFAAuF,CACxF,CAAA;QACH,CAAC;QACD,MAAM,MAAM,GAAG,YAAY,CAAC,aAAa,CAAC,CAAA;QAC1C,MAAM,cAAc,GAAG,sBAAsB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QAChE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC;YACjD,mBAAmB,EAAE,iBAAiB;SACvC,CAAC,CAAA;QACF,OAAO,4BAA4B,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAC5E,CAAC;IAED,MAAM,CAAC,uBAAuB,CAC5B,mBAAkF,EAClF,WAAkE,EAClE,UAGI,EAAE;QAEN,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,CAAA;QAC3E,IAAI,CAAC,wCAAwC,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,2BAA2B,CACnC,4CAA4C,CAC7C,CAAA;QACH,CAAC;QACD,OAAO,IAAI,4BAA4B,CAAC,kBAAkB,CAAC,CAAA;IAC7D,CAAC;IAED,MAAM,CAAC,uBAAuB,CAC5B,mBAAkF,EAClF,WAAkE,EAClE,UAGI,EAAE;QAEN,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,CAAA;QAC3E,IAAI,CAAC,wCAAwC,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,2BAA2B,CACnC,4CAA4C,CAC7C,CAAA;QACH,CAAC;QACD,OAAO,IAAI,4BAA4B,CAAC,kBAAkB,CAAC,CAAA;IAC7D,CAAC;IAED,eAAe,CACb,OAAiD;QAEjD,OAAO,IAAI,aAAa,CAA0B,IAAI,EAAE,OAAO,CAAC,CAAA;IAClE,CAAC;IAED,KAAK,CAAC,wBAAwB,CAC5B,kBAA+E;QAE/E,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAA;QACxC,MAAM,WAAW,GAAG,mCAAmC,CAAC;YACtD,kBAAkB;SACnB,CAAC,CAAA;QACF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CACb,qFAAqF,CACtF,CAAA;YACH,CAAC;QACH,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,GAAG,WAAW,EAAE,CAAA;QAC7D,MAAM,cAAc,GAAG,sBAAsB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACrE,MAAM,cAAc,CAAC,GAAG,EAAE,CAAA;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CACd,UAA0D,EAC1D,UAAuD,EAAE;QAEzD,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,4CAA4C;YACtD,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAAgD,EAChD,UAA6C,EAAE;QAE/C,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,gCAAgC;YAC1C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACH,GAAG,CACD,UAA8C,EAC9C,UAA0C,EAAE;QAE5C,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,6BAA6B;YACvC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,aAAa;YAC1B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,IAAI,CACF,UAA8C,EAC9C,UAA2C,EAAE;QAE7C,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,8BAA8B;YACxC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,cAAc;YAC3B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAAgD,EAChD,UAA6C,EAAE;QAE/C,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,gCAAgC;YAC1C,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC"}

package/lib/routes/access-grants/access-grants.d.ts

@@ -0,0 +1,339 @@
+import { type Client } from '../../client.js';
+import { type SeamHttpFromPublishableKeyOptions, type SeamHttpOptions, type SeamHttpOptionsWithApiKey, type SeamHttpOptionsWithClient, type SeamHttpOptionsWithClientSessionToken, type SeamHttpOptionsWithConsoleSessionToken, type SeamHttpOptionsWithPersonalAccessToken, type SeamHttpRequestOptions } from '../../options.js';
+import type { AccessGrant } from '../../resources/access-grant.js';
+import type { Batch } from '../../resources/batch.js';
+import { SeamHttpRequest } from '../../seam-http-request.js';
+import { SeamPaginator } from '../../seam-paginator.js';
+import { SeamHttpAccessGrantsUnmanaged } from './unmanaged/index.js';
+export declare class SeamHttpAccessGrants {
+    client: Client;
+    readonly defaults: Required<SeamHttpRequestOptions>;
+    readonly ltsVersion = "1.0.0";
+    static ltsVersion: string;
+    constructor(apiKeyOrOptions?: string | SeamHttpOptions);
+    static fromClient(client: SeamHttpOptionsWithClient['client'], options?: Omit<SeamHttpOptionsWithClient, 'client'>): SeamHttpAccessGrants;
+    static fromApiKey(apiKey: SeamHttpOptionsWithApiKey['apiKey'], options?: Omit<SeamHttpOptionsWithApiKey, 'apiKey'>): SeamHttpAccessGrants;
+    static fromClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'], options?: Omit<SeamHttpOptionsWithClientSessionToken, 'clientSessionToken'>): SeamHttpAccessGrants;
+    static fromPublishableKey(publishableKey: string, userIdentifierKey: string, options?: SeamHttpFromPublishableKeyOptions): Promise<SeamHttpAccessGrants>;
+    static fromConsoleSessionToken(consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'], workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'], options?: Omit<SeamHttpOptionsWithConsoleSessionToken, 'consoleSessionToken' | 'workspaceId'>): SeamHttpAccessGrants;
+    static fromPersonalAccessToken(personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options?: Omit<SeamHttpOptionsWithPersonalAccessToken, 'personalAccessToken' | 'workspaceId'>): SeamHttpAccessGrants;
+    createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamHttpRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
+    updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
+    get unmanaged(): SeamHttpAccessGrantsUnmanaged;
+    /**
+     * Creates a new [Access Grant](https://docs.seam.co/use-cases/granting-access/access-grants). Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using `device_ids`) and access control systems (using `acs_entrance_ids` or `space_ids`), and can issue PIN codes, key cards, and mobile keys through a single request.
+     */
+    create(parameters: AccessGrantsCreateParameters, options?: AccessGrantsCreateOptions): AccessGrantsCreateRequest;
+    /**
+     * Delete an Access Grant.
+     */
+    delete(parameters: AccessGrantsDeleteParameters, options?: AccessGrantsDeleteOptions): AccessGrantsDeleteRequest;
+    /**
+     * Get an Access Grant.
+     */
+    get(parameters?: AccessGrantsGetParameters, options?: AccessGrantsGetOptions): AccessGrantsGetRequest;
+    /**
+     * Gets all related resources for one or more Access Grants.
+     */
+    getRelated(parameters?: AccessGrantsGetRelatedParameters, options?: AccessGrantsGetRelatedOptions): AccessGrantsGetRelatedRequest;
+    /**
+     * Gets an Access Grant.
+     */
+    list(parameters?: AccessGrantsListParameters, options?: AccessGrantsListOptions): AccessGrantsListRequest;
+    /**
+     * Adds additional requested access methods to an existing Access Grant.
+     */
+    requestAccessMethods(parameters: AccessGrantsRequestAccessMethodsParameters, options?: AccessGrantsRequestAccessMethodsOptions): AccessGrantsRequestAccessMethodsRequest;
+    /**
+     * Updates an existing Access Grant's time window.
+     */
+    update(parameters?: AccessGrantsUpdateParameters, options?: AccessGrantsUpdateOptions): AccessGrantsUpdateRequest;
+}
+export type AccessGrantsCreateParameters = {
+    /**
+     * ID of user identity for whom access is being granted.
+     */
+    user_identity_id?: string | undefined;
+    /**
+     * When used, creates a new user identity with the given details, and grants them access.
+     */
+    user_identity?: {
+        /**
+         * Unique email address for the user identity.
+         */
+        email_address?: string | undefined;
+        /**
+         * Full name of the user associated with the user identity.
+         */
+        full_name?: string | undefined;
+        /**
+         * Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
+         */
+        phone_number?: string | undefined;
+        /**
+         * Unique key for the user identity.
+         */
+        user_identity_key?: string | undefined;
+    } | undefined;
+    /**
+     * Unique key for the access grant within the workspace.
+     */
+    access_grant_key?: string | undefined;
+    /**
+     * Set of IDs of the [entrances](https://docs.seam.co/api/acs/systems/list) to which access is being granted.
+     */
+    acs_entrance_ids?: Array<string> | undefined;
+    /**
+     * ID of the customization profile to apply to the Access Grant and its access methods.
+     */
+    customization_profile_id?: string | undefined;
+    /**
+     * Set of IDs of the [devices](https://docs.seam.co/api/devices/list) to which access is being granted.
+     */
+    device_ids?: Array<string> | undefined;
+    /**
+     * Date and time at which the validity of the new grant 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`.
+     */
+    ends_at?: string | undefined;
+    /**
+     * @deprecated Create a space first, then reference it using `space_ids`.
+     */
+    location?: {
+        /**
+         * @deprecated Use `acs_entrance_ids` at the top level.
+         */
+        acs_entrance_ids?: Array<string> | undefined;
+        /**
+         * @deprecated Use `device_ids` at the top level.
+         */
+        device_ids?: Array<string> | undefined;
+        /**
+         * Name of the location.
+         */
+        name?: string | undefined;
+    } | undefined;
+    /**
+     * @deprecated Use `space_ids`.
+     */
+    location_ids?: Array<string> | undefined;
+    /**
+     * Name for the access grant.
+     */
+    name?: string | undefined;
+    requested_access_methods: Array<{
+        /**
+         * Specific PIN code to use for this access method. Only applicable when mode is 'code'.
+         */
+        code?: string | undefined;
+        /**
+         * Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified.
+         */
+        instant_key_max_use_count?: number | undefined;
+        /**
+         * Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
+         */
+        mode?: 'code' | 'card' | 'mobile_key' | 'cloud_key' | undefined;
+    }>;
+    /**
+     * Reservation key for the access grant.
+     */
+    reservation_key?: string | undefined;
+    /**
+     * Set of IDs of existing spaces to which access is being granted.
+     */
+    space_ids?: Array<string> | undefined;
+    /**
+     * Set of keys of existing spaces to which access is being granted.
+     */
+    space_keys?: Array<string> | undefined;
+    /**
+     * Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+     */
+    starts_at?: string | undefined;
+};
+/**
+ * @deprecated Use AccessGrantsCreateRequest instead.
+ */
+export type AccessGrantsCreateResponse = {
+    access_grant: AccessGrant;
+};
+export type AccessGrantsCreateRequest = SeamHttpRequest<AccessGrantsCreateResponse, 'access_grant'>;
+export interface AccessGrantsCreateOptions {
+}
+export type AccessGrantsDeleteParameters = {
+    /**
+     * ID of Access Grant to delete.
+     */
+    access_grant_id: string;
+};
+/**
+ * @deprecated Use AccessGrantsDeleteRequest instead.
+ */
+export type AccessGrantsDeleteResponse = void;
+export type AccessGrantsDeleteRequest = SeamHttpRequest<void, undefined>;
+export interface AccessGrantsDeleteOptions {
+}
+export type AccessGrantsGetParameters = {
+    /**
+     * ID of Access Grant to get.
+     */
+    access_grant_id?: string | undefined;
+    /**
+     * Unique key of Access Grant to get.
+     */
+    access_grant_key?: string | undefined;
+};
+/**
+ * @deprecated Use AccessGrantsGetRequest instead.
+ */
+export type AccessGrantsGetResponse = {
+    access_grant: AccessGrant;
+};
+export type AccessGrantsGetRequest = SeamHttpRequest<AccessGrantsGetResponse, 'access_grant'>;
+export interface AccessGrantsGetOptions {
+}
+export type AccessGrantsGetRelatedParameters = {
+    /**
+     * IDs of the access grants that you want to get along with their related resources.
+     */
+    access_grant_ids?: Array<string> | undefined;
+    /**
+     * Keys of the access grants that you want to get along with their related resources.
+     */
+    access_grant_keys?: Array<string> | undefined;
+    exclude?: Array<'spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identities' | 'acs_access_groups' | 'access_methods'> | undefined;
+    include?: Array<'spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identities' | 'acs_access_groups' | 'access_methods'> | undefined;
+};
+/**
+ * @deprecated Use AccessGrantsGetRelatedRequest instead.
+ */
+export type AccessGrantsGetRelatedResponse = {
+    batch: Batch<'spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identities' | 'acs_access_groups' | 'access_methods'>;
+};
+export type AccessGrantsGetRelatedRequest = SeamHttpRequest<AccessGrantsGetRelatedResponse, 'batch'>;
+export interface AccessGrantsGetRelatedOptions {
+}
+export type AccessGrantsListParameters = {
+    /**
+     * ID of the access code by which you want to filter the list of Access Grants.
+     */
+    access_code_id?: string | undefined;
+    /**
+     * IDs of the access grants to retrieve.
+     */
+    access_grant_ids?: Array<string> | undefined;
+    /**
+     * Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key.
+     */
+    access_grant_key?: string | undefined;
+    /**
+     * ID of the entrance by which you want to filter the list of Access Grants.
+     */
+    acs_entrance_id?: string | undefined;
+    /**
+     * ID of the access system by which you want to filter the list of Access Grants.
+     */
+    acs_system_id?: string | undefined;
+    /**
+     * Customer key for which you want to list access grants.
+     */
+    customer_key?: string | undefined;
+    /**
+     * ID of the device by which you want to filter the list of Access Grants.
+     */
+    device_id?: string | undefined;
+    /**
+     * Numerical limit on the number of access grants to return.
+     */
+    limit?: number | undefined;
+    /**
+     * @deprecated Use `space_id`.
+     */
+    location_id?: string | undefined;
+    /**
+     * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+     */
+    page_cursor?: string | undefined;
+    /**
+     * Filter Access Grants by reservation_key.
+     */
+    reservation_key?: string | undefined;
+    /**
+     * ID of the space by which you want to filter the list of Access Grants.
+     */
+    space_id?: string | undefined;
+    /**
+     * ID of user identity by which you want to filter the list of Access Grants.
+     */
+    user_identity_id?: string | undefined;
+};
+/**
+ * @deprecated Use AccessGrantsListRequest instead.
+ */
+export type AccessGrantsListResponse = {
+    access_grants: Array<AccessGrant>;
+};
+export type AccessGrantsListRequest = SeamHttpRequest<AccessGrantsListResponse, 'access_grants'>;
+export interface AccessGrantsListOptions {
+}
+export type AccessGrantsRequestAccessMethodsParameters = {
+    /**
+     * ID of the Access Grant to add access methods to.
+     */
+    access_grant_id: string;
+    /**
+     * Array of requested access methods to add to the access grant.
+     */
+    requested_access_methods: Array<{
+        /**
+         * Specific PIN code to use for this access method. Only applicable when mode is 'code'.
+         */
+        code?: string | undefined;
+        /**
+         * Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified.
+         */
+        instant_key_max_use_count?: number | undefined;
+        /**
+         * Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
+         */
+        mode?: 'code' | 'card' | 'mobile_key' | 'cloud_key' | undefined;
+    }>;
+};
+/**
+ * @deprecated Use AccessGrantsRequestAccessMethodsRequest instead.
+ */
+export type AccessGrantsRequestAccessMethodsResponse = {
+    access_grant: AccessGrant;
+};
+export type AccessGrantsRequestAccessMethodsRequest = SeamHttpRequest<AccessGrantsRequestAccessMethodsResponse, 'access_grant'>;
+export interface AccessGrantsRequestAccessMethodsOptions {
+}
+export type AccessGrantsUpdateParameters = {
+    /**
+     * ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.
+     */
+    access_grant_id?: string | undefined;
+    /**
+     * Key of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.
+     */
+    access_grant_key?: string | undefined;
+    /**
+     * Date and time at which the validity of the grant 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`.
+     */
+    ends_at?: string | undefined;
+    /**
+     * Display name for the access grant.
+     */
+    name?: string | undefined;
+    /**
+     * Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+     */
+    starts_at?: string | undefined;
+};
+/**
+ * @deprecated Use AccessGrantsUpdateRequest instead.
+ */
+export type AccessGrantsUpdateResponse = void;
+export type AccessGrantsUpdateRequest = SeamHttpRequest<void, undefined>;
+export interface AccessGrantsUpdateOptions {
+}

package/lib/routes/access-grants/access-grants.js

@@ -0,0 +1,177 @@
+/*
+ * Automatically generated by codegen/smith.ts.
+ * Do not edit this file or add other files to this directory.
+ */
+import { getAuthHeadersForClientSessionToken, warnOnInsecureuserIdentifierKey, } from '../../auth.js';
+import { createClient } from '../../client.js';
+import { seamApiLtsVersion } from '../../lts-version.js';
+import { isSeamHttpOptionsWithApiKey, isSeamHttpOptionsWithClient, isSeamHttpOptionsWithClientSessionToken, isSeamHttpOptionsWithConsoleSessionToken, isSeamHttpOptionsWithPersonalAccessToken, SeamHttpInvalidOptionsError, } from '../../options.js';
+import { limitToSeamHttpRequestOptions, parseOptions, } from '../../parse-options.js';
+import { SeamHttpClientSessions } from '../../routes/client-sessions/index.js';
+import { SeamHttpRequest } from '../../seam-http-request.js';
+import { SeamPaginator } from '../../seam-paginator.js';
+import { SeamHttpAccessGrantsUnmanaged } from './unmanaged/index.js';
+export class SeamHttpAccessGrants {
+    client;
+    defaults;
+    ltsVersion = seamApiLtsVersion;
+    static ltsVersion = seamApiLtsVersion;
+    constructor(apiKeyOrOptions = {}) {
+        const options = parseOptions(apiKeyOrOptions);
+        this.client = 'client' in options ? options.client : createClient(options);
+        this.defaults = limitToSeamHttpRequestOptions(options);
+    }
+    static fromClient(client, options = {}) {
+        const constructorOptions = { ...options, client };
+        if (!isSeamHttpOptionsWithClient(constructorOptions)) {
+            throw new SeamHttpInvalidOptionsError('Missing client');
+        }
+        return new SeamHttpAccessGrants(constructorOptions);
+    }
+    static fromApiKey(apiKey, options = {}) {
+        const constructorOptions = { ...options, apiKey };
+        if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+            throw new SeamHttpInvalidOptionsError('Missing apiKey');
+        }
+        return new SeamHttpAccessGrants(constructorOptions);
+    }
+    static fromClientSessionToken(clientSessionToken, options = {}) {
+        const constructorOptions = { ...options, clientSessionToken };
+        if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+            throw new SeamHttpInvalidOptionsError('Missing clientSessionToken');
+        }
+        return new SeamHttpAccessGrants(constructorOptions);
+    }
+    static async fromPublishableKey(publishableKey, userIdentifierKey, options = {}) {
+        warnOnInsecureuserIdentifierKey(userIdentifierKey);
+        const clientOptions = parseOptions({ ...options, publishableKey });
+        if (isSeamHttpOptionsWithClient(clientOptions)) {
+            throw new SeamHttpInvalidOptionsError('The client option cannot be used with SeamHttpAccessGrants.fromPublishableKey');
+        }
+        const client = createClient(clientOptions);
+        const clientSessions = SeamHttpClientSessions.fromClient(client);
+        const { token } = await clientSessions.getOrCreate({
+            user_identifier_key: userIdentifierKey,
+        });
+        return SeamHttpAccessGrants.fromClientSessionToken(token, options);
+    }
+    static fromConsoleSessionToken(consoleSessionToken, workspaceId, options = {}) {
+        const constructorOptions = { ...options, consoleSessionToken, workspaceId };
+        if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) {
+            throw new SeamHttpInvalidOptionsError('Missing consoleSessionToken or workspaceId');
+        }
+        return new SeamHttpAccessGrants(constructorOptions);
+    }
+    static fromPersonalAccessToken(personalAccessToken, workspaceId, options = {}) {
+        const constructorOptions = { ...options, personalAccessToken, workspaceId };
+        if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+            throw new SeamHttpInvalidOptionsError('Missing personalAccessToken or workspaceId');
+        }
+        return new SeamHttpAccessGrants(constructorOptions);
+    }
+    createPaginator(request) {
+        return new SeamPaginator(this, request);
+    }
+    async updateClientSessionToken(clientSessionToken) {
+        const { headers } = this.client.defaults;
+        const authHeaders = getAuthHeadersForClientSessionToken({
+            clientSessionToken,
+        });
+        for (const key of Object.keys(authHeaders)) {
+            if (headers[key] == null) {
+                throw new Error('Cannot update a clientSessionToken on a client created without a clientSessionToken');
+            }
+        }
+        this.client.defaults.headers = { ...headers, ...authHeaders };
+        const clientSessions = SeamHttpClientSessions.fromClient(this.client);
+        await clientSessions.get();
+    }
+    get unmanaged() {
+        return SeamHttpAccessGrantsUnmanaged.fromClient(this.client, this.defaults);
+    }
+    /**
+     * Creates a new [Access Grant](https://docs.seam.co/use-cases/granting-access/access-grants). Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using `device_ids`) and access control systems (using `acs_entrance_ids` or `space_ids`), and can issue PIN codes, key cards, and mobile keys through a single request.
+     */
+    create(parameters, options = {}) {
+        return new SeamHttpRequest(this, {
+            pathname: '/access_grants/create',
+            method: 'POST',
+            body: parameters,
+            responseKey: 'access_grant',
+            options,
+        });
+    }
+    /**
+     * Delete an Access Grant.
+     */
+    delete(parameters, options = {}) {
+        return new SeamHttpRequest(this, {
+            pathname: '/access_grants/delete',
+            method: 'POST',
+            body: parameters,
+            responseKey: undefined,
+            options,
+        });
+    }
+    /**
+     * Get an Access Grant.
+     */
+    get(parameters, options = {}) {
+        return new SeamHttpRequest(this, {
+            pathname: '/access_grants/get',
+            method: 'GET',
+            params: parameters,
+            responseKey: 'access_grant',
+            options,
+        });
+    }
+    /**
+     * Gets all related resources for one or more Access Grants.
+     */
+    getRelated(parameters, options = {}) {
+        return new SeamHttpRequest(this, {
+            pathname: '/access_grants/get_related',
+            method: 'POST',
+            body: parameters,
+            responseKey: 'batch',
+            options,
+        });
+    }
+    /**
+     * Gets an Access Grant.
+     */
+    list(parameters, options = {}) {
+        return new SeamHttpRequest(this, {
+            pathname: '/access_grants/list',
+            method: 'POST',
+            body: parameters,
+            responseKey: 'access_grants',
+            options,
+        });
+    }
+    /**
+     * Adds additional requested access methods to an existing Access Grant.
+     */
+    requestAccessMethods(parameters, options = {}) {
+        return new SeamHttpRequest(this, {
+            pathname: '/access_grants/request_access_methods',
+            method: 'POST',
+            body: parameters,
+            responseKey: 'access_grant',
+            options,
+        });
+    }
+    /**
+     * Updates an existing Access Grant's time window.
+     */
+    update(parameters, options = {}) {
+        return new SeamHttpRequest(this, {
+            pathname: '/access_grants/update',
+            method: 'PATCH',
+            body: parameters,
+            responseKey: undefined,
+            options,
+        });
+    }
+}
+//# sourceMappingURL=access-grants.js.map