moodle-api
Version:
1,798 lines (1,730 loc) • 1.75 MB
text/typescript
interface Params$aS {
}
type ReturnsNamefields = (string | null)[];
interface ReturnsProfilefieldsItem {
/** Profile field id */
id: number | null;
/** Profile field shortname */
shortname: string | null;
/** Profield field name */
name: string | null;
/** Profield field datatype */
datatype: string | null;
/** Profield field description */
description: string | null;
/** description format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN */
descriptionformat: number | null;
/** Profield field category id */
categoryid: number | null;
/** Profield field category name */
categoryname: string | null;
/** Profield field sort order */
sortorder: number | null;
/** Profield field required */
required: number | null;
/** Profield field locked */
locked: number | null;
/** Profield field visible */
visible: number | null;
/** Profield field unique */
forceunique: number | null;
/** Profield field in signup form */
signup: number | null;
/** Profield field default data */
defaultdata: string | null;
/** defaultdata format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN */
defaultdataformat: number | null;
/** Profield field settings */
param1: string | null;
/** Profield field settings */
param2: string | null;
/** Profield field settings */
param3: string | null;
/** Profield field settings */
param4: string | null;
/** Profield field settings */
param5: string | null;
}
/**
* Required profile fields
*/
type ReturnsProfilefields = ReturnsProfilefieldsItem[];
/**
* warning
*/
interface ReturnsWarningsItem$5b {
/** item */
item: string | null;
/** item id */
itemid: number | null;
/** the warning code can be used by the client app to implement specific behaviour */
warningcode: string | null;
/** untranslated english message to explain the warning */
message: string | null;
}
/**
* list of warnings
*/
type ReturnsWarnings$5b = ReturnsWarningsItem$5b[];
interface Returns$8V {
namefields: ReturnsNamefields;
/** Password policy */
passwordpolicy: string | null;
/** Site policy */
sitepolicy: string | null;
/** Site policy handler */
sitepolicyhandler: string | null;
/** Default city */
defaultcity: string | null;
/** Default country */
country: string | null;
/** Required profile fields */
profilefields: ReturnsProfilefields;
/** Recaptcha public key */
recaptchapublickey: string | null;
/** Recaptcha challenge hash */
recaptchachallengehash: string | null;
/** Recaptcha challenge noscript image */
recaptchachallengeimage: string | null;
/** Recaptcha challenge js url */
recaptchachallengejs: string | null;
/** list of warnings */
warnings: ReturnsWarnings$5b;
}
type get_signup_settings_ReturnsNamefields = ReturnsNamefields;
type get_signup_settings_ReturnsProfilefields = ReturnsProfilefields;
type get_signup_settings_ReturnsProfilefieldsItem = ReturnsProfilefieldsItem;
declare namespace get_signup_settings {
export {
Params$aS as Params,
Returns$8V as Returns,
get_signup_settings_ReturnsNamefields as ReturnsNamefields,
get_signup_settings_ReturnsProfilefields as ReturnsProfilefields,
get_signup_settings_ReturnsProfilefieldsItem as ReturnsProfilefieldsItem,
ReturnsWarnings$5b as ReturnsWarnings,
ReturnsWarningsItem$5b as ReturnsWarningsItem,
};
}
interface ParamsCustomprofilefieldsItem {
/** The type of the custom field */
type: string | null;
/** The name of the custom field */
name: string | null;
/** Custom field value, can be an encoded json if required */
value: string | null;
}
/**
* User custom fields (also known as user profile fields)
*/
type ParamsCustomprofilefields = ParamsCustomprofilefieldsItem[];
interface Params$aR {
/** Username */
username: string | null;
/** Plain text password */
password: string | null;
/** The first name(s) of the user */
firstname: string | null;
/** The family name of the user */
lastname: string | null;
/** A valid and unique email address */
email: string | null;
/** Home city of the user */
city?: string | null;
/** Home country code */
country?: string | null;
/** Recaptcha challenge hash */
recaptchachallengehash?: string | null;
/** Recaptcha response */
recaptcharesponse?: string | null;
/** User custom fields (also known as user profile fields) */
customprofilefields?: ParamsCustomprofilefields;
/** Redirect the user to this site url after confirmation. */
redirect?: string | null;
}
/**
* warning
*/
interface ReturnsWarningsItem$5a {
/** item */
item: string | null;
/** item id */
itemid: number | null;
/** the warning code can be used by the client app to implement specific behaviour */
warningcode: string | null;
/** untranslated english message to explain the warning */
message: string | null;
}
/**
* list of warnings
*/
type ReturnsWarnings$5a = ReturnsWarningsItem$5a[];
interface Returns$8U {
/** True if the user was created false otherwise */
success: boolean | null;
/** list of warnings */
warnings: ReturnsWarnings$5a;
}
type signup_user_ParamsCustomprofilefields = ParamsCustomprofilefields;
type signup_user_ParamsCustomprofilefieldsItem = ParamsCustomprofilefieldsItem;
declare namespace signup_user {
export {
Params$aR as Params,
signup_user_ParamsCustomprofilefields as ParamsCustomprofilefields,
signup_user_ParamsCustomprofilefieldsItem as ParamsCustomprofilefieldsItem,
Returns$8U as Returns,
ReturnsWarnings$5a as ReturnsWarnings,
ReturnsWarningsItem$5a as ReturnsWarningsItem,
};
}
declare const index$1F_get_signup_settings: typeof get_signup_settings;
declare const index$1F_signup_user: typeof signup_user;
declare namespace index$1F {
export {
index$1F_get_signup_settings as get_signup_settings,
index$1F_signup_user as signup_user,
};
}
declare namespace auth {
export {
index$1F as email,
};
}
interface Params$aQ {
/** The course id to obtain results for. */
courseid: number | null;
}
interface ReturnsItem$1t {
/** ID */
cmid: number | null;
/** Number of errors. */
numerrors: number | null;
/** Number of checks. */
numchecks: number | null;
}
type Returns$8T = ReturnsItem$1t[];
declare namespace get_module_data {
export {
Params$aQ as Params,
Returns$8T as Returns,
ReturnsItem$1t as ReturnsItem,
};
}
interface Params$aP {
/** The course id to obtain results for. */
courseid: number | null;
}
interface ReturnsItem$1s {
/** ID */
section: number | null;
/** Number of errors. */
numerrors: number | null;
/** Number of checks. */
numchecks: number | null;
}
type Returns$8S = ReturnsItem$1s[];
declare namespace get_section_data {
export {
Params$aP as Params,
Returns$8S as Returns,
ReturnsItem$1s as ReturnsItem,
};
}
declare const index$1E_get_module_data: typeof get_module_data;
declare const index$1E_get_section_data: typeof get_section_data;
declare namespace index$1E {
export {
index$1E_get_module_data as get_module_data,
index$1E_get_section_data as get_section_data,
};
}
interface Params$aO {
/** result set limit */
limit?: number | null;
}
interface ReturnsItem$1r {
/** id */
id: number;
/** courseid */
courseid: number;
/** cmid */
cmid: number;
/** userid */
userid: number;
/** modname */
modname: string;
/** name */
name: string;
/** coursename */
coursename: string;
/** timeaccess */
timeaccess: number;
/** viewurl */
viewurl: string;
/** courseviewurl */
courseviewurl: string;
/** icon */
icon: string;
/** purpose */
purpose: string;
}
/**
* The most recently accessed activities/resources by the logged user
*/
type Returns$8R = ReturnsItem$1r[];
declare namespace get_recent_items {
export {
Params$aO as Params,
Returns$8R as Returns,
ReturnsItem$1r as ReturnsItem,
};
}
declare const index$1D_get_recent_items: typeof get_recent_items;
declare namespace index$1D {
export {
index$1D_get_recent_items as get_recent_items,
};
}
interface Params$aN {
/** Limit */
limit?: number | null;
/** Offset */
offset?: number | null;
}
interface ReturnsItem$1q {
/** id */
id: number;
/** fullname */
fullname: string;
/** shortname */
shortname: string;
/** idnumber */
idnumber: string;
/** summary */
summary: string | null;
/** summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN */
summaryformat: number | null;
/** startdate */
startdate: number;
/** enddate */
enddate: number;
/** visible */
visible: boolean;
/** showactivitydates */
showactivitydates: boolean | null;
/** showcompletionconditions */
showcompletionconditions: boolean | null;
/** pdfexportfont */
pdfexportfont: string | null;
/** fullnamedisplay */
fullnamedisplay: string;
/** viewurl */
viewurl: string;
/** courseimage */
courseimage: string;
/** progress */
progress: number;
/** hasprogress */
hasprogress: boolean;
/** isfavourite */
isfavourite: boolean;
/** hidden */
hidden: boolean;
/** timeaccess */
timeaccess: number;
/** showshortname */
showshortname: boolean;
/** coursecategory */
coursecategory: string;
}
type Returns$8Q = ReturnsItem$1q[];
declare namespace get_starred_courses {
export {
Params$aN as Params,
Returns$8Q as Returns,
ReturnsItem$1q as ReturnsItem,
};
}
declare const index$1C_get_starred_courses: typeof get_starred_courses;
declare namespace index$1C {
export {
index$1C_get_starred_courses as get_starred_courses,
};
}
declare namespace block {
export {
index$1E as accessreview,
index$1D as recentlyaccesseditems,
index$1C as starredcourses,
};
}
interface Params$aM {
/** The name of the plugin */
plugin: string | null;
/** The target state */
state: number | null;
}
interface Returns$8P {
}
declare namespace set_block_protection {
export {
Params$aM as Params,
Returns$8P as Returns,
};
}
interface Params$aL {
/** The name of the plugin */
plugin: string | null;
/** The direction to move */
direction: number | null;
}
interface Returns$8O {
}
declare namespace set_plugin_order {
export {
Params$aL as Params,
Returns$8O as Returns,
};
}
interface Params$aK {
/** The name of the plugin */
plugin: string | null;
/** The target state */
state: number | null;
}
interface Returns$8N {
}
declare namespace set_plugin_state {
export {
Params$aK as Params,
Returns$8N as Returns,
};
}
declare const index$1B_set_block_protection: typeof set_block_protection;
declare const index$1B_set_plugin_order: typeof set_plugin_order;
declare const index$1B_set_plugin_state: typeof set_plugin_state;
declare namespace index$1B {
export {
index$1B_set_block_protection as set_block_protection,
index$1B_set_plugin_order as set_plugin_order,
index$1B_set_plugin_state as set_plugin_state,
};
}
interface Params$aJ {
/** User name */
username: string | null;
/** Confirmation secret */
secret: string | null;
}
/**
* warning
*/
interface ReturnsWarningsItem$59 {
/** item */
item: string | null;
/** item id */
itemid: number | null;
/** the warning code can be used by the client app to implement specific behaviour */
warningcode: string | null;
/** untranslated english message to explain the warning */
message: string | null;
}
/**
* list of warnings
*/
type ReturnsWarnings$59 = ReturnsWarningsItem$59[];
interface Returns$8M {
/** True if the user was confirmed, false if he was already confirmed */
success: boolean | null;
/** list of warnings */
warnings: ReturnsWarnings$59;
}
declare namespace confirm_user {
export {
Params$aJ as Params,
Returns$8M as Returns,
ReturnsWarnings$59 as ReturnsWarnings,
ReturnsWarningsItem$59 as ReturnsWarningsItem,
};
}
interface Params$aI {
}
interface Returns$8L {
/** True if digital consent verification is enabled, false otherwise. */
status: boolean | null;
}
declare namespace is_age_digital_consent_verification_enabled {
export {
Params$aI as Params,
Returns$8L as Returns,
};
}
interface Params$aH {
/** Age */
age: number | null;
/** Country of residence */
country: string | null;
}
interface Returns$8K {
/** True if the user is considered to be a digital minor, false if not */
status: boolean | null;
}
declare namespace is_minor {
export {
Params$aH as Params,
Returns$8K as Returns,
};
}
interface Params$aG {
/** User name */
username?: string | null;
/** User email */
email?: string | null;
}
/**
* warning
*/
interface ReturnsWarningsItem$58 {
/** item */
item: string | null;
/** item id */
itemid: number | null;
/** the warning code can be used by the client app to implement specific behaviour */
warningcode: string | null;
/** untranslated english message to explain the warning */
message: string | null;
}
/**
* list of warnings
*/
type ReturnsWarnings$58 = ReturnsWarningsItem$58[];
interface Returns$8J {
/** The returned status of the process: dataerror: Error in the sent data (username or email). More information in warnings field. emailpasswordconfirmmaybesent: Email sent or not (depends on user found in database). emailpasswordconfirmnotsent: Failure, user not found. emailpasswordconfirmnoemail: Failure, email not found. emailalreadysent: Email already sent. emailpasswordconfirmsent: User pending confirmation. emailresetconfirmsent: Email sent. */
status: string | null;
/** Important information for the user about the process. */
notice: string | null;
/** list of warnings */
warnings: ReturnsWarnings$58;
}
declare namespace request_password_reset {
export {
Params$aG as Params,
Returns$8J as Returns,
ReturnsWarnings$58 as ReturnsWarnings,
ReturnsWarningsItem$58 as ReturnsWarningsItem,
};
}
interface Params$aF {
/** Username. */
username: string | null;
/** Plain text password. */
password: string | null;
/** Redirect the user to this site url after confirmation. */
redirect?: string | null;
}
/**
* warning
*/
interface ReturnsWarningsItem$57 {
/** item */
item: string | null;
/** item id */
itemid: number | null;
/** the warning code can be used by the client app to implement specific behaviour */
warningcode: string | null;
/** untranslated english message to explain the warning */
message: string | null;
}
/**
* list of warnings
*/
type ReturnsWarnings$57 = ReturnsWarningsItem$57[];
interface Returns$8I {
/** True if the confirmation email was sent, false otherwise. */
status: boolean | null;
/** list of warnings */
warnings: ReturnsWarnings$57;
}
declare namespace resend_confirmation_email {
export {
Params$aF as Params,
Returns$8I as Returns,
ReturnsWarnings$57 as ReturnsWarnings,
ReturnsWarningsItem$57 as ReturnsWarningsItem,
};
}
declare const index$1A_confirm_user: typeof confirm_user;
declare const index$1A_is_age_digital_consent_verification_enabled: typeof is_age_digital_consent_verification_enabled;
declare const index$1A_is_minor: typeof is_minor;
declare const index$1A_request_password_reset: typeof request_password_reset;
declare const index$1A_resend_confirmation_email: typeof resend_confirmation_email;
declare namespace index$1A {
export {
index$1A_confirm_user as confirm_user,
index$1A_is_age_digital_consent_verification_enabled as is_age_digital_consent_verification_enabled,
index$1A_is_minor as is_minor,
index$1A_request_password_reset as request_password_reset,
index$1A_resend_confirmation_email as resend_confirmation_email,
};
}
interface Params$aE {
/** Backup filename */
filename: string;
/** Context id */
contextid: number;
/** Backup id */
backupid: string;
}
/**
* Table row data.
*/
interface Returns$8H {
/** Backup file size */
filesize: string | null;
/** Backup file URL */
fileurl: string | null;
/** Backup restore URL */
restoreurl: string | null;
}
declare namespace get_async_backup_links_backup {
export {
Params$aE as Params,
Returns$8H as Returns,
};
}
interface Params$aD {
/** Backup id */
backupid: string;
/** Context id */
contextid: number;
}
/**
* Table row data.
*/
interface Returns$8G {
/** Restore url */
restoreurl: string | null;
}
declare namespace get_async_backup_links_restore {
export {
Params$aD as Params,
Returns$8G as Returns,
};
}
/**
* Backup id to get progress for
*/
type ParamsBackupids = (string | null)[];
interface Params$aC {
/** Backup id to get progress for */
backupids: ParamsBackupids;
/** Context id */
contextid: number;
}
/**
* Backup completion status
*/
interface ReturnsItem$1p {
/** Backup Status */
status: number | null;
/** Backup progress */
progress: number | null;
/** Backup id */
backupid: string | null;
/** operation type */
operation: string | null;
}
/**
* Backup data
*/
type Returns$8F = ReturnsItem$1p[];
type get_async_backup_progress_ParamsBackupids = ParamsBackupids;
declare namespace get_async_backup_progress {
export {
Params$aC as Params,
get_async_backup_progress_ParamsBackupids as ParamsBackupids,
Returns$8F as Returns,
ReturnsItem$1p as ReturnsItem,
};
}
/**
* Copy data
*/
interface ParamsCopiesItem {
/** Backup id */
backupid: string | null;
/** Restore id */
restoreid: string | null;
/** Operation type */
operation: string | null;
}
/**
* Copy data
*/
type ParamsCopies = ParamsCopiesItem[];
interface Params$aB {
/** Copy data */
copies: ParamsCopies;
}
/**
* Copy completion status
*/
interface ReturnsItem$1o {
/** Copy Status */
status: number | null;
/** Copy progress */
progress: number | null;
/** Copy id */
backupid: string | null;
/** Operation type */
operation: string | null;
}
/**
* Copy data
*/
type Returns$8E = ReturnsItem$1o[];
type get_copy_progress_ParamsCopies = ParamsCopies;
type get_copy_progress_ParamsCopiesItem = ParamsCopiesItem;
declare namespace get_copy_progress {
export {
Params$aB as Params,
get_copy_progress_ParamsCopies as ParamsCopies,
get_copy_progress_ParamsCopiesItem as ParamsCopiesItem,
Returns$8E as Returns,
ReturnsItem$1o as ReturnsItem,
};
}
interface Params$aA {
/** The data from the create copy form, encoded as a json array */
jsonformdata: string | null;
}
declare namespace submit_copy_form {
export {
Params$aA as Params,
};
}
declare const index$1z_get_async_backup_links_backup: typeof get_async_backup_links_backup;
declare const index$1z_get_async_backup_links_restore: typeof get_async_backup_links_restore;
declare const index$1z_get_async_backup_progress: typeof get_async_backup_progress;
declare const index$1z_get_copy_progress: typeof get_copy_progress;
declare const index$1z_submit_copy_form: typeof submit_copy_form;
declare namespace index$1z {
export {
index$1z_get_async_backup_links_backup as get_async_backup_links_backup,
index$1z_get_async_backup_links_restore as get_async_backup_links_restore,
index$1z_get_async_backup_progress as get_async_backup_progress,
index$1z_get_copy_progress as get_copy_progress,
index$1z_submit_copy_form as submit_copy_form,
};
}
interface Params$az {
/** Badges only for this user id, empty for current user */
userid?: number | null;
/** Filter badges by course id, empty all the courses */
courseid?: number | null;
/** The page of records to return. */
page?: number | null;
/** The number of records to return per page */
perpage?: number | null;
/** A simple string to search for */
search?: string | null;
/** Whether to return only public badges */
onlypublic?: boolean | null;
}
interface ReturnsBadgesItemEndorsement {
/** Endorsement id */
id: number;
/** Badge id */
badgeid: number;
/** Endorsement issuer name */
issuername: string;
/** Endorsement issuer URL */
issuerurl: string;
/** Endorsement issuer email */
issueremail: string;
/** Claim URL */
claimid: string | null;
/** Claim comment */
claimcomment: string | null;
/** Date issued */
dateissued: number;
}
interface ReturnsBadgesItemAlignmentItem {
/** Alignment id */
id: number;
/** Badge id */
badgeid: number;
/** Target name */
targetName: string;
/** Target URL */
targetUrl: string;
/** Target description */
targetDescription: string | null;
/** Target framework */
targetFramework: string | null;
/** Target code */
targetCode: string | null;
}
/**
* Badge alignments
*/
type ReturnsBadgesItemAlignment = ReturnsBadgesItemAlignmentItem[];
interface ReturnsBadgesItemRelatedbadgesItem {
/** Badge id */
id: number;
/** Badge name */
name: string;
/** Version */
version: string | null;
/** Language */
language: string | null;
/** Type */
type: number;
}
/**
* Related badges
*/
type ReturnsBadgesItemRelatedbadges = ReturnsBadgesItemRelatedbadgesItem[];
interface ReturnsBadgesItem {
/** Badge id */
id: number;
/** Badge name */
name: string;
/** Badge description */
description: string | null;
/** Time created */
timecreated: number;
/** Time modified */
timemodified: number;
/** User created */
usercreated: number;
/** User modified */
usermodified: number;
/** Issuer name */
issuername: string;
/** Issuer URL */
issuerurl: string;
/** Issuer contact */
issuercontact: string | null;
/** Expire date */
expiredate: number | null;
/** Expire period */
expireperiod: number | null;
/** Type */
type: number;
/** Course id */
courseid: number | null;
/** Message */
message: string;
/** Message subject */
messagesubject: string;
/** Attachment */
attachment: number;
/** Whether to notify when badge is awarded */
notification: number;
/** Next cron */
nextcron: number | null;
/** Status */
status: number;
/** Issued id */
issuedid: number;
/** Unique hash */
uniquehash: string;
/** Date issued */
dateissued: number;
/** Date expire */
dateexpire: number | null;
/** Visible */
visible: number;
/** User email */
email: string;
/** Version */
version: string | null;
/** Language */
language: string | null;
/** Name of the image author */
imageauthorname: string | null;
/** Email of the image author */
imageauthoremail: string | null;
/** URL of the image author */
imageauthorurl: string | null;
/** Caption of the image */
imagecaption: string | null;
/** Badge URL */
badgeurl: string;
endorsement: ReturnsBadgesItemEndorsement;
/** Badge alignments */
alignment: ReturnsBadgesItemAlignment;
/** Related badges */
relatedbadges: ReturnsBadgesItemRelatedbadges;
}
type ReturnsBadges = ReturnsBadgesItem[];
/**
* warning
*/
interface ReturnsWarningsItem$56 {
/** item */
item: string | null;
/** item id */
itemid: number | null;
/** the warning code can be used by the client app to implement specific behaviour */
warningcode: string | null;
/** untranslated english message to explain the warning */
message: string | null;
}
/**
* list of warnings
*/
type ReturnsWarnings$56 = ReturnsWarningsItem$56[];
interface Returns$8D {
badges: ReturnsBadges;
/** list of warnings */
warnings: ReturnsWarnings$56;
}
type get_user_badges_ReturnsBadges = ReturnsBadges;
type get_user_badges_ReturnsBadgesItem = ReturnsBadgesItem;
type get_user_badges_ReturnsBadgesItemAlignment = ReturnsBadgesItemAlignment;
type get_user_badges_ReturnsBadgesItemAlignmentItem = ReturnsBadgesItemAlignmentItem;
type get_user_badges_ReturnsBadgesItemEndorsement = ReturnsBadgesItemEndorsement;
type get_user_badges_ReturnsBadgesItemRelatedbadges = ReturnsBadgesItemRelatedbadges;
type get_user_badges_ReturnsBadgesItemRelatedbadgesItem = ReturnsBadgesItemRelatedbadgesItem;
declare namespace get_user_badges {
export {
Params$az as Params,
Returns$8D as Returns,
get_user_badges_ReturnsBadges as ReturnsBadges,
get_user_badges_ReturnsBadgesItem as ReturnsBadgesItem,
get_user_badges_ReturnsBadgesItemAlignment as ReturnsBadgesItemAlignment,
get_user_badges_ReturnsBadgesItemAlignmentItem as ReturnsBadgesItemAlignmentItem,
get_user_badges_ReturnsBadgesItemEndorsement as ReturnsBadgesItemEndorsement,
get_user_badges_ReturnsBadgesItemRelatedbadges as ReturnsBadgesItemRelatedbadges,
get_user_badges_ReturnsBadgesItemRelatedbadgesItem as ReturnsBadgesItemRelatedbadgesItem,
ReturnsWarnings$56 as ReturnsWarnings,
ReturnsWarningsItem$56 as ReturnsWarningsItem,
};
}
declare const index$1y_get_user_badges: typeof get_user_badges;
declare namespace index$1y {
export {
index$1y_get_user_badges as get_user_badges,
};
}
interface Params$ay {
/** The context ID of the page. */
pagecontextid: number | null;
/** The type of the page. */
pagetype: string | null;
/** The layout of the page. */
pagelayout: string | null;
/** The subpage identifier */
subpage?: string | null;
/** Page hash */
pagehash?: string | null;
}
interface ReturnsItem$1n {
/** The name of the block. */
name: string | null;
/** The title of the block. */
title: string | null;
/** If this block type has a form when it is being added then the classname of the form */
blockform: string | null;
}
/**
* List of addable blocks in a given page.
*/
type Returns$8C = ReturnsItem$1n[];
declare namespace fetch_addable_blocks {
export {
Params$ay as Params,
Returns$8C as Returns,
ReturnsItem$1n as ReturnsItem,
};
}
interface Params$ax {
/** course id */
courseid: number | null;
/** Whether to return the block contents. */
returncontents?: boolean | null;
}
/**
* File.
*/
interface ReturnsBlocksItemContentsFilesItem$1 {
/** File name. */
filename: string | null;
/** File path. */
filepath: string | null;
/** File size. */
filesize: number | null;
/** Downloadable file url. */
fileurl: string | null;
/** Time modified. */
timemodified: number | null;
/** File mime type. */
mimetype: string | null;
/** Whether is an external file. */
isexternalfile: boolean | null;
/** The repository type for external files. */
repositorytype: string | null;
}
/**
* Block files.
*/
type ReturnsBlocksItemContentsFiles$1 = ReturnsBlocksItemContentsFilesItem$1[];
/**
* Block contents (if required).
*/
interface ReturnsBlocksItemContents$1 {
/** Block title. */
title: string | null;
/** Block contents. */
content: string | null;
/** content format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN */
contentformat: number | null;
/** Block footer. */
footer: string | null;
/** Block files. */
files: ReturnsBlocksItemContentsFiles$1;
}
interface ReturnsBlocksItemConfigsItem$1 {
/** Name. */
name: string | null;
/** JSON encoded representation of the config value. */
value: string | null;
/** Type (instance or plugin). */
type: string | null;
}
/**
* Block instance and plugin configuration settings.
*/
type ReturnsBlocksItemConfigs$1 = ReturnsBlocksItemConfigsItem$1[];
/**
* Block information.
*/
interface ReturnsBlocksItem$1 {
/** Block instance id. */
instanceid: number | null;
/** Block name. */
name: string | null;
/** Block region. */
region: string | null;
/** Position id. */
positionid: number | null;
/** Whether the block is collapsible. */
collapsible: boolean | null;
/** Whether the block is dockable. */
dockable: boolean | null;
/** Used to order blocks within a region. */
weight: number | null;
/** Whether the block is visible. */
visible: boolean | null;
/** Block contents (if required). */
contents: ReturnsBlocksItemContents$1;
/** Block instance and plugin configuration settings. */
configs: ReturnsBlocksItemConfigs$1;
}
/**
* List of blocks in the course.
*/
type ReturnsBlocks$1 = ReturnsBlocksItem$1[];
/**
* warning
*/
interface ReturnsWarningsItem$55 {
/** item */
item: string | null;
/** item id */
itemid: number | null;
/** the warning code can be used by the client app to implement specific behaviour */
warningcode: string | null;
/** untranslated english message to explain the warning */
message: string | null;
}
/**
* list of warnings
*/
type ReturnsWarnings$55 = ReturnsWarningsItem$55[];
interface Returns$8B {
/** List of blocks in the course. */
blocks: ReturnsBlocks$1;
/** list of warnings */
warnings: ReturnsWarnings$55;
}
declare namespace get_course_blocks {
export {
Params$ax as Params,
Returns$8B as Returns,
ReturnsBlocks$1 as ReturnsBlocks,
ReturnsBlocksItem$1 as ReturnsBlocksItem,
ReturnsBlocksItemConfigs$1 as ReturnsBlocksItemConfigs,
ReturnsBlocksItemConfigsItem$1 as ReturnsBlocksItemConfigsItem,
ReturnsBlocksItemContents$1 as ReturnsBlocksItemContents,
ReturnsBlocksItemContentsFiles$1 as ReturnsBlocksItemContentsFiles,
ReturnsBlocksItemContentsFilesItem$1 as ReturnsBlocksItemContentsFilesItem,
ReturnsWarnings$55 as ReturnsWarnings,
ReturnsWarningsItem$55 as ReturnsWarningsItem,
};
}
interface Params$aw {
/** User id (optional), default is current user. */
userid?: number | null;
/** Whether to return the block contents. */
returncontents?: boolean | null;
/** What my page to return blocks of */
mypage?: string | null;
}
/**
* File.
*/
interface ReturnsBlocksItemContentsFilesItem {
/** File name. */
filename: string | null;
/** File path. */
filepath: string | null;
/** File size. */
filesize: number | null;
/** Downloadable file url. */
fileurl: string | null;
/** Time modified. */
timemodified: number | null;
/** File mime type. */
mimetype: string | null;
/** Whether is an external file. */
isexternalfile: boolean | null;
/** The repository type for external files. */
repositorytype: string | null;
}
/**
* Block files.
*/
type ReturnsBlocksItemContentsFiles = ReturnsBlocksItemContentsFilesItem[];
/**
* Block contents (if required).
*/
interface ReturnsBlocksItemContents {
/** Block title. */
title: string | null;
/** Block contents. */
content: string | null;
/** content format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN */
contentformat: number | null;
/** Block footer. */
footer: string | null;
/** Block files. */
files: ReturnsBlocksItemContentsFiles;
}
interface ReturnsBlocksItemConfigsItem {
/** Name. */
name: string | null;
/** JSON encoded representation of the config value. */
value: string | null;
/** Type (instance or plugin). */
type: string | null;
}
/**
* Block instance and plugin configuration settings.
*/
type ReturnsBlocksItemConfigs = ReturnsBlocksItemConfigsItem[];
/**
* Block information.
*/
interface ReturnsBlocksItem {
/** Block instance id. */
instanceid: number | null;
/** Block name. */
name: string | null;
/** Block region. */
region: string | null;
/** Position id. */
positionid: number | null;
/** Whether the block is collapsible. */
collapsible: boolean | null;
/** Whether the block is dockable. */
dockable: boolean | null;
/** Used to order blocks within a region. */
weight: number | null;
/** Whether the block is visible. */
visible: boolean | null;
/** Block contents (if required). */
contents: ReturnsBlocksItemContents;
/** Block instance and plugin configuration settings. */
configs: ReturnsBlocksItemConfigs;
}
/**
* List of blocks in the dashboard.
*/
type ReturnsBlocks = ReturnsBlocksItem[];
/**
* warning
*/
interface ReturnsWarningsItem$54 {
/** item */
item: string | null;
/** item id */
itemid: number | null;
/** the warning code can be used by the client app to implement specific behaviour */
warningcode: string | null;
/** untranslated english message to explain the warning */
message: string | null;
}
/**
* list of warnings
*/
type ReturnsWarnings$54 = ReturnsWarningsItem$54[];
interface Returns$8A {
/** List of blocks in the dashboard. */
blocks: ReturnsBlocks;
/** list of warnings */
warnings: ReturnsWarnings$54;
}
type get_dashboard_blocks_ReturnsBlocks = ReturnsBlocks;
type get_dashboard_blocks_ReturnsBlocksItem = ReturnsBlocksItem;
type get_dashboard_blocks_ReturnsBlocksItemConfigs = ReturnsBlocksItemConfigs;
type get_dashboard_blocks_ReturnsBlocksItemConfigsItem = ReturnsBlocksItemConfigsItem;
type get_dashboard_blocks_ReturnsBlocksItemContents = ReturnsBlocksItemContents;
type get_dashboard_blocks_ReturnsBlocksItemContentsFiles = ReturnsBlocksItemContentsFiles;
type get_dashboard_blocks_ReturnsBlocksItemContentsFilesItem = ReturnsBlocksItemContentsFilesItem;
declare namespace get_dashboard_blocks {
export {
Params$aw as Params,
Returns$8A as Returns,
get_dashboard_blocks_ReturnsBlocks as ReturnsBlocks,
get_dashboard_blocks_ReturnsBlocksItem as ReturnsBlocksItem,
get_dashboard_blocks_ReturnsBlocksItemConfigs as ReturnsBlocksItemConfigs,
get_dashboard_blocks_ReturnsBlocksItemConfigsItem as ReturnsBlocksItemConfigsItem,
get_dashboard_blocks_ReturnsBlocksItemContents as ReturnsBlocksItemContents,
get_dashboard_blocks_ReturnsBlocksItemContentsFiles as ReturnsBlocksItemContentsFiles,
get_dashboard_blocks_ReturnsBlocksItemContentsFilesItem as ReturnsBlocksItemContentsFilesItem,
ReturnsWarnings$54 as ReturnsWarnings,
ReturnsWarningsItem$54 as ReturnsWarningsItem,
};
}
declare const index$1x_fetch_addable_blocks: typeof fetch_addable_blocks;
declare const index$1x_get_course_blocks: typeof get_course_blocks;
declare const index$1x_get_dashboard_blocks: typeof get_dashboard_blocks;
declare namespace index$1x {
export {
index$1x_fetch_addable_blocks as fetch_addable_blocks,
index$1x_get_course_blocks as get_course_blocks,
index$1x_get_dashboard_blocks as get_dashboard_blocks,
};
}
interface ParamsFiltersItem$4 {
/** The expected keys (value format) are: tag PARAM_NOTAGS blog tag tagid PARAM_INT blog tag id userid PARAM_INT blog author (userid) cmid PARAM_INT course module id entryid PARAM_INT entry id groupid PARAM_INT group id courseid PARAM_INT course id search PARAM_RAW search term */
name: string | null;
/** The value of the filter. */
value: string | null;
}
/**
* Parameters to filter blog listings.
*/
type ParamsFilters$4 = ParamsFiltersItem$4[];
interface Params$av {
/** Parameters to filter blog listings. */
filters?: ParamsFilters$4;
/** The blog page to return. */
page?: number | null;
/** The number of posts to return per page. */
perpage?: number | null;
}
interface ReturnsEntriesItemSummaryfilesItem {
/** File name. */
filename: string;
/** File path. */
filepath: string;
/** File size. */
filesize: number;
/** Downloadable file url. */
fileurl: string;
/** Time modified. */
timemodified: number;
/** File mime type. */
mimetype: string;
/** Whether is an external file. */
isexternalfile: boolean;
/** The repository type for the external files. */
repositorytype: string | null;
}
/**
* summaryfiles
*/
type ReturnsEntriesItemSummaryfiles = ReturnsEntriesItemSummaryfilesItem[];
interface ReturnsEntriesItemAttachmentfilesItem {
/** File name. */
filename: string;
/** File path. */
filepath: string;
/** File size. */
filesize: number;
/** Downloadable file url. */
fileurl: string;
/** Time modified. */
timemodified: number;
/** File mime type. */
mimetype: string;
/** Whether is an external file. */
isexternalfile: boolean;
/** The repository type for the external files. */
repositorytype: string | null;
}
/**
* attachmentfiles
*/
type ReturnsEntriesItemAttachmentfiles = ReturnsEntriesItemAttachmentfilesItem[];
interface ReturnsEntriesItemTagsItem$a {
/** Tag id. */
id: number;
/** Tag name. */
name: string;
/** The raw, unnormalised name for the tag as entered by users. */
rawname: string;
/** Whether this tag is standard. */
isstandard: boolean;
/** Tag collection id. */
tagcollid: number;
/** Tag instance id. */
taginstanceid: number;
/** Context the tag instance belongs to. */
taginstancecontextid: number;
/** Id of the record tagged. */
itemid: number;
/** Tag ordering. */
ordering: number;
/** Whether the tag is flagged as inappropriate. */
flag: number | null;
}
/**
* Tags.
*/
type ReturnsEntriesItemTags$a = ReturnsEntriesItemTagsItem$a[];
interface ReturnsEntriesItem$a {
/** Post/entry id. */
id: number | null;
/** Where it was published the post (blog, blog_external...). */
module: string;
/** Post author. */
userid: number;
/** Course where the post was created. */
courseid: number;
/** Group post was created for. */
groupid: number;
/** Module id where the post was created (not used anymore). */
moduleid: number;
/** Course module id where the post was created. */
coursemoduleid: number;
/** Post subject. */
subject: string;
/** Post summary. */
summary: string | null;
/** summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN */
summaryformat?: number | null;
/** Post content. */
content: string | null;
/** Post unique hash. */
uniquehash: string;
/** Post rating. */
rating: number;
/** Post content format. */
format: number;
/** Post atachment. */
attachment: string | null;
/** Post publish state. */
publishstate: string;
/** When it was last modified. */
lastmodified: number;
/** When it was created. */
created: number;
/** User that updated the post. */
usermodified: number | null;
/** summaryfiles */
summaryfiles: ReturnsEntriesItemSummaryfiles;
/** attachmentfiles */
attachmentfiles: ReturnsEntriesItemAttachmentfiles;
/** Tags. */
tags: ReturnsEntriesItemTags$a;
}
type ReturnsEntries$a = ReturnsEntriesItem$a[];
/**
* warning
*/
interface ReturnsWarningsItem$53 {
/** item */
item: string | null;
/** item id */
itemid: number | null;
/** the warning code can be used by the client app to implement specific behaviour */
warningcode: string | null;
/** untranslated english message to explain the warning */
message: string | null;
}
/**
* list of warnings
*/
type ReturnsWarnings$53 = ReturnsWarningsItem$53[];
interface Returns$8z {
entries: ReturnsEntries$a;
/** The total number of entries found. */
totalentries: number | null;
/** list of warnings */
warnings: ReturnsWarnings$53;
}
type get_entries$1_ReturnsEntriesItemAttachmentfiles = ReturnsEntriesItemAttachmentfiles;
type get_entries$1_ReturnsEntriesItemAttachmentfilesItem = ReturnsEntriesItemAttachmentfilesItem;
type get_entries$1_ReturnsEntriesItemSummaryfiles = ReturnsEntriesItemSummaryfiles;
type get_entries$1_ReturnsEntriesItemSummaryfilesItem = ReturnsEntriesItemSummaryfilesItem;
declare namespace get_entries$1 {
export {
Params$av as Params,
ParamsFilters$4 as ParamsFilters,
ParamsFiltersItem$4 as ParamsFiltersItem,
Returns$8z as Returns,
ReturnsEntries$a as ReturnsEntries,
ReturnsEntriesItem$a as ReturnsEntriesItem,
get_entries$1_ReturnsEntriesItemAttachmentfiles as ReturnsEntriesItemAttachmentfiles,
get_entries$1_ReturnsEntriesItemAttachmentfilesItem as ReturnsEntriesItemAttachmentfilesItem,
get_entries$1_ReturnsEntriesItemSummaryfiles as ReturnsEntriesItemSummaryfiles,
get_entries$1_ReturnsEntriesItemSummaryfilesItem as ReturnsEntriesItemSummaryfilesItem,
ReturnsEntriesItemTags$a as ReturnsEntriesItemTags,
ReturnsEntriesItemTagsItem$a as ReturnsEntriesItemTagsItem,
ReturnsWarnings$53 as ReturnsWarnings,
ReturnsWarningsItem$53 as ReturnsWarningsItem,
};
}
interface ParamsFiltersItem$3 {
/** The expected keys (value format) are: tag PARAM_NOTAGS blog tag tagid PARAM_INT blog tag id userid PARAM_INT blog author (userid) cmid PARAM_INT course module id entryid PARAM_INT entry id groupid PARAM_INT group id courseid PARAM_INT course id search PARAM_RAW search term */
name: string | null;
/** The value of the filter. */
value: string | null;
}
/**
* Parameters used in the filter of view_entries.
*/
type ParamsFilters$3 = ParamsFiltersItem$3[];
interface Params$au {
/** Parameters used in the filter of view_entries. */
filters?: ParamsFilters$3;
}
/**
* warning
*/
interface ReturnsWarningsItem$52 {
/** item */
item: string | null;
/** item id */
itemid: number | null;
/** the warning code can be used by the client app to implement specific behaviour */
warningcode: string | null;
/** untranslated english message to explain the warning */
message: string | null;
}
/**
* list of warnings
*/
type ReturnsWarnings$52 = ReturnsWarningsItem$52[];
interface Returns$8y {
/** status: true if success */
status: boolean | null;
/** list of warnings */
warnings: ReturnsWarnings$52;
}
declare namespace view_entries {
export {
Params$au as Params,
ParamsFilters$3 as ParamsFilters,
ParamsFiltersItem$3 as ParamsFiltersItem,
Returns$8y as Returns,
ReturnsWarnings$52 as ReturnsWarnings,
ReturnsWarningsItem$52 as ReturnsWarningsItem,
};
}
declare const index$1w_view_entries: typeof view_entries;
declare namespace index$1w {
export {
get_entries$1 as get_entries,
index$1w_view_entries as view_entries,
};
}
/**
* event
*/
interface ParamsEventsItem$1 {
/** event name */
name: string;
/** Description */
description?: string | null;
/** description format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN */
format?: number | null;
/** course id */
courseid?: number;
/** group id */
groupid?: number;
/** number of repeats */
repeats?: number;
/** Event type */
eventtype?: string;
/** timestart */
timestart?: number;
/** time duration */
timeduration?: number;
/** visible */
visible?: number;
/** sequence */
sequence?: number;
}
type ParamsEvents$2 = ParamsEventsItem$1[];
interface Params$at {
events: ParamsEvents$2;
}
/**
* event
*/
interface ReturnsEventsItem$5 {
/** event id */
id: number | null;
/** event name */
name: string | null;
/** Description */
description: string | null;
/** description format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN */
format: number | null;
/** course id */
courseid: number | null;
/** group id */
groupid: number | null;
/** user id */
userid: number | null;
/** repeat id */
repeatid: number | null;
/** module name */
modulename: string | null;
/** instance id */
instance: number | null;
/** Event type */
eventtype: string | null;
/** timestart */
timestart: number | null;
/** time duration */
timeduration: number | null;
/** visible */
visible: number | null;
/** unique id of ical events */
uuid: string;
/** sequence */
sequence: number | null;
/** time modified */
timemodified: number | null;
/** Subscription id */
subscriptionid: number | null;
}
type ReturnsEvents$5 = ReturnsEventsItem$5[];
/**
* warning
*/
interface ReturnsWarningsItem$51 {
/** item */
item: string | null;
/** item id */
itemid: number | null;
/** the warning code can be used by the client app to implement specific behaviour */
warningcode: string | null;
/** untranslated english message to explain the warning */
message: string | null;
}
/**
* list of warnings
*/
type ReturnsWarnings$51 = ReturnsWarningsItem$51[];
interface Returns$8x {
events: ReturnsEvents$5;
/** list of warnings */
warnings: ReturnsWarnings$51;
}
declare namespace create_calendar_events {
export {
Params$at as Params,
ParamsEvents$2 as ParamsEvents,
ParamsEventsItem$1 as ParamsEventsItem,
Returns$8x as Returns,
ReturnsEvents$5 as ReturnsEvents,
ReturnsEventsItem$5 as ReturnsEventsItem,
ReturnsWarnings$51 as ReturnsWarnings,
ReturnsWarningsItem$51 as ReturnsWarningsItem,
};
}
/**
* List of events to delete
*/
interface ParamsEventsItem {
/** Event ID */
eventid: number;
/** Delete comeplete series if repeated event */
repeat: boolean | null;
}
type ParamsEvents$1 = ParamsEventsItem[];
interface Params$as {
events: ParamsEvents$1;
}
type delete_calendar_events_ParamsEventsItem = ParamsEventsItem;
declare namespace delete_calendar_events {
export {
Params$as as Params,
ParamsEvents$1 as ParamsEvents,
delete_calendar_events_ParamsEventsItem as ParamsEventsItem,
};
}
interface Params$ar {
/** The id of the subscription */
subscriptionid: number | null;
}
/**
* warning
*/
interface ReturnsWarningsItem$50 {
/** item */
item: string | null;
/** item id */
itemid: number | null;
/** the warning code can be used by the client app to implement specific behaviour */
warningcode: string | null;
/** untranslated english message to explain the warning */
message: string | null;
}
/**
* list of warnings
*/
type ReturnsWarnings$50 = ReturnsWarningsItem$50[];
interface Returns$8w {
/** status: true if success */
status: boolean | null;
/** list of warnings */
warnings: ReturnsWarnings$50;
}
declare namespace delete_subscription {
export {
Params$ar as Params,
Returns$8w as Returns,
ReturnsWarnings$50 as ReturnsWarnings,
ReturnsWarningsItem$50 as ReturnsWarningsItem,
};
}
interface Params$aq {
/** Course id */
courseid: number | null;
/** Time sort from */
timesortfrom?: number | null;
/** Time sort to */
timesortto?: number | null;
/** The last seen event id */
aftereventid?: number | null;
/** Limit number */
limitnum?: number | null;
/** The value a user wishes to search against */
searchvalue?: string | null;
}
interface ReturnsEventsItemIcon$3 {
/** key */
key: string;
/** component */
component: string;
/** alttext */
alttext: string;
/** iconurl */
iconurl: string;
/** iconclass */
iconclass: string;
}
interface ReturnsEventsItemCategory$3 {
/** id */
id: number;
/** name */
name: string;
/** idnumber */
idnumber: string | null;
/** description */
description: string;
/** parent */
parent: number;
/** coursecount */
coursecount: number;
/** visible */
visible: number;
/** timemodified */
timemodified: number;
/** depth */
depth: number;
/** nestedname */
nestedname: string;
/** url */
url: string;
}
interface ReturnsEventsItemCourse$3 {
/** id */
id: number;
/** fullname */
fullname: string;
/** shortname */
shortname: string;
/** idnumber */
idnumber: string;
/** summary */
summary: string | null;
/** summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN */
summaryformat: number | null;
/** startdate */
startdate: number;
/** enddate */
enddate: number;
/** visible */
visible: boolean;
/** showactivitydates */
showactivitydates: boolean | null;
/** showcompletionconditions */
showcompletionconditions: boolean | null;
/** pdfexportfont */
pdfexportfont: string | null;
/** fullnamedisplay */
fullnamedisplay: string;
/** viewurl */
viewurl: string;
/** courseimage */
courseimage: string;
/** progress */
progress: number;
/** hasprogress */
hasprogress: boolean;
/** isfavourite */
isfavourite: boolean;
/** hidden */
hidden: boolean;
/** timeaccess */
timeaccess: number;
/** showshortname */
showshortname: boolean;
/** coursecategory */
coursecategory: string;
}
interface ReturnsEventsItemSubscription$3 {
/** displayeventsource */
displayeventsource: boolean;
/** subscriptionname */
subscriptionname: string;
/** subscriptionurl */
subscriptionurl: string;
}
interface ReturnsEventsItemAction$3 {
/** name */
name: string;
/** url */
url: string;
/** itemcount */
itemcount: number;
/** actionable */
actionable: boolean;
/** showitemcount */
showitemcount: boolean;
}
interface ReturnsEventsItem$4 {
/** id */
id: number;
/** name */
name: string;
/**