@seamapi/http 2.0.0 → 2.2.0

package/lib/seam/connect/routes/access-codes/unmanaged/unmanaged.d.ts

@@ -17,16 +17,49 @@ export declare class SeamHttpAccessCodesUnmanaged {
     static fromPersonalAccessToken(personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options?: Omit<SeamHttpOptionsWithPersonalAccessToken, 'personalAccessToken' | 'workspaceId'>): SeamHttpAccessCodesUnmanaged;
     createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamHttpRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
     updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
+    /**
+     * 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: AccessCodesUnmanagedConvertToManagedParameters, options?: AccessCodesUnmanagedConvertToManagedOptions): AccessCodesUnmanagedConvertToManagedRequest;
+    /**
+     * Deletes an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+     */
     delete(parameters: AccessCodesUnmanagedDeleteParameters, options?: AccessCodesUnmanagedDeleteOptions): AccessCodesUnmanagedDeleteRequest;
+    /**
+     * 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?: AccessCodesUnmanagedGetParameters, options?: AccessCodesUnmanagedGetOptions): AccessCodesUnmanagedGetRequest;
+    /**
+     * 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: AccessCodesUnmanagedListParameters, options?: AccessCodesUnmanagedListOptions): AccessCodesUnmanagedListRequest;
+    /**
+     * Updates a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+     */
     update(parameters: AccessCodesUnmanagedUpdateParameters, options?: AccessCodesUnmanagedUpdateOptions): AccessCodesUnmanagedUpdateRequest;
 }
 export type AccessCodesUnmanagedConvertToManagedParameters = {
+    /**
+     * ID of the unmanaged access code that you want to convert to a managed access code.
+     */
     access_code_id: string;
+    /**
+     * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.
+     */
     allow_external_modification?: boolean | undefined;
+    /**
+     * Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`.
+     */
     force?: boolean | undefined;
+    /**
+     * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.
+     */
     is_external_modification_allowed?: boolean | undefined;
 };
 /**
@@ -37,6 +70,9 @@ export type AccessCodesUnmanagedConvertToManagedRequest = SeamHttpRequest<void,
 export interface AccessCodesUnmanagedConvertToManagedOptions {
 }
 export type AccessCodesUnmanagedDeleteParameters = {
+    /**
+     * ID of the unmanaged access code that you want to delete.
+     */
     access_code_id: string;
 };
 /**
@@ -47,8 +83,17 @@ export type AccessCodesUnmanagedDeleteRequest = SeamHttpRequest<void, undefined>
 export interface AccessCodesUnmanagedDeleteOptions {
 }
 export type AccessCodesUnmanagedGetParameters = {
+    /**
+     * ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+     */
     access_code_id?: string | undefined;
+    /**
+     * Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+     */
     code?: string | undefined;
+    /**
+     * ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+     */
     device_id?: string | undefined;
 };
 /**
@@ -61,10 +106,25 @@ export type AccessCodesUnmanagedGetRequest = SeamHttpRequest<AccessCodesUnmanage
 export interface AccessCodesUnmanagedGetOptions {
 }
 export type AccessCodesUnmanagedListParameters = {
+    /**
+     * ID of the device for which you want to list unmanaged access codes.
+     */
     device_id: string;
+    /**
+     * Numerical limit on the number of unmanaged access codes to return.
+     */
     limit?: number | undefined;
+    /**
+     * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+     */
     page_cursor?: string | undefined;
+    /**
+     * String for which to search. Filters returned access codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`.
+     */
     search?: string | undefined;
+    /**
+     * Your user ID for the user by which to filter unmanaged access codes.
+     */
     user_identifier_key?: string | undefined;
 };
 /**
@@ -77,9 +137,21 @@ export type AccessCodesUnmanagedListRequest = SeamHttpRequest<AccessCodesUnmanag
 export interface AccessCodesUnmanagedListOptions {
 }
 export type AccessCodesUnmanagedUpdateParameters = {
+    /**
+     * ID of the unmanaged access code that you want to update.
+     */
     access_code_id: string;
+    /**
+     * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.
+     */
     allow_external_modification?: boolean | undefined;
+    /**
+     * Indicates whether to force the unmanaged access code update.
+     */
     force?: boolean | undefined;
