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

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

@@ -167,80 +167,265 @@ export declare class SearchService {
                                                          * - Results are cached for performance
                                                          * - The 'resources' content type is only included by default if IBL_ENABLE_RESOURCES_IN_FACET is true
                                                          * - For debugging, add ?debug=true to see detailed information about skill matching
-                                                         * @param allowSkillSearch Enable skill-based search
-                                                         * @param alphabetical Sort alphabetically by name
-                                                         * @param certificate Filter by certificate type
-                                                         * @param content Content types to include in results
-                                                         * @param courseId Filter by specific course ID
-                                                         * @param duration Filter by course duration range
-                                                         * @param language Filter by content language
-                                                         * @param level Filter by difficulty level
-                                                         * @param limit Number of results per page
-                                                         * @param offset Starting position for pagination
-                                                         * @param orderAscending Sort direction
-                                                         * @param orderBy Field to sort results by
-                                                         * @param pathwayId Filter by specific pathway ID
-                                                         * @param price Filter by price/audit status
-                                                         * @param programId Filter by specific program ID
-                                                         * @param programType Filter by program type
-                                                         * @param promotion Filter by promotion status
-                                                         * @param query Search term to filter content by name or description
-                                                         * @param resourceType Filter by resource type
-                                                         * @param returnFacet Include facet data in response
-                                                         * @param returnItems Include items in programs/pathways
-                                                         * @param selfPaced Filter by course format
-                                                         * @param skillId Filter by specific skill ID
-                                                         * @param skills Filter by skills
-                                                         * @param subject Filter by subject areas
-                                                         * @param tags Filter by tags
-                                                         * @param tenant Filter by tenant/organization
-                                                         * @param topics Filter by topic areas
-                                                         * @param updateFacet Force facet update
                                                          * @returns GlobalCatalogSearchResponse
                                                          * @throws ApiError
                                                          */
-    static searchCatalogRetrieve(allowSkillSearch?: boolean, alphabetical?: boolean, certificate?: Array<string>, content?: Array<string>, courseId?: string, duration?: Array<string>, language?: Array<string>, level?: Array<string>, limit?: number, offset?: number, orderAscending?: boolean, orderBy?: string, pathwayId?: string, price?: string, programId?: string, programType?: Array<string>, promotion?: Array<string>, query?: string, resourceType?: Array<string>, returnFacet?: boolean, returnItems?: boolean, selfPaced?: Array<string>, skillId?: string, skills?: Array<string>, subject?: Array<string>, tags?: Array<string>, tenant?: Array<string>, topics?: Array<string>, updateFacet?: string): CancelablePromise<GlobalCatalogSearchResponse>;
+    static searchCatalogRetrieve({ allowSkillSearch, alphabetical, certificate, content, courseId, duration, language, level, limit, offset, orderAscending, orderBy, pathwayId, price, programId, programType, promotion, query, resourceType, returnFacet, returnItems, selfPaced, skillId, skills, subject, tags, tenant, topics, updateFacet, }: {
+        /**
+         * Enable skill-based search
+         */
+        allowSkillSearch?: boolean;
+        /**
+         * Sort alphabetically by name
+         */
+        alphabetical?: boolean;
+        /**
+         * Filter by certificate type
+         */
+        certificate?: Array<string>;
+        /**
+         * Content types to include in results
+         */
+        content?: Array<string>;
+        /**
+         * Filter by specific course ID
+         */
+        courseId?: string;
+        /**
+         * Filter by course duration range
+         */
+        duration?: Array<string>;
+        /**
+         * Filter by content language
+         */
+        language?: Array<string>;
+        /**
+         * Filter by difficulty level
+         */
+        level?: Array<string>;
+        /**
+         * Number of results per page
+         */
+        limit?: number;
+        /**
+         * Starting position for pagination
+         */
+        offset?: number;
+        /**
+         * Sort direction
+         */
+        orderAscending?: boolean;
+        /**
+         * Field to sort results by
+         */
+        orderBy?: string;
+        /**
+         * Filter by specific pathway ID
+         */
+        pathwayId?: string;
+        /**
+         * Filter by price/audit status
+         */
+        price?: string;
+        /**
+         * Filter by specific program ID
+         */
+        programId?: string;
+        /**
+         * Filter by program type
+         */
+        programType?: Array<string>;
+        /**
+         * Filter by promotion status
+         */
+        promotion?: Array<string>;
+        /**
+         * Search term to filter content by name or description
+         */
+        query?: string;
+        /**
+         * Filter by resource type
+         */
+        resourceType?: Array<string>;
+        /**
+         * Include facet data in response
+         */
+        returnFacet?: boolean;
+        /**
+         * Include items in programs/pathways
+         */
+        returnItems?: boolean;
+        /**
+         * Filter by course format
+         */
+        selfPaced?: Array<string>;
+        /**
+         * Filter by specific skill ID
+         */
+        skillId?: string;
+        /**
+         * Filter by skills
+         */
+        skills?: Array<string>;
+        /**
+         * Filter by subject areas
+         */
+        subject?: Array<string>;
+        /**
+         * Filter by tags
+         */
+        tags?: Array<string>;
+        /**
+         * Filter by tenant/organization
+         */
+        tenant?: Array<string>;
+        /**
+         * Filter by topic areas
+         */
+        topics?: Array<string>;
+        /**
+         * Force facet update
+         */
+        updateFacet?: string;
+    }): CancelablePromise<GlobalCatalogSearchResponse>;
     /**
      * Determine whether to serve a detail view or a list view.
      * If any detail-identifying parameters are present (course_id, program_id, etc.)
      * the detail view is returned; otherwise the aggregated list view is returned.
-     * @param username
-     * @param allowSkillSearch Enable skill-based search
-     * @param alphabetical Sort alphabetically by name
-     * @param certificate Filter by certificate type
-     * @param content Content types to include in results
-     * @param courseId Retrieve a specific course by ID
-     * @param duration Filter by course duration range
-     * @param language Filter by content language
-     * @param level Filter by difficulty level
-     * @param limit Number of results per page
-     * @param offset Starting position for pagination
-     * @param orderAscending Sort direction
-     * @param orderBy Field to sort results by
-     * @param pathwayId Retrieve a specific pathway by ID
-     * @param price Filter by price/audit status
-     * @param programId Retrieve a specific program by ID
-     * @param programType Filter by program type
-     * @param promotion Filter by promotion status
-     * @param query Search term to filter content by name or description
-     * @param recommended Show only recommended content
-     * @param resourceId Retrieve a specific resource by ID
-     * @param resourceType Filter by resource type
-     * @param returnFacet Include facet data in response
-     * @param returnItems Include items in programs/pathways
-     * @param roleId Retrieve a specific role by ID
-     * @param selfPaced Filter by course format
-     * @param skillId Retrieve a specific skill by ID
-     * @param skills Filter by skills
-     * @param subject Filter by subject areas
-     * @param tags Filter by tags
-     * @param tenant Filter by tenant/organization
-     * @param topics Filter by topic areas
-     * @param updateFacet Force facet update
      * @returns any
      * @throws ApiError
      */
-    static searchPersonalizedCatalogRetrieve(username: string, allowSkillSearch?: boolean, alphabetical?: boolean, certificate?: Array<string>, content?: Array<string>, courseId?: string, duration?: Array<string>, language?: Array<string>, level?: Array<string>, limit?: number, offset?: number, orderAscending?: boolean, orderBy?: string, pathwayId?: string, price?: string, programId?: string, programType?: Array<string>, promotion?: Array<string>, query?: string, recommended?: boolean, resourceId?: string, resourceType?: Array<string>, returnFacet?: boolean, returnItems?: boolean, roleId?: string, selfPaced?: Array<string>, skillId?: string, skills?: Array<string>, subject?: Array<string>, tags?: Array<string>, tenant?: Array<string>, topics?: Array<string>, updateFacet?: string): CancelablePromise<Record<string, any>>;
+    static searchPersonalizedCatalogRetrieve({ username, allowSkillSearch, alphabetical, certificate, content, courseId, duration, language, level, limit, offset, orderAscending, orderBy, pathwayId, price, programId, programType, promotion, query, recommended, resourceId, resourceType, returnFacet, returnItems, roleId, selfPaced, skillId, skills, subject, tags, tenant, topics, updateFacet, }: {
+        username: string;
+        /**
+         * Enable skill-based search
+         */
+        allowSkillSearch?: boolean;
+        /**
+         * Sort alphabetically by name
+         */
+        alphabetical?: boolean;
+        /**
+         * Filter by certificate type
+         */
+        certificate?: Array<string>;
+        /**
+         * Content types to include in results
+         */
+        content?: Array<string>;
+        /**
+         * Retrieve a specific course by ID
+         */
+        courseId?: string;
+        /**
+         * Filter by course duration range
+         */
+        duration?: Array<string>;
+        /**
+         * Filter by content language
+         */
+        language?: Array<string>;
+        /**
+         * Filter by difficulty level
+         */
+        level?: Array<string>;
+        /**
+         * Number of results per page
+         */
+        limit?: number;
+        /**
+         * Starting position for pagination
+         */
+        offset?: number;
+        /**
+         * Sort direction
+         */
+        orderAscending?: boolean;
+        /**
+         * Field to sort results by
+         */
+        orderBy?: string;
+        /**
+         * Retrieve a specific pathway by ID
+         */
+        pathwayId?: string;
+        /**
+         * Filter by price/audit status
+         */
+        price?: string;
+        /**
+         * Retrieve a specific program by ID
+         */
+        programId?: string;
+        /**
+         * Filter by program type
+         */
+        programType?: Array<string>;
+        /**
+         * Filter by promotion status
+         */
+        promotion?: Array<string>;
+        /**
+         * Search term to filter content by name or description
+         */
+        query?: string;
+        /**
+         * Show only recommended content
+         */
+        recommended?: boolean;
+        /**
+         * Retrieve a specific resource by ID
+         */
+        resourceId?: string;
+        /**
+         * Filter by resource type
+         */
+        resourceType?: Array<string>;
+        /**
+         * Include facet data in response
+         */
+        returnFacet?: boolean;
+        /**
+         * Include items in programs/pathways
+         */
+        returnItems?: boolean;
+        /**
+         * Retrieve a specific role by ID
+         */
+        roleId?: string;
+        /**
+         * Filter by course format
+         */
+        selfPaced?: Array<string>;
+        /**
+         * Retrieve a specific skill by ID
+         */
+        skillId?: string;
+        /**
+         * Filter by skills
+         */
+        skills?: Array<string>;
+        /**
+         * Filter by subject areas
+         */
+        subject?: Array<string>;
+        /**
+         * Filter by tags
+         */
+        tags?: Array<string>;
+        /**
+         * Filter by tenant/organization
+         */
+        tenant?: Array<string>;
+        /**
+         * Filter by topic areas
+         */
+        topics?: Array<string>;
+        /**
+         * Force facet update
+         */
+        updateFacet?: string;
+    }): CancelablePromise<Record<string, any>>;
     /**
      * Search and filter users within a specific organization/tenant.
      *
@@ -330,23 +515,63 @@ export declare class SearchService {
                                      * - The requesting user must have an active account in the specified organization
                                      * - When department_mode is enabled, the user must be an admin of at least one department
                                      * - Department filtering restricts results to users in departments where the requesting user is an admin
-                                     * @param org
-                                     * @param username
-                                     * @param department Filter by department names
-                                     * @param educationDegree Filter by degree
-                                     * @param educationFieldOfStudy Filter by field of study
-                                     * @param educationInstitution Filter by institution
-                                     * @param includeMembershipData Include user group membership data in results
-                                     * @param limit Number of results per page
-                                     * @param offset Starting position for pagination
-                                     * @param q Search term to filter users by name, email, or other attributes
-                                     * @param userResumeCompany Filter by company
-                                     * @param userResumeIndustry Filter by industry
-                                     * @param userResumeJobTitle Filter by job title
-                                     * @param userResumeLocation Filter by location
-                                     * @param userResumeSkills Filter by skills
                                      * @returns UserSearchResponse
                                      * @throws ApiError
                                      */
-    static searchUsersOrgsUsersRetrieve(org: string, username: string, department?: Array<string>, educationDegree?: string, educationFieldOfStudy?: string, educationInstitution?: string, includeMembershipData?: boolean, limit?: number, offset?: number, q?: string, userResumeCompany?: string, userResumeIndustry?: string, userResumeJobTitle?: string, userResumeLocation?: string, userResumeSkills?: string): CancelablePromise<UserSearchResponse>;
+    static searchUsersOrgsUsersRetrieve({ org, username, department, educationDegree, educationFieldOfStudy, educationInstitution, includeMembershipData, limit, offset, q, userResumeCompany, userResumeIndustry, userResumeJobTitle, userResumeLocation, userResumeSkills, }: {
+        org: string;
+        username: string;
+        /**
+         * Filter by department names
+         */
+        department?: Array<string>;
+        /**
+         * Filter by degree
+         */
+        educationDegree?: string;
+        /**
+         * Filter by field of study
+         */
+        educationFieldOfStudy?: string;
+        /**
+         * Filter by institution
+         */
+        educationInstitution?: string;
+        /**
+         * Include user group membership data in results
+         */
+        includeMembershipData?: boolean;
+        /**
+         * Number of results per page
+         */
+        limit?: number;
+        /**
+         * Starting position for pagination
+         */
+        offset?: number;
+        /**
+         * Search term to filter users by name, email, or other attributes
+         */
+        q?: string;
+        /**
+         * Filter by company
+         */
+        userResumeCompany?: string;
+        /**
+         * Filter by industry
+         */
+        userResumeIndustry?: string;
+        /**
+         * Filter by job title
+         */
+        userResumeJobTitle?: string;
+        /**
+         * Filter by location
+         */
+        userResumeLocation?: string;
+        /**
+         * Filter by skills
+         */
+        userResumeSkills?: string;
+    }): CancelablePromise<UserSearchResponse>;
 }

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

