@iblai/iblai-api 0.0.1-core

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

@@ -0,0 +1,170 @@
+import type { StripeCheckoutSessionRequest } from '../models/StripeCheckoutSessionRequest';
+import type { StripeCheckoutSessionResponse } from '../models/StripeCheckoutSessionResponse';
+import type { StripeCustomerPortalRequest } from '../models/StripeCustomerPortalRequest';
+import type { StripeCustomerPortalResponse } from '../models/StripeCustomerPortalResponse';
+import type { StripeLocalProduct } from '../models/StripeLocalProduct';
+import type { StripeSubscriptionRenewalRequest } from '../models/StripeSubscriptionRenewalRequest';
+import type { StripeSubscriptionRenewalResponse } from '../models/StripeSubscriptionRenewalResponse';
+import type { TenantLaunchRequest } from '../models/TenantLaunchRequest';
+import type { TenantLaunchResponse } from '../models/TenantLaunchResponse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class ServiceService {
+    /**
+     * User/tenant creation API
+     *
+     * To create using any payment provider, ensure you use the StudentToken Authentication Mechanism
+     * and also include the correct `provider_key` in the request body:
+     *
+     * ```
+     * apple_transaction_id: str
+     * stripe_checkout_id: str
+     * x_gcp_marketplace_token: str
+     * aws_transaction_id: str
+     * google_pay_transaction_id: str
+     * ```
+     *
+     * To create a tenant without a payment provider, call the API without ny of the above provider keys in the request body
+     * @param requestBody
+     * @returns TenantLaunchResponse
+     * @throws ApiError
+     */
+    static serviceLaunchTenantCreate(requestBody: TenantLaunchRequest): CancelablePromise<TenantLaunchResponse>;
+    /**
+     * User creation flow
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceManageUserCreate(): CancelablePromise<any>;
+    /**
+     * Make user tenant admin
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceManageUserRoleCreate(): CancelablePromise<any>;
+    /**
+     * Stripe checkout session API View for user upgrade
+     *
+     * Request the following fields:
+     *
+     * - tenant
+     * - sku
+     * - mode
+     * - success_url
+     * - cancel_url
+     *
+     * Response:
+     * {
+         * "redirect_to": "https://checkout.stripe.com/xxx/xxxx/xxxx",
+         * }
+         * @param org
+         * @param userId
+         * @param requestBody
+         * @returns StripeCheckoutSessionResponse
+         * @throws ApiError
+         */
+    static serviceOrgsUsersStripeCheckoutSessionCreate(org: string, userId: string, requestBody: StripeCheckoutSessionRequest): CancelablePromise<StripeCheckoutSessionResponse>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @returns StripeCustomerPortalResponse
+     * @throws ApiError
+     */
+    static serviceOrgsUsersStripeCustomerPortalCreate(org: string, userId: string, requestBody: StripeCustomerPortalRequest): CancelablePromise<StripeCustomerPortalResponse>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param org
+     * @param userId
+     * @returns StripeLocalProduct
+     * @throws ApiError
+     */
+    static serviceOrgsUsersStripeProductsRetrieve(org: string, userId: string): CancelablePromise<StripeLocalProduct>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @param org
+     * @param userId
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceOrgsUsersStripeProductsManageCreate(org: string, userId: string): CancelablePromise<any>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @returns StripeSubscriptionRenewalResponse
+     * @throws ApiError
+     */
+    static serviceOrgsUsersStripeSubscriptionRenewalCreate(org: string, userId: string, requestBody: StripeSubscriptionRenewalRequest): CancelablePromise<StripeSubscriptionRenewalResponse>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param org
+     * @param userId
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceOrgsUsersStripeSubscriptionsRetrieve(org: string, userId: string): CancelablePromise<any>;
+    /**
+     * Handle course payment callback after successful Stripe checkout.
+     * Enrolls the user in the purchased course.
+     *
+     * URL Parameters:
+     * - stripe_checkout_id: The local Checkout Session UUID
+     *
+     * Response:
+     * - Redirect: Successfully processed course enrollment
+     * - 404: Checkout session not found
+     * - 400: Invalid checkout session or product
+     * - 500: Server error during processing
+     * @param platformKey
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceOrgsStripeCoursePaymentCallbackRetrieve(platformKey: string): CancelablePromise<any>;
+    /**
+     * @param checkoutUuid
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceStripeCheckoutRetrieve(checkoutUuid: string): CancelablePromise<any>;
+    /**
+     * Stripe free trial checkout session. No user auth
+     *
+     * Request the following fields:
+     *
+     * - success_url
+     * - cancel_url
+     * - product
+     *
+     * Response:
+     * {
+         * "redirect_to": "https://checkout.stripe.com/xxx/xxxx/xxxx",
+         * }
+         * @param requestBody
+         * @returns StripeCheckoutSessionResponse
+         * @throws ApiError
+         */
+    static serviceStripeCheckoutFreeTrialCreate(requestBody: StripeCheckoutSessionResponse): CancelablePromise<StripeCheckoutSessionResponse>;
+    /**
+     * Check if tenant exists or not
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceTenantValidationCreate(): CancelablePromise<any>;
+    /**
+     * GET
+     * Gets site hash_key from
+     * or
+     * Gets site_id form hash_key
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceTokenRetrieve(): CancelablePromise<any>;
+    /**
+     * Check if tenant exists or not
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceUserValidationCreate(): CancelablePromise<any>;
+}

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

@@ -0,0 +1,377 @@
+import type { DesiredSkill } from '../models/DesiredSkill';
+import type { PatchedSkillThreshold } from '../models/PatchedSkillThreshold';
+import type { PointsPercentile } from '../models/PointsPercentile';
+import type { ReportedSkill } from '../models/ReportedSkill';
+import type { SkillDetail } from '../models/SkillDetail';
+import type { SkillInfo } from '../models/SkillInfo';
+import type { SkillThreshold } from '../models/SkillThreshold';
+import type { UserSkill } from '../models/UserSkill';
+import type { UserSkillPointsPercentile } from '../models/UserSkillPointsPercentile';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class SkillsService {
+    /**
+     * List all available skills on the platform.
+     *
+     * This endpoint returns information about all skills that can be
+     * acquired on the platform.
+     *
+     * Path Parameters:
+     * org (str): The platform/organization identifier
+     *
+     * Returns:
+     * A list of all skills with basic information about each skill.
+     *
+     * Access Control:
+     * - Platform admins can access this information
+     * - All authenticated users can access this information
+     * @param org
+     * @returns SkillInfo
+     * @throws ApiError
+     */
+    static skillsOrgsSkillsList(org: string): CancelablePromise<Array<SkillInfo>>;
+    /**
+     * Retrieve percentile distribution for a specific skill.
+     *
+     * This endpoint returns the percentile distribution of points earned
+     * by users for a specific skill.
+     *
+     * Path Parameters:
+     * skill_id (int): The ID of the skill to retrieve percentile information for
+     * org (str, optional): The platform/organization identifier to filter results
+     *
+     * Returns:
+     * A list of percentile breakpoints for the specified skill.
+     *
+     * Error Responses:
+     * 404 Not Found: If the specified skill doesn't exist
+     *
+     * Access Control:
+     * - Platform admins can access this information
+     * - All authenticated users can access this information
+     * @param org
+     * @param skillId
+     * @returns PointsPercentile
+     * @throws ApiError
+     */
+    static skillsOrgsSkillsPercentileRetrieve(org: string, skillId: number): CancelablePromise<PointsPercentile>;
+    /**
+     * Retrieve detailed information about a specific skill.
+     *
+     * This endpoint returns comprehensive information about a specific skill,
+     * including its description, categories, and related courses.
+     *
+     * Path Parameters:
+     * org (str): The platform/organization identifier
+     * skill_name (str): The name of the skill to retrieve details for
+     *
+     * Returns:
+     * Detailed information about the specified skill.
+     *
+     * Error Responses:
+     * 404 Not Found: If the specified skill doesn't exist
+     *
+     * Access Control:
+     * - Platform admins can access this information
+     * - All authenticated users can access this information
+     * @param org
+     * @param skillName
+     * @returns SkillDetail
+     * @throws ApiError
+     */
+    static skillsOrgsSkillsRetrieve(org: string, skillName: string): CancelablePromise<SkillDetail>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param org
+     * @returns PointsPercentile
+     * @throws ApiError
+     */
+    static skillsOrgsSkillsPercentileList(org: string): CancelablePromise<Array<PointsPercentile>>;
+    /**
+     * Manage skill thresholds for a platform.
+     *
+     * This endpoint allows platform administrators to view, create, update, and delete
+     * skill thresholds. Skill thresholds define the minimum points required to consider
+     * a skill as acquired or mastered.
+     *
+     * Path Parameters:
+     * org (str): The platform/organization identifier
+     *
+     * Methods:
+     * GET: Retrieve all skill thresholds for the platform
+     * POST: Create a new skill threshold
+     * PATCH: Update an existing skill threshold
+     * DELETE: Delete all skill thresholds for the platform
+     *
+     * Request Body (POST):
+     * name (str, required): The name of the threshold level (e.g., "Beginner", "Intermediate")
+     * threshold (int, required): The minimum points required to reach this threshold
+     *
+     * Request Body (PATCH):
+     * name (str, required): The name of the existing threshold to update
+     * threshold (int, required): The new minimum points value for this threshold
+     *
+     * Returns:
+     * GET: A list of all skill thresholds for the platform
+     * POST/PATCH: The created or updated skill threshold with format:
+     * {
+         * "name": "threshold_name",
+         * "threshold": threshold_value
+         * }
+         * DELETE: No content (204)
+         *
+         * Error Responses:
+         * 400 Bad Request: If the request data is invalid or missing required fields
+         * 404 Not Found: If the specified platform doesn't exist or the threshold
+         * to update cannot be found
+         *
+         * Access Control:
+         * - Only platform administrators can access this endpoint
+         * @param org
+         * @returns SkillThreshold
+         * @throws ApiError
+         */
+    static skillsOrgsSkillsThresholdsRetrieve(org: string): CancelablePromise<SkillThreshold>;
+    /**
+     * Manage skill thresholds for a platform.
+     *
+     * This endpoint allows platform administrators to view, create, update, and delete
+     * skill thresholds. Skill thresholds define the minimum points required to consider
+     * a skill as acquired or mastered.
+     *
+     * Path Parameters:
+     * org (str): The platform/organization identifier
+     *
+     * Methods:
+     * GET: Retrieve all skill thresholds for the platform
+     * POST: Create a new skill threshold
+     * PATCH: Update an existing skill threshold
+     * DELETE: Delete all skill thresholds for the platform
+     *
+     * Request Body (POST):
+     * name (str, required): The name of the threshold level (e.g., "Beginner", "Intermediate")
+     * threshold (int, required): The minimum points required to reach this threshold
+     *
+     * Request Body (PATCH):
+     * name (str, required): The name of the existing threshold to update
+     * threshold (int, required): The new minimum points value for this threshold
+     *
+     * Returns:
+     * GET: A list of all skill thresholds for the platform
+     * POST/PATCH: The created or updated skill threshold with format:
+     * {
+         * "name": "threshold_name",
+         * "threshold": threshold_value
+         * }
+         * DELETE: No content (204)
+         *
+         * Error Responses:
+         * 400 Bad Request: If the request data is invalid or missing required fields
+         * 404 Not Found: If the specified platform doesn't exist or the threshold
+         * to update cannot be found
+         *
+         * Access Control:
+         * - Only platform administrators can access this endpoint
+         * @param org
+         * @param requestBody
+         * @returns SkillThreshold
+         * @throws ApiError
+         */
+    static skillsOrgsSkillsThresholdsCreate(org: string, requestBody: SkillThreshold): CancelablePromise<SkillThreshold>;
+    /**
+     * Manage skill thresholds for a platform.
+     *
+     * This endpoint allows platform administrators to view, create, update, and delete
+     * skill thresholds. Skill thresholds define the minimum points required to consider
+     * a skill as acquired or mastered.
+     *
+     * Path Parameters:
+     * org (str): The platform/organization identifier
+     *
+     * Methods:
+     * GET: Retrieve all skill thresholds for the platform
+     * POST: Create a new skill threshold
+     * PATCH: Update an existing skill threshold
+     * DELETE: Delete all skill thresholds for the platform
+     *
+     * Request Body (POST):
+     * name (str, required): The name of the threshold level (e.g., "Beginner", "Intermediate")
+     * threshold (int, required): The minimum points required to reach this threshold
+     *
+     * Request Body (PATCH):
+     * name (str, required): The name of the existing threshold to update
+     * threshold (int, required): The new minimum points value for this threshold
+     *
+     * Returns:
+     * GET: A list of all skill thresholds for the platform
+     * POST/PATCH: The created or updated skill threshold with format:
+     * {
+         * "name": "threshold_name",
+         * "threshold": threshold_value
+         * }
+         * DELETE: No content (204)
+         *
+         * Error Responses:
+         * 400 Bad Request: If the request data is invalid or missing required fields
+         * 404 Not Found: If the specified platform doesn't exist or the threshold
+         * to update cannot be found
+         *
+         * Access Control:
+         * - Only platform administrators can access this endpoint
+         * @param org
+         * @param requestBody
+         * @returns SkillThreshold
+         * @throws ApiError
+         */
+    static skillsOrgsSkillsThresholdsPartialUpdate(org: string, requestBody?: PatchedSkillThreshold): CancelablePromise<SkillThreshold>;
+    /**
+     * Manage skill thresholds for a platform.
+     *
+     * This endpoint allows platform administrators to view, create, update, and delete
+     * skill thresholds. Skill thresholds define the minimum points required to consider
+     * a skill as acquired or mastered.
+     *
+     * Path Parameters:
+     * org (str): The platform/organization identifier
+     *
+     * Methods:
+     * GET: Retrieve all skill thresholds for the platform
+     * POST: Create a new skill threshold
+     * PATCH: Update an existing skill threshold
+     * DELETE: Delete all skill thresholds for the platform
+     *
+     * Request Body (POST):
+     * name (str, required): The name of the threshold level (e.g., "Beginner", "Intermediate")
+     * threshold (int, required): The minimum points required to reach this threshold
+     *
+     * Request Body (PATCH):
+     * name (str, required): The name of the existing threshold to update
+     * threshold (int, required): The new minimum points value for this threshold
+     *
+     * Returns:
+     * GET: A list of all skill thresholds for the platform
+     * POST/PATCH: The created or updated skill threshold with format:
+     * {
+         * "name": "threshold_name",
+         * "threshold": threshold_value
+         * }
+         * DELETE: No content (204)
+         *
+         * Error Responses:
+         * 400 Bad Request: If the request data is invalid or missing required fields
+         * 404 Not Found: If the specified platform doesn't exist or the threshold
+         * to update cannot be found
+         *
+         * Access Control:
+         * - Only platform administrators can access this endpoint
+         * @param org
+         * @returns void
+         * @throws ApiError
+         */
+    static skillsOrgsSkillsThresholdsDestroy(org: string): CancelablePromise<void>;
+    /**
+     * Retrieve a user's skill information.
+     *
+     * This endpoint returns information about skills that a user has acquired
+     * through the platform. It can return all skills or filter by a specific skill.
+     *
+     * Path Parameters:
+     * org (str): The platform/organization identifier
+     * user_id (str): The username of the user to retrieve skill information for
+     *
+     * Query Parameters:
+     * skill_name (str, optional): Filter results to a specific skill
+     *
+     * Returns:
+     * When skill_name is provided:
+     * Details about the specific skill including points earned and percentile ranking
+     *
+     * When skill_name is not provided:
+     * A list of all skills the user has acquired with their points
+     *
+     * Access Control:
+     * - Platform admins can access any user's skill information
+     * - Users can access their own skill information
+     * @param org
+     * @param userId
+     * @returns UserSkill
+     * @throws ApiError
+     */
+    static skillsOrgsSkillsUsersRetrieve(org: string, userId: string): CancelablePromise<UserSkill>;
+    /**
+     * Retrieve a user's desired skills.
+     *
+     * This endpoint returns the skills that a user has indicated they want
+     * to develop or acquire through the platform.
+     *
+     * Path Parameters:
+     * org (str): The platform/organization identifier
+     * user_id (str): The username of the user to retrieve skill information for
+     *
+     * Returns:
+     * The user's desired skills information.
+     *
+     * Error Responses:
+     * 400 Bad Request: If the user doesn't exist in the platform or has no desired skills
+     * 404 Not Found: If the specified platform doesn't exist
+     *
+     * Access Control:
+     * - Platform admins can access any user's information
+     * - Users can access their own information
+     * @param org
+     * @param userId
+     * @returns DesiredSkill
+     * @throws ApiError
+     */
+    static skillsOrgsSkillsUsersDesiredSkillsRetrieve(org: string, userId: string): CancelablePromise<DesiredSkill>;
+    /**
+     * Retrieve a user's total skill points and percentile ranking.
+     *
+     * This endpoint returns the total skill points a user has earned across
+     * all skills and their percentile ranking compared to other users on the platform.
+     *
+     * Path Parameters:
+     * org (str): The platform/organization identifier
+     * user_id (str): The username of the user to retrieve information for
+     *
+     * Returns:
+     * The user's total skill points and percentile ranking information:
+     * - Username
+     * - Total points earned across all skills
+     * - Percentile ranking compared to other users
+     *
+     * Access Control:
+     * - Platform admins can access any user's information
+     * - Users can access their own information
+     * @param org
+     * @param userId
+     * @returns UserSkillPointsPercentile
+     * @throws ApiError
+     */
+    static skillsOrgsSkillsUsersPointPercentileRetrieve(org: string, userId: string): CancelablePromise<UserSkillPointsPercentile>;
+    /**
+     * Retrieve a user's self-reported skills.
+     *
+     * This endpoint returns the skills that a user has reported having
+     * prior to or outside of the platform learning experience.
+     *
+     * Path Parameters:
+     * org (str): The platform/organization identifier
+     * user_id (str): The username of the user to retrieve skill information for
+     *
+     * Returns:
+     * The user's self-reported skills information.
+     *
+     * Error Responses:
+     * 400 Bad Request: If the user doesn't exist in the platform or has no reported skills
+     * 404 Not Found: If the specified platform doesn't exist
+     *
+     * Access Control:
+     * - Platform admins can access any user's information
+     * - Users can access their own information
+     * @param org
+     * @param userId
+     * @returns ReportedSkill
+     * @throws ApiError
+     */
+    static skillsOrgsSkillsUsersReportedSkillsRetrieve(org: string, userId: string): CancelablePromise<ReportedSkill>;
+}

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

