@iblai/iblai-api 3.58.0-core → 3.59.0-ai

package/src/services/{ServiceService.ts → CommerceService.ts}

@@ -2,6 +2,16 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
+import type { AppleSubscriptionStatusRequest } from '../models/AppleSubscriptionStatusRequest';
+import type { AppleSubscriptionStatusView } from '../models/AppleSubscriptionStatusView';
+import type { AppleVerifyTransactionId } from '../models/AppleVerifyTransactionId';
+import type { AssociateAccountResponse } from '../models/AssociateAccountResponse';
+import type { AssociateAppleAccount } from '../models/AssociateAppleAccount';
+import type { AWSTenantLaunchRequest } from '../models/AWSTenantLaunchRequest';
+import type { BaseResponse } from '../models/BaseResponse';
+import type { GCPTenantLaunchRequest } from '../models/GCPTenantLaunchRequest';
+import type { GooglePayAccountResponse } from '../models/GooglePayAccountResponse';
+import type { GooglePayVerifyToken } from '../models/GooglePayVerifyToken';
 import type { StripeBillingPageIdentifierResponse } from '../models/StripeBillingPageIdentifierResponse';
 import type { StripeCheckoutSessionRequest } from '../models/StripeCheckoutSessionRequest';
 import type { StripeCheckoutSessionResponse } from '../models/StripeCheckoutSessionResponse';
@@ -9,14 +19,342 @@ import type { StripeContext } from '../models/StripeContext';
 import type { StripeCustomerPortalRequest } from '../models/StripeCustomerPortalRequest';
 import type { StripeCustomerPortalResponse } from '../models/StripeCustomerPortalResponse';
 import type { StripeLocalProduct } from '../models/StripeLocalProduct';
+import type { StripeNewUserTenantLaunchRequest } from '../models/StripeNewUserTenantLaunchRequest';
 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 { VerifyGCPMarketPlaceRequest } from '../models/VerifyGCPMarketPlaceRequest';
+import type { VerifyGCPMarketPlaceResponse } from '../models/VerifyGCPMarketPlaceResponse';
 import type { CancelablePromise } from '../core/CancelablePromise';
 import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
