@iblai/iblai-api 4.441.2-core → 4.442.0-ai

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

@@ -0,0 +1,163 @@
+import type { AlignMentorBubbleEnum } from './AlignMentorBubbleEnum';
+import type { BlankEnum } from './BlankEnum';
+import type { CallConfiguration } from './CallConfiguration';
+import type { MCPServer } from './MCPServer';
+import type { MentorCategory } from './MentorCategory';
+import type { MentorType } from './MentorType';
+import type { MentorVisibilityEnum } from './MentorVisibilityEnum';
+import type { NullEnum } from './NullEnum';
+import type { Segment } from './Segment';
+import type { Subject } from './Subject';
+import type { ThemeEnum } from './ThemeEnum';
+import type { VirtualMachineEgressEnum } from './VirtualMachineEgressEnum';
+export type MentorSettings = {
+    readonly id: number;
+    display_name?: string | null;
+    profile_image?: string | null;
+    initial_message?: string | null;
+    suggested_message?: string | null;
+    theme?: ThemeEnum;
+    user_message_color?: string;
+    mentor_bubble_color?: string;
+    align_mentor_bubble?: AlignMentorBubbleEnum;
+    readonly mentor: string;
+    readonly mentor_slug: string;
+    readonly mentor_unique_id: string;
+    readonly mentor_id: number;
+    readonly metadata: any;
+    mentor_visibility?: (MentorVisibilityEnum | BlankEnum | NullEnum) | null;
+    enable_image_generation?: boolean | null;
+    enable_web_browsing?: boolean | null;
+    enable_code_interpreter?: boolean | null;
+    readonly enable_memory_component: boolean;
+    custom_css?: string | null;
+    custom_javascript?: string | null;
+    readonly enable_custom_javascript: boolean;
+    readonly allow_anonymous: boolean;
+    readonly enable_offline_mode: boolean;
+    readonly mentor_description: string;
+    readonly suggested_prompts: any;
+    readonly proactive_response: string;
+    readonly greeting_method: string;
+    readonly mentor_tools: any;
+    readonly can_use_tools: boolean;
+    readonly llm_name: string;
+    readonly proactive_prompt: string;
+    readonly study_mode_prompt: string;
+    readonly voice_instructions: string;
+    readonly transcription_language: string;
+    readonly transcription_instructions: string;
+    readonly disclaimer: string;
+    readonly enable_disclaimer: boolean;
+    readonly show_attachment: boolean;
+    readonly allowed_file_upload_extensions: Array<string>;
+    readonly show_voice_call: boolean;
+    readonly show_voice_record: boolean;
+    readonly show_rag_images: boolean;
+    readonly show_catalogue: boolean;
+    readonly show_reasoning: boolean;
+    readonly show_last_conversation: boolean;
+    readonly enable_document_filter: boolean;
+    readonly disable_privacy_mode: boolean;
+    readonly enable_in_chat_llm_change: boolean;
+    readonly starter_prompts: string;
+    readonly guided_prompts_count: number;
+    readonly welcome_heading_style: string;
+    readonly embed_is_context_aware: boolean;
+    readonly embed_open_by_default: boolean;
+    readonly embed_show_attachment: boolean;
+    readonly embed_show_voice_call: boolean;
+    readonly embed_show_voice_record: boolean;
+    readonly embed_show_canvas: boolean;
+    readonly show_explore_mentors: boolean;
+    readonly embed_icon_selection_data: any;
+    embed_custom_image?: string | null;
+    readonly placeholder_prompt: string;
+    readonly enable_email_chat: boolean;
+    readonly enable_spaced_repetition: boolean;
+    readonly enable_instruction_mode: boolean;
+    readonly enable_socratic_mode: boolean;
+    readonly is_guided_mentor: boolean;
+    readonly is_featured: boolean;
+    readonly enable_guided_prompts: boolean;
+    readonly save_flagged_prompts: boolean;
+    readonly enable_moderation: boolean;
+    readonly enable_multi_query_rag: boolean;
+    readonly enable_prompt_caching: boolean;
+    readonly enable_post_processing_system: boolean;
+    readonly enable_safety_system: boolean;
+    readonly enable_privacy_router: boolean;
+    readonly filter_pii: boolean;
+    readonly filter_phi: boolean;
+    readonly forkable: boolean;
+    readonly forkable_with_training_data: boolean;
+    readonly mentor_name: string;
+    readonly categories: Array<MentorCategory>;
+    readonly types: Array<MentorType>;
+    readonly subjects: Array<Subject>;
+    readonly segment: Segment | null;
+    readonly recently_accessed_at: string;
+    readonly created_by: string;
+    readonly created_at: string;
+    readonly updated_at: string;
+    readonly platform_key: string;
+    readonly llm_config: any;
+    readonly llm_provider: string;
+    readonly enable_voice_call: boolean;
+    readonly system_prompt: string;
+    readonly shared_system_prompt_source: Record<string, any> | null;
+    readonly llm_temperature: number;
+    readonly safety_system_prompt: string;
+    readonly safety_response: string;
+    readonly privacy_action: string;
+    readonly privacy_entities: Array<any>;
+    readonly privacy_response: string;
+    readonly enable_privacy_output_filter: boolean;
+    readonly phi_action: string;
+    readonly phi_entities: Array<any>;
+    readonly phi_response: string;
+    readonly moderation_system_prompt: string;
+    readonly post_processing_prompt: string;
+    readonly moderation_response: string;
+    readonly mcp_servers: Array<MCPServer>;
+    readonly department: string;
+    readonly disable_chathistory: string;
+    readonly strip_page_content_html: boolean;
+    readonly chat_history_max_tokens: number;
+    readonly chat_history_max_messages: number;
+    readonly rag_retrieval_k: number;
+    readonly call_configuration: CallConfiguration;
+    readonly guided_prompt_instructions: string;
+    readonly seo_tags: any;
+    readonly marketing_conversations: any;
+    readonly template_mentor: any;
+    readonly google_voice: string;
+    readonly openai_voice: string;
+    readonly iblai_voice: string;
+    readonly voice_provider: string;
+    readonly enable_openai_assistant: boolean;
+    readonly enable_total_grounding: boolean;
+    readonly enable_suggested_prompts: boolean;
+    readonly is_deleted: boolean;
+    /**
+     * Enables LTI access for this mentor. When True, LTI users can be granted access via RBAC policies.
+     */
+    is_lti_accessible?: boolean | null;
+    enable_claw?: boolean;
+    /**
+     * Gives the graph agent an `execute` shell tool backed by an isolated per-chat-run VM (iblai-sandbox). The VM is created lazily on the first executed command and destroyed when the chat run ends. Supersedes the quickjs computational runtime when both are enabled.
+     */
+    enable_virtual_machine?: boolean;
+    /**
+     * Network policy for the mentor's virtual machine, passed to the sandbox control plane as the egress profile. Defaults to no network access: the VM runs untrusted code, so outbound access is opt-in. The tenant must be granted the matching profile on the control plane. 'custom' uses virtual_machine_network_policy.
+     *
+     * * `none` - None
+     * * `registries` - Registries
+     * * `public` - Public
+     * * `custom` - Custom
+     */
+    virtual_machine_egress?: VirtualMachineEgressEnum;
+    readonly virtual_machine_network_policy: any;
+    readonly virtual_machine_secrets: any;
+    readonly enable_computational_runtime: boolean;
+};

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

