@seamapi/http 2.0.0 → 2.2.0

package/lib/seam/connect/routes/acs/credentials/credentials.d.ts

@@ -18,18 +18,51 @@ export declare class SeamHttpAcsCredentials {
     static fromPersonalAccessToken(personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options?: Omit<SeamHttpOptionsWithPersonalAccessToken, 'personalAccessToken' | 'workspaceId'>): SeamHttpAcsCredentials;
     createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamHttpRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
     updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
+    /**
+     * Assigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+     */
     assign(parameters: AcsCredentialsAssignParameters, options?: AcsCredentialsAssignOptions): AcsCredentialsAssignRequest;
+    /**
+     * Creates a new [credential](https://docs.seam.co/low-level-apis/managing-credentials) for a specified [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management). For granting access, we recommend [Access Grants](https://docs.seam.co/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.
+     */
     create(parameters: AcsCredentialsCreateParameters, options?: AcsCredentialsCreateOptions): AcsCredentialsCreateRequest;
+    /**
+     * Deletes a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     delete(parameters: AcsCredentialsDeleteParameters, options?: AcsCredentialsDeleteOptions): AcsCredentialsDeleteRequest;
+    /**
+     * Returns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     get(parameters: AcsCredentialsGetParameters, options?: AcsCredentialsGetOptions): AcsCredentialsGetRequest;
+    /**
+     * Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     list(parameters?: AcsCredentialsListParameters, options?: AcsCredentialsListOptions): AcsCredentialsListRequest;
+    /**
+     * Returns a list of all [entrances](https://docs.seam.co/api/acs/entrances) to which a [credential](https://docs.seam.co/api/acs/credentials) grants access.
+     */
     listAccessibleEntrances(parameters: AcsCredentialsListAccessibleEntrancesParameters, options?: AcsCredentialsListAccessibleEntrancesOptions): AcsCredentialsListAccessibleEntrancesRequest;
+    /**
+     * Unassigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+     */
     unassign(parameters: AcsCredentialsUnassignParameters, options?: AcsCredentialsUnassignOptions): AcsCredentialsUnassignRequest;
+    /**
+     * Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     update(parameters: AcsCredentialsUpdateParameters, options?: AcsCredentialsUpdateOptions): AcsCredentialsUpdateRequest;
 }
 export type AcsCredentialsAssignParameters = {
+    /**
+     * ID of the credential that you want to assign to an access system user.
+     */
     acs_credential_id: string;
+    /**
+     * ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id.
+     */
     acs_user_id?: string | undefined;
+    /**
+     * ID of the user identity to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
+     */
     user_identity_id?: string | undefined;
 };
 /**
@@ -40,25 +73,67 @@ export type AcsCredentialsAssignRequest = SeamHttpRequest<void, undefined>;
 export interface AcsCredentialsAssignOptions {
 }
 export type AcsCredentialsCreateParameters = {
+    /**
+     * Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
+     */
     access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
+    /**
+     * ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.
+     */
     acs_system_id?: string | undefined;
+    /**
+     * ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.
+     */
     acs_user_id?: string | undefined;
+    /**
+     * Set of IDs of the [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for which the new credential grants access.
+     */
     allowed_acs_entrance_ids?: Array<string> | undefined;
+    /**
+     * Vostio-specific metadata for the new credential.
+     */
     assa_abloy_vostio_metadata?: {
         auto_join?: boolean | undefined;
         join_all_guest_acs_entrances?: boolean | undefined;
         override_all_guest_acs_entrances?: boolean | undefined;
         override_guest_acs_entrance_ids?: Array<string> | undefined;
     } | undefined;
+    /**
+     * Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/device-and-system-integration-guides).
+     */
     code?: string | undefined;
+    /**
+     * ACS system ID of the credential manager for the new credential.
+     */
     credential_manager_acs_system_id?: string | undefined;
+    /**
+     * Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+     */
     ends_at?: string | undefined;
+    /**
+     * Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
+     */
     is_multi_phone_sync_credential?: boolean | undefined;