@@ -0,0 +1,49 @@
+import type { GroupList } from '../models/GroupList';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class UserGroupsService {
+    /**
+     * Get a list of user groups with metrics and filtering options.
+     *
+     * This endpoint provides a paginated list of user groups with aggregated metrics
+     * about learner performance, course completions, and skill acquisition.
+     *
+     * This endpoint uses DM token authentication and respects department-based
+     * access controls.
+     *
+     * Query Parameters:
+     * page (int, optional): Page number for pagination
+     * length (int, optional): Number of items per page
+     * program (str, optional): Filter by program
+     * pathway (str, optional): Filter by pathway
+     * groups (list, optional): Filter by group names
+     * location (str, optional): Filter by location
+     * is_enrolled (bool, optional): Filter for groups with enrolled users
+     * start_date (date, optional): Filter by learner join date (start range)
+     * end_date (date, optional): Filter by learner join date (end range)
+     *
+     * Returns:
+     * A paginated list of user groups with comprehensive metrics.
+     *
+     * Access Control:
+     * - Platform admins can see all groups
+     * - Department admins can only see groups in their departments
+     * @param key
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate Filter by learners date_joined. Start date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param groups Groups search string. Single string or list of strings. e.g 'sample_group' or `['group', 'another group']`
+     * @param includeMainPlatform Include main platform data
+     * @param isEnrolled Filter for users who have at least an enrollment
+     * @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 userGroupsOrgsRetrieve(key: string, departmentId?: number, endDate?: string, format?: 'json', groups?: Array<string>, includeMainPlatform?: boolean, isEnrolled?: boolean | null, length?: number, location?: string, page?: number, pathway?: string, program?: string, startDate?: string): CancelablePromise<GroupList>;
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@iblai/iblai-api",
+  "version": "0.0.1-core",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "type": "module",
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "npm run clean && rollup -c"
+  },
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "keywords": [],
+  "author": "ibl.ai",
+  "license": "ISC",
+  "description": "",
+  "devDependencies": {
+    "@babel/preset-typescript": "^7.27.0",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "openapi-typescript-codegen": "^0.29.0",
+    "rollup": "^4.40.0",
+    "rollup-plugin-dts": "^6.2.1",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "tslib": "^2.8.1"
+  }
+}