@fusionauth/typescript-client 1.43.0 → 1.45.0

package/build/src/FusionAuthClient.d.ts

@@ -1883,9 +1883,9 @@ export declare class FusionAuthClient {
      * Call the UserInfo endpoint to retrieve User Claims from the access token issued by FusionAuth.
      *
      * @param {string} encodedJWT The encoded JWT (access token).
-     * @returns {Promise<ClientResponse<UserResponse>>}
+     * @returns {Promise<ClientResponse<UserinfoResponse>>}
      */
-    retrieveUserInfoFromAccessToken(encodedJWT: string): Promise<ClientResponse<UserResponse>>;
+    retrieveUserInfoFromAccessToken(encodedJWT: string): Promise<ClientResponse<UserinfoResponse>>;
     /**
      * Retrieve a single Identity Provider user (link).
      *
@@ -2057,6 +2057,13 @@ export declare class FusionAuthClient {
      * @returns {Promise<ClientResponse<void>>}
      */
     revokeUserConsent(userConsentId: UUID): Promise<ClientResponse<void>>;
+    /**
+     * Searches applications with the specified criteria and pagination.
+     *
+     * @param {ApplicationSearchRequest} request The search criteria and pagination information.
+     * @returns {Promise<ClientResponse<ApplicationSearchResponse>>}
+     */
+    searchApplications(request: ApplicationSearchRequest): Promise<ClientResponse<ApplicationSearchResponse>>;
     /**
      * Searches the audit logs with the specified criteria and pagination.
      *
@@ -2064,6 +2071,20 @@ export declare class FusionAuthClient {
      * @returns {Promise<ClientResponse<AuditLogSearchResponse>>}
      */
     searchAuditLogs(request: AuditLogSearchRequest): Promise<ClientResponse<AuditLogSearchResponse>>;
+    /**
+     * Searches consents with the specified criteria and pagination.
+     *
+     * @param {ConsentSearchRequest} request The search criteria and pagination information.
+     * @returns {Promise<ClientResponse<ConsentSearchResponse>>}
+     */
+    searchConsents(request: ConsentSearchRequest): Promise<ClientResponse<ConsentSearchResponse>>;
+    /**
+     * Searches email templates with the specified criteria and pagination.
+     *
+     * @param {EmailTemplateSearchRequest} request The search criteria and pagination information.
+     * @returns {Promise<ClientResponse<EmailTemplateSearchResponse>>}
+     */
+    searchEmailTemplates(request: EmailTemplateSearchRequest): Promise<ClientResponse<EmailTemplateSearchResponse>>;
     /**
      * Searches entities with the specified criteria and pagination.
      *
@@ -2120,6 +2141,27 @@ export declare class FusionAuthClient {
      * @returns {Promise<ClientResponse<IPAccessControlListSearchResponse>>}
      */
     searchIPAccessControlLists(request: IPAccessControlListSearchRequest): Promise<ClientResponse<IPAccessControlListSearchResponse>>;
+    /**
+     * Searches identity providers with the specified criteria and pagination.
+     *
+     * @param {IdentityProviderSearchRequest} request The search criteria and pagination information.
+     * @returns {Promise<ClientResponse<IdentityProviderSearchResponse>>}
+     */
+    searchIdentityProviders(request: IdentityProviderSearchRequest): Promise<ClientResponse<IdentityProviderSearchResponse>>;
+    /**
+     * Searches keys with the specified criteria and pagination.
+     *
+     * @param {KeySearchRequest} request The search criteria and pagination information.
+     * @returns {Promise<ClientResponse<KeySearchResponse>>}
+     */
+    searchKeys(request: KeySearchRequest): Promise<ClientResponse<KeySearchResponse>>;
+    /**
+     * Searches lambdas with the specified criteria and pagination.
+     *
+     * @param {LambdaSearchRequest} request The search criteria and pagination information.
+     * @returns {Promise<ClientResponse<LambdaSearchResponse>>}
+     */
+    searchLambdas(request: LambdaSearchRequest): Promise<ClientResponse<LambdaSearchResponse>>;
     /**
      * Searches the login records with the specified criteria and pagination.
      *
@@ -2127,6 +2169,27 @@ export declare class FusionAuthClient {
      * @returns {Promise<ClientResponse<LoginRecordSearchResponse>>}
      */
     searchLoginRecords(request: LoginRecordSearchRequest): Promise<ClientResponse<LoginRecordSearchResponse>>;
+    /**
+     * Searches tenants with the specified criteria and pagination.
+     *
+     * @param {TenantSearchRequest} request The search criteria and pagination information.
+     * @returns {Promise<ClientResponse<TenantSearchResponse>>}
+     */
+    searchTenants(request: TenantSearchRequest): Promise<ClientResponse<TenantSearchResponse>>;
+    /**
+     * Searches themes with the specified criteria and pagination.
+     *
+     * @param {ThemeSearchRequest} request The search criteria and pagination information.
+     * @returns {Promise<ClientResponse<ThemeSearchResponse>>}
+     */
+    searchThemes(request: ThemeSearchRequest): Promise<ClientResponse<ThemeSearchResponse>>;
+    /**
+     * Searches user comments with the specified criteria and pagination.
+     *
+     * @param {UserCommentSearchRequest} request The search criteria and pagination information.
+     * @returns {Promise<ClientResponse<UserCommentSearchResponse>>}
+     */
+    searchUserComments(request: UserCommentSearchRequest): Promise<ClientResponse<UserCommentSearchResponse>>;
     /**
      * Retrieves the users for the given ids. If any id is invalid, it is ignored.
      *
@@ -2161,6 +2224,13 @@ export declare class FusionAuthClient {
      * @deprecated This method has been renamed to searchUsersByQuery, use that method instead.
      */
     searchUsersByQueryString(request: SearchRequest): Promise<ClientResponse<SearchResponse>>;
+    /**
+     * Searches webhooks with the specified criteria and pagination.
+     *
+     * @param {WebhookSearchRequest} request The search criteria and pagination information.
+     * @returns {Promise<ClientResponse<WebhookSearchResponse>>}
+     */
+    searchWebhooks(request: WebhookSearchRequest): Promise<ClientResponse<WebhookSearchResponse>>;
     /**
      * Send an email using an email template id. You can optionally provide <code>requestData</code> to access key value
      * pairs in the email template.
@@ -2803,6 +2873,7 @@ export interface ApplicationExternalIdentifierConfiguration {
  */
 export interface ApplicationFormConfiguration {
     adminRegistrationFormId?: UUID;
+    selfServiceFormConfiguration?: SelfServiceFormConfiguration;
     selfServiceFormId?: UUID;
 }
 /**
@@ -2864,6 +2935,33 @@ export interface ApplicationRole {
     lastUpdateInstant?: number;
     name?: string;
 }
+/**
+ * Search criteria for Applications
+ *
+ * @author Spencer Witt
+ */
+export interface ApplicationSearchCriteria extends BaseSearchCriteria {
+    name?: string;
+    state?: ObjectState;
+    tenantId?: UUID;
+}
+/**
+ * Search request for Applications
+ *
+ * @author Spencer Witt
+ */
+export interface ApplicationSearchRequest {
+    search?: ApplicationSearchCriteria;
+}
+/**
+ * Application search response
+ *
+ * @author Spencer Witt
+ */
+export interface ApplicationSearchResponse {
+    applications?: Array<Application>;
+    total?: number;
+}
 /**
  * @author Daniel DeGroff
  */
@@ -3332,6 +3430,31 @@ export interface ConsentResponse {
     consent?: Consent;
     consents?: Array<Consent>;
 }
+/**
+ * Search criteria for Consents
+ *
+ * @author Spencer Witt
+ */
+export interface ConsentSearchCriteria extends BaseSearchCriteria {
+    name?: string;
+}
+/**
+ * Search request for Consents
+ *
+ * @author Spencer Witt
+ */
+export interface ConsentSearchRequest {
+    search?: ConsentSearchCriteria;
+}
+/**
+ * Consent search response
+ *
+ * @author Spencer Witt
+ */
+export interface ConsentSearchResponse {
+    consents?: Array<Consent>;
+    total?: number;
+}
 /**
  * Models a consent.
  *
@@ -3599,6 +3722,31 @@ export interface EmailTemplateResponse {
     emailTemplate?: EmailTemplate;
     emailTemplates?: Array<EmailTemplate>;
 }
+/**
+ * Search criteria for Email templates
+ *
+ * @author Mark Manes
+ */
+export interface EmailTemplateSearchCriteria extends BaseSearchCriteria {
+    name?: string;
+}
+/**
+ * Search request for email templates
+ *
+ * @author Mark Manes
+ */
+export interface EmailTemplateSearchRequest {
+    search?: EmailTemplateSearchCriteria;
+}
+/**
+ * Email template search response
+ *
+ * @author Mark Manes
+ */
+export interface EmailTemplateSearchResponse {
+    emailTemplates?: Array<EmailTemplate>;
+    total?: number;
+}
 /**
  * @author Daniel DeGroff
  */
@@ -4360,6 +4508,7 @@ export interface GoogleApplicationConfiguration extends BaseIdentityProviderAppl
     client_id?: string;
     client_secret?: string;
     loginMethod?: IdentityProviderLoginMethod;
+    properties?: GoogleIdentityProviderProperties;
     scope?: string;
 }
 /**
@@ -4372,8 +4521,18 @@ export interface GoogleIdentityProvider extends BaseIdentityProvider<GoogleAppli
     client_id?: string;
     client_secret?: string;
     loginMethod?: IdentityProviderLoginMethod;
+    properties?: GoogleIdentityProviderProperties;
     scope?: string;
 }
+/**
+ * Google social login provider parameters.
+ *
+ * @author Daniel DeGroff
+ */
+export interface GoogleIdentityProviderProperties {
+    api?: string;
+    button?: string;
+}
 /**
  * Authorization Grant types as defined by the <a href="https://tools.ietf.org/html/rfc6749">The OAuth 2.0 Authorization
  * Framework - RFC 6749</a>.
@@ -4693,7 +4852,8 @@ export interface IdentityProviderLinkResponse {
  */
 export declare enum IdentityProviderLoginMethod {
     UsePopup = "UsePopup",
-    UseRedirect = "UseRedirect"
+    UseRedirect = "UseRedirect",
+    UseVendorJavaScript = "UseVendorJavaScript"
 }
 /**
  * Login API request object used for login to third-party systems (i.e. Login with Facebook).
@@ -4735,6 +4895,33 @@ export interface IdentityProviderResponse {
     identityProvider?: BaseIdentityProvider<any>;
     identityProviders?: Array<BaseIdentityProvider<any>>;
 }
+/**
+ * Search criteria for Identity Providers.
+ *
+ * @author Spencer Witt
+ */
+export interface IdentityProviderSearchCriteria extends BaseSearchCriteria {
+    applicationId?: UUID;
+    name?: string;
+    type?: IdentityProviderType;
+}
+/**
+ * Search request for Identity Providers
+ *
+ * @author Spencer Witt
+ */
+export interface IdentityProviderSearchRequest {
+    search?: IdentityProviderSearchCriteria;
+}
+/**
+ * Identity Provider response.
+ *
+ * @author Spencer Witt
+ */
+export interface IdentityProviderSearchResponse {
+    identityProviders?: Array<BaseIdentityProvider<any>>;
+    total?: number;
+}
 /**
  * @author Daniel DeGroff
  */
