@iblai/iblai-api 0.0.1-core

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

@@ -0,0 +1,638 @@
+import type { CeleryHeartbeat } from '../models/CeleryHeartbeat';
+import type { EdxSignalReceiverRequest } from '../models/EdxSignalReceiverRequest';
+import type { ImageUpload } from '../models/ImageUpload';
+import type { LauncherViewPostRequest } from '../models/LauncherViewPostRequest';
+import type { LtiKey } from '../models/LtiKey';
+import type { LtiTool } from '../models/LtiTool';
+import type { PatchedPlatformPublicMetadata } from '../models/PatchedPlatformPublicMetadata';
+import type { PlatformApiKey } from '../models/PlatformApiKey';
+import type { PlatformList } from '../models/PlatformList';
+import type { PlatformPublicMetadata } from '../models/PlatformPublicMetadata';
+import type { PlatformUpdatePostRequest } from '../models/PlatformUpdatePostRequest';
+import type { RedirectTokenRequest } from '../models/RedirectTokenRequest';
+import type { RedirectTokenResponse } from '../models/RedirectTokenResponse';
+import type { TokenProxyInput } from '../models/TokenProxyInput';
+import type { TokenProxyOutput } from '../models/TokenProxyOutput';
+import type { UserDeleteAPIRequest } from '../models/UserDeleteAPIRequest';
+import type { UserDeleteAPIResponse } from '../models/UserDeleteAPIResponse';
+import type { UserPlatformLink } from '../models/UserPlatformLink';
+import type { UserPlatformManagementListViewGetResponse } from '../models/UserPlatformManagementListViewGetResponse';
+import type { UserPlatformViewPostRequest } from '../models/UserPlatformViewPostRequest';
+import type { UserProxyBulkRequest } from '../models/UserProxyBulkRequest';
+import type { UserProxyGetResponse } from '../models/UserProxyGetResponse';
+import type { UserProxyPostRequest } from '../models/UserProxyPostRequest';
+import type { UserProxyPostResponse } from '../models/UserProxyPostResponse';
+import type { UserSearchViewGetResponse } from '../models/UserSearchViewGetResponse';
+import type { WhitelistedDomain } from '../models/WhitelistedDomain';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class CoreService {
+    /**
+     * Create DM and AXD Tokens for user and platform_key
+     *
+     * Params:
+     * - Any of user_id, username, or email (choose one only, required)
+     * - platform_key: str (required)
+     * @param requestBody
+     * @returns TokenProxyOutput
+     * @throws ApiError
+     */
+    static coreConsolidatedTokenProxyCreate(requestBody: TokenProxyInput): CancelablePromise<TokenProxyOutput>;
+    /**
+     * Show (active) departments associated with a platform
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreDepartmentsRetrieve(): CancelablePromise<any>;
+    /**
+     * Create/update a department
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreDepartmentsCreate(): CancelablePromise<any>;
+    /**
+     * Delete department
+     * @returns void
+     * @throws ApiError
+     */
+    static coreDepartmentsDestroy(): CancelablePromise<void>;
+    /**
+     * Show active users in department (paginated)
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreDepartmentsMembersRetrieve(): CancelablePromise<any>;
+    /**
+     * Add single user to department, or update status
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreDepartmentsMembersCreate(): CancelablePromise<any>;
+    /**
+     * Delete department member
+     * @returns void
+     * @throws ApiError
+     */
+    static coreDepartmentsMembersDestroy(): CancelablePromise<void>;
+    /**
+     * Add users to department, or update status
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreDepartmentsMembersBulkCreate(): CancelablePromise<any>;
+    /**
+     * Get department member admin info of requesting user
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreDepartmentsMembersCheckRetrieve(): CancelablePromise<any>;
+    /**
+     * Check if a domain is whitelisted
+     * @param url
+     * @param isActive
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreDomainsWhitelistRetrieve(url: string, isActive?: boolean): CancelablePromise<any>;
+    /**
+     * Add a new domain to whitelist
+     * @param requestBody
+     * @returns WhitelistedDomain
+     * @throws ApiError
+     */
+    static coreDomainsWhitelistCreate(requestBody: WhitelistedDomain): CancelablePromise<WhitelistedDomain>;
+    /**
+     * **Use Case**
+     *
+     * Celery heartbeat endpoint.
+     *
+     * **Example Request**
+     *
+     * GET /api/core/heartbeat/celery/
+     *
+     * **Response Values**
+     *
+     * * 200 on success.
+     * * 500 on failure.
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreHeartbeatCeleryRetrieve(): CancelablePromise<any>;
+    /**
+     * **Use Case**
+     *
+     * Celery Beat heartbeat endpoint.
+     *
+     * **Example Request**
+     *
+     * GET /api/core/heartbeat/celery-beat/
+     *
+     * **Response Values**
+     *
+     * * 200 on success.
+     * * 500 on failure.
+     * @returns CeleryHeartbeat
+     * @throws ApiError
+     */
+    static coreHeartbeatCeleryBeatRetrieve(): CancelablePromise<CeleryHeartbeat>;
+    /**
+     * GET Launch status
+     *
+     * Params:
+     * key
+     * user_id: Optional
+     * @param key
+     * @param userId
+     * @returns PlatformList
+     * @throws ApiError
+     */
+    static coreLauncherRetrieve(key: string, userId?: number): CancelablePromise<PlatformList>;
+    /**
+     * POST: Launch a new edX platform
+     *
+     * Params:
+     * user_id: The ID of the requesting user (required)
+     * key: The Deep LMS subdomain (required)
+     * name: The edX platform name ("optional")
+     * org: The edX organization ("optional")
+     * lms_url: LMS URL ("optional")
+     * cms_url: CMS URL ("optional")
+     * portal_url: Portal URL ("optional")
+     * @param requestBody
+     * @returns PlatformList
+     * @throws ApiError
+     */
+    static coreLauncherCreate(requestBody: LauncherViewPostRequest): CancelablePromise<PlatformList>;
+    /**
+     * List your LTI Provider Key's
+     * @param platformKey Platform Key
+     * @returns LtiKey
+     * @throws ApiError
+     */
+    static coreLti1P3ProviderLtiKeysList(platformKey: string): CancelablePromise<Array<LtiKey>>;
+    /**
+     * Create a new LTI Provider Key
+     * @param requestBody
+     * @returns LtiKey
+     * @throws ApiError
+     */
+    static coreLti1P3ProviderLtiKeysCreate(requestBody: LtiKey): CancelablePromise<LtiKey>;
+    /**
+     * Get details about a specific LTI Provider Key
+     * @param id
+     * @param platformKey Platform Key
+     * @returns LtiKey
+     * @throws ApiError
+     */
+    static coreLti1P3ProviderLtiKeysRetrieve(id: string, platformKey: string): CancelablePromise<LtiKey>;
+    /**
+     * Update an LTI Provider Key
+     * @param id
+     * @param requestBody
+     * @returns LtiKey
+     * @throws ApiError
+     */
+    static coreLti1P3ProviderLtiKeysUpdate(id: string, requestBody: LtiKey): CancelablePromise<LtiKey>;
+    /**
+     * Delete an LTI Provider Key
+     *
+     * **DANGER:** Deleting a key will also delete all Tools that reference that Key. If you need to delete a Key you should first create a new one and update all Tools to reference the new Key before deleting the old one.
+     * @param id
+     * @param platformKey Platform Key
+     * @returns void
+     * @throws ApiError
+     */
+    static coreLti1P3ProviderLtiKeysDestroy(id: string, platformKey: string): CancelablePromise<void>;
+    /**
+     * List your LTI Tool's
+     * @param platformKey Platform Key
+     * @returns LtiTool
+     * @throws ApiError
+     */
+    static coreLti1P3ProviderLtiToolsList(platformKey: string): CancelablePromise<Array<LtiTool>>;
+    /**
+     * Create a new LTI Tool
+     * @param requestBody
+     * @returns LtiTool
+     * @throws ApiError
+     */
+    static coreLti1P3ProviderLtiToolsCreate(requestBody: LtiTool): CancelablePromise<LtiTool>;
+    /**
+     * Get details about a specific LTI Tool
+     * @param id
+     * @param platformKey Platform Key
+     * @returns LtiTool
+     * @throws ApiError
+     */
+    static coreLti1P3ProviderLtiToolsRetrieve(id: string, platformKey: string): CancelablePromise<LtiTool>;
+    /**
+     * Update an LTI Tool
+     * @param id
+     * @param requestBody
+     * @returns LtiTool
+     * @throws ApiError
+     */
+    static coreLti1P3ProviderLtiToolsUpdate(id: string, requestBody: LtiTool): CancelablePromise<LtiTool>;
+    /**
+     * Delete an LTI Tool
+     * @param id
+     * @param platformKey Platform Key
+     * @returns void
+     * @throws ApiError
+     */
+    static coreLti1P3ProviderLtiToolsDestroy(id: string, platformKey: string): CancelablePromise<void>;
+    /**
+     * Get platform logo
+     * @param org
+     * @returns any
+     * @throws ApiError
+     */
+    static coreOrgsDarkModeLogoRetrieve(org: string): CancelablePromise<Record<string, any>>;
+    /**
+     * Upload a new platform logo
+     * @param org
+     * @param requestBody
+     * @returns ImageUpload
+     * @throws ApiError
+     */
+    static coreOrgsDarkModeLogoCreateCreate(org: string, requestBody: ImageUpload): CancelablePromise<ImageUpload>;
+    /**
+     * Get platform logo
+     * @param org
+     * @returns any
+     * @throws ApiError
+     */
+    static coreOrgsFaviconRetrieve(org: string): CancelablePromise<Record<string, any>>;
+    /**
+     * Upload a new platform logo
+     * @param org
+     * @param requestBody
+     * @returns ImageUpload
+     * @throws ApiError
+     */
+    static coreOrgsFaviconCreateCreate(org: string, requestBody: ImageUpload): CancelablePromise<ImageUpload>;
+    /**
+     * Get platform logo
+     * @param org
+     * @returns any
+     * @throws ApiError
+     */
+    static coreOrgsLogoRetrieve(org: string): CancelablePromise<Record<string, any>>;
+    /**
+     * Upload a new platform logo
+     * @param org
+     * @param requestBody
+     * @returns ImageUpload
+     * @throws ApiError
+     */
+    static coreOrgsLogoCreateCreate(org: string, requestBody: ImageUpload): CancelablePromise<ImageUpload>;
+    /**
+     * @param org
+     * @returns PlatformPublicMetadata
+     * @throws ApiError
+     */
+    static coreOrgsMetadataRetrieve(org: string): CancelablePromise<PlatformPublicMetadata>;
+    /**
+     * @param org
+     * @param requestBody
+     * @returns PlatformPublicMetadata
+     * @throws ApiError
+     */
+    static coreOrgsMetadataUpdate(org: string, requestBody?: PlatformPublicMetadata): CancelablePromise<PlatformPublicMetadata>;
+    /**
+     * @param org
+     * @param requestBody
+     * @returns PlatformPublicMetadata
+     * @throws ApiError
+     */
+    static coreOrgsMetadataPartialUpdate(org: string, requestBody?: PatchedPlatformPublicMetadata): CancelablePromise<PlatformPublicMetadata>;
+    /**
+     * Creates redirect tokens for a URL specified by for a platform
+     * @param org
+     * @param requestBody
+     * @returns RedirectTokenResponse
+     * @throws ApiError
+     */
+    static coreOrgsRedirectTokensCreate(org: string, requestBody: RedirectTokenRequest): CancelablePromise<RedirectTokenResponse>;
+    /**
+     * Returns Redirect URL for the token specified.
+     *
+     * ```
+     * Requires user to be a member of the platform with the token passed
+     * ```
+     * @param org
+     * @param redirectToken
+     * @returns RedirectTokenResponse
+     * @throws ApiError
+     */
+    static coreOrgsRedirectTokensRetrieve(org: string, redirectToken: string): CancelablePromise<RedirectTokenResponse>;
+    /**
+     * Delete specific token
+     * @param org
+     * @param redirectToken
+     * @returns void
+     * @throws ApiError
+     */
+    static coreOrgsRedirectTokensDeleteDestroy(org: string, redirectToken: string): CancelablePromise<void>;
+    /**
+     * Get platform logo
+     * @param org
+     * @returns any
+     * @throws ApiError
+     */
+    static coreOrgsThumbnailRetrieve(org: string): CancelablePromise<Record<string, any>>;
+    /**
+     * Upload a new platform logo
+     * @param org
+     * @param requestBody
+     * @returns ImageUpload
+     * @throws ApiError
+     */
+    static coreOrgsThumbnailCreateCreate(org: string, requestBody: ImageUpload): CancelablePromise<ImageUpload>;
+    /**
+     * GET /api/core/platform/
+     * Get main platform info.
+     *
+     * POST /api/core/platform/
+     * Save main platform settings.
+     *
+     * Params:
+     * user_id (optional)
+     * key
+     * field_key (POST)
+     * value (POST)
+     * @param key
+     * @param userId
+     * @returns PlatformList
+     * @throws ApiError
+     */
+    static corePlatformRetrieve(key: string, userId?: number): CancelablePromise<PlatformList>;
+    /**
+     * Update platform object
+     *
+     * Params:
+     * user_id
+     *
+     * key
+     * new_key (If changing platform key)
+     * name
+     *
+     * Advanced Params (Don't expose these to users)
+     * lms_url
+     * cms_url
+     * portal_url
+     * @param requestBody
+     * @returns PlatformList
+     * @throws ApiError
+     */
+    static corePlatformCreate(requestBody: PlatformUpdatePostRequest): CancelablePromise<PlatformList>;
+    /**
+     * List Platform API Key's belonging to the target platform
+     * @param platformKey Platform key of target platform
+     * @returns PlatformApiKey
+     * @throws ApiError
+     */
+    static corePlatformApiTokensList(platformKey: string): CancelablePromise<Array<PlatformApiKey>>;
+    /**
+     * Create a new Platform Api Key for the target platform
+     * @param requestBody
+     * @returns PlatformApiKey
+     * @throws ApiError
+     */
+    static corePlatformApiTokensCreate(requestBody: PlatformApiKey): CancelablePromise<PlatformApiKey>;
+    /**
+     * Delete Platform Api Key by name in the target platform
+     * @param name
+     * @param platformKey Platform key of target platform
+     * @returns void
+     * @throws ApiError
+     */
+    static corePlatformApiTokensDestroy(name: string, platformKey: string): CancelablePromise<void>;
+    /**
+     * GET /site
+     * Get site settings.
+     *
+     * POST /site
+     * Save site settings.
+     *
+     * Params:
+     * user_id
+     * key
+     * field_key (POST)
+     * value (POST)
+     * @param key
+     * @param userId
+     * @returns any
+     * @throws ApiError
+     */
+    static corePlatformConfigSiteRetrieve(key: string, userId?: number): CancelablePromise<Record<string, any>>;
+    /**
+     * GET /site
+     * Get site settings.
+     *
+     * POST /site
+     * Save site settings.
+     *
+     * Params:
+     * user_id
+     * key
+     * field_key (POST)
+     * value (POST)
+     * @param requestBody
+     * @returns any
+     * @throws ApiError
+     */
+    static corePlatformConfigSiteCreate(requestBody?: Record<string, any>): CancelablePromise<Record<string, any>>;
+    /**
+     * Retrieve users associated with platform
+     *
+     * Params:
+     * platform_key
+     * platform_org
+     *
+     * query
+     * sort
+     *
+     * is_admin: Return tenant admin users
+     * @param page
+     * @param pageSize
+     * @param platformKey
+     * @param platformOrg
+     * @param query
+     * @param sort
+     * @returns UserPlatformManagementListViewGetResponse
+     * @throws ApiError
+     */
+    static corePlatformUsersRetrieve(page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, query?: string, sort?: string): CancelablePromise<UserPlatformManagementListViewGetResponse>;
+    /**
+     * Invalidate all tokens for the authenticated user
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreSessionLogoutCreate(): CancelablePromise<any>;
+    /**
+     * POST signals/edx/
+     * @param requestBody
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreSignalsEdxCreate(requestBody: EdxSignalReceiverRequest): CancelablePromise<any>;
+    /**
+     * Param:
+     * Any of user_id/username/email
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreTokenProxyCreate(): CancelablePromise<any>;
+    /**
+     * Check token user
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreTokenVerifyRetrieve(): CancelablePromise<any>;
+    /**
+     * Show (active) user groups associated with a platform
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreUserGroupsRetrieve(): CancelablePromise<any>;
+    /**
+     * Create/update a user group
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreUserGroupsCreate(): CancelablePromise<any>;
+    /**
+     * Delete user group
+     * @returns void
+     * @throws ApiError
+     */
+    static coreUserGroupsDestroy(): CancelablePromise<void>;
+    /**
+     * Show active users in user group (paginated)
+     *
+     * group_id is numeric ID of group
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreUserGroupsLinkRetrieve(): CancelablePromise<any>;
+    /**
+     * Add single user to user group, or update status
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreUserGroupsLinkCreate(): CancelablePromise<any>;
+    /**
+     * Delete user group link
+     * @returns void
+     * @throws ApiError
+     */
+    static coreUserGroupsLinkDestroy(): CancelablePromise<void>;
+    /**
+     * Add users to user group, or update status
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreUserGroupsLinkBulkCreate(): CancelablePromise<any>;
+    /**
+     * Initiates the account deletion process for the authenticated user or specified username.
+     * @param requestBody
+     * @returns UserDeleteAPIResponse
+     * @throws ApiError
+     */
+    static coreUsersDeleteCreate(requestBody?: UserDeleteAPIRequest): CancelablePromise<UserDeleteAPIResponse>;
+    /**
+     * Get detailed user information.
+     *
+     * Make permission check for platform admins here,
+     * then proxy request to edx.
+     * @param email
+     * @param userId
+     * @param username
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreUsersMetadataProxyRetrieve(email?: string, userId?: number, username?: string): CancelablePromise<any>;
+    /**
+     * Retrieve platforms associated with user_id
+     *
+     * Params:
+     * user_id
+     * username
+     * email
+     * @param email
+     * @param userId
+     * @param username
+     * @returns UserPlatformLink
+     * @throws ApiError
+     */
+    static coreUsersPlatformsList(email?: string, userId?: number, username?: string): CancelablePromise<Array<UserPlatformLink>>;
+    /**
+     * Explicitly link platform to user_id
+     *
+     * Params:
+     * user_id
+     * platform_key
+     * added_on (optional)
+     * expired_on (optional)
+     * is_admin (optional)
+     * active (optional)
+     * @param requestBody
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static coreUsersPlatformsCreate(requestBody: UserPlatformViewPostRequest): CancelablePromise<any>;
+    /**
+     * Retrieve proxy user information by user_id
+     * @param email
+     * @param userId
+     * @param username
+     * @returns UserProxyGetResponse
+     * @throws ApiError
+     */
+    static coreUsersProxyRetrieve(email?: string, userId?: number, username?: string): CancelablePromise<UserProxyGetResponse>;
+    /**
+     * Add proxy user
+     *
+     * Params:
+     * user_id
+     * username
+     * email
+     * edx_data
+     * data
+     * @param requestBody
+     * @returns UserProxyPostResponse
+     * @throws ApiError
+     */
+    static coreUsersProxyCreate(requestBody: UserProxyPostRequest): CancelablePromise<UserProxyPostResponse>;
+    /**
+     * Add proxy users by bulk
+     *
+     * Params:
+     * users: list of user objects
+     * ```
+     * [
+         * {"user_id": 1, ...},
+         * {"user_id": 2, ...}
+         * ]
+         * ```
+         * @param requestBody
+         * @returns string
+         * @throws ApiError
+         */
+    static coreUsersProxyBulkCreate(requestBody: UserProxyBulkRequest): CancelablePromise<Array<Record<string, string>>>;
+    /**
+     * Retrieve users based on query
+     * Not intended for public use with multitenant platforms
+     *
+     * Params:
+     * query
+     * sort
+     * @param page
+     * @param pageSize
+     * @param query
+     * @param sort
+     * @returns UserSearchViewGetResponse
+     * @throws ApiError
+     */
+    static coreUsersSearchRetrieve(page?: number, pageSize?: number, query?: string, sort?: string): CancelablePromise<UserSearchViewGetResponse>;
+}