+    /**
+     * Salto Space-specific metadata for the new credential.
+     */
     salto_space_metadata?: {
+        /**
+         * Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials).
+         */
         assign_new_key?: boolean | undefined;
     } | undefined;
+    /**
+     * Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+     */
     starts_at?: string | undefined;
+    /**
+     * ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.
+     */
     user_identity_id?: string | undefined;
+    /**
+     * Visionline-specific metadata for the new credential.
+     */
     visionline_metadata?: {
         auto_join?: boolean | undefined;
         card_format?: 'TLCode' | 'rfid48' | undefined;
@@ -77,6 +152,9 @@ export type AcsCredentialsCreateRequest = SeamHttpRequest<AcsCredentialsCreateRe
 export interface AcsCredentialsCreateOptions {
 }
 export type AcsCredentialsDeleteParameters = {
+    /**
+     * ID of the credential that you want to delete.
+     */
     acs_credential_id: string;
 };
 /**
@@ -87,6 +165,9 @@ export type AcsCredentialsDeleteRequest = SeamHttpRequest<void, undefined>;
 export interface AcsCredentialsDeleteOptions {
 }
 export type AcsCredentialsGetParameters = {
+    /**
+     * ID of the credential that you want to get.
+     */
     acs_credential_id: string;
 };
 /**
@@ -99,13 +180,37 @@ export type AcsCredentialsGetRequest = SeamHttpRequest<AcsCredentialsGetResponse
 export interface AcsCredentialsGetOptions {
 }
 export type AcsCredentialsListParameters = {
+    /**
+     * ID of the access system user for which you want to retrieve all credentials.
+     */
     acs_user_id?: string | undefined;
+    /**
+     * ID of the access system for which you want to retrieve all credentials.
+     */
     acs_system_id?: string | undefined;
+    /**
+     * ID of the user identity for which you want to retrieve all credentials.
+     */
     user_identity_id?: string | undefined;
+    /**
+     * Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.
+     */
     created_before?: string | undefined;
+    /**
+     * Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.
+     */
     is_multi_phone_sync_credential?: boolean | undefined;
+    /**
+     * Number of credentials 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 credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`.
+     */
     search?: string | undefined;
 };
 /**
@@ -118,6 +223,9 @@ export type AcsCredentialsListRequest = SeamHttpRequest<AcsCredentialsListRespon
 export interface AcsCredentialsListOptions {
 }
 export type AcsCredentialsListAccessibleEntrancesParameters = {
+    /**
+     * ID of the credential for which you want to retrieve all entrances to which the credential grants access.
+     */
     acs_credential_id: string;
 };
 /**
@@ -130,8 +238,17 @@ export type AcsCredentialsListAccessibleEntrancesRequest = SeamHttpRequest<AcsCr
 export interface AcsCredentialsListAccessibleEntrancesOptions {
 }
 export type AcsCredentialsUnassignParameters = {
+    /**
+     * ID of the credential that you want to unassign from an access system user.
+     */
     acs_credential_id: string;
+    /**
+     * ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.
+     */
     acs_user_id?: string | undefined;
+    /**
+     * ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.
+     */
     user_identity_id?: string | undefined;
 };
 /**
@@ -142,8 +259,17 @@ export type AcsCredentialsUnassignRequest = SeamHttpRequest<void, undefined>;
 export interface AcsCredentialsUnassignOptions {
 }
 export type AcsCredentialsUpdateParameters = {
+    /**
+     * ID of the credential that you want to update.
+     */
     acs_credential_id: string;
+    /**
+     * Replacement access (PIN) code for the credential that you want to update.
+     */
     code?: string | undefined;
+    /**
+     * Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential.
+     */
     ends_at?: string | undefined;
 };
 /**

package/lib/seam/connect/routes/acs/credentials/credentials.js

@@ -85,6 +85,9 @@ export class SeamHttpAcsCredentials {
         const clientSessions = SeamHttpClientSessions.fromClient(this.client);
         await clientSessions.get();
     }
+    /**
+     * Assigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+     */
     assign(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/credentials/assign',
@@ -94,6 +97,9 @@ export class SeamHttpAcsCredentials {
             options,
         });
     }
