@asgardeo/javascript 0.0.1 → 0.1.1

package/dist/api/updateMeProfile.d.ts

@@ -0,0 +1,82 @@
+/**
+ * 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 { User } from '../models/user';
+/**
+ * Configuration for the updateMeProfile request
+ */
+export interface UpdateMeProfileConfig extends Omit<RequestInit, 'method' | 'body'> {
+    /**
+     * The absolute API endpoint.
+     */
+    url?: string;
+    /**
+     * The base path of the API endpoint.
+     */
+    baseUrl?: string;
+    /**
+     * The value object to patch (SCIM2 PATCH value)
+     */
+    payload: any;
+    /**
+     * Optional custom fetcher function.
+     * If not provided, native fetch will be used
+     */
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+}
+/**
+ * Updates the user profile information at the specified SCIM2 Me endpoint.
+ *
+ * @param config - Configuration object with URL, payload and optional request config.
+ * @returns A promise that resolves with the updated user profile information.
+ * @example
+ * ```typescript
+ * // Using default fetch
+ * await updateMeProfile({
+ *   url: "https://api.asgardeo.io/t/<ORG>/scim2/Me",
+ *   payload: { "urn:scim:wso2:schema": { mobileNumbers: ["0777933830"] } }
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using custom fetcher (e.g., axios-based httpClient)
+ * await updateMeProfile({
+ *   url: "https://api.asgardeo.io/t/<ORG>/scim2/Me",
+ *   payload: { "urn:scim:wso2:schema": { mobileNumbers: ["0777933830"] } },
+ *   fetcher: async (url, config) => {
+ *     const response = await httpClient({
+ *       url,
+ *       method: config.method,
+ *       headers: config.headers,
+ *       data: config.body,
+ *       ...config
+ *     });
+ *     // Convert axios-like response to fetch-like Response
+ *     return {
+ *       ok: response.status >= 200 && response.status < 300,
+ *       status: response.status,
+ *       statusText: response.statusText,
+ *       json: () => Promise.resolve(response.data),
+ *       text: () => Promise.resolve(typeof response.data === 'string' ? response.data : JSON.stringify(response.data))
+ *     } as Response;
+ *   }
+ * });
+ * ```
+ */
+declare const updateMeProfile: ({ url, baseUrl, payload, fetcher, ...requestConfig }: UpdateMeProfileConfig) => Promise<User>;
+export default updateMeProfile;

package/dist/api/updateOrganization.d.ts

@@ -0,0 +1,118 @@
+/**
+ * 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';
+/**
+ * Configuration for the updateOrganization request
+ */
+export interface UpdateOrganizationConfig extends Omit<RequestInit, 'method' | 'body'> {
+    /**
+     * The base URL for the API endpoint.
+     */
+    baseUrl: string;
+    /**
+     * The ID of the organization to update
+     */
+    organizationId: string;
+    /**
+     * Array of patch operations to apply
+     */
+    operations: Array<{
+        operation: 'REPLACE' | 'ADD' | 'REMOVE';
+        path: string;
+        value?: any;
+    }>;
+    /**
+     * Optional custom fetcher function.
+     * If not provided, native fetch will be used
+     */
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+}
+/**
+ * Updates the organization information using the Organizations Management API.
+ *
+ * @param config - Configuration object with baseUrl, organizationId, operations and optional request config.
+ * @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" }
+ *   ]
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using custom fetcher (e.g., axios-based httpClient)
+ * await updateOrganization({
+ *   baseUrl: "https://api.asgardeo.io/t/<ORG>",
+ *   organizationId: "0d5e071b-d3d3-475d-b3c6-1a20ee2fa9b1",
+ *   operations: [
+ *     { operation: "REPLACE", path: "/name", value: "Updated Organization Name" }
+ *   ],
+ *   fetcher: async (url, config) => {
+ *     const response = await httpClient({
+ *       url,
+ *       method: config.method,
+ *       headers: config.headers,
+ *       data: config.body,
+ *       ...config
+ *     });
+ *     // Convert axios-like response to fetch-like Response
+ *     return {
+ *       ok: response.status >= 200 && response.status < 300,
+ *       status: response.status,
+ *       statusText: response.statusText,
+ *       json: () => Promise.resolve(response.data),
+ *       text: () => Promise.resolve(typeof response.data === 'string' ? response.data : JSON.stringify(response.data))
+ *     } as Response;
+ *   }
+ * });
+ * ```
+ */
+declare const updateOrganization: ({ baseUrl, organizationId, operations, fetcher, ...requestConfig }: UpdateOrganizationConfig) => 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;