@iblai/iblai-api 3.34.5-core

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

@@ -0,0 +1,210 @@
+import type { Company } from '../models/Company';
+import type { Education } from '../models/Education';
+import type { Experience } from '../models/Experience';
+import type { Institution } from '../models/Institution';
+import type { Program } from '../models/Program';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class CareerService {
+    /**
+     * API endpoint for managing user base locations
+     * @param org
+     * @param username
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static careerLocationOrgsUsersRetrieve(org: string, username: string): CancelablePromise<any>;
+    /**
+     * API endpoint for managing user base locations
+     * @param org
+     * @param username
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static careerLocationOrgsUsersCreate(org: string, username: string): CancelablePromise<any>;
+    /**
+     * API endpoint for managing user base locations
+     * @param org
+     * @param username
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static careerLocationOrgsUsersUpdate(org: string, username: string): CancelablePromise<any>;
+    /**
+     * Platform-wide location statistics (GET only)
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static careerLocationsOrgsRetrieve(org: string): CancelablePromise<any>;
+    /**
+     * @param org
+     * @param username
+     * @returns Company
+     * @throws ApiError
+     */
+    static careerOrgsCompaniesUsersRetrieve(org: string, username: string): CancelablePromise<Company>;
+    /**
+     * @param org
+     * @param username
+     * @param requestBody
+     * @returns Company
+     * @throws ApiError
+     */
+    static careerOrgsCompaniesUsersCreate(org: string, username: string, requestBody: Company): CancelablePromise<Company>;
+    /**
+     * @param org
+     * @param username
+     * @param requestBody
+     * @returns Company
+     * @throws ApiError
+     */
+    static careerOrgsCompaniesUsersUpdate(org: string, username: string, requestBody: Company): CancelablePromise<Company>;
+    /**
+     * @param org
+     * @param username
+     * @returns void
+     * @throws ApiError
+     */
+    static careerOrgsCompaniesUsersDestroy(org: string, username: string): CancelablePromise<void>;
+    /**
+     * @param org
+     * @param username
+     * @returns Education
+     * @throws ApiError
+     */
+    static careerOrgsEducationUsersRetrieve(org: string, username: string): CancelablePromise<Education>;
+    /**
+     * @param org
+     * @param username
+     * @param requestBody
+     * @returns Education
+     * @throws ApiError
+     */
+    static careerOrgsEducationUsersCreate(org: string, username: string, requestBody: Education): CancelablePromise<Education>;
+    /**
+     * @param org
+     * @param username
+     * @param requestBody
+     * @returns Education
+     * @throws ApiError
+     */
+    static careerOrgsEducationUsersUpdate(org: string, username: string, requestBody: Education): CancelablePromise<Education>;
+    /**
+     * @param org
+     * @param username
+     * @returns void
+     * @throws ApiError
+     */
+    static careerOrgsEducationUsersDestroy(org: string, username: string): CancelablePromise<void>;
+    /**
+     * @param org
+     * @param username
+     * @returns Experience
+     * @throws ApiError
+     */
+    static careerOrgsExperienceUsersRetrieve(org: string, username: string): CancelablePromise<Experience>;
+    /**
+     * @param org
+     * @param username
+     * @param requestBody
+     * @returns Experience
+     * @throws ApiError
+     */
+    static careerOrgsExperienceUsersCreate(org: string, username: string, requestBody: Experience): CancelablePromise<Experience>;
+    /**
+     * @param org
+     * @param username
+     * @param requestBody
+     * @returns Experience
+     * @throws ApiError
+     */
+    static careerOrgsExperienceUsersUpdate(org: string, username: string, requestBody: Experience): CancelablePromise<Experience>;
+    /**
+     * @param org
+     * @param username
+     * @returns void
+     * @throws ApiError
+     */
+    static careerOrgsExperienceUsersDestroy(org: string, username: string): CancelablePromise<void>;
+    /**
+     * @param org
+     * @param username
+     * @returns Institution
+     * @throws ApiError
+     */
+    static careerOrgsInstitutionsUsersRetrieve(org: string, username: string): CancelablePromise<Institution>;
+    /**
+     * @param org
+     * @param username
+     * @param requestBody
+     * @returns Institution
+     * @throws ApiError
+     */
+    static careerOrgsInstitutionsUsersCreate(org: string, username: string, requestBody: Institution): CancelablePromise<Institution>;
+    /**
+     * @param org
+     * @param username
+     * @param requestBody
+     * @returns Institution
+     * @throws ApiError
+     */
+    static careerOrgsInstitutionsUsersUpdate(org: string, username: string, requestBody: Institution): CancelablePromise<Institution>;
+    /**
+     * @param org
+     * @param username
+     * @returns void
+     * @throws ApiError
+     */
+    static careerOrgsInstitutionsUsersDestroy(org: string, username: string): CancelablePromise<void>;
+    /**
+     * @param org
+     * @param username
+     * @returns Program
+     * @throws ApiError
+     */
+    static careerOrgsProgramsUsersRetrieve(org: string, username: string): CancelablePromise<Program>;
+    /**
+     * @param org
+     * @param username
+     * @param requestBody
+     * @returns Program
+     * @throws ApiError
+     */
+    static careerOrgsProgramsUsersCreate(org: string, username: string, requestBody: Program): CancelablePromise<Program>;
+    /**
+     * @param org
+     * @param username
+     * @param requestBody
+     * @returns Program
+     * @throws ApiError
+     */
+    static careerOrgsProgramsUsersUpdate(org: string, username: string, requestBody: Program): CancelablePromise<Program>;
+    /**
+     * @param org
+     * @param username
+     * @returns void
+     * @throws ApiError
+     */
+    static careerOrgsProgramsUsersDestroy(org: string, username: string): CancelablePromise<void>;
+    /**
+     * @param org
+     * @param username
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static careerResumeOrgsUsersRetrieve(org: string, username: string): CancelablePromise<any>;
+    /**
+     * @param org
+     * @param username
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static careerResumeOrgsUsersCreate(org: string, username: string): CancelablePromise<any>;
+    /**
+     * @param org
+     * @param username
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static careerResumeOrgsUsersUpdate(org: string, username: string): CancelablePromise<any>;
+}

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

@@ -0,0 +1,196 @@
+import type { ImageUpload } from '../models/ImageUpload';
+import type { LtiKey } from '../models/LtiKey';
+import type { LtiTool } from '../models/LtiTool';
+import type { PatchedPlatformPublicMetadata } from '../models/PatchedPlatformPublicMetadata';
+import type { PlatformPublicMetadata } from '../models/PlatformPublicMetadata';
+import type { RedirectTokenRequest } from '../models/RedirectTokenRequest';
+import type { RedirectTokenResponse } from '../models/RedirectTokenResponse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class CoreService {
+    /**
+     * 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>;
+}