Class ApplicationShortCodesClient

sdk.applications.shortCodes — short login codes granting access to an application.

Index

Constructors

Methods

create delete list redeem update

Constructors

constructor

new ApplicationShortCodesClient(call: Caller): ApplicationShortCodesClient
Parameters
- call: Caller
Returns ApplicationShortCodesClient
- Defined in src/resources/applications.ts:690

Methods

create

create(
    params: {
        applicationId: string;
        expiresAt?: string;
        maxUses?: number;
        name: string;
    },
    opts?: RequestOptions,
): Promise<ApplicationShortCodeData>
The backend returns the created short-code row directly (no envelope).
Parameters
- params: { applicationId: string; expiresAt?: string; maxUses?: number; name: string }
- Optionalopts: RequestOptions
Returns Promise<ApplicationShortCodeData>
- Defined in src/resources/applications.ts:702

delete

delete(
params: { applicationId: string; codeId: string },
opts?: RequestOptions,
): Promise<void>
Delete a short code.
Parameters
- params: { applicationId: string; codeId: string }
- Optionalopts: RequestOptions
Returns Promise<void>
Throws
NotFoundError if the application or code does not exist.
- Defined in src/resources/applications.ts:746

list

list(
params: { applicationId: string },
opts?: RequestOptions,
): Promise<ApplicationShortCodeData[]>
List an application's short codes.
Parameters
- params: { applicationId: string }
- Optionalopts: RequestOptions
Returns Promise<ApplicationShortCodeData[]>
- Defined in src/resources/applications.ts:693

redeem

redeem(
params: { code: string },
opts?: RequestOptions,
): Promise<RedeemShortCodeResult>
Redeem a short code for access to its application (authenticated).
Parameters
- params: { code: string }
- Optionalopts: RequestOptions
Returns Promise<RedeemShortCodeResult>
- Defined in src/resources/applications.ts:754

update

update(
    params: {
        applicationId: string;
        codeId: string;
        enabled?: boolean;
        expiresAt?: string;
        maxUses?: number;
        name?: string;
    },
    opts?: RequestOptions,
): Promise<ApplicationShortCodeData>
Update a short code's name/enabled/expiry/maxUses; returns the updated row.
Parameters
- params: {
      applicationId: string;
      codeId: string;
      enabled?: boolean;
      expiresAt?: string;
      maxUses?: number;
      name?: string;
  }
- Optionalopts: RequestOptions
Returns Promise<ApplicationShortCodeData>
Throws
NotFoundError if the application or code does not exist.
- Defined in src/resources/applications.ts:724