@asgardeo/react 0.3.0 → 0.5.0

package/README.md

@@ -124,6 +124,10 @@ function App() {
 }
 ```
 
+## Documentation
+
+For complete API documentation including all components, hooks, and customization options, see [API.md](./API.md).
+
 ## License
 
-Apache-2.0
+Licenses this source under the Apache License, Version 2.0 [LICENSE](../../LICENSE), You may not use this file except in compliance with the License.

package/dist/AsgardeoReactClient.d.ts

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { AsgardeoBrowserClient, SignInOptions, SignOutOptions, User } from '@asgardeo/browser';
+import { AsgardeoBrowserClient, UserProfile, SignInOptions, SignOutOptions, User, EmbeddedFlowExecuteResponse, SignUpOptions, EmbeddedFlowExecuteRequestPayload, EmbeddedSignInFlowHandleRequestPayload, Organization, EmbeddedFlowExecuteRequestConfig } from '@asgardeo/browser';
 import { AsgardeoReactConfig } from './models/config';
 /**
  * Client for mplementing Asgardeo in React applications.
@@ -26,12 +26,20 @@ import { AsgardeoReactConfig } from './models/config';
 declare class AsgardeoReactClient<T extends AsgardeoReactConfig = AsgardeoReactConfig> extends AsgardeoBrowserClient<T> {
     private asgardeo;
     constructor();
-    initialize(config: T): Promise<boolean>;
-    getUser(): Promise<any>;
+    initialize(config: AsgardeoReactConfig): Promise<boolean>;
+    getUser(): Promise<User>;
+    getUserProfile(): Promise<UserProfile>;
+    getOrganizations(): Promise<Organization[]>;
+    getCurrentOrganization(): Promise<Organization | null>;
+    switchOrganization(organization: Organization): Promise<void>;
     isLoading(): boolean;
+    isInitialized(): Promise<boolean>;
     isSignedIn(): Promise<boolean>;
-    signIn(options?: SignInOptions): Promise<User>;
+    signIn(options?: SignInOptions, sessionId?: string, onSignInSuccess?: (afterSignInUrl: string) => void): Promise<User>;
+    signIn(payload: EmbeddedSignInFlowHandleRequestPayload, request: EmbeddedFlowExecuteRequestConfig, sessionId?: string, onSignInSuccess?: (afterSignInUrl: string) => void): Promise<User>;
     signOut(options?: SignOutOptions, afterSignOut?: (redirectUrl: string) => void): Promise<string>;
     signOut(options?: SignOutOptions, sessionId?: string, afterSignOut?: (redirectUrl: string) => void): Promise<string>;
+    signUp(options?: SignUpOptions): Promise<void>;
+    signUp(payload: EmbeddedFlowExecuteRequestPayload): Promise<EmbeddedFlowExecuteResponse>;
 }
 export default AsgardeoReactClient;

package/dist/__temp__/api.d.ts

@@ -1,7 +1,7 @@
 /**
- * Copyright (c) 2025, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
  *
- * WSO2 Inc. licenses this file to you under the Apache License,
+ * WSO2 LLC. licenses this file to you under the Apache License,
  * Version 2.0 (the "License"); you may not use this file except
  * in compliance with the License.
  * You may obtain a copy of the License at
@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { AsgardeoSPAClient, AuthClientConfig, BasicUserInfo, LegacyConfig as Config, IdTokenPayload, FetchResponse, Hooks, HttpClientInstance, HttpRequestConfig, HttpResponse, OIDCEndpoints, SignInConfig, SPACustomGrantConfig } from '@asgardeo/browser';
+import { AsgardeoSPAClient, AuthClientConfig, User, LegacyConfig as Config, IdToken, Hooks, HttpClientInstance, HttpRequestConfig, HttpResponse, OIDCEndpoints, SignInConfig, SPACustomGrantConfig } from '@asgardeo/browser';
 import { AuthStateInterface } from './models';
 declare class AuthAPI {
     static DEFAULT_STATE: AuthStateInterface;
@@ -25,7 +25,6 @@ declare class AuthAPI {
     constructor(spaClient?: AsgardeoSPAClient);
     _setIsLoading(isLoading: boolean): void;
     _getIsLoading(): boolean;
-    isSignedIn(): Promise<boolean>;
     isLoading(): boolean;
     /**
      * Method to return Auth Client instance authentication state.
@@ -45,6 +44,12 @@ declare class AuthAPI {
      * @returns {Promise<AuthClientConfig<Config>>} - A promise that resolves with the configuration data.
      */
     getConfigData(): Promise<AuthClientConfig<Config>>;
+    /**
+     * Method to get the configuration data.
+     *
+     * @returns {Promise<AuthClientConfig<Config>>} - A promise that resolves with the configuration data.
+     */
+    isInitialized(): Promise<boolean>;
     /**
      * Method to handle user Sign In requests.
      *
@@ -52,9 +57,9 @@ declare class AuthAPI {
      * @param {AuthStateInterface} state - Current authentication state in React Auth Context.
      * @param {any} callback - Action to trigger on successful sign in.
      */
-    signIn(config: SignInConfig, authorizationCode?: string, sessionState?: string, authState?: string, callback?: (response: BasicUserInfo) => void, tokenRequestConfig?: {
+    signIn(config: SignInConfig, authorizationCode?: string, sessionState?: string, authState?: string, callback?: (response: User) => void, tokenRequestConfig?: {
         params: Record<string, unknown>;
-    }): Promise<BasicUserInfo>;
+    }): Promise<any>;
     /**
      * Method to handle user Sign Out requests.
      *
@@ -72,9 +77,9 @@ declare class AuthAPI {
     /**
      * This method returns a Promise that resolves with the basic user information obtained from the ID token.
      *
-     * @return {Promise<BasicUserInfo>} - A promise that resolves with the user information.
+     * @return {Promise<User>} - A promise that resolves with the user information.
      */
-    getBasicUserInfo(): Promise<BasicUserInfo>;
+    getUser(): Promise<User>;
     /**
      * This method sends an API request to a protected endpoint.
      * The access token is automatically attached to the header of the request.
@@ -83,7 +88,7 @@ declare class AuthAPI {
      *
      * @param {HttpRequestConfig} config -  The config object containing attributes necessary to send a request.
      *
-     * @return {Promise<FetchResponse>} - Returns a Promise that resolves with the response to the request.
+     * @return {Promise<Response>} - Returns a Promise that resolves with the response to the request.
      */
     httpRequest(config: HttpRequestConfig): Promise<HttpResponse<any>>;
     /**
@@ -94,7 +99,7 @@ declare class AuthAPI {
      *
      * @param {HttpRequestConfig[]} config -  The config object containing attributes necessary to send a request.
      *
-     * @return {Promise<FetchResponse[]>} - Returns a Promise that resolves with the responses to the requests.
+     * @return {Promise<Response>} - Returns a Promise that resolves with the responses to the requests.
      */
     httpRequestAll(configs: HttpRequestConfig[]): Promise<HttpResponse<any>[]>;
     /**
@@ -102,10 +107,10 @@ declare class AuthAPI {
      *
      * @param {CustomGrantRequestParams} config - The request parameters.
      *
-     * @return {Promise<FetchResponse<any> | SignInResponse>} - A Promise that resolves with
+     * @return {Promise<Response | SignInResponse>} - A Promise that resolves with
      * the value returned by the custom grant request.
      */
-    requestCustomGrant(config: SPACustomGrantConfig, callback: (response: BasicUserInfo | FetchResponse<any>) => void, dispatch: (state: AuthStateInterface) => void): Promise<BasicUserInfo | FetchResponse<any>>;
+    exchangeToken(config: SPACustomGrantConfig, callback: (response: User | Response) => void, dispatch: (state: AuthStateInterface) => void): Promise<User | Response>;
     /**
      * This method ends a user session. The access token is revoked and the session information is destroyed.
      *
@@ -117,7 +122,7 @@ declare class AuthAPI {
      *
      * @return {Promise<ServiceResourcesType} - A Promise that resolves with an object containing the service endpoints.
      */
-    getOIDCServiceEndpoints(): Promise<OIDCEndpoints>;
+    getOpenIDProviderEndpoints(): Promise<OIDCEndpoints>;
     /**
      * This methods returns the Axios http client.
      *
@@ -130,20 +135,20 @@ declare class AuthAPI {
      * @return {Promise<DecodedIDTokenPayloadInterface>} - A Promise that resolves with
      * the decoded payload of the id token.
      */
-    getDecodedIDToken(): Promise<IdTokenPayload>;
+    getDecodedIdToken(): Promise<IdToken>;
     /**
      * This method decodes the payload of the idp id token and returns it.
      *
      * @return {Promise<DecodedIDTokenPayloadInterface>} - A Promise that resolves with
      * the decoded payload of the idp id token.
      */
-    getDecodedIDPIDToken(): Promise<IdTokenPayload>;
+    getDecodedIDPIDToken(): Promise<IdToken>;
     /**
      * This method returns the ID token.
      *
      * @return {Promise<string>} - A Promise that resolves with the id token.
      */
-    getIDToken(): Promise<string>;
+    getIdToken(): Promise<string>;
     /**
      * This method return a Promise that resolves with the access token.
      *
@@ -167,13 +172,13 @@ declare class AuthAPI {
      * @return {TokenResponseInterface} - A Promise that resolves with an object containing
      * information about the refreshed access token.
      */
-    refreshAccessToken(): Promise<BasicUserInfo>;
+    refreshAccessToken(): Promise<User>;
     /**
      * This method specifies if the user is authenticated or not.
      *
      * @return {Promise<boolean>} - A Promise that resolves with `true` if teh user is authenticated.
      */
-    isAuthenticated(): Promise<boolean>;
+    isSignedIn(): Promise<boolean>;
     /**
      * This method specifies if the session is active or not.
      *
@@ -198,7 +203,7 @@ declare class AuthAPI {
      *
      * @param {Partial<AuthClientConfig<T>>} config - A config object to update the SDK configurations with.
      */
-    updateConfig(config: Partial<AuthClientConfig<Config>>): Promise<void>;
+    reInitialize(config: Partial<AuthClientConfig<Config>>): Promise<void>;
     /**
      * This method attaches a callback function to an event hook that fires the callback when the event happens.
      *
@@ -214,7 +219,7 @@ declare class AuthAPI {
      * First, this method sends a prompt none request to see if there is an active user session in the identity server.
      * If there is one, then it requests the access token and stores it. Else, it returns false.
      *
-     * @return {Promise<BasicUserInfo | boolean>} - A Promise that resolves with the user information after signing in
+     * @return {Promise<User | boolean>} - A Promise that resolves with the user information after signing in
      * or with `false` if the user is not signed in.
      *
      * @example
@@ -224,6 +229,6 @@ declare class AuthAPI {
      */
     trySignInSilently(state: AuthStateInterface, dispatch: (state: AuthStateInterface) => void, additionalParams?: Record<string, string | boolean>, tokenRequestConfig?: {
         params: Record<string, unknown>;
-    }): Promise<BasicUserInfo | boolean | undefined>;
+    }): Promise<User | boolean | undefined>;
 }
 export default AuthAPI;

package/dist/__temp__/models.d.ts

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { AsgardeoAuthException, AuthClientConfig, AuthSPAClientConfig, BasicUserInfo, Config, CustomGrantConfig, IdTokenPayload, FetchResponse, Hooks, HttpClientInstance, HttpRequestConfig, HttpResponse, OIDCEndpoints, SignInConfig } from '@asgardeo/browser';
+import { AsgardeoAuthException, AuthClientConfig, AuthSPAClientConfig, Config, TokenExchangeRequestConfig, IdToken, Hooks, HttpClientInstance, HttpRequestConfig, HttpResponse, OIDCEndpoints, SignInConfig, User } from '@asgardeo/browser';
 export interface ReactConfig {
     /**
      * The SDK's `AuthProvider` by default is listening to the URL changes to see
@@ -36,10 +36,6 @@ export type AuthReactConfig = AuthSPAClientConfig & ReactConfig;
  * via `state` object from `useAuthContext` hook.
  */
 export interface AuthStateInterface {
-    /**
-     * The scopes that are allowed for the user.
-     */
-    allowedScopes: string;
     /**
      * The display name of the user.
      */
@@ -51,44 +47,40 @@ export interface AuthStateInterface {
     /**
      * Specifies if the user is authenticated or not.
      */
-    isAuthenticated: boolean;
+    isSignedIn: boolean;
     /**
      * Are the Auth requests loading.
      */
     isLoading: boolean;
-    /**
-     * The uid corresponding to the user who the ID token belonged to.
-     */
-    sub?: string;
     /**
      * The username of the user.
      */
     username?: string;
 }
 export interface AuthContextInterface {
-    signIn: (config?: SignInConfig, authorizationCode?: string, sessionState?: string, state?: string, callback?: (response: BasicUserInfo) => void, tokenRequestConfig?: {
+    signIn: (config?: SignInConfig, authorizationCode?: string, sessionState?: string, state?: string, callback?: (response: User) => void, tokenRequestConfig?: {
         params: Record<string, unknown>;
-    }) => Promise<BasicUserInfo>;
+    }) => Promise<User>;
     signOut: (callback?: (response: boolean) => void) => Promise<boolean>;
-    getBasicUserInfo(): Promise<BasicUserInfo>;
+    getUser(): Promise<User>;
     httpRequest(config: HttpRequestConfig): Promise<HttpResponse<any>>;
     httpRequestAll(configs: HttpRequestConfig[]): Promise<HttpResponse<any>[]>;
-    requestCustomGrant(config: CustomGrantConfig, callback?: (response: BasicUserInfo | FetchResponse<any>) => void): void;
+    exchangeToken(config: TokenExchangeRequestConfig, callback?: (response: User | Response) => void): void;
     revokeAccessToken(): Promise<boolean>;
-    getOIDCServiceEndpoints(): Promise<OIDCEndpoints>;
+    getOpenIDProviderEndpoints(): Promise<OIDCEndpoints>;
     getHttpClient(): Promise<HttpClientInstance>;
-    getDecodedIDPIDToken(): Promise<IdTokenPayload>;
-    getDecodedIDToken(): Promise<IdTokenPayload>;
-    getIDToken(): Promise<string>;
+    getDecodedIDPIDToken(): Promise<IdToken>;
+    getDecodedIdToken(): Promise<IdToken>;
+    getIdToken(): Promise<string>;
     getAccessToken(): Promise<string>;
-    refreshAccessToken(): Promise<BasicUserInfo>;
-    isAuthenticated(): Promise<boolean>;
+    refreshAccessToken(): Promise<User>;
+    isSignedIn(): Promise<boolean>;
     enableHttpHandler(): Promise<boolean>;
     disableHttpHandler(): Promise<boolean>;
-    updateConfig(config: Partial<AuthClientConfig<Config>>): Promise<void>;
+    reInitialize(config: Partial<AuthClientConfig<Config>>): Promise<void>;
     trySignInSilently: (additionalParams?: Record<string, string | boolean>, tokenRequestConfig?: {
         params: Record<string, unknown>;
-    }) => Promise<boolean | BasicUserInfo>;
+    }) => Promise<boolean | User>;
     on(hook: Hooks.CustomGrant, callback: (response?: any) => void, id: string): void;
     on(hook: Exclude<Hooks, Hooks.CustomGrant>, callback: (response?: any) => void): void;
     on(hook: Hooks, callback: (response?: any) => void, id?: string): void;

package/dist/api/scim2/createOrganization.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { Organization } from '@asgardeo/browser';
+/**
+ * Interface for organization creation payload.
+ */
+export interface CreateOrganizationPayload {
+    /**
+     * Organization description.
+     */
+    description: string;
+    /**
+     * Organization handle/slug.
+     */
+    orgHandle?: string;
+    /**
+     * Organization name.
+     */
+    name: string;
+    /**
+     * Parent organization ID.
+     */
+    parentId: string;
+    /**
+     * Organization type.
+     */
+    type: 'TENANT';
+}
+/**
+ * Creates a new organization.
+ *
+ * @param config - Configuration object containing baseUrl, payload and optional request config.
+ * @returns A promise that resolves with the created organization information.
+ * @example
+ * ```typescript
+ * try {
+ *   const organization = await createOrganization({
+ *     baseUrl: "https://api.asgardeo.io/t/<ORGANIZATION>",
+ *     payload: {
+ *       description: "Share your screens",
+ *       name: "Team Viewer",
+ *       orgHandle: "team-viewer",
+ *       parentId: "f4825104-4948-40d9-ab65-a960eee3e3d5",
+ *       type: "TENANT"
+ *     }
+ *   });
+ *   console.log(organization);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to create organization:', error.message);
+ *   }
+ * }
+ * ```
+ */
+declare const createOrganization: ({ baseUrl, payload, ...requestConfig }: Partial<Request> & {
+    baseUrl: string;
+    payload: CreateOrganizationPayload;
+}) => Promise<Organization>;
+export default createOrganization;

package/dist/api/scim2/getAllOrganizations.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { Organization } from '@asgardeo/browser';
+/**
+ * Interface for paginated organization response.
+ */
+export interface PaginatedOrganizationsResponse {
+    hasMore?: boolean;
+    nextCursor?: string;
+    organizations: Organization[];
+    totalCount?: number;
+}
+/**
+ * Retrieves all organizations with pagination support.
+ *
+ * @param config - Configuration object containing baseUrl, optional query parameters, and request config.
+ * @returns A promise that resolves with the paginated organizations information.
+ * @example
+ * ```typescript
+ * try {
+ *   const response = await getAllOrganizations({
+ *     baseUrl: "https://api.asgardeo.io/t/<ORGANIZATION>",
+ *     filter: "",
+ *     limit: 10,
+ *     recursive: false
+ *   });
+ *   console.log(response.organizations);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get organizations:', error.message);
+ *   }
+ * }
+ * ```
+ */
+declare const getAllOrganizations: ({ baseUrl, filter, limit, recursive, ...requestConfig }: Partial<Request> & {
+    baseUrl: string;
+    filter?: string;
+    limit?: number;
+    recursive?: boolean;
+}) => Promise<PaginatedOrganizationsResponse>;
+export default getAllOrganizations;

package/dist/api/scim2/getMeOrganizations.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { Organization } from '@asgardeo/browser';
+/**
+ * Retrieves the organizations associated with the current user.
+ *
+ * @param config - Configuration object containing baseUrl, optional query parameters, and request config.
+ * @returns A promise that resolves with the organizations information.
+ * @example
+ * ```typescript
+ * try {
+ *   const organizations = await getMeOrganizations({
+ *     baseUrl: "https://api.asgardeo.io/t/<ORGANIZATION>",
+ *     after: "",
+ *     before: "",
+ *     filter: "",
+ *     limit: 10,
+ *     recursive: false
+ *   });
+ *   console.log(organizations);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get organizations:', error.message);
+ *   }
+ * }
+ * ```
+ */
+declare const getMeOrganizations: ({ baseUrl, after, authorizedAppName, before, filter, limit, recursive, ...requestConfig }: Partial<Request> & {
+    baseUrl: string;
+    after?: string;
+    authorizedAppName?: string;
+    before?: string;
+    filter?: string;
+    limit?: number;
+    recursive?: boolean;
+}) => Promise<Organization[]>;
+export default getMeOrganizations;

package/dist/api/scim2/getOrganization.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+/**
+ * Extended organization interface with additional properties
+ */
+export interface OrganizationDetails {
+    attributes?: Record<string, any>;
+    created?: string;
+    description?: string;
+    id: string;
+    lastModified?: string;
+    name: string;
+    orgHandle: string;
+    parent?: {
+        id: string;
+        ref: string;
+    };
+    permissions?: string[];
+    status?: string;
+    type?: string;
+}
+/**
+ * Retrieves detailed information for a specific organization.
+ *
+ * @param config - Configuration object containing baseUrl, organizationId, and request config.
+ * @returns A promise that resolves with the organization details.
+ * @example
+ * ```typescript
+ * try {
+ *   const organization = await getOrganization({
+ *     baseUrl: "https://api.asgardeo.io/t/dxlab",
+ *     organizationId: "0d5e071b-d3d3-475d-b3c6-1a20ee2fa9b1"
+ *   });
+ *   console.log(organization);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get organization:', error.message);
+ *   }
+ * }
+ * ```
+ */
+declare const getOrganization: ({ baseUrl, organizationId, ...requestConfig }: Partial<Request> & {
+    baseUrl: string;
+    organizationId: string;
+}) => Promise<OrganizationDetails>;
+export default getOrganization;

package/dist/api/scim2/updateOrganization.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { OrganizationDetails } from './getOrganization';
+/**
+ * Updates the organization information using the Organizations Management API.
+ *
+ * @param baseUrl - The base URL for the API.
+ * @param organizationId - The ID of the organization to update.
+ * @param operations - Array of patch operations to apply.
+ * @param requestConfig - Additional request config if needed.
+ * @returns A promise that resolves with the updated organization information.
+ * @example
+ * ```typescript
+ * // Using the helper function to create operations automatically
+ * const operations = createPatchOperations({
+ *   name: "Updated Organization Name",      // Will use REPLACE
+ *   description: "",                        // Will use REMOVE (empty string)
+ *   customField: "Some value"              // Will use REPLACE
+ * });
+ *
+ * await updateOrganization({
+ *   baseUrl: "https://api.asgardeo.io/t/<ORG>",
+ *   organizationId: "0d5e071b-d3d3-475d-b3c6-1a20ee2fa9b1",
+ *   operations
+ * });
+ *
+ * // Or manually specify operations
+ * await updateOrganization({
+ *   baseUrl: "https://api.asgardeo.io/t/<ORG>",
+ *   organizationId: "0d5e071b-d3d3-475d-b3c6-1a20ee2fa9b1",
+ *   operations: [
+ *     { operation: "REPLACE", path: "/name", value: "Updated Organization Name" },
+ *     { operation: "REMOVE", path: "/description" }
+ *   ]
+ * });
+ * ```
+ */
+declare const updateOrganization: ({ baseUrl, organizationId, operations, ...requestConfig }: {
+    baseUrl: string;
+    organizationId: string;
+    operations: Array<{
+        operation: "REPLACE" | "ADD" | "REMOVE";
+        path: string;
+        value?: any;
+    }>;
+} & Partial<Request>) => Promise<OrganizationDetails>;
+/**
+ * Helper function to convert field updates to patch operations format.
+ * Uses REMOVE operation when the value is empty, otherwise uses REPLACE.
+ *
+ * @param payload - Object containing field updates
+ * @returns Array of patch operations
+ */
+export declare const createPatchOperations: (payload: Record<string, any>) => Array<{
+    operation: "REPLACE" | "REMOVE";
+    path: string;
+    value?: any;
+}>;
+export default updateOrganization;