@groton/canvas-api 0.3.0

package/dist/Endpoints/V1/Users/CustomData/store_custom_data.js

@@ -0,0 +1,121 @@
+import { client } from '../../../../Client.js';
+/**
+ * Store custom data
+ *
+ * Store arbitrary user data as JSON.
+ *
+ * Arbitrary JSON data can be stored for a User. A typical scenario would be an
+ * external site/service that registers users in Canvas and wants to capture
+ * additional info about them. The part of the URL that follows +/custom_data/+
+ * defines the scope of the request, and it reflects the structure of the JSON
+ * data to be stored or retrieved.
+ *
+ * The value +self+ may be used for +user_id+ to store data associated with the
+ * calling user. In order to access another user's custom data, you must be an
+ * account administrator with permission to manage users.
+ *
+ * A namespace parameter, +ns+, is used to prevent custom_data collisions
+ * between different apps. This parameter is required for all custom_data
+ * requests.
+ *
+ * A request with Content-Type multipart/form-data or Content-Type
+ * application/x-www-form-urlencoded can only be used to store strings.
+ *
+ * Example PUT with multipart/form-data data: curl
+ * 'https://<canvas>/api/v1/users/<user_id>/custom_data/telephone'\
+ * -X PUT\
+ * -F 'ns=com.my-organization.canvas-app'\
+ * -F 'data=555-1234'\
+ * -H 'Authorization: Bearer <token>'
+ *
+ * Response: !!!javascript { "data": "555-1234" }
+ *
+ * Subscopes (or, generated scopes) can also be specified by passing values to
+ * +data+[+subscope+].
+ *
+ * Example PUT specifying subscopes: curl
+ * 'https://<canvas>/api/v1/users/<user_id>/custom_data/body/measurements'\
+ * -X PUT\
+ * -F 'ns=com.my-organization.canvas-app'\
+ * -F 'data[waist]=32in'\
+ * -F 'data[inseam]=34in'\
+ * -F 'data[chest]=40in'\
+ * -H 'Authorization: Bearer <token>'
+ *
+ * Response: !!!javascript { "data": { "chest": "40in", "waist": "32in",
+ * "inseam": "34in" } }
+ *
+ * Following such a request, subsets of the stored data to be retrieved directly
+ * from a subscope.
+ *
+ * Example {api:UsersController#get_custom_data GET} from a generated scope curl
+ * 'https://<canvas>/api/v1/users/<user_id>/custom_data/body/measurements/chest'\
+ * -X GET\
+ * -F 'ns=com.my-organization.canvas-app'\
+ * -H 'Authorization: Bearer <token>'
+ *
+ * Response: !!!javascript { "data": "40in" }
+ *
+ * If you want to store more than just strings (i.e. numbers, arrays, hashes,
+ * true, false, and/or null), you must make a request with Content-Type
+ * application/json as in the following example.
+ *
+ * Example PUT with JSON data: curl
+ * 'https://<canvas>/api/v1/users/<user_id>/custom_data'\
+ * -H 'Content-Type: application/json'\
+ * -X PUT\
+ * -d '{ "ns": "com.my-organization.canvas-app", "data": { "a-number": 6.02e23,
+ * "a-bool": true, "a-string": "true", "a-hash": {"a": {"b": "ohai"}},
+ * "an-array": [1, "two", null, false] } }'\
+ * -H 'Authorization: Bearer <token>'
+ *
+ * Response: !!!javascript { "data": { "a-number": 6.02e+23, "a-bool": true,
+ * "a-string": "true", "a-hash": { "a": { "b": "ohai" } }, "an-array": [1,
+ * "two", null, false] } }
+ *
+ * If the data is an Object (as it is in the above example), then subsets of the
+ * data can be accessed by including the object's (possibly nested) keys in the
+ * scope of a GET request.
+ *
+ * Example {api:UsersController#get_custom_data GET} with a generated scope:
+ * curl 'https://<canvas>/api/v1/users/<user_id>/custom_data/a-hash/a/b'\
+ * -X GET\
+ * -F 'ns=com.my-organization.canvas-app'\
+ * -H 'Authorization: Bearer <token>'
+ *
+ * Response: !!!javascript { "data": "ohai" }
+ *
+ * On success, this endpoint returns an object containing the data that was
+ * stored.
+ *
+ * Responds with status code 200 if the scope already contained data, and it was
+ * overwritten by the data specified in the request.
+ *
+ * Responds with status code 201 if the scope was previously empty, and the data
+ * specified in the request was successfully stored there.
+ *
+ * Responds with status code 400 if the namespace parameter, +ns+, is missing or
+ * invalid, or if the +data+ parameter is missing.
+ *
+ * Responds with status code 409 if the requested scope caused a conflict and
+ * data was not stored. This happens when storing data at the requested scope
+ * would cause data at an outer scope to be lost. e.g., if +/custom_data+ was
+ * +{"fashion_app": {"hair": "blonde"}}+, but you tried to +`PUT
+ * /custom_data/fashion_app/hair/style -F data=buzz`+, then for the request to
+ * succeed,the value of +/custom_data/fashion_app/hair+ would have to become a
+ * hash, and its old string value would be lost. In this situation, an error
+ * object is returned with the following format:
+ *
+ * !!!javascript { "message": "write conflict for custom_data hash",
+ * "conflict_scope": "fashion_app/hair", "type_at_conflict": "String",
+ * "value_at_conflict": "blonde" }
+ *
+ * Nickname: store_custom_data
+ */
+export async function store_custom_data(options) {
+    const response = await client().fetchAs(`/api/v1/users/{user_id}/custom_data`, {
+        method: 'PUT',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Users/DashboardPositions/get.d.ts

@@ -0,0 +1,28 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type getPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    id: string | number;
+};
+export type getSearchParameters = Masquerade;
+type Options = {
+    pathParams: getPathParameters;
+} & ({
+    searchParams?: Partial<getSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: getSearchParameters;
+    strict: true;
+});
+/**
+ * Get dashboard positions
+ *
+ * Returns all dashboard positions that have been saved for a user.
+ *
+ * Nickname: get_dashboard_positions
+ */
+export declare function get(options: Options): Promise<void>;
+export {};

package/dist/Endpoints/V1/Users/DashboardPositions/get.js

@@ -0,0 +1,15 @@
+import { client } from '../../../../Client.js';
+/**
+ * Get dashboard positions
+ *
+ * Returns all dashboard positions that have been saved for a user.
+ *
+ * Nickname: get_dashboard_positions
+ */
+export async function get(options) {
+    const response = await client().fetchAs(`/api/v1/users/{id}/dashboard_positions`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Users/DashboardPositions/index.d.ts

@@ -0,0 +1,2 @@
+export * from '././get.js';
+export * from '././update.js';

package/dist/Endpoints/V1/Users/DashboardPositions/index.js

@@ -0,0 +1,2 @@
+export * from '././get.js';
+export * from '././update.js';

package/dist/Endpoints/V1/Users/DashboardPositions/update.d.ts

@@ -0,0 +1,33 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type updatePathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    id: string | number;
+};
+export type updateSearchParameters = Masquerade;
+type Options = {
+    pathParams: updatePathParameters;
+} & ({
+    searchParams?: Partial<updateSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: updateSearchParameters;
+    strict: true;
+});
+/**
+ * Update dashboard positions
+ *
+ * Updates the dashboard positions for a user for a given context. This allows
+ * positions for the dashboard cards and elsewhere to be customized on a per
+ * user basis.
+ *
+ * The asset string parameter should be in the format 'context_id', for example
+ * 'course_42'
+ *
+ * Nickname: update_dashboard_positions
+ */
+export declare function update(options: Options): Promise<void>;
+export {};

package/dist/Endpoints/V1/Users/DashboardPositions/update.js

@@ -0,0 +1,20 @@
+import { client } from '../../../../Client.js';
+/**
+ * Update dashboard positions
+ *
+ * Updates the dashboard positions for a user for a given context. This allows
+ * positions for the dashboard cards and elsewhere to be customized on a per
+ * user basis.
+ *
+ * The asset string parameter should be in the format 'context_id', for example
+ * 'course_42'
+ *
+ * Nickname: update_dashboard_positions
+ */
+export async function update(options) {
+    const response = await client().fetchAs(`/api/v1/users/{id}/dashboard_positions`, {
+        method: 'PUT',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Users/Enrollments/index.d.ts

@@ -0,0 +1 @@
+export * from '././list.js';

package/dist/Endpoints/V1/Users/Enrollments/index.js

@@ -0,0 +1 @@
+export * from '././list.js';

package/dist/Endpoints/V1/Users/Enrollments/list.d.ts

@@ -0,0 +1,127 @@
+import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
+import { Enrollment } from '../../../../Resources/Enrollments.js';
+export type listPathParameters = {
+    /**
+     * Filter by user_id (only valid for course or section enrollment queries).
+     * If set to the current user's id, this is a way to determine if the user
+     * has any enrollments in the course or section, independent of whether the
+     * user has permission to view other people on the roster.
+     *
+     * Type: string
+     */
+    user_id: string | number;
+};
+export type listSearchParameters = Masquerade & Paginated & Partial<{
+    /**
+     * A list of enrollment types to return. Accepted values are
+     * 'StudentEnrollment', 'TeacherEnrollment', 'TaEnrollment',
+     * 'DesignerEnrollment', and 'ObserverEnrollment.' If omitted, all
+     * enrollment types are returned. This argument is ignored if `role` is
+     * given.
+     */
+    type: string[];
+    /**
+     * A list of enrollment roles to return. Accepted values include
+     * course-level roles created by the {api:RoleOverridesController#add_role
+     * Add Role API} as well as the base enrollment types accepted by the `type`
+     * argument above.
+     */
+    role: string[];
+    /**
+     * Filter by enrollment state. If omitted, 'active' and 'invited'
+     * enrollments are returned. The following synthetic states are supported
+     * only when querying a user's enrollments (either via user_id argument or
+     * via user enrollments endpoint): +current_and_invited+,
+     * +current_and_future+, +current_future_and_restricted+,
+     * +current_and_concluded+
+     */
+    state: string[];
+    /**
+     * Array of additional information to include on the enrollment or user
+     * records. "avatar_url" and "group_ids" will be returned on the user
+     * record. If "current_points" is specified, the fields "current_points" and
+     * (if the caller has permissions to manage grades)
+     * "unposted_current_points" will be included in the "grades" hash for
+     * student enrollments.
+     */
+    include: string[];
+    /**
+     * Return grades for the given grading_period. If this parameter is not
+     * specified, the returned grades will be for the whole course.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    grading_period_id: number | string;
+    /**
+     * Returns only enrollments for the specified enrollment term. This
+     * parameter only applies to the user enrollments path. May pass the ID from
+     * the enrollment terms api or the SIS id prepended with 'sis_term_id:'.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    enrollment_term_id: number | string;
+    /**
+     * Returns only enrollments for the specified SIS account ID(s). Does not
+     * look into sub_accounts. May pass in array or string.
+     */
+    sis_account_id: string[];
+    /**
+     * Returns only enrollments matching the specified SIS course ID(s). May
+     * pass in array or string.
+     */
+    sis_course_id: string[];
+    /**
+     * Returns only section enrollments matching the specified SIS section
+     * ID(s). May pass in array or string.
+     */
+    sis_section_id: string[];
+    /**
+     * Returns only enrollments for the specified SIS user ID(s). May pass in
+     * array or string.
+     */
+    sis_user_id: string[];
+    /**
+     * If sis_user_id is present and created_for_sis_id is true, Returns only
+     * enrollments for the specified SIS ID(s). If a user has two sis_id's, one
+     * enrollment may be created using one of the two ids. This would limit the
+     * enrollments returned from the endpoint to enrollments that were created
+     * from a sis_import with that sis_user_id
+     */
+    created_for_sis_id: boolean | string[];
+}>;
+type Options = {
+    pathParams: listPathParameters;
+} & ({
+    searchParams?: Partial<listSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: listSearchParameters;
+    strict: true;
+});
+/**
+ * List enrollments
+ *
+ * Depending on the URL given, return a paginated list of either (1) all of the
+ * enrollments in a course, (2) all of the enrollments in a section or (3) all
+ * of a user's enrollments. This includes student, teacher, TA, and observer
+ * enrollments.
+ *
+ * If a user has multiple enrollments in a context (e.g. as a teacher and a
+ * student or in multiple course sections), each enrollment will be listed
+ * separately.
+ *
+ * Note: Currently, only a root level admin user can return other users'
+ * enrollments. A user can, however, return his/her own enrollments.
+ *
+ * Enrollments scoped to a course context will include inactive states by
+ * default if the caller has account admin authorization and the state[]
+ * parameter is omitted.
+ *
+ * Nickname: list_enrollments_users
+ */
+export declare function list(options: Options): Promise<Enrollment[]>;
+export {};

package/dist/Endpoints/V1/Users/Enrollments/list.js

@@ -0,0 +1,29 @@
+import { client } from '../../../../Client.js';
+/**
+ * List enrollments
+ *
+ * Depending on the URL given, return a paginated list of either (1) all of the
+ * enrollments in a course, (2) all of the enrollments in a section or (3) all
+ * of a user's enrollments. This includes student, teacher, TA, and observer
+ * enrollments.
+ *
+ * If a user has multiple enrollments in a context (e.g. as a teacher and a
+ * student or in multiple course sections), each enrollment will be listed
+ * separately.
+ *
+ * Note: Currently, only a root level admin user can return other users'
+ * enrollments. A user can, however, return his/her own enrollments.
+ *
+ * Enrollments scoped to a course context will include inactive states by
+ * default if the caller has account admin authorization and the state[]
+ * parameter is omitted.
+ *
+ * Nickname: list_enrollments_users
+ */
+export async function list(options) {
+    const response = await client().fetchAs(`/api/v1/users/{user_id}/enrollments`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Users/Eportfolios/get.d.ts

@@ -0,0 +1,35 @@
+import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
+import { ePortfolio } from '../../../../Resources/EPortfolios.js';
+export type getPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    user_id: string | number;
+};
+export type getSearchParameters = Masquerade & Paginated & Partial<{
+    /**
+     * Deleted:: Include deleted ePortfolios. Only available to admins who can
+     * moderate_user_content.
+     */
+    include: string[];
+}>;
+type Options = {
+    pathParams: getPathParameters;
+} & ({
+    searchParams?: Partial<getSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: getSearchParameters;
+    strict: true;
+});
+/**
+ * Get all ePortfolios for a User
+ *
+ * Get a list of all ePortfolios for the specified user.
+ *
+ * Nickname: get_all_eportfolios_for_user
+ */
+export declare function get(options: Options): Promise<ePortfolio[]>;
+export {};

package/dist/Endpoints/V1/Users/Eportfolios/get.js

@@ -0,0 +1,15 @@
+import { client } from '../../../../Client.js';
+/**
+ * Get all ePortfolios for a User
+ *
+ * Get a list of all ePortfolios for the specified user.
+ *
+ * Nickname: get_all_eportfolios_for_user
+ */
+export async function get(options) {
+    const response = await client().fetchAs(`/api/v1/users/{user_id}/eportfolios`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Users/Eportfolios/index.d.ts

@@ -0,0 +1,2 @@
+export * from '././get.js';
+export * from '././moderate_all_eportfolios_for_user.js';

package/dist/Endpoints/V1/Users/Eportfolios/index.js

@@ -0,0 +1,2 @@
+export * from '././get.js';
+export * from '././moderate_all_eportfolios_for_user.js';

package/dist/Endpoints/V1/Users/Eportfolios/moderate_all_eportfolios_for_user.d.ts

@@ -0,0 +1,35 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type moderate_all_eportfolios_for_userPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    user_id: string | number;
+};
+export type moderate_all_eportfolios_for_userSearchParameters = Masquerade;
+export type moderate_all_eportfolios_for_userFormParameters = Masquerade & {
+    /** The spam status for all the ePortfolios */
+    spam_status: string;
+};
+type Options = {
+    pathParams: moderate_all_eportfolios_for_userPathParameters;
+} & ({
+    searchParams?: Partial<moderate_all_eportfolios_for_userSearchParameters>;
+    params?: Partial<moderate_all_eportfolios_for_userFormParameters>;
+    strict?: false;
+} | {
+    searchParams: moderate_all_eportfolios_for_userSearchParameters;
+    params: moderate_all_eportfolios_for_userFormParameters;
+    strict: true;
+});
+/**
+ * Moderate all ePortfolios for a User
+ *
+ * Update the spam_status for all active eportfolios of a user. Only available
+ * to admins who can moderate_user_content.
+ *
+ * Nickname: moderate_all_eportfolios_for_user
+ */
+export declare function moderate_all_eportfolios_for_user(options: Options): Promise<void>;
+export {};

package/dist/Endpoints/V1/Users/Eportfolios/moderate_all_eportfolios_for_user.js

@@ -0,0 +1,16 @@
+import { client } from '../../../../Client.js';
+/**
+ * Moderate all ePortfolios for a User
+ *
+ * Update the spam_status for all active eportfolios of a user. Only available
+ * to admins who can moderate_user_content.
+ *
+ * Nickname: moderate_all_eportfolios_for_user
+ */
+export async function moderate_all_eportfolios_for_user(options) {
+    const response = await client().fetchAs(`/api/v1/users/{user_id}/eportfolios`, {
+        method: 'PUT',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Users/Features/Enabled/index.d.ts

@@ -0,0 +1 @@
+export * from '././list.js';

package/dist/Endpoints/V1/Users/Features/Enabled/index.js

@@ -0,0 +1 @@
+export * from '././list.js';

package/dist/Endpoints/V1/Users/Features/Enabled/list.d.ts

@@ -0,0 +1,29 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type listPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    user_id: string | number;
+};
+export type listSearchParameters = Masquerade;
+type Options = {
+    pathParams: listPathParameters;
+} & ({
+    searchParams?: Partial<listSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: listSearchParameters;
+    strict: true;
+});
+/**
+ * List enabled features
+ *
+ * A paginated list of all features that are enabled on a given Account, Course,
+ * or User. Only the feature names are returned.
+ *
+ * Nickname: list_enabled_features_users
+ */
+export declare function list(options: Options): Promise<void>;
+export {};

package/dist/Endpoints/V1/Users/Features/Enabled/list.js

@@ -0,0 +1,16 @@
+import { client } from '../../../../../Client.js';
+/**
+ * List enabled features
+ *
+ * A paginated list of all features that are enabled on a given Account, Course,
+ * or User. Only the feature names are returned.
+ *
+ * Nickname: list_enabled_features_users
+ */
+export async function list(options) {
+    const response = await client().fetchAs(`/api/v1/users/{user_id}/features/enabled`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Users/Features/Flags/get.d.ts

@@ -0,0 +1,35 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+import { FeatureFlag } from '../../../../../Resources/FeatureFlags.js';
+export type getPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    user_id: string | number;
+    /** ID */
+    feature: string;
+};
+export type getSearchParameters = Masquerade;
+type Options = {
+    pathParams: getPathParameters;
+} & ({
+    searchParams?: Partial<getSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: getSearchParameters;
+    strict: true;
+});
+/**
+ * Get feature flag
+ *
+ * Get the feature flag that applies to a given Account, Course, or User. The
+ * flag may be defined on the object, or it may be inherited from a parent
+ * account. You can look at the context_id and context_type of the returned
+ * object to determine which is the case. If these fields are missing, then the
+ * object is the global Canvas default.
+ *
+ * Nickname: get_feature_flag_users
+ */
+export declare function get(options: Options): Promise<FeatureFlag>;
+export {};

package/dist/Endpoints/V1/Users/Features/Flags/get.js

@@ -0,0 +1,19 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Get feature flag
+ *
+ * Get the feature flag that applies to a given Account, Course, or User. The
+ * flag may be defined on the object, or it may be inherited from a parent
+ * account. You can look at the context_id and context_type of the returned
+ * object to determine which is the case. If these fields are missing, then the
+ * object is the global Canvas default.
+ *
+ * Nickname: get_feature_flag_users
+ */
+export async function get(options) {
+    const response = await client().fetchAs(`/api/v1/users/{user_id}/features/flags/{feature}`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Users/Features/Flags/index.d.ts

@@ -0,0 +1,3 @@
+export * from '././get.js';
+export * from '././remove_feature_flag_users.js';
+export * from '././set_feature_flag_users.js';

package/dist/Endpoints/V1/Users/Features/Flags/index.js

@@ -0,0 +1,3 @@
+export * from '././get.js';
+export * from '././remove_feature_flag_users.js';
+export * from '././set_feature_flag_users.js';

package/dist/Endpoints/V1/Users/Features/Flags/remove_feature_flag_users.d.ts

@@ -0,0 +1,35 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+import { FeatureFlag } from '../../../../../Resources/FeatureFlags.js';
+export type remove_feature_flag_usersPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    user_id: string | number;
+    /** ID */
+    feature: string;
+};
+export type remove_feature_flag_usersSearchParameters = Masquerade;
+type Options = {
+    pathParams: remove_feature_flag_usersPathParameters;
+} & ({
+    searchParams?: Partial<remove_feature_flag_usersSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: remove_feature_flag_usersSearchParameters;
+    strict: true;
+});
+/**
+ * Remove feature flag
+ *
+ * Remove feature flag for a given Account, Course, or User. (Note that the flag
+ * must be defined on the Account, Course, or User directly.) The object will
+ * then inherit the feature flags from a higher account, if any exist. If this
+ * flag was 'on' or 'off', then lower-level account flags that were masked by
+ * this one will apply again.
+ *
+ * Nickname: remove_feature_flag_users
+ */
+export declare function remove_feature_flag_users(options: Options): Promise<FeatureFlag>;
+export {};