@@ -0,0 +1,104 @@
+import type { AlignMentorBubbleEnum } from './AlignMentorBubbleEnum';
+import type { BlankEnum } from './BlankEnum';
+import type { MentorCategory } from './MentorCategory';
+import type { MentorType } from './MentorType';
+import type { MentorVisibilityEnum } from './MentorVisibilityEnum';
+import type { NullEnum } from './NullEnum';
+import type { Segment } from './Segment';
+import type { Subject } from './Subject';
+import type { ThemeEnum } from './ThemeEnum';
+export type MentorSettingsPublic = {
+    readonly id: number;
+    display_name?: string | null;
+    profile_image?: string | null;
+    initial_message?: string | null;
+    suggested_message?: string | null;
+    theme?: ThemeEnum;
+    user_message_color?: string;
+    mentor_bubble_color?: string;
+    align_mentor_bubble?: AlignMentorBubbleEnum;
+    readonly mentor: string;
+    readonly mentor_slug: string;
+    readonly mentor_unique_id: string;
+    readonly mentor_id: number;
+    readonly metadata: any;
+    mentor_visibility?: (MentorVisibilityEnum | BlankEnum | NullEnum) | null;
+    enable_image_generation?: boolean | null;
+    enable_web_browsing?: boolean | null;
+    enable_code_interpreter?: boolean | null;
+    readonly enable_memory_component: boolean;
+    custom_css?: string | null;
+    readonly custom_javascript: string;
+    readonly enable_custom_javascript: boolean;
+    readonly allow_anonymous: boolean;
+    readonly enable_offline_mode: boolean;
+    readonly mentor_description: string;
+    readonly suggested_prompts: any;
+    readonly proactive_response: string;
+    readonly greeting_method: string;
+    readonly mentor_tools: any;
+    readonly can_use_tools: boolean;
+    readonly llm_name: string;
+    readonly proactive_prompt: string;
+    readonly study_mode_prompt: string;
+    readonly voice_instructions: string;
+    readonly transcription_language: string;
+    readonly transcription_instructions: string;
+    readonly disclaimer: string;
+    readonly enable_disclaimer: boolean;
+    readonly show_attachment: boolean;
+    readonly allowed_file_upload_extensions: Array<string>;
+    readonly show_voice_call: boolean;
+    readonly show_voice_record: boolean;
+    readonly show_rag_images: boolean;
+    readonly show_catalogue: boolean;
+    readonly show_reasoning: boolean;
+    readonly show_last_conversation: boolean;
+    readonly enable_document_filter: boolean;
+    readonly disable_privacy_mode: boolean;
+    readonly enable_in_chat_llm_change: boolean;
+    readonly starter_prompts: string;
+    readonly guided_prompts_count: number;
+    readonly welcome_heading_style: string;
+    readonly embed_is_context_aware: boolean;
+    readonly embed_open_by_default: boolean;
+    readonly embed_show_attachment: boolean;
+    readonly embed_show_voice_call: boolean;
+    readonly embed_show_voice_record: boolean;
+    readonly embed_show_canvas: boolean;
+    readonly show_explore_mentors: boolean;
+    readonly embed_icon_selection_data: any;
+    embed_custom_image?: string | null;
+    readonly placeholder_prompt: string;
+    readonly enable_email_chat: boolean;
+    readonly enable_spaced_repetition: boolean;
+    readonly enable_instruction_mode: boolean;
+    readonly enable_socratic_mode: boolean;
+    readonly is_guided_mentor: boolean;
+    readonly is_featured: boolean;
+    readonly enable_guided_prompts: boolean;
+    readonly save_flagged_prompts: boolean;
+    readonly enable_moderation: boolean;
+    readonly enable_multi_query_rag: boolean;
+    readonly enable_prompt_caching: boolean;
+    readonly enable_post_processing_system: boolean;
+    readonly enable_safety_system: boolean;
+    readonly enable_privacy_router: boolean;
+    readonly filter_pii: boolean;
+    readonly filter_phi: boolean;
+    readonly forkable: boolean;
+    readonly forkable_with_training_data: boolean;
+    readonly mentor_name: string;
+    readonly categories: Array<MentorCategory>;
+    readonly types: Array<MentorType>;
+    readonly subjects: Array<Subject>;
+    readonly segment: Segment | null;
+    readonly recently_accessed_at: string;
+    readonly created_by: string;
+    readonly created_at: string;
+    readonly updated_at: string;
+    readonly platform_key: string;
+    readonly llm_config: any;
+    readonly llm_provider: string;
+    readonly enable_voice_call: boolean;
+};

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

