@simpleapps-com/augur-api 0.3.0 → 0.3.2

package/dist/cjs/services/joomla/client.d.ts

@@ -1,11 +1,8 @@
 import { BaseServiceClient } from '../../core/base-client';
 import type { HTTPClient } from '../../core/client';
-import { ContentListParamsSchema, ContentGetParams, ContentResponse, ContentDocumentResponse, UserListParamsSchema, UserGroupListParams, UserGroupListResponse, UserGroupMembershipParams, UserGroupMembershipResponse, UserGroupDetailResponse, TagListParamsSchema, VerifyPasswordRequest, VerifyPasswordResponse, TrinityDocParams, TrinityDocResponse, CreateUserRequestSchema, UpdateUserRequestSchema, UserGroupMappingRequest, UserGroupMappingResponse, UserDocumentResponse } from './schemas';
+import { GenericResponse, VerifyPasswordRequest, VerifyPasswordResponse, CreateUserRequestSchema, UpdateUserRequestSchema } from './schemas';
 import type { z } from 'zod';
 import { BaseGetParamsSchema } from '../../core/schemas';
-type ContentListParams = z.infer<typeof ContentListParamsSchema>;
-type UserListParams = z.infer<typeof UserListParamsSchema>;
-type TagListParams = z.infer<typeof TagListParamsSchema>;
 type CreateUserRequest = z.infer<typeof CreateUserRequestSchema>;
 type UpdateUserRequest = z.infer<typeof UpdateUserRequestSchema>;
 type BaseGetParams = z.infer<typeof BaseGetParamsSchema>;