+    /**
+     * Creates a new [credential](https://docs.seam.co/low-level-apis/managing-credentials) for a specified [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management). For granting access, we recommend [Access Grants](https://docs.seam.co/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.
+     */
     create(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/credentials/create',
@@ -103,6 +109,9 @@ export class SeamHttpAcsCredentials {
             options,
         });
     }
+    /**
+     * Deletes a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     delete(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/credentials/delete',
@@ -112,6 +121,9 @@ export class SeamHttpAcsCredentials {
             options,
         });
     }
+    /**
+     * Returns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     get(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/credentials/get',
@@ -121,6 +133,9 @@ export class SeamHttpAcsCredentials {
             options,
         });
     }
+    /**
+     * Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     list(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/credentials/list',
@@ -130,6 +145,9 @@ export class SeamHttpAcsCredentials {
             options,
         });
     }
+    /**
+     * Returns a list of all [entrances](https://docs.seam.co/api/acs/entrances) to which a [credential](https://docs.seam.co/api/acs/credentials) grants access.
+     */
     listAccessibleEntrances(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/credentials/list_accessible_entrances',
@@ -139,6 +157,9 @@ export class SeamHttpAcsCredentials {
             options,
         });
     }
+    /**
+     * Unassigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+     */
     unassign(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/credentials/unassign',
@@ -148,6 +169,9 @@ export class SeamHttpAcsCredentials {
             options,
         });
     }
+    /**
+     * Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     update(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/credentials/update',

package/lib/seam/connect/routes/acs/credentials/credentials.js.map

@@ -1 +1 @@
-{"version":3,"file":"credentials.js","sourceRoot":"","sources":["../../../../../../src/lib/seam/connect/routes/acs/credentials/credentials.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,MAAM,OAAO,sBAAsB;IACjC,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,sBAAsB,CAAC,kBAAkB,CAAC,CAAA;IACvD,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,sBAAsB,CAAC,kBAAkB,CAAC,CAAA;IACvD,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,sBAAsB,CAAC,kBAAkB,CAAC,CAAA;IACvD,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,iFAAiF,CAClF,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,sBAAsB,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACtE,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,sBAAsB,CAAC,kBAAkB,CAAC,CAAA;IACvD,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,sBAAsB,CAAC,kBAAkB,CAAC,CAAA;IACvD,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,MAAM,CACJ,UAA0C,EAC1C,UAAuC,EAAE;QAEzC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,yBAAyB;YACnC,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CACJ,UAA0C,EAC1C,UAAuC,EAAE;QAEzC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,yBAAyB;YACnC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,gBAAgB;YAC7B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CACJ,UAA0C,EAC1C,UAAuC,EAAE;QAEzC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,yBAAyB;YACnC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,GAAG,CACD,UAAuC,EACvC,UAAoC,EAAE;QAEtC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,sBAAsB;YAChC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,gBAAgB;YAC7B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,IAAI,CACF,UAAyC,EACzC,UAAqC,EAAE;QAEvC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,uBAAuB;YACjC,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,UAAU;YAClB,WAAW,EAAE,iBAAiB;YAC9B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,uBAAuB,CACrB,UAA2D,EAC3D,UAAwD,EAAE;QAE1D,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,4CAA4C;YACtD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,eAAe;YAC5B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,QAAQ,CACN,UAA4C,EAC5C,UAAyC,EAAE;QAE3C,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,2BAA2B;YACrC,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CACJ,UAA0C,EAC1C,UAAuC,EAAE;QAEzC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,yBAAyB;YACnC,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC"}
+{"version":3,"file":"credentials.js","sourceRoot":"","sources":["../../../../../../src/lib/seam/connect/routes/acs/credentials/credentials.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,MAAM,OAAO,sBAAsB;IACjC,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,sBAAsB,CAAC,kBAAkB,CAAC,CAAA;IACvD,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,sBAAsB,CAAC,kBAAkB,CAAC,CAAA;IACvD,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,sBAAsB,CAAC,kBAAkB,CAAC,CAAA;IACvD,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,iFAAiF,CAClF,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,sBAAsB,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACtE,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,sBAAsB,CAAC,kBAAkB,CAAC,CAAA;IACvD,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,sBAAsB,CAAC,kBAAkB,CAAC,CAAA;IACvD,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;;OAEG;IACH,MAAM,CACJ,UAA0C,EAC1C,UAAuC,EAAE;QAEzC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,yBAAyB;YACnC,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAA0C,EAC1C,UAAuC,EAAE;QAEzC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,yBAAyB;YACnC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,gBAAgB;YAC7B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAA0C,EAC1C,UAAuC,EAAE;QAEzC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,yBAAyB;YACnC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,GAAG,CACD,UAAuC,EACvC,UAAoC,EAAE;QAEtC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,sBAAsB;YAChC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,gBAAgB;YAC7B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,IAAI,CACF,UAAyC,EACzC,UAAqC,EAAE;QAEvC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,uBAAuB;YACjC,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,UAAU;YAClB,WAAW,EAAE,iBAAiB;YAC9B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,uBAAuB,CACrB,UAA2D,EAC3D,UAAwD,EAAE;QAE1D,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,4CAA4C;YACtD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,eAAe;YAC5B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,UAA4C,EAC5C,UAAyC,EAAE;QAE3C,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,2BAA2B;YACrC,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAA0C,EAC1C,UAAuC,EAAE;QAEzC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,yBAAyB;YACnC,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC"}

package/lib/seam/connect/routes/acs/encoders/encoders.d.ts

@@ -20,15 +20,39 @@ export declare class SeamHttpAcsEncoders {
     createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamHttpRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
     updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
     get simulate(): SeamHttpAcsEncodersSimulate;
+    /**
+     * Encodes an existing [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id`
+     */
     encodeCredential(parameters: AcsEncodersEncodeCredentialParameters, options?: AcsEncodersEncodeCredentialOptions): AcsEncodersEncodeCredentialRequest;