@@ -5092,6 +5279,33 @@ export interface KeyResponse {
     key?: Key;
     keys?: Array<Key>;
 }
+/**
+ * Search criteria for Keys
+ *
+ * @author Spencer Witt
+ */
+export interface KeySearchCriteria extends BaseSearchCriteria {
+    algorithm?: KeyAlgorithm;
+    name?: string;
+    type?: KeyType;
+}
+/**
+ * Search request for Keys
+ *
+ * @author Spencer Witt
+ */
+export interface KeySearchRequest {
+    search?: KeySearchCriteria;
+}
+/**
+ * Key search response
+ *
+ * @author Spencer Witt
+ */
+export interface KeySearchResponse {
+    keys?: Array<Key>;
+    total?: number;
+}
 export declare enum KeyType {
     EC = "EC",
     RSA = "RSA",
@@ -5131,16 +5345,16 @@ export interface Lambda {
     type?: LambdaType;
 }
 export interface LambdaConfiguration {
-    accessTokenPopulateId?: UUID;
-    idTokenPopulateId?: UUID;
-    samlv2PopulateId?: UUID;
-    selfServiceRegistrationValidationId?: UUID;
+    reconcileId?: UUID;
 }
 export interface LambdaConfiguration {
     reconcileId?: UUID;
 }
 export interface LambdaConfiguration {
-    reconcileId?: UUID;
+    accessTokenPopulateId?: UUID;
+    idTokenPopulateId?: UUID;
+    samlv2PopulateId?: UUID;
+    selfServiceRegistrationValidationId?: UUID;
 }
 /**
  * @author Daniel DeGroff
@@ -5166,6 +5380,33 @@ export interface LambdaResponse {
     lambda?: Lambda;
     lambdas?: Array<Lambda>;
 }
+/**
+ * Search criteria for Lambdas
+ *
+ * @author Mark Manes
+ */
+export interface LambdaSearchCriteria extends BaseSearchCriteria {
+    body?: string;
+    name?: string;
+    type?: LambdaType;
+}
+/**
+ * Search request for Lambdas
+ *
+ * @author Mark Manes
+ */
+export interface LambdaSearchRequest {
+    search?: LambdaSearchCriteria;
+}
+/**
+ * Lambda search response
+ *
+ * @author Mark Manes
+ */
+export interface LambdaSearchResponse {
+    lambdas?: Array<Lambda>;
+    total?: number;
+}
 /**
  * The types of lambdas that indicate how they are invoked by FusionAuth.
  *
@@ -6459,6 +6700,12 @@ export interface SecureIdentity {
     usernameStatus?: ContentStatus;
     verified?: boolean;
 }
+/**
+ * @author andrewpai
+ */
+export interface SelfServiceFormConfiguration {
+    requireCurrentPasswordOnPasswordChange?: boolean;
+}
 /**
  * @author Daniel DeGroff
  */
@@ -6527,10 +6774,20 @@ export interface SortField {
     name?: string;
     order?: Sort;
 }
+/**
+ * Steam API modes.
+ *
+ * @author Daniel DeGroff
+ */
+export declare enum SteamAPIMode {
+    Public = "Public",
+    Partner = "Partner"
+}
 /**
  * @author Brett Pontarelli
  */
 export interface SteamApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
+    apiMode?: SteamAPIMode;
     buttonText?: string;
     client_id?: string;
     scope?: string;
@@ -6542,6 +6799,7 @@ export interface SteamApplicationConfiguration extends BaseIdentityProviderAppli
  * @author Brett Pontarelli
  */
 export interface SteamIdentityProvider extends BaseIdentityProvider<SteamApplicationConfiguration> {
+    apiMode?: SteamAPIMode;
     buttonText?: string;
     client_id?: string;
     scope?: string;
@@ -6783,6 +7041,31 @@ export interface TenantSCIMServerConfiguration extends Enableable {
     schemas?: Record<string, any>;
     serverEntityTypeId?: UUID;
 }
+/**
+ * Search criteria for Tenants
+ *
+ * @author Mark Manes
+ */
+export interface TenantSearchCriteria extends BaseSearchCriteria {
+    name?: string;
+}
+/**
+ * Search request for Tenants
+ *
+ * @author Mark Manes
+ */
+export interface TenantSearchRequest {
+    search?: TenantSearchCriteria;
+}
+/**
+ * Tenant search response
+ *
+ * @author Mark Manes
+ */
+export interface TenantSearchResponse {
+    tenants?: Array<Tenant>;
+    total?: number;
+}
 /**
  * @author Brett Pontarelli
  */
@@ -6867,6 +7150,31 @@ export interface ThemeResponse {
     theme?: Theme;
     themes?: Array<Theme>;
 }
+/**
+ * Search criteria for themes
+ *
+ * @author Mark Manes
+ */
+export interface ThemeSearchCriteria extends BaseSearchCriteria {
+    name?: string;
+}
+/**
+ * Search request for Themes.
+ *
+ * @author Mark Manes
+ */
+export interface ThemeSearchRequest {
+    search?: ThemeSearchCriteria;
+}
+/**
+ * Search response for Themes
+ *
+ * @author Mark Manes
+ */
+export interface ThemeSearchResponse {
+    themes?: Array<Theme>;
+    total?: number;
+}
 /**
  * A policy for deleting Users.
  *
@@ -7304,6 +7612,34 @@ export interface UserCommentResponse {
     userComment?: UserComment;
     userComments?: Array<UserComment>;
 }
+/**
+ * Search criteria for user comments.
+ *
+ * @author Spencer Witt
+ */
+export interface UserCommentSearchCriteria extends BaseSearchCriteria {
+    comment?: string;
+    commenterId?: UUID;
+    tenantId?: UUID;
+    userId?: UUID;
+}
+/**
+ * Search request for user comments
+ *
+ * @author Spencer Witt
+ */
+export interface UserCommentSearchRequest {
+    search?: UserCommentSearchCriteria;
+}
+/**
+ * User comment search response
+ *
+ * @author Spencer Witt
+ */
+export interface UserCommentSearchResponse {
+    total?: number;
+    userComments?: Array<UserComment>;
+}
 /**
  * Models a User consent.
  *
@@ -7672,6 +8008,7 @@ export interface UserRegistrationVerifiedEvent extends BaseEvent {
  */
 export interface UserRequest extends BaseEventRequest {
     applicationId?: UUID;
+    currentPassword?: string;
     disableDomainBlock?: boolean;
     sendSetPasswordEmail?: boolean;
     skipVerification?: boolean;
@@ -8040,6 +8377,33 @@ export interface WebhookResponse {
     webhook?: Webhook;
     webhooks?: Array<Webhook>;
 }
+/**
+ * Search criteria for webhooks.
+ *
+ * @author Spencer Witt
+ */
+export interface WebhookSearchCriteria extends BaseSearchCriteria {
+    description?: string;
+    tenantId?: UUID;
+    url?: string;
+}
+/**
+ * Search request for webhooks
+ *
+ * @author Spencer Witt
+ */
+export interface WebhookSearchRequest {
+    search?: WebhookSearchCriteria;
+}
+/**
+ * Webhook search response
+ *
+ * @author Spencer Witt
+ */
+export interface WebhookSearchResponse {
+    total?: number;
+    webhooks?: Array<Webhook>;
+}
 /**
  * @author Brett Pontarelli
  */