@@ -91,32 +88,9 @@ export declare class JoomlaClient extends BaseServiceClient {
             edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
             limit?: number | undefined;
             offset?: number | undefined;
-            q?: string | undefined;
-            orderBy?: string | undefined;
-            categoryIdList?: string | undefined;
-            tagsList?: string | undefined;
         } | undefined) => Promise<{
             params: Record<string, unknown> | unknown[];
-            data: {
-                id: number;
-                title: string;
-                alias: string;
-                catid: number;
-                created: string;
-                modified: string;
-                state?: number | undefined;
-                introtext?: string | undefined;
-                fulltext?: string | undefined;
-                ordering?: number | undefined;
-                images?: {
-                    image_intro?: string | undefined;
-                    image_fulltext?: string | undefined;
-                    float_intro?: string | undefined;
-                    float_fulltext?: string | undefined;
-                } | undefined;
-                hits?: number | undefined;
-                metadata?: unknown;
-            }[];
+            data: unknown[];
             options: Record<string, unknown> | unknown[];
             status: number;
             message: string;
@@ -164,7 +138,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * const cachedContent = await api.joomla.content.get(123, { edgeCache: 8 });
          * ```
          */
-        get: (contentId: number | string, params?: ContentGetParams) => Promise<ContentResponse>;
+        get: (contentId: number | string, params?: BaseGetParams) => Promise<GenericResponse>;
         /**
          * Get content documentation
          * @description Returns enhanced content document with custom fields, images, and metadata
@@ -179,34 +153,13 @@ export declare class JoomlaClient extends BaseServiceClient {
          */
         getDoc: (id: string | number, params?: unknown) => Promise<{
             params: Record<string, unknown> | unknown[];
-            data: {
-                id: number;
-                title: string;
-                alias: string;
-                catid: number;
-                introtext: string;
-                fulltext: string;
-                ordering?: number | undefined;
-                images?: {
-                    image_intro?: string | undefined;
-                    image_fulltext?: string | undefined;
-                    float_intro?: string | undefined;
-                    float_fulltext?: string | undefined;
-                } | undefined;
-                fields?: {
-                    value: string;
-                    type: string;
-                    id: number;
-                    title: string;
-                    name: string;
-                }[] | undefined;
-            };
             options: Record<string, unknown> | unknown[];
             status: number;
             message: string;
             count: number;
             total: number;
             totalResults: number;
+            data?: unknown;
         }>;
         /**
          * Retrieve a paginated list of content items (data only)
@@ -215,26 +168,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * @returns Array of content items (data only)
          * @throws ValidationError When parameters are invalid or response is malformed
          */
-        listData: (params?: ContentListParams) => Promise<{
-            id: number;
-            title: string;
-            alias: string;
-            catid: number;
-            created: string;
-            modified: string;
-            state?: number | undefined;
-            introtext?: string | undefined;
-            fulltext?: string | undefined;
-            ordering?: number | undefined;
-            images?: {
-                image_intro?: string | undefined;
-                image_fulltext?: string | undefined;
-                float_intro?: string | undefined;
-                float_fulltext?: string | undefined;
-            } | undefined;
-            hits?: number | undefined;
-            metadata?: unknown;
-        }[]>;
+        listData: (params?: BaseGetParams) => Promise<unknown[]>;
         /**
          * Get content details by ID (data only)
          * @description Returns only the data from content item details response
@@ -243,26 +177,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * @returns Content item details (data only)
          * @throws ValidationError When parameters are invalid or response is malformed
          */
-        getData: (contentId: number | string, params?: ContentGetParams) => Promise<{
-            id: number;
-            title: string;
-            alias: string;
-            catid: number;
-            created: string;
-            modified: string;
-            state?: number | undefined;
-            introtext?: string | undefined;
-            fulltext?: string | undefined;
-            ordering?: number | undefined;
-            images?: {
-                image_intro?: string | undefined;
-                image_fulltext?: string | undefined;
-                float_intro?: string | undefined;
-                float_fulltext?: string | undefined;
-            } | undefined;
-            hits?: number | undefined;
-            metadata?: unknown;
-        }>;
+        getData: (contentId: number | string, params?: BaseGetParams) => Promise<unknown>;
         /**
          * Get content documentation (data only)
          * @description Returns only the data from enhanced content document response
@@ -270,28 +185,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * @returns Enhanced content document (data only)
          * @throws ValidationError When response is malformed
          */
-        getDocData: (contentId: number | string) => Promise<{
-            id: number;
-            title: string;
-            alias: string;
-            catid: number;
-            introtext: string;
-            fulltext: string;
-            ordering?: number | undefined;
-            images?: {
-                image_intro?: string | undefined;
-                image_fulltext?: string | undefined;
-                float_intro?: string | undefined;
-                float_fulltext?: string | undefined;
-            } | undefined;
-            fields?: {
-                value: string;
-                type: string;
-                id: number;
-                title: string;
-                name: string;
-            }[] | undefined;
-        }>;
+        getDocData: (contentId: number | string) => Promise<unknown>;
     };
     /**
      * User endpoints
@@ -347,30 +241,9 @@ export declare class JoomlaClient extends BaseServiceClient {
             edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
             limit?: number | undefined;
             offset?: number | undefined;
-            q?: string | undefined;
-            orderBy?: string | undefined;
         } | undefined) => Promise<{
             params: Record<string, unknown> | unknown[];
-            data: {
-                id: number;
-                name: string;
-                username: string;
-                email: string;
-                registerDate: string;
-                lastvisitDate: string;
-                lastResetTime?: string | undefined;
-                activation?: string | undefined;
-                block?: number | undefined;
-                timezone?: string | undefined;
-                language?: string | undefined;
-                customerId?: string | undefined;
-                contactId?: string | undefined;
-                profileValues?: unknown[] | Record<string, string | string[]> | null | undefined;
-                groups?: Record<string, unknown> | Record<string, never> | z.objectInputType<{
-                    id: z.ZodNumber;
-                    title: z.ZodString;
-                }, z.ZodTypeAny, "passthrough">[] | undefined;
-            }[];
+            data: unknown[];
             options: Record<string, unknown> | unknown[];
             status: number;
             message: string;
@@ -410,35 +283,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * const cachedUser = await api.joomla.users.get(123, { edgeCache: 1 });
          * ```
          */
-        get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
-            params: Record<string, unknown> | unknown[];
-            data: boolean | {
-                id: number;
-                name: string;
-                username: string;
-                email: string;
-                registerDate: string;
-                lastvisitDate: string;
-                lastResetTime?: string | undefined;
-                activation?: string | undefined;
-                block?: number | undefined;
-                timezone?: string | undefined;
-                language?: string | undefined;
-                customerId?: string | undefined;
-                contactId?: string | undefined;
-                profileValues?: unknown[] | Record<string, string | string[]> | null | undefined;
-                groups?: Record<string, unknown> | Record<string, never> | z.objectInputType<{
-                    id: z.ZodNumber;
-                    title: z.ZodString;
-                }, z.ZodTypeAny, "passthrough">[] | undefined;
-            };
-            options: Record<string, unknown> | unknown[];
-            status: number;
-            message: string;
-            count: number;
-            total: number;
-            totalResults: number;
-        }>;
+        get: (userId: number | string) => Promise<GenericResponse>;
         /**
          * Get user documentation
          * @description Returns enhanced user document with profile values, customer information, and metadata
@@ -452,7 +297,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * console.log(userDoc.profileValues?.['simpleweb_customer.simpleweb_customer_companyname']);
          * ```
          */