-export class ServiceService {
+export class CommerceService {
+    /**
+     * Handle callbacks from Stripe after successful checkout.
+     *
+     * Updates:
+     * - Platform launch state
+     * - Association configuration status
+     * @returns any
+     * @throws ApiError
+     */
+    public static providerAssociationStripeCallbackRetrieve({
+        launchId,
+    }: {
+        launchId: string,
+    }): CancelablePromise<{
+        message?: string;
+    }> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/provider-association/stripe/callback/{launch_id}/',
+            path: {
+                'launch_id': launchId,
+            },
+        });
+    }
+    /**
+     * Associate an Apple account with a user known user
+     * @returns AssociateAccountResponse
+     * @throws ApiError
+     */
+    public static providersAppleAssociateAccountCreate({
+        requestBody,
+    }: {
+        requestBody: AssociateAppleAccount,
+    }): CancelablePromise<AssociateAccountResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/providers/apple/associate-account/',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * View to handle apple webhooks
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static providersAppleHookCreate(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/providers/apple/hook/',
+        });
+    }
+    /**
+     * Returns information about a user subscription status
+     * @returns AppleSubscriptionStatusView
+     * @throws ApiError
+     */
+    public static providersAppleSubscriptionStatusCreate({
+        requestBody,
+    }: {
+        requestBody?: AppleSubscriptionStatusRequest,
+    }): CancelablePromise<AppleSubscriptionStatusView> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/providers/apple/subscription-status/',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Checks if a provided transaction_id is valid
+     * @returns BaseResponse
+     * @throws ApiError
+     */
+    public static providersAppleValidateTransactionIdCreate({
+        requestBody,
+    }: {
+        requestBody: AppleVerifyTransactionId,
+    }): CancelablePromise<BaseResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/providers/apple/validate-transaction-id/',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Serves a view that redirects to the AWS marketplace create organization page
+     *
+     * Set CREATE_ORGANIZATION_URL in GlobalConfigurationFetcher to the
+     * URL of the AWS marketplace create organization page
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static providersAwsCreateOrganizationCreate(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/providers/aws/create-organization/',
+        });
+    }
+    /**
+     * API endpoint to get domain setup status
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static providersAwsDomainStatusRetrieve(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/providers/aws/domain-status/',
+        });
+    }
+    /**
+     * Proxy to the Platform launch API
+     *
+     * We cannot expose launching a tenant to an authorized user hence the need for the API
+     *
+     * The API validates the x_amzn_marketplace_token and then proxies the request to the Platform Launch API
+     * @returns TenantLaunchResponse
+     * @throws ApiError
+     */
+    public static providersAwsLaunchTenantCreate({
+        requestBody,
+    }: {
+        requestBody: AWSTenantLaunchRequest,
+    }): CancelablePromise<TenantLaunchResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/providers/aws/launch-tenant/',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * API endpoint to get/update CNAME records for domain setup
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static providersAwsSyncDomainRecordsRetrieve(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/providers/aws/sync-domain-records/',
+        });
+    }
+    /**
+     * API endpoint to get/update CNAME records for domain setup
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static providersAwsSyncDomainRecordsCreate(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/providers/aws/sync-domain-records/',
+        });
+    }
+    /**
+     * Serves a view that redirects to the GCP marketplace create organization page
+     *
+     * Set CREATE_ORGANIZATION_URL in GlobalConfigurationFetcher to the URL of the GCP marketplace create organization
+     * page
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static providersGcpCreateOrganizationCreate(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/providers/gcp/create-organization/',
+        });
+    }
+    /**
+     * Serves a view that redirects to the GCP marketplace create organization page
+     *
+     * Set CREATE_ORGANIZATION_URL in GlobalConfigurationFetcher to the URL of the GCP marketplace create organization
+     * page
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static providersGcpCreateOrganizationCreate2({
+        productId,
+    }: {
+        productId: string,
+    }): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/providers/gcp/create-organization/{product_id}/',
+            path: {
+                'product_id': productId,
+            },
+        });
+    }
+    /**
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static providersGcpHookCreate(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/providers/gcp/hook/',
+        });
+    }
+    /**
+     * Proxy to the Platform launch API
+     *
+     * We cannot expose launching a tenant to an authorized user hence the need for the API
+     *
+     * The API validates the x_gcp_marketplace_token and then proxies the request to the Platform Launc API
+     * @returns TenantLaunchResponse
+     * @throws ApiError
+     */
+    public static providersGcpLaunchTenantCreate({
+        requestBody,
+    }: {
+        requestBody: GCPTenantLaunchRequest,
+    }): CancelablePromise<TenantLaunchResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/providers/gcp/launch-tenant/',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * @returns VerifyGCPMarketPlaceResponse
+     * @throws ApiError
+     */
+    public static providersGcpValidateSignupTokenCreate({
+        requestBody,
+    }: {
+        requestBody: VerifyGCPMarketPlaceRequest,
+    }): CancelablePromise<VerifyGCPMarketPlaceResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/providers/gcp/validate-signup-token/',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Google Allows us to pass an obfuscated account id to be sent to during a subscription purchase
+     * @returns GooglePayAccountResponse
+     * @throws ApiError
+     */
+    public static providersGooglePayGetAccountRetrieve({
+        bundleId,
+    }: {
+        bundleId: string,
+    }): CancelablePromise<GooglePayAccountResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/providers/google-pay/get-account/{bundle_id}',
+            path: {
+                'bundle_id': bundleId,
+            },
+        });
+    }
+    /**
+     * View to handle Google Pay webhooks
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static providersGooglePayHookCreate(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/providers/google-pay/hook/',
+        });
+    }
+    /**
+     * Associate a Google Pay account with a known user
+     * @returns BaseResponse
+     * @throws ApiError
+     */
+    public static providersGooglePayValidateTransactionIdCreate({
+        requestBody,
+    }: {
+        requestBody: GooglePayVerifyToken,
+    }): CancelablePromise<BaseResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/providers/google-pay/validate-transaction-id/',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Proxy to the Platform launch API
+     *
+     * We cannot expose launching a tenant to an unauthorized user hence the need for the API
+     *
+     * The API validates the stripe_checkout_id and then proxies the request to the Platform Launch API
+     * @returns TenantLaunchResponse
+     * @throws ApiError
+     */
+    public static providersStripeCreateOrganizationCreate({
+        requestBody,
+    }: {
+        requestBody: StripeNewUserTenantLaunchRequest,
+    }): CancelablePromise<TenantLaunchResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/providers/stripe/create-organization/',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * POST
+     * Update platform provisioning config
+     *
+     * request body:
+     * {"config_name": "demo_config}
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static provisionCreate({
+        configName,
+    }: {
+        configName: string,
+    }): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/provision/{config_name}/',
+            path: {
+                'config_name': configName,
+            },
+        });
+    }
     /**
      * User/tenant creation API
      *

package/src/services/CoreService.ts

@@ -3,7 +3,9 @@
 /* tslint:disable */
 /* eslint-disable */
 import type { CeleryHeartbeat } from '../models/CeleryHeartbeat';
