@fusionauth/typescript-client 1.56.0 → 1.57.0

package/build/src/FusionAuthClient.d.ts

@@ -1077,6 +1077,14 @@ export declare class FusionAuthClient {
      * @returns {Promise<ClientResponse<EmailTemplateResponse>>}
      */
     patchEmailTemplate(emailTemplateId: UUID, request: EmailTemplateRequest): Promise<ClientResponse<EmailTemplateResponse>>;
+    /**
+     * Updates, via PATCH, the Entity with the given Id.
+     *
+     * @param {UUID} entityId The Id of the Entity Type to update.
+     * @param {EntityRequest} request The request that contains just the new Entity information.
+     * @returns {Promise<ClientResponse<EntityResponse>>}
+     */
+    patchEntity(entityId: UUID, request: EntityRequest): Promise<ClientResponse<EntityResponse>>;
     /**
      * Updates, via PATCH, the Entity Type with the given Id.
      *
@@ -1085,6 +1093,31 @@ export declare class FusionAuthClient {
      * @returns {Promise<ClientResponse<EntityTypeResponse>>}
      */
     patchEntityType(entityTypeId: UUID, request: EntityTypeRequest): Promise<ClientResponse<EntityTypeResponse>>;
+    /**
+     * Patches the permission with the given Id for the entity type.
+     *
+     * @param {UUID} entityTypeId The Id of the entityType that the permission belongs to.
+     * @param {UUID} permissionId The Id of the permission to patch.
+     * @param {EntityTypeRequest} request The request that contains the new permission information.
+     * @returns {Promise<ClientResponse<EntityTypeResponse>>}
+     */
+    patchEntityTypePermission(entityTypeId: UUID, permissionId: UUID, request: EntityTypeRequest): Promise<ClientResponse<EntityTypeResponse>>;
+    /**
+     * Patches the form with the given Id.
+     *
+     * @param {UUID} formId The Id of the form to patch.
+     * @param {FormRequest} request The request object that contains the new form information.
+     * @returns {Promise<ClientResponse<FormResponse>>}
+     */
+    patchForm(formId: UUID, request: FormRequest): Promise<ClientResponse<FormResponse>>;
+    /**
+     * Patches the form field with the given Id.
+     *
+     * @param {UUID} fieldId The Id of the form field to patch.
+     * @param {FormFieldRequest} request The request object that contains the new form field information.
+     * @returns {Promise<ClientResponse<FormFieldResponse>>}
+     */
+    patchFormField(fieldId: UUID, request: FormFieldRequest): Promise<ClientResponse<FormFieldResponse>>;
     /**
      * Updates, via PATCH, the group with the given Id.
      *
@@ -1093,6 +1126,14 @@ export declare class FusionAuthClient {
      * @returns {Promise<ClientResponse<GroupResponse>>}
      */
     patchGroup(groupId: UUID, request: GroupRequest): Promise<ClientResponse<GroupResponse>>;
+    /**
+     * Update the IP Access Control List with the given Id.
+     *
+     * @param {UUID} accessControlListId The Id of the IP Access Control List to patch.
+     * @param {IPAccessControlListRequest} request The request that contains the new IP Access Control List information.
+     * @returns {Promise<ClientResponse<IPAccessControlListResponse>>}
+     */
+    patchIPAccessControlList(accessControlListId: UUID, request: IPAccessControlListRequest): Promise<ClientResponse<IPAccessControlListResponse>>;
     /**
      * Updates, via PATCH, the identity provider with the given Id.
      *
@@ -1204,6 +1245,14 @@ export declare class FusionAuthClient {
      * @returns {Promise<ClientResponse<UserConsentResponse>>}
      */
     patchUserConsent(userConsentId: UUID, request: UserConsentRequest): Promise<ClientResponse<UserConsentResponse>>;
+    /**
+     * Patches the webhook with the given Id.
+     *
+     * @param {UUID} webhookId The Id of the webhook to update.
+     * @param {WebhookRequest} request The request that contains the new webhook information.
+     * @returns {Promise<ClientResponse<WebhookResponse>>}
+     */
+    patchWebhook(webhookId: UUID, request: WebhookRequest): Promise<ClientResponse<WebhookResponse>>;
     /**
      * Reactivates the application with the given Id.
      *
@@ -2538,6 +2587,14 @@ export declare class FusionAuthClient {
      * @returns {Promise<ClientResponse<EntityTypeResponse>>}
      */
     updateEntityTypePermission(entityTypeId: UUID, permissionId: UUID, request: EntityTypeRequest): Promise<ClientResponse<EntityTypeResponse>>;
+    /**
+     * Updates a family with a given Id.
+     *
+     * @param {UUID} familyId The Id of the family to update.
+     * @param {FamilyRequest} request The request object that contains all the new family information.
+     * @returns {Promise<ClientResponse<FamilyResponse>>}
+     */
+    updateFamily(familyId: UUID, request: FamilyRequest): Promise<ClientResponse<FamilyResponse>>;
     /**
      * Updates the form with the given Id.
      *
@@ -2811,6 +2868,15 @@ export default FusionAuthClient;
  * A 128 bit UUID in string format "8-4-4-4-12", for example "58D5E212-165B-4CA0-909B-C86B9CEE0111".
  */
 export declare type UUID = string;
+/**
+ * Identity Provider response.
+ *
+ * @author Spencer Witt
+ */
+export interface IdentityProviderSearchResponse {
+    identityProviders?: Array<BaseIdentityProvider<any>>;
+    total?: number;
+}
 /**
  * Authorization Grant types as defined by the <a href="https://tools.ietf.org/html/rfc6749">The OAuth 2.0 Authorization
  * Framework - RFC 6749</a>.
@@ -2841,15 +2907,6 @@ export declare enum AttestationType {
     anonymizationCa = "anonymizationCa",
     none = "none"
 }
-/**
- * Identity Provider response.
- *
- * @author Spencer Witt
- */
-export interface IdentityProviderSearchResponse {
-    identityProviders?: Array<BaseIdentityProvider<any>>;
-    total?: number;
-}
 /**
  * @author Daniel DeGroff
  */
@@ -3547,6 +3604,11 @@ export interface DisplayableRawLogin extends RawLogin {
     location?: Location;
     loginId?: string;
 }
+/**
+ * @author Daniel DeGroff
+ */
+export interface UserinfoResponse extends Record<string, any> {
+}
 /**
  * A number identifying a cryptographic algorithm. Values should be registered with the <a
  * href="https://www.iana.org/assignments/cose/cose.xhtml#algorithms">IANA COSE Algorithms registry</a>
@@ -3564,11 +3626,6 @@ export declare enum CoseAlgorithmIdentifier {
     PS384 = "SHA-384",
     PS512 = "SHA-512"
 }
-/**
- * @author Daniel DeGroff
- */
-export interface UserinfoResponse extends Record<string, any> {
-}
 /**
  * @author Daniel DeGroff
  */
@@ -3642,6 +3699,14 @@ export interface WebhookCallResponse {
     statusCode?: number;
     url?: string;
 }
+/**
+ * Search request for user comments
+ *
+ * @author Spencer Witt
+ */
+export interface UserCommentSearchRequest {
+    search?: UserCommentSearchCriteria;
+}
 /**
  * Provides the <i>authenticator</i> with the data it needs to generate an assertion.
  *
@@ -3654,14 +3719,6 @@ export interface PublicKeyCredentialRequestOptions {
     timeout?: number;
     userVerification?: UserVerificationRequirement;
 }
-/**
- * Search request for user comments
- *
- * @author Spencer Witt
- */
-export interface UserCommentSearchRequest {
-    search?: UserCommentSearchCriteria;
-}
 /**
  * @author Daniel DeGroff
  */
@@ -3685,12 +3742,6 @@ export declare enum MessengerType {
     Kafka = "Kafka",
     Twilio = "Twilio"
 }
-/**
- * @author Brian Pontarelli
- */
-export interface EventLogSearchRequest {
-    search?: EventLogSearchCriteria;
-}
 /**
  * Event log response.
  *
@@ -3700,6 +3751,12 @@ export interface EventLogSearchResponse {
     eventLogs?: Array<EventLog>;
     total?: number;
 }
+/**
+ * @author Brian Pontarelli
+ */
+export interface EventLogSearchRequest {
+    search?: EventLogSearchCriteria;
+}
 /**
  * Webhook event log response.
  *
@@ -3958,6 +4015,17 @@ export declare enum ConsentStatus {
     Active = "Active",
     Revoked = "Revoked"
 }
+/**
+ * Models the User Deleted Registration Event.
+ * <p>
+ * This is different than user.registration.delete in that it is sent after the TX has been committed. This event cannot be transactional.
+ *
+ * @author Daniel DeGroff
+ */
+export interface UserRegistrationDeleteCompleteEvent extends BaseUserEvent {
+    applicationId?: UUID;
+    registration?: UserRegistration;
+}
 /**
  * @author Daniel DeGroff
  */
@@ -3970,17 +4038,6 @@ export declare enum HTTPMethod {
     OPTIONS = "OPTIONS",
     PATCH = "PATCH"
 }
-/**
- * Models the User Deleted Registration Event.
- * <p>
- * This is different than user.registration.delete in that it is sent after the TX has been committed. This event cannot be transactional.
- *
- * @author Daniel DeGroff
- */
-export interface UserRegistrationDeleteCompleteEvent extends BaseUserEvent {
-    applicationId?: UUID;
-    registration?: UserRegistration;
-}
 /**
  * Steam gaming login provider.
  *
@@ -4180,7 +4237,7 @@ export declare enum UserState {
  *
  * @author Spencer Witt
  */
-export interface WebhookEventLogConfiguration {
+export interface WebhookEventLogConfiguration extends Enableable {
     delete?: DeleteConfiguration;
 }
 /**
@@ -5169,19 +5226,6 @@ export interface TwitterApplicationConfiguration extends BaseIdentityProviderApp
 export interface ConnectorRequest {
     connector?: BaseConnectorConfiguration;
 }
-/**
- * External JWT-only identity provider.
- *
- * @author Daniel DeGroff and Brian Pontarelli
- */
-export interface ExternalJWTIdentityProvider extends BaseIdentityProvider<ExternalJWTApplicationConfiguration> {
-    claimMap?: Record<string, string>;
-    defaultKeyId?: UUID;
-    domains?: Array<string>;
-    headerKeyParameter?: string;
-    oauth2?: IdentityProviderOauth2Configuration;
-    uniqueIdentityClaim?: string;
-}
 /**
  * Request to register a new public key with WebAuthn
  *
@@ -5195,6 +5239,19 @@ export interface WebAuthnPublicKeyRegistrationRequest {
     transports?: Array<string>;
     type?: string;
 }
+/**
+ * External JWT-only identity provider.
+ *
+ * @author Daniel DeGroff and Brian Pontarelli
+ */
+export interface ExternalJWTIdentityProvider extends BaseIdentityProvider<ExternalJWTApplicationConfiguration> {
+    claimMap?: Record<string, string>;
+    defaultKeyId?: UUID;
+    domains?: Array<string>;
+    headerKeyParameter?: string;
+    oauth2?: IdentityProviderOauth2Configuration;
+    uniqueIdentityClaim?: string;
+}
 /**
  * Webhook search response
  *
@@ -5204,6 +5261,11 @@ export interface WebhookSearchResponse {
     total?: number;
     webhooks?: Array<Webhook>;
 }
+/**
+ * @author Daniel DeGroff
+ */
+export interface RefreshResponse {
+}
 /**
  * Response for the login report.
  *
@@ -5213,11 +5275,6 @@ export interface LoginReportResponse {
     hourlyCounts?: Array<Count>;
     total?: number;
 }
-/**
- * @author Daniel DeGroff
- */
-export interface RefreshResponse {
-}
 /**
  * Group Member Delete Request
  *
@@ -5261,6 +5318,13 @@ export interface RateLimitedRequestConfiguration extends Enableable {
  */
 export interface NonTransactionalEvent {
 }
+/**
+ * @author Daniel DeGroff
+ */
+export interface TwoFactorResponse {
+    code?: string;
+    recoveryCodes?: Array<string>;
+}
 /**
  * @author Brett Guy
  */
@@ -5269,13 +5333,6 @@ export declare enum ProofKeyForCodeExchangePolicy {
     NotRequired = "NotRequired",
     NotRequiredWhenUsingClientAuthentication = "NotRequiredWhenUsingClientAuthentication"
 }
-/**
- * @author Daniel DeGroff
- */
-export interface TwoFactorResponse {
-    code?: string;
-    recoveryCodes?: Array<string>;
-}
 /**
  * Epic gaming login provider.
  *
@@ -5741,6 +5798,14 @@ export declare enum DeviceType {
 export interface SystemConfigurationResponse {
     systemConfiguration?: SystemConfiguration;
 }
+/**
+ * API response for completing WebAuthn assertion
+ *
+ * @author Spencer Witt
+ */
+export interface WebAuthnAssertResponse {
+    credential?: WebAuthnCredential;
+}
 /**
  * @author Daniel DeGroff
  */
@@ -5766,14 +5831,6 @@ export interface ReactorStatus {
     webAuthnPlatformAuthenticators?: ReactorFeatureStatus;
     webAuthnRoamingAuthenticators?: ReactorFeatureStatus;
 }
-/**
- * API response for completing WebAuthn assertion
- *
- * @author Spencer Witt
- */
-export interface WebAuthnAssertResponse {
-    credential?: WebAuthnCredential;
-}
 /**
  * @author Daniel DeGroff
  */
@@ -5851,6 +5908,14 @@ export interface SAMLv2IdentityProvider extends BaseSAMLv2IdentityProvider<SAMLv
 export interface EntityTypeSearchRequest {
     search?: EntityTypeSearchCriteria;
 }
+/**
+ * API request for managing families and members.
+ *
+ * @author Brian Pontarelli
+ */
+export interface FamilyRequest {
+    familyMember?: FamilyMember;
+}
 export interface BaseConnectorConfiguration {
     data?: Record<string, any>;
     debug?: boolean;
@@ -5860,14 +5925,6 @@ export interface BaseConnectorConfiguration {
     name?: string;
     type?: ConnectorType;
 }
-/**
- * API request for managing families and members.
- *
- * @author Brian Pontarelli
- */
-export interface FamilyRequest {
-    familyMember?: FamilyMember;
-}
 /**
  * @author Daniel DeGroff
  */
@@ -5903,16 +5960,16 @@ export interface MultiFactorSMSTemplate {
 /**
  * @author Daniel DeGroff
  */
-export interface IssueResponse {
-    refreshToken?: string;
-    token?: string;
+export interface IdentityProviderLinkResponse {
+    identityProviderLink?: IdentityProviderLink;
+    identityProviderLinks?: Array<IdentityProviderLink>;
 }
 /**
  * @author Daniel DeGroff
  */
-export interface IdentityProviderLinkResponse {
-    identityProviderLink?: IdentityProviderLink;
-    identityProviderLinks?: Array<IdentityProviderLink>;
+export interface IssueResponse {
+    refreshToken?: string;
+    token?: string;
 }
 /**
  * Request to authenticate with WebAuthn
@@ -6685,6 +6742,12 @@ export interface ProvidedScopePolicy {
  */
 export interface GroupDeleteEvent extends BaseGroupEvent {
 }
+/**
+ * @author Daniel DeGroff
+ */
+export interface LoginHintConfiguration extends Enableable {
+    parameterName?: string;
+}
 /**
  * Supply additional information about the Relying Party when creating a new credential
  *
@@ -6693,12 +6756,6 @@ export interface GroupDeleteEvent extends BaseGroupEvent {
 export interface PublicKeyCredentialRelyingPartyEntity extends PublicKeyCredentialEntity {
     id?: string;
 }
-/**
- * @author Daniel DeGroff
- */
-export interface LoginHintConfiguration extends Enableable {
-    parameterName?: string;
-}
 /**
  * Search response for entity types.
  *
@@ -6788,13 +6845,6 @@ export interface TwitterIdentityProvider extends BaseIdentityProvider<TwitterApp
     consumerKey?: string;
     consumerSecret?: string;
 }
-/**
- * @author Michael Sleevi
- */
-export interface SMSMessageTemplate extends MessageTemplate {
-    defaultTemplate?: string;
-    localizedTemplates?: LocalizedStrings;
-}
 /**
  * Lambda API request object.
  *
@@ -6803,6 +6853,13 @@ export interface SMSMessageTemplate extends MessageTemplate {
 export interface LambdaRequest {
     lambda?: Lambda;
 }
+/**
+ * @author Michael Sleevi
+ */
+export interface SMSMessageTemplate extends MessageTemplate {
+    defaultTemplate?: string;
+    localizedTemplates?: LocalizedStrings;
+}
 /**
  * Models an event where a user is being created with an "in-use" login Id (email or username).
  *
@@ -7986,14 +8043,11 @@ export interface CertificateInformation {
     validTo?: number;
 }
 /**
- * Search criteria for entity grants.
- *
- * @author Brian Pontarelli
+ * @author Trevor Smith
  */
-export interface EntityGrantSearchCriteria extends BaseSearchCriteria {
-    entityId?: UUID;
-    name?: string;
-    userId?: UUID;
+export interface ConnectorResponse {
+    connector?: BaseConnectorConfiguration;
+    connectors?: Array<BaseConnectorConfiguration>;
 }
 /**
  * Models the FusionAuth connector.
@@ -8002,13 +8056,6 @@ export interface EntityGrantSearchCriteria extends BaseSearchCriteria {
  */
 export interface FusionAuthConnectorConfiguration extends BaseConnectorConfiguration {
 }
-/**
- * @author Trevor Smith
- */
-export interface ConnectorResponse {
-    connector?: BaseConnectorConfiguration;
-    connectors?: Array<BaseConnectorConfiguration>;
-}
 /**
  * Controls the policy for requesting user permission to grant access to requested scopes during an OAuth workflow
  * for a third-party application.
@@ -8020,6 +8067,16 @@ export declare enum OAuthScopeConsentMode {
     RememberDecision = "RememberDecision",
     NeverPrompt = "NeverPrompt"
 }
+/**
+ * Search criteria for entity grants.
+ *
+ * @author Brian Pontarelli
+ */
+export interface EntityGrantSearchCriteria extends BaseSearchCriteria {
+    entityId?: UUID;
+    name?: string;
+    userId?: UUID;
+}
 /**
  * @author Daniel DeGroff
  */
@@ -8034,14 +8091,6 @@ export interface RefreshTokenSlidingWindowConfiguration {
 export interface ThemeSearchRequest {
     search?: ThemeSearchCriteria;
 }
-/**
- * Search request for Consents
- *
- * @author Spencer Witt
- */
-export interface ConsentSearchRequest {
-    search?: ConsentSearchCriteria;
-}
 /**
  * @author Daniel DeGroff
  */
@@ -8050,6 +8099,14 @@ export declare enum ObjectState {
     Inactive = "Inactive",
     PendingDelete = "PendingDelete"
 }
+/**
+ * Search request for Consents
+ *
+ * @author Spencer Witt
+ */
+export interface ConsentSearchRequest {
+    search?: ConsentSearchCriteria;
+}
 /**
  * Search request for Identity Providers
  *
@@ -8463,11 +8520,6 @@ export interface UserDeleteRequest extends BaseEventRequest {
 export interface TenantAccessControlConfiguration {
     uiIPAccessControlListId?: UUID;
 }
-/**
- * Interface for any object that can provide JSON Web key Information.
- */
-export interface JSONWebKeyInfoProvider {
-}
 /**
  * This class is a simple attachment with a byte array, name and MIME type.
  *
@@ -8478,6 +8530,11 @@ export interface Attachment {
     mime?: string;
     name?: string;
 }
+/**
+ * Interface for any object that can provide JSON Web key Information.
+ */
+export interface JSONWebKeyInfoProvider {
+}
 /**
  * Tenant-level configuration for WebAuthn
  *
@@ -8599,14 +8656,6 @@ export interface LambdaResponse {
     lambda?: Lambda;
     lambdas?: Array<Lambda>;
 }
-/**
- * The Integration Request
- *
- * @author Daniel DeGroff
- */
-export interface IntegrationRequest {
-    integrations?: Integrations;
-}
 /**
  * Models the JWT public key Refresh Token Revoke Event. This event might be for a single
  * token, a user or an entire application.
@@ -8616,6 +8665,14 @@ export interface IntegrationRequest {
 export interface JWTPublicKeyUpdateEvent extends BaseEvent {
     applicationIds?: Array<UUID>;
 }
+/**
+ * The Integration Request
+ *
+ * @author Daniel DeGroff
+ */
+export interface IntegrationRequest {
+    integrations?: Integrations;
+}
 /**
  * @author Brett Pontarelli
  */
@@ -8854,13 +8911,6 @@ export interface EntityTypePermission {
     lastUpdateInstant?: number;
     name?: string;
 }
-/**
- * This class is the user query. It provides a build pattern as well as public fields for use on forms and in actions.
- *
- * @author Brian Pontarelli
- */
-export interface UserSearchCriteria extends BaseElasticSearchCriteria {
-}
 /**
  * User comment search response
  *
@@ -8870,6 +8920,13 @@ export interface UserCommentSearchResponse {
     total?: number;
     userComments?: Array<UserComment>;
 }
+/**
+ * This class is the user query. It provides a build pattern as well as public fields for use on forms and in actions.
+ *
+ * @author Brian Pontarelli
+ */
+export interface UserSearchCriteria extends BaseElasticSearchCriteria {
+}
 /**
  * @author Daniel DeGroff
  */