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

package/dist/types/services/{ServiceService.d.ts → CommerceService.d.ts}

@@ -1,3 +1,13 @@
+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';
@@ -5,12 +15,188 @@ 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';
-export declare class ServiceService {
+export declare class CommerceService {
+    /**
+     * Handle callbacks from Stripe after successful checkout.
+     *
+     * Updates:
+     * - Platform launch state
+     * - Association configuration status
+     * @returns any
+     * @throws ApiError
+     */
+    static providerAssociationStripeCallbackRetrieve({ launchId, }: {
+        launchId: string;
+    }): CancelablePromise<{
+        message?: string;
+    }>;
+    /**
+     * Associate an Apple account with a user known user
+     * @returns AssociateAccountResponse
+     * @throws ApiError
+     */
+    static providersAppleAssociateAccountCreate({ requestBody, }: {
+        requestBody: AssociateAppleAccount;
+    }): CancelablePromise<AssociateAccountResponse>;
+    /**
+     * View to handle apple webhooks
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static providersAppleHookCreate(): CancelablePromise<any>;
+    /**
+     * Returns information about a user subscription status
+     * @returns AppleSubscriptionStatusView
+     * @throws ApiError
+     */
+    static providersAppleSubscriptionStatusCreate({ requestBody, }: {
+        requestBody?: AppleSubscriptionStatusRequest;
+    }): CancelablePromise<AppleSubscriptionStatusView>;
+    /**
+     * Checks if a provided transaction_id is valid
+     * @returns BaseResponse
+     * @throws ApiError
+     */
+    static providersAppleValidateTransactionIdCreate({ requestBody, }: {
+        requestBody: AppleVerifyTransactionId;
+    }): CancelablePromise<BaseResponse>;
+    /**
+     * 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
+     */
+    static providersAwsCreateOrganizationCreate(): CancelablePromise<any>;
+    /**
+     * API endpoint to get domain setup status
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static providersAwsDomainStatusRetrieve(): CancelablePromise<any>;
+    /**
+     * 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
+     */
+    static providersAwsLaunchTenantCreate({ requestBody, }: {
+        requestBody: AWSTenantLaunchRequest;
+    }): CancelablePromise<TenantLaunchResponse>;
+    /**
+     * API endpoint to get/update CNAME records for domain setup
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static providersAwsSyncDomainRecordsRetrieve(): CancelablePromise<any>;
+    /**
+     * API endpoint to get/update CNAME records for domain setup
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static providersAwsSyncDomainRecordsCreate(): CancelablePromise<any>;
+    /**
+     * 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
+     */
+    static providersGcpCreateOrganizationCreate(): CancelablePromise<any>;
+    /**
+     * 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
+     */
+    static providersGcpCreateOrganizationCreate2({ productId, }: {
+        productId: string;
+    }): CancelablePromise<any>;
+    /**
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static providersGcpHookCreate(): CancelablePromise<any>;
+    /**
+     * 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
+     */
+    static providersGcpLaunchTenantCreate({ requestBody, }: {
+        requestBody: GCPTenantLaunchRequest;
+    }): CancelablePromise<TenantLaunchResponse>;
+    /**
+     * @returns VerifyGCPMarketPlaceResponse
+     * @throws ApiError
+     */
+    static providersGcpValidateSignupTokenCreate({ requestBody, }: {
+        requestBody: VerifyGCPMarketPlaceRequest;
+    }): CancelablePromise<VerifyGCPMarketPlaceResponse>;
+    /**
+     * Google Allows us to pass an obfuscated account id to be sent to during a subscription purchase
+     * @returns GooglePayAccountResponse
+     * @throws ApiError
+     */
+    static providersGooglePayGetAccountRetrieve({ bundleId, }: {
+        bundleId: string;
+    }): CancelablePromise<GooglePayAccountResponse>;
+    /**
+     * View to handle Google Pay webhooks
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static providersGooglePayHookCreate(): CancelablePromise<any>;
+    /**
+     * Associate a Google Pay account with a known user
+     * @returns BaseResponse
+     * @throws ApiError
+     */
+    static providersGooglePayValidateTransactionIdCreate({ requestBody, }: {
+        requestBody: GooglePayVerifyToken;
+    }): CancelablePromise<BaseResponse>;
+    /**
+     * 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
+     */
+    static providersStripeCreateOrganizationCreate({ requestBody, }: {
+        requestBody: StripeNewUserTenantLaunchRequest;
+    }): CancelablePromise<TenantLaunchResponse>;
+    /**
+     * POST
+     * Update platform provisioning config
+     *
+     * request body:
+     * {"config_name": "demo_config}
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static provisionCreate({ configName, }: {
+        configName: string;
+    }): CancelablePromise<any>;
     /**
      * User/tenant creation API
      *

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

@@ -1,5 +1,7 @@
 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';
@@ -20,6 +22,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';
@@ -961,4 +964,216 @@ export declare class CoreService {
         query?: string;
         sort?: string;
     }): CancelablePromise<UserSearchViewGetResponse>;
+    /**
+     * 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
+     */
+    static departmentsOrgsRetrieve({ org, departmentId, departments, endDate, format, includeMainPlatform, 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>;
+    /**
+     * 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
+     */
+    static rolesPlatformOrgsRolesUsersDesiredRolesRetrieve({ org, username, }: {
+        org: string;
+        username: string;
+    }): CancelablePromise<DesiredRole>;
+    /**
+     * 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
+     */
+    static rolesPlatformOrgsRolesUsersReportedRolesRetrieve({ org, username, }: {
+        org: string;
+        username: string;
+    }): CancelablePromise<ReportedRole>;
+    /**
+     * 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
+     */
+    static userGroupsOrgsRetrieve({ key, departmentId, endDate, format, groups, includeMainPlatform, 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>;
 }

package/dist/types/services/{MediaResourcesService.d.ts → MediaService.d.ts}

@@ -1,7 +1,7 @@
 import type { MediaResource } from '../models/MediaResource';
 import type { PatchedMediaResource } from '../models/PatchedMediaResource';
 import type { CancelablePromise } from '../core/CancelablePromise';
-export declare class MediaResourcesService {
+export declare 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

package/dist/types/services/{NotificationService.d.ts → NotificationsService.d.ts}

@@ -1,12 +1,20 @@
 import type { CampaignEnablement } from '../models/CampaignEnablement';
 import type { CampaignExclusion } from '../models/CampaignExclusion';
+import type { ContextResponse } from '../models/ContextResponse';
 import type { MarkAllReadRequest } from '../models/MarkAllReadRequest';
 import type { MarkAllReadResponse } from '../models/MarkAllReadResponse';
 import type { Notification } from '../models/Notification';
 import type { NotificationCount } from '../models/NotificationCount';
+import type { NotificationPreview } from '../models/NotificationPreview';
+import type { NotificationSource } from '../models/NotificationSource';
 import type { PatchedNotification } from '../models/PatchedNotification';
+import type { PreviewResponse } from '../models/PreviewResponse';
+import type { Recipient } from '../models/Recipient';
+import type { SendNotification } from '../models/SendNotification';
+import type { SendResponse } from '../models/SendResponse';
+import type { ValidateSourceResponse } from '../models/ValidateSourceResponse';
 import type { CancelablePromise } from '../core/CancelablePromise';
-export declare class NotificationService {
+export declare class NotificationsService {
     /**
      * Unsubscribe from a campaign using a hash
      * @returns any
@@ -132,4 +140,65 @@ export declare class NotificationService {
         platformKey: string;
         requestBody?: MarkAllReadRequest;
     }): CancelablePromise<MarkAllReadResponse>;
+    /**
+     * Get build recipients
+     * Get paginated list of recipients for a notification build
+     * @returns Recipient
+     * @throws ApiError
+     */
+    static notificationV1OrgsNotificationBuilderRecipientsList({ id, platformKey, page, pageSize, search, }: {
+        id: string;
+        platformKey: string;
+        /**
+         * Page number
+         */
+        page?: number;
+        /**
+         * Number of items per page
+         */
+        pageSize?: number;
+        /**
+         * Search recipients by username or email
+         */
+        search?: string;
+    }): CancelablePromise<Array<Recipient>>;
+    /**
+     * Get notification context data
+     * Get all context data needed for notification building including templates, channels, and platforms
+     * @returns ContextResponse
+     * @throws ApiError
+     */
+    static notificationV1OrgsNotificationBuilderContextRetrieve({ platformKey, }: {
+        platformKey: string;
+    }): CancelablePromise<ContextResponse>;
+    /**
+     * Preview notification
+     * Preview notification recipients and get build ID for sending
+     * @returns PreviewResponse
+     * @throws ApiError
+     */
+    static notificationV1OrgsNotificationBuilderPreviewCreate({ platformKey, requestBody, }: {
+        platformKey: string;
+        requestBody: NotificationPreview;
+    }): CancelablePromise<PreviewResponse>;
+    /**
+     * Send notification
+     * Send notifications to all recipients in a build
+     * @returns SendResponse
+     * @throws ApiError
+     */
+    static notificationV1OrgsNotificationBuilderSendCreate({ platformKey, requestBody, }: {
+        platformKey: string;
+        requestBody: SendNotification;
+    }): CancelablePromise<SendResponse>;
+    /**
+     * Validate notification source
+     * Validate a single notification source (email, username, platform, csv)
+     * @returns ValidateSourceResponse
+     * @throws ApiError
+     */
+    static notificationV1OrgsNotificationBuilderValidateSourceCreate({ platformKey, requestBody, }: {
+        platformKey: string;
+        requestBody: NotificationSource;
+    }): CancelablePromise<ValidateSourceResponse>;
 }

package/dist/types/services/{OrgsService.d.ts → ScimService.d.ts}

@@ -1,5 +1,5 @@
 import type { CancelablePromise } from '../core/CancelablePromise';
-export declare class OrgsService {
+export declare class ScimService {
     /**
      * GET /scim/v2/DepartmentMembers
      * List all department members in the system.