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

package/src/services/ServiceService.ts

@@ -2,8 +2,10 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
+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';
@@ -30,13 +32,14 @@ export 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
      */
-    public static serviceLaunchTenantCreate(
+    public static serviceLaunchTenantCreate({
+        requestBody,
+    }: {
         requestBody: TenantLaunchRequest,
-    ): CancelablePromise<TenantLaunchResponse> {
+    }): CancelablePromise<TenantLaunchResponse> {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/api/service/launch/tenant/',
@@ -81,17 +84,18 @@ export class ServiceService {
      * {
          * "redirect_to": "https://checkout.stripe.com/xxx/xxxx/xxxx",
          * }
-         * @param org
-         * @param userId
-         * @param requestBody
          * @returns StripeCheckoutSessionResponse
          * @throws ApiError
          */
-        public static serviceOrgsUsersStripeCheckoutSessionCreate(
+        public static serviceOrgsUsersStripeCheckoutSessionCreate({
+            org,
+            userId,
+            requestBody,
+        }: {
             org: string,
             userId: string,
             requestBody: StripeCheckoutSessionRequest,
-        ): CancelablePromise<StripeCheckoutSessionResponse> {
+        }): CancelablePromise<StripeCheckoutSessionResponse> {
             return __request(OpenAPI, {
                 method: 'POST',
                 url: '/api/service/orgs/{org}/users/{user_id}/stripe/checkout-session/',
@@ -105,17 +109,18 @@ export class ServiceService {
         }
         /**
          * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-         * @param org
-         * @param userId
-         * @param requestBody
          * @returns StripeCustomerPortalResponse
          * @throws ApiError
          */
-        public static serviceOrgsUsersStripeCustomerPortalCreate(
+        public static serviceOrgsUsersStripeCustomerPortalCreate({
+            org,
+            userId,
+            requestBody,
+        }: {
             org: string,
             userId: string,
             requestBody: StripeCustomerPortalRequest,
-        ): CancelablePromise<StripeCustomerPortalResponse> {
+        }): CancelablePromise<StripeCustomerPortalResponse> {
             return __request(OpenAPI, {
                 method: 'POST',
                 url: '/api/service/orgs/{org}/users/{user_id}/stripe/customer-portal/',
@@ -129,15 +134,16 @@ export class ServiceService {
         }
         /**
          * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-         * @param org
-         * @param userId
          * @returns StripeLocalProduct
          * @throws ApiError
          */
-        public static serviceOrgsUsersStripeProductsRetrieve(
+        public static serviceOrgsUsersStripeProductsRetrieve({
+            org,
+            userId,
+        }: {
             org: string,
             userId: string,
-        ): CancelablePromise<StripeLocalProduct> {
+        }): CancelablePromise<StripeLocalProduct> {
             return __request(OpenAPI, {
                 method: 'GET',
                 url: '/api/service/orgs/{org}/users/{user_id}/stripe/products/',
@@ -149,15 +155,16 @@ export class ServiceService {
         }
         /**
          * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-         * @param org
-         * @param userId
          * @returns any No response body
          * @throws ApiError
          */
-        public static serviceOrgsUsersStripeProductsManageCreate(
+        public static serviceOrgsUsersStripeProductsManageCreate({
+            org,
+            userId,
+        }: {
             org: string,
             userId: string,
-        ): CancelablePromise<any> {
+        }): CancelablePromise<any> {
             return __request(OpenAPI, {
                 method: 'POST',
                 url: '/api/service/orgs/{org}/users/{user_id}/stripe/products/manage/',
@@ -169,17 +176,18 @@ export class ServiceService {
         }
         /**
          * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-         * @param org
-         * @param userId
-         * @param requestBody
          * @returns StripeSubscriptionRenewalResponse
          * @throws ApiError
          */
-        public static serviceOrgsUsersStripeSubscriptionRenewalCreate(
+        public static serviceOrgsUsersStripeSubscriptionRenewalCreate({
+            org,
+            userId,
+            requestBody,
+        }: {
             org: string,
             userId: string,
             requestBody: StripeSubscriptionRenewalRequest,
-        ): CancelablePromise<StripeSubscriptionRenewalResponse> {
+        }): CancelablePromise<StripeSubscriptionRenewalResponse> {
             return __request(OpenAPI, {
                 method: 'POST',
                 url: '/api/service/orgs/{org}/users/{user_id}/stripe/subscription-renewal/',
@@ -193,15 +201,16 @@ export class ServiceService {
         }
         /**
          * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-         * @param org
-         * @param userId
          * @returns any No response body
          * @throws ApiError
          */
-        public static serviceOrgsUsersStripeSubscriptionsRetrieve(
+        public static serviceOrgsUsersStripeSubscriptionsRetrieve({
+            org,
+            userId,
+        }: {
             org: string,
             userId: string,
-        ): CancelablePromise<any> {
+        }): CancelablePromise<any> {
             return __request(OpenAPI, {
                 method: 'GET',
                 url: '/api/service/orgs/{org}/users/{user_id}/stripe/subscriptions/',
@@ -223,13 +232,14 @@ export 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
          */
-        public static serviceOrgsStripeCoursePaymentCallbackRetrieve(
+        public static serviceOrgsStripeCoursePaymentCallbackRetrieve({
+            platformKey,
+        }: {
             platformKey: string,
-        ): CancelablePromise<any> {
+        }): CancelablePromise<any> {
             return __request(OpenAPI, {
                 method: 'GET',
                 url: '/api/service/orgs/{platform_key}/stripe/course-payment-callback/',
@@ -239,13 +249,112 @@ export class ServiceService {
             });
         }
         /**
-         * @param checkoutUuid
+         * Create a uuid to help us track internally user initiated checkout
+         * @returns StripeContext
+         * @throws ApiError
+         */
+        public static servicePlatformsStripeContextRetrieve({
+            platformKey,
+        }: {
+            platformKey: string,
+        }): CancelablePromise<StripeContext> {
+            return __request(OpenAPI, {
+                method: 'GET',
+                url: '/api/service/platforms/{platform_key}/stripe/context/',
+                path: {
+                    'platform_key': platformKey,
+                },
+            });
+        }
+        /**
+         * 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
+         */
+        public static servicePlatformsStripeCreditTopupCallbackRetrieve({
+            checkoutSessionId,
+            platformKey,
+        }: {
+            checkoutSessionId: string,
+            platformKey: string,
+        }): CancelablePromise<any> {
+            return __request(OpenAPI, {
+                method: 'GET',
+                url: '/api/service/platforms/{platform_key}/stripe/credit-topup-callback/{checkout_session_id}/',
+                path: {
+                    'checkout_session_id': checkoutSessionId,
+                    'platform_key': platformKey,
+                },
+            });
+        }
+        /**
+         * 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
+         */
+        public static servicePlatformsStripePricingPageCallbackRetrieve({
+            checkoutSessionId,
+            platformKey,
+        }: {
+            checkoutSessionId: string,
+            platformKey: string,
+        }): CancelablePromise<any> {
+            return __request(OpenAPI, {
+                method: 'GET',
+                url: '/api/service/platforms/{platform_key}/stripe/pricing-page-callback/{checkout_session_id}/',
+                path: {
+                    'checkout_session_id': checkoutSessionId,
+                    'platform_key': platformKey,
+                },
+            });
+        }
+        /**
+         * Create a uuid to help us track internally user initiated checkout
+         * @returns StripeBillingPageIdentifierResponse
+         * @throws ApiError
+         */
+        public static servicePlatformsStripePricingPageSessionRetrieve({
+            platformKey,
+        }: {
+            platformKey: string,
+        }): CancelablePromise<StripeBillingPageIdentifierResponse> {
+            return __request(OpenAPI, {
+                method: 'GET',
+                url: '/api/service/platforms/{platform_key}/stripe/pricing-page-session/',
+                path: {
+                    'platform_key': platformKey,
+                },
+            });
+        }
+        /**
          * @returns any No response body
          * @throws ApiError
          */
-        public static serviceStripeCheckoutRetrieve(
+        public static serviceStripeCheckoutRetrieve({
+            checkoutUuid,
+        }: {
             checkoutUuid: string,
-        ): CancelablePromise<any> {
+        }): CancelablePromise<any> {
             return __request(OpenAPI, {
                 method: 'GET',
                 url: '/api/service/stripe/checkout/{checkout_uuid}/',
@@ -267,13 +376,14 @@ export class ServiceService {
          * {
              * "redirect_to": "https://checkout.stripe.com/xxx/xxxx/xxxx",
              * }
-             * @param requestBody
              * @returns StripeCheckoutSessionResponse
              * @throws ApiError
              */
-            public static serviceStripeCheckoutFreeTrialCreate(
+            public static serviceStripeCheckoutFreeTrialCreate({
+                requestBody,
+            }: {
                 requestBody: StripeCheckoutSessionResponse,
-            ): CancelablePromise<StripeCheckoutSessionResponse> {
+            }): CancelablePromise<StripeCheckoutSessionResponse> {
                 return __request(OpenAPI, {
                     method: 'POST',
                     url: '/api/service/stripe/checkout/free-trial/',

package/src/services/SkillsService.ts

@@ -30,13 +30,14 @@ export class SkillsService {
      * Access Control:
      * - Platform admins can access this information
      * - All authenticated users can access this information
-     * @param org
      * @returns SkillInfo
      * @throws ApiError
      */
-    public static skillsOrgsSkillsList(
+    public static skillsOrgsSkillsList({
+        org,
+    }: {
         org: string,
-    ): CancelablePromise<Array<SkillInfo>> {
+    }): CancelablePromise<Array<SkillInfo>> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/skills/orgs/{org}/skills',
@@ -64,15 +65,16 @@ export class SkillsService {
      * Access Control:
      * - Platform admins can access this information
      * - All authenticated users can access this information
-     * @param org
-     * @param skillId
      * @returns PointsPercentile
      * @throws ApiError
      */
-    public static skillsOrgsSkillsPercentileRetrieve(
+    public static skillsOrgsSkillsPercentileRetrieve({
+        org,
+        skillId,
+    }: {
         org: string,
         skillId: number,
-    ): CancelablePromise<PointsPercentile> {
+    }): CancelablePromise<PointsPercentile> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/skills/orgs/{org}/skills/{skill_id}/percentile/',
@@ -101,15 +103,16 @@ export class SkillsService {
      * Access Control:
      * - Platform admins can access this information
      * - All authenticated users can access this information
-     * @param org
-     * @param skillName
      * @returns SkillDetail
      * @throws ApiError
      */
-    public static skillsOrgsSkillsRetrieve(
+    public static skillsOrgsSkillsRetrieve({
+        org,
+        skillName,
+    }: {
         org: string,
         skillName: string,
-    ): CancelablePromise<SkillDetail> {
+    }): CancelablePromise<SkillDetail> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/skills/orgs/{org}/skills/{skill_name}/',
@@ -121,13 +124,14 @@ export class SkillsService {
     }
     /**
      * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-     * @param org
      * @returns PointsPercentile
      * @throws ApiError
      */
-    public static skillsOrgsSkillsPercentileList(
+    public static skillsOrgsSkillsPercentileList({
+        org,
+    }: {
         org: string,
-    ): CancelablePromise<Array<PointsPercentile>> {
+    }): CancelablePromise<Array<PointsPercentile>> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/skills/orgs/{org}/skills/percentile/',
@@ -176,13 +180,14 @@ export class SkillsService {
          *
          * Access Control:
          * - Only platform administrators can access this endpoint
-         * @param org
          * @returns SkillThreshold
          * @throws ApiError
          */
-        public static skillsOrgsSkillsThresholdsRetrieve(
+        public static skillsOrgsSkillsThresholdsRetrieve({
+            org,
+        }: {
             org: string,
-        ): CancelablePromise<SkillThreshold> {
+        }): CancelablePromise<SkillThreshold> {
             return __request(OpenAPI, {
                 method: 'GET',
                 url: '/api/skills/orgs/{org}/skills/thresholds/',
@@ -231,15 +236,16 @@ export class SkillsService {
              *
              * Access Control:
              * - Only platform administrators can access this endpoint
-             * @param org
-             * @param requestBody
              * @returns SkillThreshold
              * @throws ApiError
              */
-            public static skillsOrgsSkillsThresholdsCreate(
+            public static skillsOrgsSkillsThresholdsCreate({
+                org,
+                requestBody,
+            }: {
                 org: string,
                 requestBody: SkillThreshold,
-            ): CancelablePromise<SkillThreshold> {
+            }): CancelablePromise<SkillThreshold> {
                 return __request(OpenAPI, {
                     method: 'POST',
                     url: '/api/skills/orgs/{org}/skills/thresholds/',
@@ -290,15 +296,16 @@ export class SkillsService {
                  *
                  * Access Control:
                  * - Only platform administrators can access this endpoint
-                 * @param org
-                 * @param requestBody
                  * @returns SkillThreshold
                  * @throws ApiError
                  */
-                public static skillsOrgsSkillsThresholdsPartialUpdate(
+                public static skillsOrgsSkillsThresholdsPartialUpdate({
+                    org,
+                    requestBody,
+                }: {
                     org: string,
                     requestBody?: PatchedSkillThreshold,
-                ): CancelablePromise<SkillThreshold> {
+                }): CancelablePromise<SkillThreshold> {
                     return __request(OpenAPI, {
                         method: 'PATCH',
                         url: '/api/skills/orgs/{org}/skills/thresholds/',
@@ -349,13 +356,14 @@ export class SkillsService {
                      *
                      * Access Control:
                      * - Only platform administrators can access this endpoint
-                     * @param org
                      * @returns void
                      * @throws ApiError
                      */
-                    public static skillsOrgsSkillsThresholdsDestroy(
+                    public static skillsOrgsSkillsThresholdsDestroy({
+                        org,
+                    }: {
                         org: string,
-                    ): CancelablePromise<void> {
+                    }): CancelablePromise<void> {
                         return __request(OpenAPI, {
                             method: 'DELETE',
                             url: '/api/skills/orgs/{org}/skills/thresholds/',
@@ -387,15 +395,16 @@ export class SkillsService {
                      * 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
                      */
-                    public static skillsOrgsSkillsUsersRetrieve(
+                    public static skillsOrgsSkillsUsersRetrieve({
+                        org,
+                        userId,
+                    }: {
                         org: string,
                         userId: string,
-                    ): CancelablePromise<UserSkill> {
+                    }): CancelablePromise<UserSkill> {
                         return __request(OpenAPI, {
                             method: 'GET',
                             url: '/api/skills/orgs/{org}/skills/users/{user_id}/',
@@ -425,15 +434,16 @@ export class SkillsService {
                      * Access Control:
                      * - Platform admins can access any user's information
                      * - Users can access their own information
-                     * @param org
-                     * @param userId
                      * @returns DesiredSkill
                      * @throws ApiError
                      */
-                    public static skillsOrgsSkillsUsersDesiredSkillsRetrieve(
+                    public static skillsOrgsSkillsUsersDesiredSkillsRetrieve({
+                        org,
+                        userId,
+                    }: {
                         org: string,
                         userId: string,
-                    ): CancelablePromise<DesiredSkill> {
+                    }): CancelablePromise<DesiredSkill> {
                         return __request(OpenAPI, {
                             method: 'GET',
                             url: '/api/skills/orgs/{org}/skills/users/{user_id}/desired-skills/',
@@ -462,15 +472,16 @@ export class SkillsService {
                      * Access Control:
                      * - Platform admins can access any user's information
                      * - Users can access their own information
-                     * @param org
-                     * @param userId
                      * @returns UserSkillPointsPercentile
                      * @throws ApiError
                      */
-                    public static skillsOrgsSkillsUsersPointPercentileRetrieve(
+                    public static skillsOrgsSkillsUsersPointPercentileRetrieve({
+                        org,
+                        userId,
+                    }: {
                         org: string,
                         userId: string,
-                    ): CancelablePromise<UserSkillPointsPercentile> {
+                    }): CancelablePromise<UserSkillPointsPercentile> {
                         return __request(OpenAPI, {
                             method: 'GET',
                             url: '/api/skills/orgs/{org}/skills/users/{user_id}/point-percentile/',
@@ -500,15 +511,16 @@ export class SkillsService {
                      * Access Control:
                      * - Platform admins can access any user's information
                      * - Users can access their own information
-                     * @param org
-                     * @param userId
                      * @returns ReportedSkill
                      * @throws ApiError
                      */
-                    public static skillsOrgsSkillsUsersReportedSkillsRetrieve(
+                    public static skillsOrgsSkillsUsersReportedSkillsRetrieve({
+                        org,
+                        userId,
+                    }: {
                         org: string,
                         userId: string,
-                    ): CancelablePromise<ReportedSkill> {
+                    }): CancelablePromise<ReportedSkill> {
                         return __request(OpenAPI, {
                             method: 'GET',
                             url: '/api/skills/orgs/{org}/skills/users/{user_id}/reported-skills/',

package/src/services/UserGroupsService.ts

@@ -33,39 +33,76 @@ export class UserGroupsService {
      * 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
      */
-    public static userGroupsOrgsRetrieve(
+    public static userGroupsOrgsRetrieve({
+        key,
+        departmentId,
+        endDate,
+        format = 'json',
+        groups,
+        includeMainPlatform = true,
+        isEnrolled,
+        length,
+        location,
+        page,
+        pathway,
+        program,
+        startDate,
+    }: {
         key: string,
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
         departmentId?: number,
+        /**
+         * Filter by learners date_joined. Start date. ISO 8601
+         */
         endDate?: string,
-        format: 'json' = 'json',
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Groups search string. Single string or list of strings. e.g 'sample_group' or `['group', 'another group']`
+         */
         groups?: Array<string>,
-        includeMainPlatform: boolean = true,
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * Filter for users who have at least an enrollment
+         */
         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> {
+    }): CancelablePromise<GroupList> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/user-groups/orgs/{key}/',

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

@@ -1,10 +0,0 @@
-/**
- * Response serializer for BlockSkillPointInfoView GET endpoint.
- * Returns a mapping of skill names/objects to their point values.
- */
-export type BlockSkillPointInfoResponse = {
-    /**
-     * Dictionary mapping skill names/objects to point values. Keys are skill names (or skill objects if get_obj=True)
-     */
-    skill_points: Record<string, number>;
-};

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

@@ -1,11 +0,0 @@
-import type { CourseCompletion } from './CourseCompletion';
-/**
- * Response serializer for CourseCompletionCatalogView GET endpoint.
- * Maps course IDs to their completion information.
- */
-export type CourseCompletionCatalogResponse = {
-    /**
-     * Completion information for each course. Keys are course IDs.
-     */
-    '{course_id}'?: CourseCompletion;
-};