+import type { DesiredRole } from '../models/DesiredRole';
 import type { EdxSignalReceiverRequest } from '../models/EdxSignalReceiverRequest';
+import type { GroupList } from '../models/GroupList';
 import type { ImageUpload } from '../models/ImageUpload';
 import type { LauncherViewPostRequest } from '../models/LauncherViewPostRequest';
 import type { LtiKey } from '../models/LtiKey';
@@ -24,6 +26,7 @@ import type { RbacPolicy } from '../models/RbacPolicy';
 import type { RbacRole } from '../models/RbacRole';
 import type { RedirectTokenRequest } from '../models/RedirectTokenRequest';
 import type { RedirectTokenResponse } from '../models/RedirectTokenResponse';
+import type { ReportedRole } from '../models/ReportedRole';
 import type { TokenProxyInput } from '../models/TokenProxyInput';
 import type { TokenProxyOutput } from '../models/TokenProxyOutput';
 import type { UserDeleteAPIRequest } from '../models/UserDeleteAPIRequest';
@@ -1885,4 +1888,312 @@ export class CoreService {
                 },
             });
         }
+        /**
+         * Get a list of departments with metrics and filtering options.
+         *
+         * This endpoint provides a paginated list of departments with aggregated metrics
+         * about learner performance, course completions, and skill acquisition.
+         *
+         * 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
+         * departments (list, optional): Filter by department ids
+         * department_id (str, optional): Filter by department id
+         * location (str, optional): Filter by location
+         * is_enrolled (bool, optional): Filter for departments 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 departments with comprehensive metrics.
+         * @returns GroupList
+         * @throws ApiError
+         */
+        public static departmentsOrgsRetrieve({
+            org,
+            departmentId,
+            departments,
+            endDate,
+            format = 'json',
+            includeMainPlatform = true,
+            isEnrolled,
+            length,
+            location,
+            page,
+            pathway,
+            program,
+            startDate,
+        }: {
+            org: string,
+            /**
+             * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+             */
+            departmentId?: number,
+            /**
+             * Departments search string. Single string or list of strings. e.g 'sample_department' or `['department', 'another department']`
+             */
+            departments?: Array<string>,
+            /**
+             * Filter by learners date_joined. Start date. ISO 8601
+             */
+            endDate?: string,
+            /**
+             * Format
+             *
+             * * `json` - json
+             */
+            format?: 'json',
+            /**
+             * Include main platform data
+             */
+            includeMainPlatform?: boolean,
+            /**
+             * Filter for users who have at least an enro;lment
+             */
+            isEnrolled?: boolean | null,
+            /**
+             * Size of data to return
+             */
+            length?: number,
+            /**
+             * Location search string
+             */
+            location?: string,
+            /**
+             * Page offset
+             */
+            page?: number,
+            /**
+             * Pathway string
+             */
+            pathway?: string,
+            /**
+             * Program search string
+             */
+            program?: string,
+            /**
+             * Filter by learners date_joined. Start date. ISO 8601
+             */
+            startDate?: string,
+        }): CancelablePromise<GroupList> {
+            return __request(OpenAPI, {
+                method: 'GET',
+                url: '/api/departments/orgs/{org}/',
+                path: {
+                    'org': org,
+                },
+                query: {
+                    'department_id': departmentId,
+                    'departments': departments,
+                    'end_date': endDate,
+                    'format': format,
+                    'include_main_platform': includeMainPlatform,
+                    'is_enrolled': isEnrolled,
+                    'length': length,
+                    'location': location,
+                    'page': page,
+                    'pathway': pathway,
+                    'program': program,
+                    'start_date': startDate,
+                },
+            });
+        }
+        /**
+         * Retrieve a user's desired role information.
+         *
+         * This endpoint returns the role and skills that a user has indicated
+         * they want to develop or acquire. This represents the user's career
+         * goals and learning objectives.
+         *
+         * Path Parameters:
+         * org (str): The platform/organization identifier
+         * username (str): The username of the user to retrieve role information for
+         *
+         * Returns:
+         * The user's desired role information including:
+         * - Target role title
+         * - Skills needed for the role
+         * - Current progress toward skill acquisition
+         *
+         * Error Responses:
+         * 400 Bad Request: If the user doesn't exist in the platform or has no desired role
+         * 404 Not Found: If the specified platform doesn't exist
+         * @returns DesiredRole
+         * @throws ApiError
+         */
+        public static rolesPlatformOrgsRolesUsersDesiredRolesRetrieve({
+            org,
+            username,
+        }: {
+            org: string,
+            username: string,
+        }): CancelablePromise<DesiredRole> {
+            return __request(OpenAPI, {
+                method: 'GET',
+                url: '/api/roles/platform/orgs/{org}/roles/users/{username}/desired-roles/',
+                path: {
+                    'org': org,
+                    'username': username,
+                },
+            });
+        }
+        /**
+         * Retrieve a user's reported role information.
+         *
+         * This endpoint returns the role and skills that a user has reported
+         * having in their profile. This represents the user's current skills
+         * and professional role.
+         *
+         * Path Parameters:
+         * org (str): The platform/organization identifier
+         * username (str): The username of the user to retrieve role information for
+         *
+         * Returns:
+         * The user's reported role information including:
+         * - Role title
+         * - Skills associated with the role
+         * - Experience level
+         *
+         * Error Responses:
+         * 400 Bad Request: If the user doesn't exist in the platform or has no reported role
+         * 404 Not Found: If the specified platform doesn't exist
+         * @returns ReportedRole
+         * @throws ApiError
+         */
+        public static rolesPlatformOrgsRolesUsersReportedRolesRetrieve({
+            org,
+            username,
+        }: {
+            org: string,
+            username: string,
+        }): CancelablePromise<ReportedRole> {
+            return __request(OpenAPI, {
+                method: 'GET',
+                url: '/api/roles/platform/orgs/{org}/roles/users/{username}/reported-roles/',
+                path: {
+                    'org': org,
+                    'username': username,
+                },
+            });
+        }
+        /**
+         * 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
+         * @returns GroupList
+         * @throws ApiError
+         */
+        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',
+            /**
+             * Groups search string. Single string or list of strings. e.g 'sample_group' or `['group', 'another group']`
+             */
+            groups?: Array<string>,
+            /**
+             * 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> {
+            return __request(OpenAPI, {
+                method: 'GET',
+                url: '/api/user-groups/orgs/{key}/',
+                path: {
+                    'key': key,
+                },
+                query: {
+                    'department_id': departmentId,
+                    'end_date': endDate,
+                    'format': format,
+                    'groups': groups,
+                    'include_main_platform': includeMainPlatform,
+                    'is_enrolled': isEnrolled,
+                    'length': length,
+                    'location': location,
+                    'page': page,
+                    'pathway': pathway,
+                    'program': program,
+                    'start_date': startDate,
+                },
+            });
+        }
     }

package/src/services/{MediaResourcesService.ts → MediaService.ts}

@@ -7,7 +7,7 @@ import type { PatchedMediaResource } from '../models/PatchedMediaResource';
 import type { CancelablePromise } from '../core/CancelablePromise';
 import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
-export class MediaResourcesService {
+export class MediaService {
     /**
      * List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.
      * @returns any Successfully retrieved media resources