+    /**
+     * Returns a specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     get(parameters: AcsEncodersGetParameters, options?: AcsEncodersGetOptions): AcsEncodersGetRequest;
+    /**
+     * Returns a list of all [encoders](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     list(parameters?: AcsEncodersListParameters, options?: AcsEncodersListOptions): AcsEncodersListRequest;
+    /**
+     * Scans an encoded [acs_credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     scanCredential(parameters: AcsEncodersScanCredentialParameters, options?: AcsEncodersScanCredentialOptions): AcsEncodersScanCredentialRequest;
+    /**
+     * Scans a physical card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`.
+     */
     scanToAssignCredential(parameters: AcsEncodersScanToAssignCredentialParameters, options?: AcsEncodersScanToAssignCredentialOptions): AcsEncodersScanToAssignCredentialRequest;
 }
 export type AcsEncodersEncodeCredentialParameters = {
+    /**
+     * ID of the `access_method` to encode onto a card.
+     */
     access_method_id?: string | undefined;
+    /**
+     * ID of the `acs_credential` to encode onto a card.
+     */
     acs_credential_id?: string | undefined;
+    /**
+     * ID of the `acs_encoder` to use to encode the `acs_credential`.
+     */
     acs_encoder_id: string;
 };
 /**
@@ -40,6 +64,9 @@ export type AcsEncodersEncodeCredentialResponse = {
 export type AcsEncodersEncodeCredentialRequest = SeamHttpRequest<AcsEncodersEncodeCredentialResponse, 'action_attempt'>;
 export type AcsEncodersEncodeCredentialOptions = Pick<SeamHttpRequestOptions, 'waitForActionAttempt'>;
 export type AcsEncodersGetParameters = {
+    /**
+     * ID of the encoder that you want to get.
+     */
     acs_encoder_id: string;
 };
 /**
@@ -52,10 +79,25 @@ export type AcsEncodersGetRequest = SeamHttpRequest<AcsEncodersGetResponse, 'acs
 export interface AcsEncodersGetOptions {
 }
 export type AcsEncodersListParameters = {
+    /**
+     * ID of the access system for which you want to retrieve all encoders.
+     */
     acs_system_id?: string | undefined;