@@ -1,5 +1,7 @@
+import type { StripeBillingPageIdentifierResponse } from '../models/StripeBillingPageIdentifierResponse';
 import type { StripeCheckoutSessionRequest } from '../models/StripeCheckoutSessionRequest';
 import type { StripeCheckoutSessionResponse } from '../models/StripeCheckoutSessionResponse';
+import type { StripeContext } from '../models/StripeContext';
 import type { StripeCustomerPortalRequest } from '../models/StripeCustomerPortalRequest';
 import type { StripeCustomerPortalResponse } from '../models/StripeCustomerPortalResponse';
 import type { StripeLocalProduct } from '../models/StripeLocalProduct';
@@ -24,11 +26,12 @@ export declare class ServiceService {
      * ```
      *
      * 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>;
+    static serviceLaunchTenantCreate({ requestBody, }: {
+        requestBody: TenantLaunchRequest;
+    }): CancelablePromise<TenantLaunchResponse>;
     /**
      * User creation flow
      * @returns any No response body
@@ -56,55 +59,55 @@ export declare class ServiceService {
      * {
          * "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>;
+    static serviceOrgsUsersStripeCheckoutSessionCreate({ org, userId, requestBody, }: {
+        org: 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>;
+    static serviceOrgsUsersStripeCustomerPortalCreate({ org, userId, requestBody, }: {
+        org: 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>;
+    static serviceOrgsUsersStripeProductsRetrieve({ org, userId, }: {
+        org: 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>;
+    static serviceOrgsUsersStripeProductsManageCreate({ org, userId, }: {
+        org: 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>;
+    static serviceOrgsUsersStripeSubscriptionRenewalCreate({ org, userId, requestBody, }: {
+        org: 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>;
+    static serviceOrgsUsersStripeSubscriptionsRetrieve({ org, userId, }: {
+        org: string;
+    }): CancelablePromise<any>;
     /**
      * Handle course payment callback after successful Stripe checkout.
      * Enrolls the user in the purchased course.
@@ -117,17 +120,73 @@ export declare class ServiceService {
      * - 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>;
+    static serviceOrgsStripeCoursePaymentCallbackRetrieve({ platformKey, }: {
+        platformKey: string;
+    }): CancelablePromise<any>;
+    /**
+     * Create a uuid to help us track internally user initiated checkout
+     * @returns StripeContext
+     * @throws ApiError
+     */
+    static servicePlatformsStripeContextRetrieve({ platformKey, }: {
+        platformKey: string;
+    }): CancelablePromise<StripeContext>;
+    /**
+     * Handle  callback after successful Stripe checkout for credit top up.
+     * Redirects user to another page, ensures user credit is updated accordingly.
+     *
+     * URL Parameters:
+     * - stripe_checkout_id: The Checkout Session UUID
+     *
+     * Response:
+     * - Redirect: Successfully validated and sending to next page
+     * - 404: Checkout session not found
+     * - 400: Invalid checkout session or product
+     * - 500: Server error during processing
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static servicePlatformsStripeCreditTopupCallbackRetrieve({ checkoutSessionId, platformKey, }: {
+        checkoutSessionId: string;
+        platformKey: string;
+    }): CancelablePromise<any>;
+    /**
+     * Handle  callback after successful Stripe checkout.
+     * Redirects user to another page, ensures user subscription is updated accordingly.
+     *
+     * URL Parameters:
+     * - stripe_checkout_id: The local Checkout Session UUID
+     *
+     * Response:
+     * - Redirect: Successfully validated and sending to next page
+     * - 404: Checkout session not found
+     * - 400: Invalid checkout session or product
+     * - 500: Server error during processing
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static servicePlatformsStripePricingPageCallbackRetrieve({ checkoutSessionId, platformKey, }: {
+        checkoutSessionId: string;
+        platformKey: string;
+    }): CancelablePromise<any>;
+    /**
+     * Create a uuid to help us track internally user initiated checkout
+     * @returns StripeBillingPageIdentifierResponse
+     * @throws ApiError
+     */
+    static servicePlatformsStripePricingPageSessionRetrieve({ platformKey, }: {
+        platformKey: string;
+    }): CancelablePromise<StripeBillingPageIdentifierResponse>;
     /**
-     * @param checkoutUuid
      * @returns any No response body
      * @throws ApiError
      */
-    static serviceStripeCheckoutRetrieve(checkoutUuid: string): CancelablePromise<any>;
+    static serviceStripeCheckoutRetrieve({ checkoutUuid, }: {
+        checkoutUuid: string;
+    }): CancelablePromise<any>;
     /**
      * Stripe free trial checkout session. No user auth
      *
@@ -141,11 +200,12 @@ export declare class ServiceService {
      * {
          * "redirect_to": "https://checkout.stripe.com/xxx/xxxx/xxxx",
          * }
-         * @param requestBody
          * @returns StripeCheckoutSessionResponse
          * @throws ApiError
          */
-    static serviceStripeCheckoutFreeTrialCreate(requestBody: StripeCheckoutSessionResponse): CancelablePromise<StripeCheckoutSessionResponse>;
+    static serviceStripeCheckoutFreeTrialCreate({ requestBody, }: {
+        requestBody: StripeCheckoutSessionResponse;
+    }): CancelablePromise<StripeCheckoutSessionResponse>;
     /**
      * Check if tenant exists or not
      * @returns any No response body