@iblai/iblai-api 0.0.2-core → 0.0.12-scan-core

package/dist/types/services/CredentialsService.d.ts

@@ -5,6 +5,7 @@ import type { Issuer } from '../models/Issuer';
 import type { IssuerAuthority } from '../models/IssuerAuthority';
 import type { OverTime } from '../models/OverTime';
 import type { OvertimeWithChangeInfo } from '../models/OvertimeWithChangeInfo';
+import type { PaginatedAssertionsResponse } from '../models/PaginatedAssertionsResponse';
 import type { UploadedImage } from '../models/UploadedImage';
 import type { CancelablePromise } from '../core/CancelablePromise';
 export declare class CredentialsService {
@@ -18,12 +19,12 @@ export declare class CredentialsService {
      * - search: Search term to filter credentials
      * - course: Course ID to filter credentials
      * - program: Program ID to filter credentials
-     * @param org
-     * @param userId
      * @returns Credential
      * @throws ApiError
      */
-    static credentialsOrgsUsersRetrieve(org: string, userId: string): CancelablePromise<Credential>;
+    static credentialsOrgsUsersRetrieve({ org, userId, }: {
+        org: string;
+    }): CancelablePromise<Credential>;
     /**
      * API View for managing credentials across a platform.
      *
@@ -101,13 +102,13 @@ export declare class CredentialsService {
                      * Access Control:
                      * - Requires CredentialAssignmentPermission
                      * - Only public credentials are returned by default
-                     * @param org
-                     * @param userId
-                     * @param requestBody
                      * @returns Credential
                      * @throws ApiError
                      */
-    static credentialsOrgsUsersCreate(org: string, userId: string, requestBody: Credential): CancelablePromise<Credential>;
+    static credentialsOrgsUsersCreate({ org, userId, requestBody, }: {
+        org: string;
+        requestBody: Credential;
+    }): CancelablePromise<Credential>;
     /**
      * API View for managing individual credentials.
      *
@@ -163,13 +164,13 @@ export declare class CredentialsService {
              * Access Control:
              * - Requires CredentialAssignmentPermission
              * - Users can only manage credentials they have permission to access
-             * @param entityId
-             * @param org
-             * @param userId
              * @returns Credential
              * @throws ApiError
              */
-    static credentialsOrgsUsersRetrieve2(entityId: string, org: string, userId: string): CancelablePromise<Credential>;
+    static credentialsOrgsUsersRetrieve2({ entityId, org, userId, }: {
+        entityId: string;
+        org: string;
+    }): CancelablePromise<Credential>;
     /**
      * API View for managing individual credentials.
      *
@@ -225,14 +226,14 @@ export declare class CredentialsService {
              * Access Control:
              * - Requires CredentialAssignmentPermission
              * - Users can only manage credentials they have permission to access
-             * @param entityId
-             * @param org
-             * @param userId
-             * @param requestBody
              * @returns Credential
              * @throws ApiError
              */
-    static credentialsOrgsUsersUpdate(entityId: string, org: string, userId: string, requestBody: Credential): CancelablePromise<Credential>;
+    static credentialsOrgsUsersUpdate({ entityId, org, userId, requestBody, }: {
+        entityId: string;
+        org: string;
+        requestBody: Credential;
+    }): CancelablePromise<Credential>;
     /**
      * API View for managing individual credentials.
      *
@@ -288,13 +289,13 @@ export declare class CredentialsService {
              * Access Control:
              * - Requires CredentialAssignmentPermission
              * - Users can only manage credentials they have permission to access
-             * @param entityId
-             * @param org
-             * @param userId
              * @returns void
              * @throws ApiError
              */
-    static credentialsOrgsUsersDestroy(entityId: string, org: string, userId: string): CancelablePromise<void>;
+    static credentialsOrgsUsersDestroy({ entityId, org, userId, }: {
+        entityId: string;
+        org: string;
+    }): CancelablePromise<void>;
     /**
      * Endpoint to issue and retrieve credential assertions for a specific credential.
      *
@@ -324,13 +325,13 @@ export declare class CredentialsService {
      * 403 Forbidden: If the user does not have permission to access this resource
      * 404 Not Found: If the credential doesn't exist
      * 500 Internal Server Error: If an unexpected error occurs
-     * @param entityId
-     * @param org
-     * @param userId
-     * @returns Assertion
+     * @returns PaginatedAssertionsResponse
      * @throws ApiError
      */
-    static credentialsOrgsUsersAssertionsRetrieve3(entityId: string, org: string, userId: string): CancelablePromise<Assertion>;
+    static credentialsOrgsUsersAssertionsRetrieve3({ entityId, org, userId, }: {
+        entityId: string;
+        org: string;
+    }): CancelablePromise<PaginatedAssertionsResponse>;
     /**
      * Endpoint to issue and retrieve credential assertions for a specific credential.
      *
@@ -360,14 +361,14 @@ export declare class CredentialsService {
      * 403 Forbidden: If the user does not have permission to access this resource
      * 404 Not Found: If the credential doesn't exist
      * 500 Internal Server Error: If an unexpected error occurs
-     * @param entityId
-     * @param org
-     * @param userId
-     * @param requestBody
      * @returns Assertion
      * @throws ApiError
      */
-    static credentialsOrgsUsersAssertionsCreate(entityId: string, org: string, userId: string, requestBody: Assertion): CancelablePromise<Assertion>;
+    static credentialsOrgsUsersAssertionsCreate({ entityId, org, userId, requestBody, }: {
+        entityId: string;
+        org: string;
+        requestBody: Assertion;
+    }): CancelablePromise<Assertion>;
     /**
      * Endpoint to issue credential assertions in bulk for a specific credential.
      *
@@ -396,14 +397,14 @@ export declare class CredentialsService {
          * 403 Forbidden: If the user does not have permission to access this resource
          * 404 Not Found: If the credential doesn't exist
          * 500 Internal Server Error: If an unexpected error occurs
-         * @param entityId
-         * @param org
-         * @param userId
-         * @param requestBody
          * @returns BulkCreateAssertion
          * @throws ApiError
          */
-    static credentialsOrgsUsersAssertionsBulkCreate(entityId: string, org: string, userId: string, requestBody: BulkCreateAssertion): CancelablePromise<BulkCreateAssertion>;
+    static credentialsOrgsUsersAssertionsBulkCreate({ entityId, org, userId, requestBody, }: {
+        entityId: string;
+        org: string;
+        requestBody: BulkCreateAssertion;
+    }): CancelablePromise<BulkCreateAssertion>;
     /**
      * Endpoint to retrieve all credential assertions for a user within an organization.
      *
@@ -428,33 +429,43 @@ export declare class CredentialsService {
      * 403 Forbidden: If the user does not have permission to access this resource
      * 404 Not Found: If the user or organization doesn't exist
      * 500 Internal Server Error: If an unexpected error occurs
-     * @param org
-     * @param userId
-     * @param course
-     * @param excludeMainTenantAssertions
-     * @param includeExpired
-     * @param includeRevoked
-     * @param page
-     * @param pageSize
-     * @returns Assertion
+     * @returns PaginatedAssertionsResponse
      * @throws ApiError
      */
-    static credentialsOrgsUsersAssertionsRetrieve(org: string, userId: string, course?: string, excludeMainTenantAssertions?: boolean, includeExpired?: boolean, includeRevoked?: boolean, page?: number, pageSize?: number): CancelablePromise<Assertion>;
+    static credentialsOrgsUsersAssertionsRetrieve({ org, userId, course, excludeMainTenantAssertions, includeExpired, includeRevoked, page, pageSize, }: {
+        org: string;
+        course?: string;
+        excludeMainTenantAssertions?: boolean;
+        includeExpired?: boolean;
+        includeRevoked?: boolean;
+        page?: number;
+        pageSize?: number;
+    }): CancelablePromise<PaginatedAssertionsResponse>;
     /**
      * Get all credentials of a given tenant
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns OvertimeWithChangeInfo
      * @throws ApiError
      */
-    static credentialsOrgsUsersAssertionsOverTimeRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+    static credentialsOrgsUsersAssertionsOverTimeRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * end date. ISO 8601
+         */
+        endDate?: string; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<OvertimeWithChangeInfo>;
     /**
      * Endpoint to retrieve and update a specific credential assertion.
      *
@@ -485,13 +496,13 @@ export declare class CredentialsService {
      * 403 Forbidden: If the user does not have permission to access this resource
      * 404 Not Found: If the assertion doesn't exist
      * 500 Internal Server Error: If an unexpected error occurs
-     * @param entityId
-     * @param org
-     * @param userId
      * @returns Assertion
      * @throws ApiError
      */
-    static credentialsOrgsUsersAssertionsRetrieve2(entityId: string, org: string, userId: string): CancelablePromise<Assertion>;
+    static credentialsOrgsUsersAssertionsRetrieve2({ entityId, org, userId, }: {
+        entityId: string;
+        org: string;
+    }): CancelablePromise<Assertion>;
     /**
      * Endpoint to retrieve and update a specific credential assertion.
      *
@@ -522,74 +533,84 @@ export declare class CredentialsService {
      * 403 Forbidden: If the user does not have permission to access this resource
      * 404 Not Found: If the assertion doesn't exist
      * 500 Internal Server Error: If an unexpected error occurs
-     * @param entityId
-     * @param org
-     * @param userId
-     * @param requestBody
      * @returns Assertion
      * @throws ApiError
      */
-    static credentialsOrgsUsersAssertionsUpdate(entityId: string, org: string, userId: string, requestBody: Assertion): CancelablePromise<Assertion>;
+    static credentialsOrgsUsersAssertionsUpdate({ entityId, org, userId, requestBody, }: {
+        entityId: string;
+        org: string;
+        requestBody: Assertion;
+    }): CancelablePromise<Assertion>;
     /**
      * Delete a credential assignment using its entity_id.
      * Only platform admins and department admins can delete assignments.
-     * @param assignmentId
-     * @param org
-     * @param userId
      * @returns void
      * @throws ApiError
      */
-    static credentialsOrgsUsersAssignmentsDestroy(assignmentId: string, org: string, userId: string): CancelablePromise<void>;
+    static credentialsOrgsUsersAssignmentsDestroy({ assignmentId, org, userId, }: {
+        assignmentId: string;
+        org: string;
+    }): CancelablePromise<void>;
     /**
      * Get group assignments with department-aware filtering
-     * @param org
-     * @param userId
      * @returns any No response body
      * @throws ApiError
      */
-    static credentialsOrgsUsersAssignmentsGroupsRetrieve(org: string, userId: string): CancelablePromise<any>;
+    static credentialsOrgsUsersAssignmentsGroupsRetrieve({ org, userId, }: {
+        org: string;
+    }): CancelablePromise<any>;
     /**
      * Create group assignment with department access validation
-     * @param org
-     * @param userId
      * @returns any No response body
      * @throws ApiError
      */
-    static credentialsOrgsUsersAssignmentsGroupsCreate(org: string, userId: string): CancelablePromise<any>;
+    static credentialsOrgsUsersAssignmentsGroupsCreate({ org, userId, }: {
+        org: string;
+    }): CancelablePromise<any>;
     /**
      * Get assignments and their corresponding assertions based on user role:
      * - Regular users: get only their own assignments
      * - Platform admins: get assignments for all users in their platform
      * - Department admins: get assignments for users in their department groups
-     * @param org
-     * @param userId
      * @returns any No response body
      * @throws ApiError
      */
-    static credentialsOrgsUsersAssignmentsUsersRetrieve(org: string, userId: string): CancelablePromise<any>;
+    static credentialsOrgsUsersAssignmentsUsersRetrieve({ org, userId, }: {
+        org: string;
+    }): CancelablePromise<any>;
     /**
      * Create assignments with department access validation
-     * @param org
-     * @param userId
      * @returns any No response body
      * @throws ApiError
      */
-    static credentialsOrgsUsersAssignmentsUsersCreate(org: string, userId: string): CancelablePromise<any>;
+    static credentialsOrgsUsersAssignmentsUsersCreate({ org, userId, }: {
+        org: string;
+    }): CancelablePromise<any>;
     /**
      * Get all credentials of a given tenant
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns OverTime
      * @throws ApiError
      */
-    static credentialsOrgsUsersCourseAssertionsOverTimeRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTime>;
+    static credentialsOrgsUsersCourseAssertionsOverTimeRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * end date. ISO 8601
+         */
+        endDate?: string; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<OverTime>;
     /**
      * Endpoint to retrieve the credentials of a given tenant grouped by course.
      *
@@ -612,29 +633,43 @@ export declare class CredentialsService {
      * 403 Forbidden: If the user does not have permission to access this data
      * 404 Not Found: If the organization doesn't exist
      * 500 Internal Server Error: If an unexpected error occurs
-     * @param org
-     * @param userId
-     * @param page A page number within the paginated result set.
-     * @param pageSize Number of results to return per page.
      * @returns any No response body
      * @throws ApiError
      */
-    static credentialsOrgsUsersCourseCredentialsList(org: string, userId: string, page?: number, pageSize?: number): CancelablePromise<any>;
+    static credentialsOrgsUsersCourseCredentialsList({ org, userId, page, pageSize, }: {
+        org: string; /**
+         * A page number within the paginated result set.
+         */
+        page?: number; /**
+         * Number of results to return per page.
+         */
+        pageSize?: number;
+    }): CancelablePromise<any>;
     /**
      * Get all credentials of a given tenant
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns OverTime
      * @throws ApiError
      */
-    static credentialsOrgsUsersCredentialsOverTimeRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTime>;
+    static credentialsOrgsUsersCredentialsOverTimeRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * end date. ISO 8601
+         */
+        endDate?: string; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<OverTime>;
     /**
      * API View for managing uploaded images for credentials.
      *
@@ -689,12 +724,12 @@ export declare class CredentialsService {
                      * Access Control:
                      * - Requires IsAdminUserOrStudentDRFMixin
                      * - Only authenticated users with appropriate permissions can upload and retrieve images
-                     * @param org
-                     * @param userId
                      * @returns UploadedImage
                      * @throws ApiError
                      */
-    static credentialsOrgsUsersImagesRetrieve(org: string, userId: string): CancelablePromise<UploadedImage>;
+    static credentialsOrgsUsersImagesRetrieve({ org, userId, }: {
+        org: string;
+    }): CancelablePromise<UploadedImage>;
     /**
      * API View for managing uploaded images for credentials.
      *
@@ -749,13 +784,13 @@ export declare class CredentialsService {
                      * Access Control:
                      * - Requires IsAdminUserOrStudentDRFMixin
                      * - Only authenticated users with appropriate permissions can upload and retrieve images
-                     * @param org
-                     * @param userId
-                     * @param requestBody
                      * @returns UploadedImage
                      * @throws ApiError
                      */
-    static credentialsOrgsUsersImagesCreate(org: string, userId: string, requestBody?: UploadedImage): CancelablePromise<UploadedImage>;
+    static credentialsOrgsUsersImagesCreate({ org, userId, requestBody, }: {
+        org: string;
+        requestBody?: UploadedImage;
+    }): CancelablePromise<UploadedImage>;
     /**
      * API View for managing credential issuers.
      *
@@ -818,13 +853,13 @@ export declare class CredentialsService {
                      * Access Control:
                      * - Requires IsAdminUserOrStudentDRFMixin
                      * - Only authenticated users with appropriate permissions can manage issuers
-                     * @param org
-                     * @param q
-                     * @param userId
                      * @returns Issuer
                      * @throws ApiError
                      */
-    static credentialsOrgsUsersIssuersRetrieve(org: string, q: string, userId: string): CancelablePromise<Issuer>;
+    static credentialsOrgsUsersIssuersRetrieve({ org, q, userId, }: {
+        org: string;
+        q: string;
+    }): CancelablePromise<Issuer>;
     /**
      * API View for managing credential issuers.
      *
@@ -887,14 +922,14 @@ export declare class CredentialsService {
                      * Access Control:
                      * - Requires IsAdminUserOrStudentDRFMixin
                      * - Only authenticated users with appropriate permissions can manage issuers
-                     * @param org
-                     * @param q
-                     * @param userId
-                     * @param requestBody
                      * @returns Issuer
                      * @throws ApiError
                      */
-    static credentialsOrgsUsersIssuersCreate(org: string, q: string, userId: string, requestBody: Issuer): CancelablePromise<Issuer>;
+    static credentialsOrgsUsersIssuersCreate({ org, q, userId, requestBody, }: {
+        org: string;
+        q: string;
+        requestBody: Issuer;
+    }): CancelablePromise<Issuer>;
     /**
      * API View for managing individual issuers.
      *
@@ -961,13 +996,13 @@ export declare class CredentialsService {
                          * Access Control:
                          * - Requires IsAdminUserOrStudentDRFMixin
                          * - Only authenticated users with appropriate permissions can manage issuers
-                         * @param entityId
-                         * @param org
-                         * @param userId
                          * @returns Issuer
                          * @throws ApiError
                          */
-    static credentialsOrgsUsersIssuersRetrieve2(entityId: string, org: string, userId: string): CancelablePromise<Issuer>;
+    static credentialsOrgsUsersIssuersRetrieve2({ entityId, org, userId, }: {
+        entityId: string;
+        org: string;
+    }): CancelablePromise<Issuer>;
     /**
      * API View for managing individual issuers.
      *
@@ -1034,14 +1069,14 @@ export declare class CredentialsService {
                          * Access Control:
                          * - Requires IsAdminUserOrStudentDRFMixin
                          * - Only authenticated users with appropriate permissions can manage issuers
-                         * @param entityId
-                         * @param org
-                         * @param userId
-                         * @param requestBody
                          * @returns Issuer
                          * @throws ApiError
                          */
-    static credentialsOrgsUsersIssuersUpdate(entityId: string, org: string, userId: string, requestBody: Issuer): CancelablePromise<Issuer>;
+    static credentialsOrgsUsersIssuersUpdate({ entityId, org, userId, requestBody, }: {
+        entityId: string;
+        org: string;
+        requestBody: Issuer;
+    }): CancelablePromise<Issuer>;
     /**
      * API View for managing individual issuers.
      *
@@ -1108,13 +1143,13 @@ export declare class CredentialsService {
                          * Access Control:
                          * - Requires IsAdminUserOrStudentDRFMixin
                          * - Only authenticated users with appropriate permissions can manage issuers
-                         * @param entityId
-                         * @param org
-                         * @param userId
                          * @returns void
                          * @throws ApiError
                          */
-    static credentialsOrgsUsersIssuersDestroy(entityId: string, org: string, userId: string): CancelablePromise<void>;
+    static credentialsOrgsUsersIssuersDestroy({ entityId, org, userId, }: {
+        entityId: string;
+        org: string;
+    }): CancelablePromise<void>;
     /**
      * API View for managing issuer authorities (signatories).
      *
@@ -1157,13 +1192,13 @@ export declare class CredentialsService {
              * Access Control:
              * - Requires IsAdminUserOrStudentDRFMixin
              * - Only authenticated users with appropriate permissions can manage authorities
-             * @param org
-             * @param userId
-             * @param requestBody
              * @returns IssuerAuthority
              * @throws ApiError
              */
-    static credentialsOrgsUsersIssuersAuthorityCreate(org: string, userId: string, requestBody: IssuerAuthority): CancelablePromise<IssuerAuthority>;
+    static credentialsOrgsUsersIssuersAuthorityCreate({ org, userId, requestBody, }: {
+        org: string;
+        requestBody: IssuerAuthority;
+    }): CancelablePromise<IssuerAuthority>;
     /**
      * Public endpoint to retrieve a specific credential assertion by its entity ID.
      *
@@ -1181,9 +1216,10 @@ export declare class CredentialsService {
      * - If the assertion doesn't exist: Empty response with 404 status
      * - If the assertion has been revoked: JSON with error detail and revocation reason
      * 500 Internal Server Error: If an unexpected error occurs
-     * @param entityId
-     * @returns any No response body
+     * @returns Assertion
      * @throws ApiError
      */
-    static credentialsPublicAssertionsRetrieve(entityId: string): CancelablePromise<any>;
+    static credentialsPublicAssertionsRetrieve({ entityId, }: {
+        entityId: string;
+    }): CancelablePromise<Assertion>;
 }

package/dist/types/services/DepartmentsService.d.ts

@@ -21,23 +21,60 @@ export declare class DepartmentsService {
      *
      * Returns:
      * A paginated list of departments with comprehensive metrics.
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param departments Departments search string. Single string or list of strings. e.g 'sample_department' or `['department', 'another department']`
-     * @param endDate Filter by learners date_joined. Start date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param isEnrolled Filter for users who have at least an enro;lment
-     * @param length Size of data to return
-     * @param location Location search string
-     * @param page Page offset
-     * @param pathway Pathway string
-     * @param program Program search string
-     * @param startDate Filter by learners date_joined. Start date. ISO 8601
      * @returns GroupList
      * @throws ApiError
      */
-    static departmentsOrgsRetrieve(org: string, departmentId?: number, departments?: Array<string>, endDate?: string, format?: 'json', includeMainPlatform?: boolean, isEnrolled?: boolean | null, length?: number, location?: string, page?: number, pathway?: string, program?: string, startDate?: string): CancelablePromise<GroupList>;
+    static departmentsOrgsRetrieve({ org, departmentId, departments, endDate, format, includeMainPlatform, isEnrolled, length, location, page, pathway, program, startDate, }: {
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * Departments search string. Single string or list of strings. e.g 'sample_department' or `['department', 'another department']`
+         */
+        departments?: Array<string>;
+        /**
+         * Filter by learners date_joined. Start date. ISO 8601
+         */
+        endDate?: string;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * Filter for users who have at least an enro;lment
+         */
+        isEnrolled?: boolean | null;
+        /**
+         * Size of data to return
+         */
+        length?: number;
+        /**
+         * Location search string
+         */
+        location?: string;
+        /**
+         * Page offset
+         */
+        page?: number;
+        /**
+         * Pathway string
+         */
+        pathway?: string;
+        /**
+         * Program search string
+         */
+        program?: string;
+        /**
+         * Filter by learners date_joined. Start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<GroupList>;
 }