-        getDoc: (userId: number | string) => Promise<UserDocumentResponse>;
+        getDoc: (userId: number | string) => Promise<GenericResponse>;
         /**
          * Get Trinity user documentation
          * @description Returns specialized Trinity business logic document with territory assignment and role detection
@@ -469,7 +314,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * const filtered = await client.users.getTrinityDoc(123, { q: 'search', limit: 5 });
          * ```
          */
-        getTrinityDoc: (userId: number | string, params?: TrinityDocParams) => Promise<TrinityDocResponse>;
+        getTrinityDoc: (userId: number | string, params?: BaseGetParams) => Promise<GenericResponse>;
         /**
          * User groups sub-endpoints
          * @description Methods for managing user group memberships and relationships
@@ -505,7 +350,7 @@ export declare class JoomlaClient extends BaseServiceClient {
              * groups.forEach(group => console.log(group.title, group.groupId));
              * ```
              */
-            list: (userId: string, params?: UserGroupMembershipParams) => Promise<UserGroupMembershipResponse>;
+            list: (userId: string, params?: BaseGetParams) => Promise<GenericResponse>;
             /**
              * Get specific user group membership
              * @description Returns detailed information about a user's membership in a specific group
@@ -519,7 +364,7 @@ export declare class JoomlaClient extends BaseServiceClient {
              * console.log(membership.groupTitle, membership.memberSince);
              * ```
              */
-            get: (userId: string, groupId: number | string) => Promise<UserGroupDetailResponse>;
+            get: (userId: string, groupId: number | string) => Promise<GenericResponse>;
             /**
              * Create or update user group mapping
              * @description Adds or updates a user's membership in a group
@@ -533,7 +378,7 @@ export declare class JoomlaClient extends BaseServiceClient {
              * console.log(mapping.created ? 'Created' : 'Updated', 'group mapping');
              * ```
              */
-            createMapping: (userId: number | string, request: UserGroupMappingRequest) => Promise<UserGroupMappingResponse>;
+            createMapping: (userId: number | string, request: unknown) => Promise<GenericResponse>;
             /**
              * Get user's groups (data only)
              * @description Returns only the data array from user group memberships response
@@ -542,12 +387,7 @@ export declare class JoomlaClient extends BaseServiceClient {
              * @returns Array of user group memberships (data only)
              * @throws ValidationError When response is malformed
              */
-            listData: (userId: string, params?: UserGroupMembershipParams) => Promise<{
-                title: string;
-                username: string;
-                groupId: number;
-                userId: number;
-            }[]>;
+            listData: (userId: string, params?: BaseGetParams) => Promise<unknown>;
             /**
              * Get specific user group membership (data only)
              * @description Returns only the data from user group membership details response
@@ -556,13 +396,7 @@ export declare class JoomlaClient extends BaseServiceClient {
              * @returns User group membership details (data only)
              * @throws ValidationError When response is malformed
              */
