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

package/dist/types/models/PaginatedProgramLicense.d.ts

@@ -19,11 +19,11 @@ export type PaginatedProgramLicense = {
     /**
      * URL for next page of results
      */
-    next: string | null;
+    next_page: string | null;
     /**
      * URL for previous page of results
      */
-    previous: string | null;
+    previous_page: string | null;
     /**
      * List of program licenses
      */

package/dist/types/models/PaginatedProgramLicenseAssignment.d.ts

@@ -19,11 +19,11 @@ export type PaginatedProgramLicenseAssignment = {
     /**
      * URL for next page of results
      */
-    next: string | null;
+    next_page: string | null;
     /**
      * URL for previous page of results
      */
-    previous: string | null;
+    previous_page: string | null;
     /**
      * List of program license assignments
      */

package/dist/types/models/PaginatedProgramLicenseGroupAssignment.d.ts

@@ -19,11 +19,11 @@ export type PaginatedProgramLicenseGroupAssignment = {
     /**
      * URL for next page of results
      */
-    next: string | null;
+    next_page: string | null;
     /**
      * URL for previous page of results
      */
-    previous: string | null;
+    previous_page: string | null;
     /**
      * List of program license group assignments
      */

package/dist/types/models/PaginatedProgramSuggestion.d.ts

@@ -10,11 +10,11 @@ export type PaginatedProgramSuggestion = {
     /**
      * URL for next page of results
      */
-    next: string | null;
+    next_page: string | null;
     /**
      * URL for previous page of results
      */
-    previous: string | null;
+    previous_page: string | null;
     /**
      * List of program suggestions
      */

package/dist/types/models/PaginatedRbacGroupList.d.ts

@@ -0,0 +1,7 @@
+import type { RbacGroup } from './RbacGroup';
+export type PaginatedRbacGroupList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<RbacGroup>;
+};

package/dist/types/models/PaginatedRbacPolicyList.d.ts

@@ -0,0 +1,7 @@
+import type { RbacPolicy } from './RbacPolicy';
+export type PaginatedRbacPolicyList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<RbacPolicy>;
+};

package/dist/types/models/PaginatedRbacRoleList.d.ts

@@ -0,0 +1,7 @@
+import type { RbacRole } from './RbacRole';
+export type PaginatedRbacRoleList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<RbacRole>;
+};

package/dist/types/models/PaginatedSkill.d.ts

@@ -0,0 +1,7 @@
+import type { Skill } from './Skill';
+export type PaginatedSkill = {
+    next_page: string;
+    previous_page: string;
+    readonly results: Array<Skill>;
+    readonly count: number;
+};

package/dist/types/models/PaginatedUserLicense.d.ts

@@ -10,11 +10,11 @@ export type PaginatedUserLicense = {
     /**
      * URL for next page of results
      */
-    next: string | null;
+    next_page: string | null;
     /**
      * URL for previous page of results
      */
-    previous: string | null;
+    previous_page: string | null;
     /**
      * List of user licenses
      */

package/dist/types/models/PaginatedUserLicenseAssignment.d.ts

@@ -10,11 +10,11 @@ export type PaginatedUserLicenseAssignment = {
     /**
      * URL for next page of results
      */
-    next: string | null;
+    next_page: string | null;
     /**
      * URL for previous page of results
      */
-    previous: string | null;
+    previous_page: string | null;
     /**
      * List of user license assignments
      */

package/dist/types/models/PaginatedUserLicenseGroupAssignment.d.ts

@@ -10,11 +10,11 @@ export type PaginatedUserLicenseGroupAssignment = {
     /**
      * URL for next page of results
      */
-    next: string | null;
+    next_page: string | null;
     /**
      * URL for previous page of results
      */
-    previous: string | null;
+    previous_page: string | null;
     /**
      * List of user license group assignments
      */

package/dist/types/models/PatchedRbacGroup.d.ts

@@ -0,0 +1,34 @@
+import type { RbacPlatform } from './RbacPlatform';
+import type { RbacUser } from './RbacUser';
+/**
+ * Serializer for RBAC groups.
+ */
+export type PatchedRbacGroup = {
+    readonly id?: number;
+    /**
+     * The unique identifier for the group
+     */
+    unique_id?: string;
+    readonly platform?: RbacPlatform;
+    /**
+     * The platform key
+     */
+    platform_key?: string;
+    /**
+     * Optional name of the group
+     */
+    name?: string;
+    /**
+     * Optional group description
+     */
+    description?: string;
+    readonly users?: Array<RbacUser>;
+    /**
+     * List of user IDs to add to this group
+     */
+    users_to_add?: Array<number>;
+    /**
+     * List of user IDs to remove from this group
+     */
+    users_to_remove?: Array<number>;
+};

package/dist/types/models/PatchedRbacPolicy.d.ts

@@ -0,0 +1,48 @@
+import type { RbacBaseRole } from './RbacBaseRole';
+import type { RbacPlatform } from './RbacPlatform';
+import type { RbacPolicyGroup } from './RbacPolicyGroup';
+import type { RbacUser } from './RbacUser';
+/**
+ * Serializer for policies.
+ */
+export type PatchedRbacPolicy = {
+    readonly id?: number;
+    /**
+     * Role information (read-only)
+     */
+    readonly role?: RbacBaseRole;
+    /**
+     * Platform information (read-only)
+     */
+    readonly platform?: RbacPlatform;
+    /**
+     * List of resource paths this policy grants access to (e.g., ['/platforms/1/mentors', '/platforms/1/mentors/settings'])
+     */
+    resources?: Array<string>;
+    readonly users?: Array<RbacUser>;
+    readonly groups?: Array<RbacPolicyGroup>;
+    /**
+     * ID of the role this policy applies to
+     */
+    role_id?: number;
+    /**
+     * Platform key where this policy applies
+     */
+    platform_key?: string;
+    /**
+     * List of user IDs to add to this Policy
+     */
+    users_to_add?: Array<number>;
+    /**
+     * List of user IDs to remove from this Policy
+     */
+    users_to_remove?: Array<number>;
+    /**
+     * List of group IDs to add to this Policy
+     */
+    groups_to_add?: Array<number>;
+    /**
+     * List of group IDs to remove from this Policy
+     */
+    groups_to_remove?: Array<number>;
+};

package/dist/types/models/PatchedRbacRole.d.ts

@@ -0,0 +1,20 @@
+import type { RbacPlatform } from './RbacPlatform';
+/**
+ * Serializer for roles.
+ */
+export type PatchedRbacRole = {
+    readonly id?: number;
+    name?: string;
+    /**
+     * Platform information (read-only)
+     */
+    readonly platform?: RbacPlatform;
+    /**
+     * Platform key where this role belongs
+     */
+    platform_key?: string;
+    /**
+     * List of actions/permissions this role can perform (e.g., ['Ibl.Mentor/Settings/read', 'Ibl.Mentor/Settings/write'])
+     */
+    actions?: Array<string>;
+};

package/dist/types/models/PathwayGroupSuggestionDetail.d.ts

@@ -21,7 +21,7 @@ export type PathwayGroupSuggestionDetail = {
     /**
      * Whether the suggestion has been accepted
      */
-    accepted: boolean;
+    accepted?: boolean;
     /**
      * Whether the suggestion is visible
      */
@@ -57,5 +57,5 @@ export type PathwayGroupSuggestionDetail = {
     /**
      * Number of users in the group
      */
-    user_count: number;
+    user_count?: number;
 };

package/dist/types/models/PlatformInvitationDetail.d.ts

@@ -9,7 +9,7 @@ export type PlatformInvitationDetail = {
     /**
      * The ID of the user associated with the invitation
      */
-    user_id: number | null;
+    user_id?: number | null;
     /**
      * The username of the user associated with the invitation
      */
@@ -21,7 +21,7 @@ export type PlatformInvitationDetail = {
     /**
      * When the invitation was created
      */
-    created: string;
+    created?: string;
     /**
      * When the invitation was started
      */

package/dist/types/models/PlatformSkillPointResponse.d.ts

@@ -13,9 +13,9 @@ export type PlatformSkillPointResponse = {
     /**
      * URL for next page of results
      */
-    next: string | null;
+    next_page: string | null;
     /**
      * URL for previous page of results
      */
-    previous: string | null;
+    previous_page: string | null;
 };

package/dist/types/models/ProgramEnrollmentSearchResponse.d.ts

@@ -0,0 +1,22 @@
+import type { ProgramEnrollmentPlus } from './ProgramEnrollmentPlus';
+/**
+ * Response serializer for ProgramEnrollmentSearchView GET endpoint.
+ */
+export type ProgramEnrollmentSearchResponse = {
+    /**
+     * List of program enrollments
+     */
+    results: Array<ProgramEnrollmentPlus>;
+    /**
+     * Total number of reviews
+     */
+    count: number;
+    /**
+     * Next page number
+     */
+    next_page: number | null;
+    /**
+     * Previous page number
+     */
+    previous_page: number | null;
+};

package/dist/types/models/ProgramLicenseAssignmentDetail.d.ts

@@ -20,7 +20,6 @@
  * license_id: The ID of the program license
  * license_name: The name of the program license
  * program_key: The program key associated with the license
- * program_name: The name of the program associated with the license
  */
 export type ProgramLicenseAssignmentDetail = {
     /**
@@ -54,11 +53,11 @@ export type ProgramLicenseAssignmentDetail = {
     /**
      * Whether the assignment was directly assigned to the user (vs. via a group)
      */
-    direct: boolean | null;
+    direct?: boolean;
     /**
      * URL to redirect to after fulfillment
      */
-    redirect_to: string | null;
+    redirect_to?: string;
     /**
      * Additional metadata for the assignment
      */
@@ -66,11 +65,11 @@ export type ProgramLicenseAssignmentDetail = {
     /**
      * When the assignment was created
      */
-    created: string;
+    created?: string;
     /**
      * When the assignment was last modified
      */
-    modified: string;
+    modified?: string;
     /**
      * The ID of the program license
      */
@@ -83,8 +82,4 @@ export type ProgramLicenseAssignmentDetail = {
      * The program key associated with the license
      */
     program_key: string;
-    /**
-     * The name of the program associated with the license
-     */
-    program_name: string;
 };

package/dist/types/models/ProgramLicenseDetail.d.ts

@@ -74,11 +74,15 @@ export type ProgramLicenseDetail = {
     /**
      * The program ID associated with the license
      */
-    program_id: string;
+    program_id?: string;
+    /**
+     * The program key associated with the license
+     */
+    program_key?: string;
     /**
      * The name of the program associated with the license
      */
-    program_name: string;
+    program_name?: string;
     /**
      * Number of assignments using this license
      */

package/dist/types/models/ProgramMetadataRequest.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Request serializer for ProgramMetadataView POST endpoint.
+ */
+export type ProgramMetadataRequest = {
+    /**
+     * The unique identifier for the program
+     */
+    program_id: string;
+    /**
+     * The organization associated with the program
+     */
+    org?: string;
+    /**
+     * Platform key identifier (alternative to org)
+     */
+    platform_key?: string;
+    /**
+     * Program key (alternative to program_id + org)
+     */
+    program_key?: string;
+    /**
+     * Metadata to update for the program
+     */
+    metadata: Record<string, any>;
+    /**
+     * Whether to update existing metadata
+     */
+    update?: boolean;
+};

package/dist/types/models/ProgramMetadataResponse.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Response serializer for ProgramMetadataView GET endpoint.
+ */
+export type ProgramMetadataResponse = {
+    /**
+     * Program name
+     */
+    name?: string | null;
+    /**
+     * Program description
+     */
+    description?: string | null;
+    /**
+     * Whether the program is enabled
+     */
+    enabled?: boolean | null;
+    /**
+     * Program slug
+     */
+    slug?: string | null;
+    /**
+     * List of associated skills
+     */
+    skills?: Array<string>;
+    /**
+     * Platform key
+     */
+    platform_key?: string | null;
+};

package/dist/types/models/ProgramReview.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Serializer for program review data.
+ */
+export type ProgramReview = {
+    /**
+     * The user identifier
+     */
+    user_id: number;
+    /**
+     * The username of the reviewer
+     */
+    username: string;
+    /**
+     * Review content/text
+     */
+    content: string;
+    /**
+     * Rating value (typically 1-5)
+     */
+    rating: number | null;
+    /**
+     * Review title
+     */
+    title: string;
+    /**
+     * Whether the review is visible
+     */
+    visible: boolean;
+    /**
+     * Date when review was created
+     */
+    created: string | null;
+    /**
+     * Date when review was last modified
+     */
+    modified: string | null;
+    /**
+     * The program key identifier
+     */
+    program_key: string;
+};

package/dist/types/models/ProgramReviewPaginatedResponse.d.ts

@@ -0,0 +1,22 @@
+import type { ProgramReview } from './ProgramReview';
+/**
+ * Paginated response serializer for ProgramReviewQueryView GET endpoint.
+ */
+export type ProgramReviewPaginatedResponse = {
+    /**
+     * Total number of reviews
+     */
+    count: number;
+    /**
+     * Next page number
+     */
+    next_page: number | null;
+    /**
+     * Previous page number
+     */
+    previous_page: number | null;
+    /**
+     * List of program reviews
+     */
+    results: Array<ProgramReview>;
+};

package/dist/types/models/ProgramReviewRequest.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Request serializer for ProgramReviewUpdateView POST endpoint.
+ */
+export type ProgramReviewRequest = {
+    /**
+     * The program key to review (format: program-v1:org+program_id)
+     */
+    program_key: string;
+    /**
+     * The username of the reviewer
+     */
+    username: string;
+    /**
+     * The user ID of the reviewer (alternative to username)
+     */
+    user_id?: number;
+    /**
+     * The rating value (typically 1-5)
+     */
+    rating?: number | null;
+    /**
+     * The review title
+     */
+    title?: string;
+    /**
+     * The review content/text
+     */
+    content?: string;
+    /**
+     * Whether the review is visible
+     */
+    visible?: boolean;
+    /**
+     * Additional review metadata
+     */
+    metadata?: any;
+};

package/dist/types/models/RbacBaseRole.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Serializer for roles.
+ */
+export type RbacBaseRole = {
+    readonly id: number;
+    name: string;
+    /**
+     * Platform key where this role belongs
+     */
+    platform_key: string;
+    /**
+     * List of actions/permissions this role can perform (e.g., ['Ibl.Mentor/Settings/read', 'Ibl.Mentor/Settings/write'])
+     */
+    actions: Array<string>;
+};

package/dist/types/models/RbacGroup.d.ts

@@ -0,0 +1,34 @@
+import type { RbacPlatform } from './RbacPlatform';
+import type { RbacUser } from './RbacUser';
+/**
+ * Serializer for RBAC groups.
+ */
+export type RbacGroup = {
+    readonly id: number;
+    /**
+     * The unique identifier for the group
+     */
+    unique_id: string;
+    readonly platform: RbacPlatform;
+    /**
+     * The platform key
+     */
+    platform_key: string;
+    /**
+     * Optional name of the group
+     */
+    name?: string;
+    /**
+     * Optional group description
+     */
+    description?: string;
+    readonly users: Array<RbacUser>;
+    /**
+     * List of user IDs to add to this group
+     */
+    users_to_add?: Array<number>;
+    /**
+     * List of user IDs to remove from this group
+     */
+    users_to_remove?: Array<number>;
+};

package/dist/types/models/RbacPlatform.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Serializer for platforms.
+ */
+export type RbacPlatform = {
+    readonly id: number;
+    /**
+     * The platform key
+     */
+    key: string;
+    /**
+     * The name of the platform
+     */
+    name?: string | null;
+};

package/dist/types/models/RbacPolicy.d.ts

@@ -0,0 +1,48 @@
+import type { RbacBaseRole } from './RbacBaseRole';
+import type { RbacPlatform } from './RbacPlatform';
+import type { RbacPolicyGroup } from './RbacPolicyGroup';
+import type { RbacUser } from './RbacUser';
+/**
+ * Serializer for policies.
+ */
+export type RbacPolicy = {
+    readonly id: number;
+    /**
+     * Role information (read-only)
+     */
+    readonly role: RbacBaseRole;
+    /**
+     * Platform information (read-only)
+     */
+    readonly platform: RbacPlatform;
+    /**
+     * List of resource paths this policy grants access to (e.g., ['/platforms/1/mentors', '/platforms/1/mentors/settings'])
+     */
+    resources: Array<string>;
+    readonly users: Array<RbacUser>;
+    readonly groups: Array<RbacPolicyGroup>;
+    /**
+     * ID of the role this policy applies to
+     */
+    role_id: number;
+    /**
+     * Platform key where this policy applies
+     */
+    platform_key: string;
+    /**
+     * List of user IDs to add to this Policy
+     */
+    users_to_add?: Array<number>;
+    /**
+     * List of user IDs to remove from this Policy
+     */
+    users_to_remove?: Array<number>;
+    /**
+     * List of group IDs to add to this Policy
+     */
+    groups_to_add?: Array<number>;
+    /**
+     * List of group IDs to remove from this Policy
+     */
+    groups_to_remove?: Array<number>;
+};

package/dist/types/models/RbacPolicyGroup.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Serializer for RBAC groups when returned in a policy.
+ *
+ * We are limiting the returne data since we don't need everything there
+ */
+export type RbacPolicyGroup = {
+    readonly id: number;
+    /**
+     * Optional name of the group
+     */
+    name?: string;
+    /**
+     * The unique identifier for the group
+     */
+    unique_id: string;
+    /**
+     * Optional group description
+     */
+    description?: string;
+};