+    /**
+     * IDs of the access systems for which you want to retrieve all encoders.
+     */
     acs_system_ids?: Array<string> | undefined;
+    /**
+     * IDs of the encoders that you want to retrieve.
+     */
     acs_encoder_ids?: Array<string> | undefined;
+    /**
+     * Number of encoders 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;
 };
 /**
@@ -68,8 +110,17 @@ export type AcsEncodersListRequest = SeamHttpRequest<AcsEncodersListResponse, 'a
 export interface AcsEncodersListOptions {
 }
 export type AcsEncodersScanCredentialParameters = {
+    /**
+     * ID of the encoder to use for the scan.
+     */
     acs_encoder_id: string;
+    /**
+     * Salto KS-specific metadata for the scan action.
+     */
     salto_ks_metadata?: {
+        /**
+         * When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false.
+         */
         detect_new_tags?: boolean | undefined;
     } | undefined;
 };
@@ -82,11 +133,26 @@ export type AcsEncodersScanCredentialResponse = {
 export type AcsEncodersScanCredentialRequest = SeamHttpRequest<AcsEncodersScanCredentialResponse, 'action_attempt'>;
 export type AcsEncodersScanCredentialOptions = Pick<SeamHttpRequestOptions, 'waitForActionAttempt'>;
 export type AcsEncodersScanToAssignCredentialParameters = {
+    /**
+     * ID of the `acs_encoder` to use to scan the credential.
+     */
     acs_encoder_id: string;
+    /**
+     * ID of the `acs_user` to assign the scanned credential to.
+     */
     acs_user_id?: string | undefined;
+    /**
+     * Salto KS-specific metadata for the scan action.
+     */
     salto_ks_metadata?: {
+        /**
+         * When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false.
+         */
         detect_new_tags?: boolean | undefined;
     } | undefined;
+    /**
+     * ID of the `user_identity` to assign the scanned credential to. If the ACS system contains an ACS user linked to this user identity, it is used. Otherwise, one is created.
+     */
     user_identity_id?: string | undefined;
 };
 /**

package/lib/seam/connect/routes/acs/encoders/encoders.js

@@ -89,6 +89,9 @@ export class SeamHttpAcsEncoders {
     get simulate() {
         return SeamHttpAcsEncodersSimulate.fromClient(this.client, this.defaults);
     }
+    /**
+     * Encodes an existing [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id`
+     */
     encodeCredential(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/encoders/encode_credential',
@@ -98,6 +101,9 @@ export class SeamHttpAcsEncoders {
             options,
         });
     }