-            getData: (userId: string, groupId: number | string) => Promise<{
-                id: number;
-                title: string;
-                level: number;
-                groupId: number;
-                userId: number;
-            }>;
+            getData: (userId: string, groupId: number | string) => Promise<unknown>;
             /**
              * Create or update user group mapping (data only)
              * @description Returns only the data from created/updated group mapping response
@@ -571,12 +405,7 @@ export declare class JoomlaClient extends BaseServiceClient {
              * @returns Group mapping information (data only)
              * @throws ValidationError When request is invalid or response is malformed
              */
-            createMappingData: (userId: number | string, request: UserGroupMappingRequest) => Promise<{
-                id: number;
-                created: boolean;
-                groupId: number;
-                userId: number;
-            }>;
+            createMappingData: (userId: number | string, request: unknown) => Promise<unknown>;
         };
         /**
          * Verify user credentials and authenticate
@@ -668,24 +497,19 @@ export declare class JoomlaClient extends BaseServiceClient {
         create: (data: {
             username: string;
             email: string;
+            password?: string | undefined;
             name?: string | undefined;
-            profileValues?: Record<string, string> | undefined;
             groups?: number[] | undefined;
-            password?: string | undefined;
+            profileValues?: Record<string, string> | undefined;
         }) => Promise<{
             params: Record<string, unknown> | unknown[];
-            data: {
-                id: number;
-                name: string;
-                username: string;
-                email: string;
-            };
             options: Record<string, unknown> | unknown[];
             status: number;
             message: string;
             count: number;
             total: number;
             totalResults: number;
+            data?: unknown;
         }>;
         /**
          * Update an existing user
@@ -705,20 +529,20 @@ export declare class JoomlaClient extends BaseServiceClient {
          * ```
          */
         update: (id: string | number, data: {
-            name?: string | undefined;
             username?: string | undefined;
+            password?: string | undefined;
             email?: string | undefined;
+            name?: string | undefined;
             profileValues?: Record<string, string | string[]> | undefined;
-            password?: string | undefined;
         }) => Promise<{
             params: Record<string, unknown> | unknown[];
-            data: boolean;
             options: Record<string, unknown> | unknown[];
             status: number;
             message: string;
             count: number;
             total: number;
             totalResults: number;
+            data?: unknown;
         }>;
         /**
          * Block (deactivate) a user
@@ -736,13 +560,13 @@ export declare class JoomlaClient extends BaseServiceClient {
          */
         block: (id: string | number) => Promise<{
             params: Record<string, unknown> | unknown[];
-            data: boolean;
             options: Record<string, unknown> | unknown[];
             status: number;
             message: string;
             count: number;
             total: number;
             totalResults: number;
+            data?: unknown;
         }>;
         /**
          * Retrieve a paginated list of users (data only)
@@ -751,26 +575,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * @returns Array of users (data only)
          * @throws ValidationError When parameters are invalid or response is malformed
          */
-        listData: (params?: UserListParams) => Promise<{
-            id: number;
-            name: string;
-            username: string;
-            email: string;
-            registerDate: string;
-            lastvisitDate: string;
-            lastResetTime?: string | undefined;
-            activation?: string | undefined;
-            block?: number | undefined;
-            timezone?: string | undefined;
-            language?: string | undefined;
-            customerId?: string | undefined;
-            contactId?: string | undefined;
-            profileValues?: unknown[] | Record<string, string | string[]> | null | undefined;
-            groups?: Record<string, unknown> | Record<string, never> | z.objectInputType<{
-                id: z.ZodNumber;
-                title: z.ZodString;
-            }, z.ZodTypeAny, "passthrough">[] | undefined;
-        }[]>;
+        listData: (params?: BaseGetParams) => Promise<unknown[]>;
         /**
          * Get user details by ID (data only)
          * @description Returns only the data from user details response
@@ -779,26 +584,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * @returns User details (data only)
          * @throws ValidationError When response is malformed
          */