@@ -0,0 +1,141 @@
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+import type { MentorSettingsRequestVoiceProviderEnum } from './MentorSettingsRequestVoiceProviderEnum';
+import type { PhiActionEnum } from './PhiActionEnum';
+import type { PrivacyActionEnum } from './PrivacyActionEnum';
+import type { StarterPromptsDd8Enum } from './StarterPromptsDd8Enum';
+import type { VirtualMachineEgressEnum } from './VirtualMachineEgressEnum';
+import type { WelcomeHeadingStyle5edEnum } from './WelcomeHeadingStyle5edEnum';
+export type MentorSettingsRequest = {
+    mentor_name?: string;
+    template_name?: string;
+    display_name?: string;
+    profile_image?: string;
+    initial_message?: string | null;
+    suggested_message?: string | null;
+    theme?: string;
+    user_message_color?: string;
+    mentor_bubble_color?: string;
+    align_mentor_bubble?: string;
+    system_prompt?: string;
+    llm_provider?: string;
+    llm_name?: string;
+    featured?: boolean;
+    disable_chathistory?: boolean;
+    disable_privacy_mode?: boolean;
+    strip_page_content_html?: boolean;
+    enable_computational_runtime?: boolean;
+    chat_history_max_tokens?: number | null;
+    chat_history_max_messages?: number | null;
+    rag_retrieval_k?: number | null;
+    metadata?: any;
+    custom_css?: string | null;
+    custom_javascript?: string | null;
+    /**
+     * Department to authorize users by
+     */
+    department_id?: number | null;
+    mentor_visibility?: string;
+    enable_image_generation?: boolean;
+    enable_web_browsing?: boolean;
+    enable_code_interpreter?: boolean;
+    enable_claw?: boolean;
+    enable_virtual_machine?: boolean;
+    virtual_machine_egress?: VirtualMachineEgressEnum;
+    /**
+     * Id of the platform's VM network policy the mentor runs with under virtual_machine_egress='custom'. null clears it.
+     */
+    virtual_machine_network_policy_id?: number | null;
+    /**
+     * Ids of the platform's VM secrets this mentor may use. Requires virtual_machine_egress 'public' or 'custom'.
+     */
+    virtual_machine_secret_ids?: Array<number> | null;
+    is_lti_accessible?: boolean;
+    allow_anonymous?: boolean;
+    enable_offline_mode?: boolean;
+    forkable?: boolean;
+    forkable_with_training_data?: boolean;
+    mentor_description?: string;
+    uploaded_profile_image?: string;
+    embed_custom_image?: string | null;
+    proactive_response?: string;
+    greeting_method?: GreetingMethodEnum;
+    can_use_tools?: boolean;
+    tool_slugs?: Array<string>;
+    llm_temperature?: number;
+    proactive_prompt?: string;
+    study_mode_prompt?: string;
+    disclaimer?: string;
+    placeholder_prompt?: string;
+    moderation_system_prompt?: string;
+    post_processing_prompt?: string;
+    moderation_response?: string;
+    enable_moderation?: boolean;
+    enable_multi_query_rag?: boolean;
+    enable_prompt_caching?: boolean;
+    enable_post_processing_system?: boolean;
+    enable_openai_assistant?: boolean;
+    enable_total_grounding?: boolean;
+    enable_suggested_prompts?: boolean | null;
+    enable_guided_prompts?: boolean | null;
+    save_flagged_prompts?: boolean | null;
+    mcp_servers?: Array<number> | null;
+    show_attachment?: boolean;
+    /**
+     * Lowercase file extensions (no dot) allowed for in-chat uploads. Empty list = allow all supported types.
+     */
+    allowed_file_upload_extensions?: Array<string> | null;
+    show_voice_call?: boolean;
+    show_voice_record?: boolean;
+    show_rag_images?: boolean;
+    show_catalogue?: boolean;
+    show_reasoning?: boolean;
+    show_last_conversation?: boolean;
+    enable_document_filter?: boolean;
+    enable_in_chat_llm_change?: boolean;
+    starter_prompts?: StarterPromptsDd8Enum;
+    guided_prompts_count?: number;
+    welcome_heading_style?: WelcomeHeadingStyle5edEnum;
+    embed_is_context_aware?: boolean;
+    embed_open_by_default?: boolean;
+    embed_show_attachment?: boolean;
+    embed_show_voice_call?: boolean;
+    embed_show_voice_record?: boolean;
+    embed_show_canvas?: boolean;
+    show_explore_mentors?: boolean;
+    embed_icon_selection_data?: any;
+    google_voice?: number;
+    openai_voice?: number;
+    iblai_voice?: number;
+    voice_provider?: MentorSettingsRequestVoiceProviderEnum;
+    voice_instructions?: string;
+    transcription_language?: string;
+    transcription_instructions?: string;
+    guided_prompt_instructions?: string | null;
+    safety_system_prompt?: string;
+    safety_response?: string;
+    enable_safety_system?: boolean;
+    enable_privacy_router?: boolean;
+    enable_privacy_output_filter?: boolean;
+    filter_pii?: boolean;
+    privacy_action?: PrivacyActionEnum;
+    privacy_entities?: Array<string>;
+    privacy_response?: string;
+    filter_phi?: boolean;
+    phi_action?: PhiActionEnum;
+    phi_entities?: Array<string>;
+    phi_response?: string;
+    enable_memory_component?: boolean;
+    enable_spaced_repetition?: boolean;
+    enable_instruction_mode?: boolean;
+    enable_socratic_mode?: boolean;
+    is_guided_mentor?: boolean;
+    is_featured?: boolean;
+    enable_email_chat?: boolean;
+    categories?: Array<number>;
+    types?: Array<number>;
+    subjects?: Array<number>;
+    /**
+     * ID of the segment, or null to clear it
+     */
+    segment?: number | null;
+};

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