+    /**
+     * Returns a specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     get(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/encoders/get',
@@ -107,6 +113,9 @@ export class SeamHttpAcsEncoders {
             options,
         });
     }
+    /**
+     * Returns a list of all [encoders](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     list(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/encoders/list',
@@ -116,6 +125,9 @@ export class SeamHttpAcsEncoders {
             options,
         });
     }
+    /**
+     * Scans an encoded [acs_credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     scanCredential(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/encoders/scan_credential',
@@ -125,6 +137,9 @@ export class SeamHttpAcsEncoders {
             options,
         });
     }
+    /**
+     * Scans a physical card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`.
+     */
     scanToAssignCredential(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/encoders/scan_to_assign_credential',

package/lib/seam/connect/routes/acs/encoders/encoders.js.map

@@ -1 +1 @@
-{"version":3,"file":"encoders.js","sourceRoot":"","sources":["../../../../../../src/lib/seam/connect/routes/acs/encoders/encoders.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,2BAA2B,EAAE,MAAM,qBAAqB,CAAA;AAEjE,MAAM,OAAO,mBAAmB;IAC9B,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,mBAAmB,CAAC,kBAAkB,CAAC,CAAA;IACpD,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,mBAAmB,CAAC,kBAAkB,CAAC,CAAA;IACpD,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,mBAAmB,CAAC,kBAAkB,CAAC,CAAA;IACpD,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,8EAA8E,CAC/E,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,mBAAmB,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACnE,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,mBAAmB,CAAC,kBAAkB,CAAC,CAAA;IACpD,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,mBAAmB,CAAC,kBAAkB,CAAC,CAAA;IACpD,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,QAAQ;QACV,OAAO,2BAA2B,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC3E,CAAC;IAED,gBAAgB,CACd,UAAiD,EACjD,UAA8C,EAAE;QAEhD,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,iCAAiC;YAC3C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,gBAAgB;YAC7B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,GAAG,CACD,UAAoC,EACpC,UAAiC,EAAE;QAEnC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,mBAAmB;YAC7B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,aAAa;YAC1B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,IAAI,CACF,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,cAAc,CACZ,UAA+C,EAC/C,UAA4C,EAAE;QAE9C,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,+BAA+B;YACzC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,gBAAgB;YAC7B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,sBAAsB,CACpB,UAAuD,EACvD,UAAoD,EAAE;QAEtD,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,yCAAyC;YACnD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,gBAAgB;YAC7B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC"}
+{"version":3,"file":"encoders.js","sourceRoot":"","sources":["../../../../../../src/lib/seam/connect/routes/acs/encoders/encoders.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,2BAA2B,EAAE,MAAM,qBAAqB,CAAA;AAEjE,MAAM,OAAO,mBAAmB;IAC9B,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,mBAAmB,CAAC,kBAAkB,CAAC,CAAA;IACpD,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,mBAAmB,CAAC,kBAAkB,CAAC,CAAA;IACpD,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,mBAAmB,CAAC,kBAAkB,CAAC,CAAA;IACpD,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,8EAA8E,CAC/E,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,mBAAmB,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACnE,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,mBAAmB,CAAC,kBAAkB,CAAC,CAAA;IACpD,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,mBAAmB,CAAC,kBAAkB,CAAC,CAAA;IACpD,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,QAAQ;QACV,OAAO,2BAA2B,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC3E,CAAC;IAED;;OAEG;IACH,gBAAgB,CACd,UAAiD,EACjD,UAA8C,EAAE;QAEhD,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,iCAAiC;YAC3C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,gBAAgB;YAC7B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,GAAG,CACD,UAAoC,EACpC,UAAiC,EAAE;QAEnC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,mBAAmB;YAC7B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,aAAa;YAC1B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,IAAI,CACF,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,cAAc,CACZ,UAA+C,EAC/C,UAA4C,EAAE;QAE9C,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,+BAA+B;YACzC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,gBAAgB;YAC7B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,sBAAsB,CACpB,UAAuD,EACvD,UAAoD,EAAE;QAEtD,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,yCAAyC;YACnD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,gBAAgB;YAC7B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC"}

package/lib/seam/connect/routes/acs/encoders/simulate/simulate.d.ts

@@ -16,14 +16,35 @@ export declare class SeamHttpAcsEncodersSimulate {
     static fromPersonalAccessToken(personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options?: Omit<SeamHttpOptionsWithPersonalAccessToken, 'personalAccessToken' | 'workspaceId'>): SeamHttpAcsEncodersSimulate;
     createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamHttpRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
     updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
+    /**
+     * Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     nextCredentialEncodeWillFail(parameters: AcsEncodersSimulateNextCredentialEncodeWillFailParameters, options?: AcsEncodersSimulateNextCredentialEncodeWillFailOptions): AcsEncodersSimulateNextCredentialEncodeWillFailRequest;
+    /**
+     * Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     nextCredentialEncodeWillSucceed(parameters: AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters, options?: AcsEncodersSimulateNextCredentialEncodeWillSucceedOptions): AcsEncodersSimulateNextCredentialEncodeWillSucceedRequest;
+    /**
+     * Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     nextCredentialScanWillFail(parameters: AcsEncodersSimulateNextCredentialScanWillFailParameters, options?: AcsEncodersSimulateNextCredentialScanWillFailOptions): AcsEncodersSimulateNextCredentialScanWillFailRequest;
+    /**
+     * Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     nextCredentialScanWillSucceed(parameters: AcsEncodersSimulateNextCredentialScanWillSucceedParameters, options?: AcsEncodersSimulateNextCredentialScanWillSucceedOptions): AcsEncodersSimulateNextCredentialScanWillSucceedRequest;
 }
 export type AcsEncodersSimulateNextCredentialEncodeWillFailParameters = {
+    /**
+     * ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
+     */
     acs_encoder_id: string;
+    /**
+     * Code of the error to simulate.
+     */
     error_code?: 'no_credential_on_encoder' | 'encoding_interrupted' | 'uncategorized_error' | 'action_attempt_expired' | undefined;
+    /**
+     * ID of the `acs_credential` that will fail to be encoded onto a card in the next request.
+     */
     acs_credential_id?: string | undefined;
 };
 /**
@@ -34,7 +55,13 @@ export type AcsEncodersSimulateNextCredentialEncodeWillFailRequest = SeamHttpReq
 export interface AcsEncodersSimulateNextCredentialEncodeWillFailOptions {
 }
 export type AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters = {
+    /**
+     * ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
+     */
     acs_encoder_id: string;
+    /**
+     * Scenario to simulate.
+     */
     scenario?: 'credential_is_issued' | undefined;
 };
 /**
@@ -45,6 +72,9 @@ export type AcsEncodersSimulateNextCredentialEncodeWillSucceedRequest = SeamHttp
 export interface AcsEncodersSimulateNextCredentialEncodeWillSucceedOptions {
 }
 export type AcsEncodersSimulateNextCredentialScanWillFailParameters = {
+    /**
+     * ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.
+     */
     acs_encoder_id: string;
     error_code?: 'no_credential_on_encoder' | 'uncategorized_error' | 'action_attempt_expired' | undefined;
     acs_credential_id_on_seam?: string | undefined;
@@ -57,8 +87,17 @@ export type AcsEncodersSimulateNextCredentialScanWillFailRequest = SeamHttpReque
 export interface AcsEncodersSimulateNextCredentialScanWillFailOptions {
 }
 export type AcsEncodersSimulateNextCredentialScanWillSucceedParameters = {
+    /**
+     * ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation.
+     */
     acs_credential_id_on_seam?: string | undefined;
+    /**
+     * ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.
+     */
     acs_encoder_id: string;
+    /**
+     * Scenario to simulate.
+     */
     scenario?: 'credential_exists_on_seam' | 'credential_on_encoder_needs_update' | 'credential_does_not_exist_on_seam' | 'credential_on_encoder_is_empty' | undefined;
 };
 /**

package/lib/seam/connect/routes/acs/encoders/simulate/simulate.js

@@ -85,6 +85,9 @@ export class SeamHttpAcsEncodersSimulate {
         const clientSessions = SeamHttpClientSessions.fromClient(this.client);
         await clientSessions.get();
     }
+    /**
+     * Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     nextCredentialEncodeWillFail(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/encoders/simulate/next_credential_encode_will_fail',
@@ -94,6 +97,9 @@ export class SeamHttpAcsEncodersSimulate {
             options,
         });
     }
+    /**
+     * Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     nextCredentialEncodeWillSucceed(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/encoders/simulate/next_credential_encode_will_succeed',
@@ -103,6 +109,9 @@ export class SeamHttpAcsEncodersSimulate {
             options,
         });
     }
+    /**
+     * Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     nextCredentialScanWillFail(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/encoders/simulate/next_credential_scan_will_fail',
@@ -112,6 +121,9 @@ export class SeamHttpAcsEncodersSimulate {
             options,
         });
     }
+    /**
+     * Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     nextCredentialScanWillSucceed(parameters, options = {}) {
         return new SeamHttpRequest(this, {
             pathname: '/acs/encoders/simulate/next_credential_scan_will_succeed',