-        getData: (userId: number | string, params?: BaseGetParams) => Promise<boolean | {
-            id: number;
-            name: string;
-            username: string;
-            email: string;
-            registerDate: string;
-            lastvisitDate: string;
-            lastResetTime?: string | undefined;
-            activation?: string | undefined;
-            block?: number | undefined;
-            timezone?: string | undefined;
-            language?: string | undefined;
-            customerId?: string | undefined;
-            contactId?: string | undefined;
-            profileValues?: unknown[] | Record<string, string | string[]> | null | undefined;
-            groups?: Record<string, unknown> | Record<string, never> | z.objectInputType<{
-                id: z.ZodNumber;
-                title: z.ZodString;
-            }, z.ZodTypeAny, "passthrough">[] | undefined;
-        }>;
+        getData: (userId: number | string) => Promise<unknown>;
         /**
          * Get user documentation (data only)
          * @description Returns only the data from enhanced user document response
@@ -806,25 +592,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * @returns Enhanced user document (data only)
          * @throws ValidationError When response is malformed
          */
-        getDocData: (userId: number | string) => Promise<boolean | {
-            id: number;
-            name: string;
-            username: string;
-            email: string;
-            registerDate: string;
-            lastvisitDate: string;
-            lastResetTime: string;
-            block: number;
-            timezone: string;
-            language: string;
-            customerId: string;
-            contactId: string;
-            profileValues: Record<string, string | string[]>;
-            groups: z.objectOutputType<{
-                id: z.ZodNumber;
-                title: z.ZodString;
-            }, z.ZodTypeAny, "passthrough">[];
-        }>;
+        getDocData: (userId: number | string) => Promise<unknown>;
         /**
          * Get Trinity user documentation (data only)
          * @description Returns only the data from specialized Trinity business logic document response
@@ -833,46 +601,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * @returns Trinity document (data only)
          * @throws ValidationError When parameters are invalid or response is malformed
          */
-        getTrinityDocData: (userId: number | string, params?: TrinityDocParams) => Promise<{
-            groups: z.objectOutputType<{
-                id: z.ZodNumber;
-                title: z.ZodString;
-            }, z.ZodTypeAny, "passthrough">[];
-            profile: {
-                id: number;
-                title: string | null;
-                name: string;
-                username: string;
-                email: string;
-                registerDate: string;
-                lastvisitDate: string;
-                block: number;
-                customerId: number | null;
-                contactId: number | null;
-                contractNo: string | null;
-                shipTo: string | null;
-                phone: string | null;
-                companyName: string | null;
-                approved: number | null;
-            };
-            p21Role: {
-                id: number;
-                contactRoleUid: number;
-                contactRoleId: number;
-                contactRoleName: string;
-                parentName: string;
-                parentGroupId: number;
-                groupId: number;
-                address: {
-                    physState: string | null;
-                    mailState: string | null;
-                } & {
-                    [k: string]: unknown;
-                };
-            } | null;
-            territory: string;
-            role: string;
-        }>;
+        getTrinityDocData: (userId: number | string, params?: BaseGetParams) => Promise<unknown>;
         /**
          * Verify user password (data only)
          * @description Returns only the data from password verification response
@@ -882,9 +611,9 @@ export declare class JoomlaClient extends BaseServiceClient {
         verifyPasswordData: (request: VerifyPasswordRequest) => Promise<{
             id: number;
             username: string;
-            email: string;
             isVerified: boolean;
-            token: string | boolean;
+            token: string;
+            email: string;
         }>;
         /**
          * Create a new user (data only)
@@ -893,12 +622,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * @returns Created user information (data only)
          * @throws ValidationError When request is invalid or response is malformed
          */