@@ -0,0 +1,12 @@
+/**
+ * * `browser` - browser
+ * * `openai` - openai
+ * * `google` - google
+ * * `iblai` - iblai
+ */
+export declare enum MentorSettingsRequestVoiceProviderEnum {
+    BROWSER = "browser",
+    OPENAI = "openai",
+    GOOGLE = "google",
+    IBLAI = "iblai"
+}

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

@@ -0,0 +1,12 @@
+export type MentorSkillAssignment = {
+    readonly id: number;
+    readonly mentor: string;
+    readonly mentor_name: string;
+    readonly mentor_slug: string;
+    skill: string;
+    readonly skill_name: string;
+    readonly skill_slug: string;
+    enabled?: boolean;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,5 @@
+export type MentorSummary = {
+    rating: number | null;
+    summary: string | null;
+    tags: Array<string>;
+};

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

@@ -0,0 +1,5 @@
+export type MentorType = {
+    readonly id: number;
+    name: string;
+    description?: string | null;
+};

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

@@ -0,0 +1,4 @@
+export type MentorUserSetting = {
+    reference_saved_memories?: boolean;
+    as_tenant_admin?: boolean;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * * `viewable_by_tenant_admins` - Viewable By Tenant Admins
+ * * `viewable_by_tenant_students` - Viewable By Tenant Students
+ * * `viewable_by_anyone` - Viewable By Anyone
+ */
+export declare enum MentorVisibilityEnum {
+    VIEWABLE_BY_TENANT_ADMINS = "viewable_by_tenant_admins",
+    VIEWABLE_BY_TENANT_STUDENTS = "viewable_by_tenant_students",
+    VIEWABLE_BY_ANYONE = "viewable_by_anyone"
+}

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

@@ -0,0 +1,4 @@
+export type MentorWizard = {
+    name: string;
+    description: string;
+};

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

@@ -0,0 +1,5 @@
+export type MessageStatistics = {
+    time: string;
+    avg_messages: number;
+    total_sessions: number;
+};

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

@@ -0,0 +1,12 @@
+export type MessageView = {
+    count: number;
+    title: string;
+    is_shared: boolean;
+    proactive_prompt: string;
+    mentor_unique_id: string;
+    platform_key: string;
+    previous: string;
+    next: string;
+    results: Array<any>;
+    client_context?: any;
+};

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

@@ -0,0 +1,9 @@
+export type MessageViewRequest = {
+    title?: string;
+    /**
+     * List of tools slugs to use
+     */
+    tools?: Array<string> | null;
+    enable_artifacts?: boolean;
+    is_shared?: boolean;
+};

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

@@ -0,0 +1,3 @@
+export type MessageViewUpdatResponse = {
+    detail: string;
+};

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

@@ -0,0 +1,5 @@
+export type Metadata = {
+    metadata: any;
+    prompt?: string;
+    prompt_id?: number;
+};

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

@@ -0,0 +1,4 @@
+export type MetricChange = {
+    total: number;
+    change: number;
+};

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

@@ -0,0 +1,5 @@
+export type MetricInfo = {
+    name: string;
+    unit: string;
+    description: string;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * * `text` - Text
+ * * `multimodal` - Multimodal
+ * * `voice` - Voice
+ */
+export declare enum ModalityEnum {
+    TEXT = "text",
+    MULTIMODAL = "multimodal",
+    VOICE = "voice"
+}

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

@@ -0,0 +1,4 @@
+export type ModelCost = {
+    model: string;
+    total_cost: number;
+};

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

@@ -0,0 +1,21 @@
+import type { TargetSystemEnum } from './TargetSystemEnum';
+/**
+ * A moderation/safety log row.
+ *
+ * ``ModerationLog`` denormalizes only ``username``, so the email and name
+ * come from the mixin — one query per page, and a row whose user has since
+ * been deleted reports nulls instead of raising. ``email`` keeps its
+ * established name, so the mixin's ``user_email`` twin is dropped.
+ */
+export type ModerationLog = {
+    readonly id: number;
+    username?: string;
+    readonly email: string | null;
+    readonly user_full_name: string | null;
+    platform_key: string;
+    mentor: number;
+    prompt: string;
+    reason: string;
+    target_system?: TargetSystemEnum;
+    readonly date_created: string;
+};

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

@@ -0,0 +1,57 @@
+/**
+ * Artifact embedded in another response (version rows, session open).
+ *
+ * The bytes live once and are fetched from the artifact detail endpoint (or
+ * carried by the current version's own `binary_content`); repeating them on
+ * every embedding would put a copy — and a storage read — on each row.
+ */
+export type NestedArtifact = {
+    readonly id: number;
+    /**
+     * Title or identifier for the artifact
+     */
+    title: string;
+    /**
+     * Text content of the artifact; empty for binary artifacts
+     */
+    readonly content: string;
+    /**
+     * Always null on an embedded artifact; fetch the artifact (or the current version) for the bytes.
+     */
+    readonly binary_content: string;
+    /**
+     * True when the artifact carries `binary_content` instead of `content`
+     */
+    readonly is_binary: boolean;
+    /**
+     * MIME type of a binary artifact, e.g. application/pdf.
+     */
+    readonly mime_type: string;
+    /**
+     * The extension of the file for the artifact. eg. `py`, `md`, `html`, `json`, `csv`, etc
+     */
+    readonly file_extension: string;
+    readonly llm_name: string;
+    readonly llm_provider: string;
+    readonly date_created: string;
+    readonly date_updated: string;
+    /**
+     * Additional metadata for the artifact
+     */
+    readonly metadata: any;
+    /**
+     * Username of the student who owns this artifact
+     */
+    readonly username: string;
+    readonly user_email: string | null;
+    readonly user_full_name: string | null;
+    readonly session_id: string | null;
+    /**
+     * Version number of the current version
+     */
+    readonly current_version_number: number;
+    /**
+     * Total number of versions for this artifact
+     */
+    readonly version_count: number;
+};

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

@@ -0,0 +1,3 @@
+export type NoChatMessagesFound = {
+    error?: string;
+};

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

@@ -0,0 +1,24 @@
+import type { OauthCredentialsMasked } from './OauthCredentialsMasked';
+import type { OAuthService } from './OAuthService';
+/**
+ * Read-only serializer for OAuth providers, including the services they expose.
+ */
+export type OAuthProvider = {
+    readonly id: number;
+    readonly name: string;
+    readonly description: string;
+    readonly url: string;
+    readonly image: string | null;
+    readonly scope_map: any;
+    readonly auth_url: string;
+    readonly token_url: string;
+    readonly is_enabled: boolean;
+    readonly created_at: string;
+    readonly updated_at: string;
+    readonly services: Array<OAuthService>;
+    readonly credentials: OauthCredentialsMasked;
+    /**
+     * Whether to use basic authentication for the OAuth provider. By default client id and client secret are sent to the Authorization server as post data.
+     */
+    readonly use_basic_auth: boolean;
+};

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

@@ -0,0 +1,18 @@
+/**
+ * Read-only serializer exposing details about an OAuth service.
+ */
+export type OAuthService = {
+    readonly id: number;
+    readonly oauth_provider: string;
+    oauth_provider_id?: number | null;
+    readonly name: string;
+    /**
+     * Human readable label for the OAuth service scope.
+     */
+    readonly display_name: string;
+    readonly description: string;
+    readonly scope: string;
+    readonly image: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};