+    /**
+     * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.
+     */
     is_external_modification_allowed?: boolean | undefined;
     is_managed: boolean;
 };

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

@@ -85,6 +85,13 @@ export class SeamHttpAccessCodesUnmanaged {
         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',
@@ -94,6 +101,9 @@ export class SeamHttpAccessCodesUnmanaged {
             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',
@@ -103,6 +113,11 @@ export class SeamHttpAccessCodesUnmanaged {
             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',
@@ -112,6 +127,9 @@ export class SeamHttpAccessCodesUnmanaged {
             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',
@@ -121,6 +139,9 @@ export class SeamHttpAccessCodesUnmanaged {
             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',

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

@@ -1 +1 @@
-{"version":3,"file":"unmanaged.js","sourceRoot":"","sources":["../../../../../../src/lib/seam/connect/routes/access-codes/unmanaged/unmanaged.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,EACL,mCAAmC,EACnC,+BAA+B,GAChC,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAe,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,uCAAuC,EACvC,wCAAwC,EACxC,wCAAwC,EAExC,2BAA2B,GAQ5B,MAAM,6BAA6B,CAAA;AACpC,OAAO,EACL,6BAA6B,EAC7B,YAAY,GACb,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EAAE,sBAAsB,EAAE,MAAM,kDAAkD,CAAA;AACzF,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAA;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAA;AAElE,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,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,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,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,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,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"}
+{"version":3,"file":"unmanaged.js","sourceRoot":"","sources":["../../../../../../src/lib/seam/connect/routes/access-codes/unmanaged/unmanaged.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,EACL,mCAAmC,EACnC,+BAA+B,GAChC,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAe,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,uCAAuC,EACvC,wCAAwC,EACxC,wCAAwC,EAExC,2BAA2B,GAQ5B,MAAM,6BAA6B,CAAA;AACpC,OAAO,EACL,6BAA6B,EAC7B,YAAY,GACb,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EAAE,sBAAsB,EAAE,MAAM,kDAAkD,CAAA;AACzF,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAA;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAA;AAElE,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/seam/connect/routes/access-grants/access-grants.d.ts

@@ -20,42 +20,135 @@ export declare class 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;
 };
 /**
@@ -68,6 +161,9 @@ export type AccessGrantsCreateRequest = SeamHttpRequest<AccessGrantsCreateRespon
 export interface AccessGrantsCreateOptions {
 }
 export type AccessGrantsDeleteParameters = {
+    /**
+     * ID of Access Grant to delete.
+     */
     access_grant_id: string;
 };
 /**
@@ -78,7 +174,13 @@ 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;
 };
 /**
@@ -91,7 +193,13 @@ export type AccessGrantsGetRequest = SeamHttpRequest<AccessGrantsGetResponse, 'a
 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;
@@ -106,18 +214,57 @@ export type AccessGrantsGetRelatedRequest = SeamHttpRequest<AccessGrantsGetRelat
 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;
 };
 /**
@@ -130,10 +277,25 @@ export type AccessGrantsListRequest = SeamHttpRequest<AccessGrantsListResponse,
 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;
     }>;
 };
@@ -147,10 +309,25 @@ export type AccessGrantsRequestAccessMethodsRequest = SeamHttpRequest<AccessGran
 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;
 };
 /**

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

@@ -89,6 +89,9 @@ export class SeamHttpAccessGrants {
     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',
@@ -98,6 +101,9 @@ export class SeamHttpAccessGrants {
             options,
         });
     }
+    /**
+     * Delete an Access Grant.
+     */
     delete(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/access_grants/delete',
@@ -107,6 +113,9 @@ export class SeamHttpAccessGrants {
             options,
         });
     }
+    /**
+     * Get an Access Grant.
+     */
     get(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/access_grants/get',
@@ -116,6 +125,9 @@ export class SeamHttpAccessGrants {
             options,
         });
     }
+    /**
+     * Gets all related resources for one or more Access Grants.
+     */
     getRelated(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/access_grants/get_related',
@@ -125,6 +137,9 @@ export class SeamHttpAccessGrants {
             options,
         });
     }
+    /**
+     * Gets an Access Grant.
+     */
     list(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/access_grants/list',
@@ -134,6 +149,9 @@ export class SeamHttpAccessGrants {
             options,
         });
     }
+    /**
+     * Adds additional requested access methods to an existing Access Grant.
+     */
     requestAccessMethods(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/access_grants/request_access_methods',
@@ -143,6 +161,9 @@ export class SeamHttpAccessGrants {
             options,
         });
     }
+    /**
+     * Updates an existing Access Grant's time window.
+     */
     update(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/access_grants/update',

package/lib/seam/connect/routes/access-grants/access-grants.js.map

@@ -1 +1 @@
-{"version":3,"file":"access-grants.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/routes/access-grants/access-grants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,EACL,mCAAmC,EACnC,+BAA+B,GAChC,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAe,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,uCAAuC,EACvC,wCAAwC,EACxC,wCAAwC,EAExC,2BAA2B,GAQ5B,MAAM,6BAA6B,CAAA;AACpC,OAAO,EACL,6BAA6B,EAC7B,YAAY,GACb,MAAM,mCAAmC,CAAA;AAG1C,OAAO,EAAE,sBAAsB,EAAE,MAAM,kDAAkD,CAAA;AACzF,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAA;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAA;AAElE,OAAO,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAA;AAEpE,MAAM,OAAO,oBAAoB;IAC/B,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,oBAAoB,CAAC,kBAAkB,CAAC,CAAA;IACrD,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,oBAAoB,CAAC,kBAAkB,CAAC,CAAA;IACrD,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,oBAAoB,CAAC,kBAAkB,CAAC,CAAA;IACrD,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,+EAA+E,CAChF,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,oBAAoB,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACpE,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,oBAAoB,CAAC,kBAAkB,CAAC,CAAA;IACrD,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,oBAAoB,CAAC,kBAAkB,CAAC,CAAA;IACrD,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,IAAI,SAAS;QACX,OAAO,6BAA6B,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC7E,CAAC;IAED,MAAM,CACJ,UAAwC,EACxC,UAAqC,EAAE;QAEvC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,uBAAuB;YACjC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,cAAc;YAC3B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CACJ,UAAwC,EACxC,UAAqC,EAAE;QAEvC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,uBAAuB;YACjC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,GAAG,CACD,UAAsC,EACtC,UAAkC,EAAE;QAEpC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,oBAAoB;YAC9B,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,UAAU;YAClB,WAAW,EAAE,cAAc;YAC3B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,UAAU,CACR,UAA6C,EAC7C,UAAyC,EAAE;QAE3C,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,4BAA4B;YACtC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,OAAO;YACpB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,IAAI,CACF,UAAuC,EACvC,UAAmC,EAAE;QAErC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,qBAAqB;YAC/B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,eAAe;YAC5B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,oBAAoB,CAClB,UAAsD,EACtD,UAAmD,EAAE;QAErD,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,uCAAuC;YACjD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,cAAc;YAC3B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CACJ,UAAyC,EACzC,UAAqC,EAAE;QAEvC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,uBAAuB;YACjC,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC"}
+{"version":3,"file":"access-grants.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/routes/access-grants/access-grants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,EACL,mCAAmC,EACnC,+BAA+B,GAChC,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAe,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,uCAAuC,EACvC,wCAAwC,EACxC,wCAAwC,EAExC,2BAA2B,GAQ5B,MAAM,6BAA6B,CAAA;AACpC,OAAO,EACL,6BAA6B,EAC7B,YAAY,GACb,MAAM,mCAAmC,CAAA;AAG1C,OAAO,EAAE,sBAAsB,EAAE,MAAM,kDAAkD,CAAA;AACzF,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAA;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAA;AAElE,OAAO,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAA;AAEpE,MAAM,OAAO,oBAAoB;IAC/B,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,oBAAoB,CAAC,kBAAkB,CAAC,CAAA;IACrD,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,oBAAoB,CAAC,kBAAkB,CAAC,CAAA;IACrD,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,oBAAoB,CAAC,kBAAkB,CAAC,CAAA;IACrD,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,+EAA+E,CAChF,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,oBAAoB,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACpE,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,oBAAoB,CAAC,kBAAkB,CAAC,CAAA;IACrD,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,oBAAoB,CAAC,kBAAkB,CAAC,CAAA;IACrD,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,IAAI,SAAS;QACX,OAAO,6BAA6B,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC7E,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAAwC,EACxC,UAAqC,EAAE;QAEvC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,uBAAuB;YACjC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,cAAc;YAC3B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAAwC,EACxC,UAAqC,EAAE;QAEvC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,uBAAuB;YACjC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,GAAG,CACD,UAAsC,EACtC,UAAkC,EAAE;QAEpC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,oBAAoB;YAC9B,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,UAAU;YAClB,WAAW,EAAE,cAAc;YAC3B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,UAAU,CACR,UAA6C,EAC7C,UAAyC,EAAE;QAE3C,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,4BAA4B;YACtC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,OAAO;YACpB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,IAAI,CACF,UAAuC,EACvC,UAAmC,EAAE;QAErC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,qBAAqB;YAC/B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,eAAe;YAC5B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,oBAAoB,CAClB,UAAsD,EACtD,UAAmD,EAAE;QAErD,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,uCAAuC;YACjD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,cAAc;YAC3B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAAyC,EACzC,UAAqC,EAAE;QAEvC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,uBAAuB;YACjC,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC"}

package/lib/seam/connect/routes/access-grants/unmanaged/unmanaged.d.ts

@@ -17,11 +17,27 @@ export declare class SeamHttpAccessGrantsUnmanaged {
     static fromPersonalAccessToken(personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options?: Omit<SeamHttpOptionsWithPersonalAccessToken, 'personalAccessToken' | 'workspaceId'>): SeamHttpAccessGrantsUnmanaged;
     createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamHttpRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
     updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
+    /**
+     * Get an unmanaged Access Grant (where is_managed = false).
+     */
     get(parameters: AccessGrantsUnmanagedGetParameters, options?: AccessGrantsUnmanagedGetOptions): AccessGrantsUnmanagedGetRequest;
+    /**
+     * Gets unmanaged Access Grants (where is_managed = false).
+     */
     list(parameters?: AccessGrantsUnmanagedListParameters, options?: AccessGrantsUnmanagedListOptions): AccessGrantsUnmanagedListRequest;
+    /**
+     * Updates an unmanaged Access Grant to make it managed.
+     *
+     * This endpoint can only be used to convert unmanaged access grants to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed access grants back to unmanaged.
+     *
+     * When converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.
+     */
     update(parameters: AccessGrantsUnmanagedUpdateParameters, options?: AccessGrantsUnmanagedUpdateOptions): AccessGrantsUnmanagedUpdateRequest;
 }
 export type AccessGrantsUnmanagedGetParameters = {
+    /**
+     * ID of unmanaged Access Grant to get.
+     */
     access_grant_id: string;
 };
 /**
@@ -34,11 +50,29 @@ export type AccessGrantsUnmanagedGetRequest = SeamHttpRequest<AccessGrantsUnmana
 export interface AccessGrantsUnmanagedGetOptions {
 }
 export type AccessGrantsUnmanagedListParameters = {
+    /**
+     * ID of the entrance by which you want to filter the list of unmanaged Access Grants.
+     */
     acs_entrance_id?: string | undefined;
+    /**
+     * ID of the access system by which you want to filter the list of unmanaged Access Grants.
+     */
     acs_system_id?: string | undefined;
+    /**
+     * Numerical limit on the number of unmanaged access grants to return.
+     */
     limit?: number | undefined;
+    /**
+     * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+     */
     page_cursor?: string | undefined;
+    /**
+     * Filter unmanaged Access Grants by reservation_key.
+     */
     reservation_key?: string | undefined;
+    /**
+     * ID of user identity by which you want to filter the list of unmanaged Access Grants.
+     */
     user_identity_id?: string | undefined;
 };
 /**
@@ -51,8 +85,17 @@ export type AccessGrantsUnmanagedListRequest = SeamHttpRequest<AccessGrantsUnman
 export interface AccessGrantsUnmanagedListOptions {
 }
 export type AccessGrantsUnmanagedUpdateParameters = {
+    /**
+     * ID of the unmanaged Access Grant to update.
+     */
     access_grant_id: string;
+    /**
+     * Unique key for the access grant. If not provided, the existing key will be preserved.
+     */
     access_grant_key?: string | undefined;
+    /**
+     * Must be set to true to convert the unmanaged access grant to managed.
+     */
     is_managed: boolean;
 };
 /**