-        createData: (request: CreateUserRequest) => Promise<{
-            id: number;
-            name: string;
-            username: string;
-            email: string;
-        }>;
+        createData: (request: CreateUserRequest) => Promise<unknown>;
         /**
          * Update an existing user (data only)
          * @description Returns only the data from updated user response
@@ -907,7 +631,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * @returns Updated user object (data only)
          * @throws ValidationError When request is invalid or response is malformed
          */
-        updateData: (userId: number | string, request: UpdateUserRequest) => Promise<boolean>;
+        updateData: (userId: number | string, request: UpdateUserRequest) => Promise<unknown>;
         /**
          * Block (deactivate) a user (data only)
          * @description Returns only the data from user blocking response
@@ -915,7 +639,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * @returns Blocking operation result (data only)
          * @throws ValidationError When response is malformed
          */
-        blockData: (userId: number | string) => Promise<boolean>;
+        blockData: (userId: number | string) => Promise<unknown>;
     };
     /**
      * User Groups endpoints
@@ -967,7 +691,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * });
          * ```
          */
-        list: (params?: UserGroupListParams) => Promise<UserGroupListResponse>;
+        list: (params?: BaseGetParams) => Promise<GenericResponse>;
         /**
          * Get user groups (data only)
          * @description Returns only the data array from user groups response
@@ -975,14 +699,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * @returns Array of user groups (data only)
          * @throws ValidationError When parameters are invalid or response is malformed
          */
-        listData: (params?: UserGroupListParams) => Promise<{
-            id: number;
-            title: string;
-            parentId: number;
-            level: number;
-            lft: number;
-            rgt: number;
-        }[]>;
+        listData: (params?: BaseGetParams) => Promise<unknown>;
     };
     /**
      * Tags endpoints
@@ -1042,21 +759,9 @@ export declare class JoomlaClient extends BaseServiceClient {
             edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
             limit?: number | undefined;
             offset?: number | undefined;
-            q?: string | undefined;
-            parentId?: number | undefined;
-            catId?: number | undefined;
         } | undefined) => Promise<{
             params: Record<string, unknown> | unknown[];
-            data: {
-                path: string;
-                id: number;
-                title: string;
-                alias: string;
-                hits: number;
-                parentId: number;
-                level: number;
-                note?: string | undefined;
-            }[];
+            data: unknown[];
             options: Record<string, unknown> | unknown[];
             status: number;
             message: string;
@@ -1071,16 +776,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * @returns Array of tags (data only)
          * @throws ValidationError When parameters are invalid or response is malformed
          */
-        listData: (params?: TagListParams) => Promise<{
-            path: string;
-            id: number;
-            title: string;
-            alias: string;
-            hits: number;
-            parentId: number;
-            level: number;
-            note?: string | undefined;
-        }[]>;
+        listData: (params?: BaseGetParams) => Promise<unknown[]>;
     };
     /**
      * Menu endpoints
@@ -1100,7 +796,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * console.log('Level:', menuDoc.data.level, 'Parent:', menuDoc.data.parentId);
          * ```
          */
-        getDoc: (menuId: string) => Promise<ContentDocumentResponse>;
+        getDoc: (menuId: string) => Promise<GenericResponse>;
         /**
          * Get menu documentation (data only)
          * @description Returns only the data from enhanced menu item document response
@@ -1108,28 +804,7 @@ export declare class JoomlaClient extends BaseServiceClient {
          * @returns Menu document (data only)
          * @throws ValidationError When response is malformed
          */
-        getDocData: (menuId: string) => Promise<{
-            id: number;
-            title: string;
-            alias: string;
-            catid: number;
-            introtext: string;
-            fulltext: string;
-            ordering?: number | undefined;
-            images?: {
-                image_intro?: string | undefined;
-                image_fulltext?: string | undefined;
-                float_intro?: string | undefined;
-                float_fulltext?: string | undefined;
-            } | undefined;
-            fields?: {
-                value: string;
-                type: string;
-                id: number;
-                title: string;
-                name: string;
-            }[] | undefined;
-        }>;
+        getDocData: (menuId: string) => Promise<unknown>;
     };
     /**
      * Check service health (no bearer token required)