@groton/veracross-api 0.0.1 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/dist/Authorization/Oauth/Authorize/get.d.ts +6 -0
- package/dist/Authorization/Oauth/Authorize/get.js +11 -0
- package/dist/Authorization/Oauth/Authorize/index.d.ts +1 -0
- package/dist/Authorization/Oauth/Authorize/index.js +1 -0
- package/dist/Authorization/Oauth/Authorize/read.d.ts +7 -0
- package/dist/Authorization/Oauth/Authorize/read.js +12 -0
- package/dist/Authorization/Oauth/Discovery/Keys/get.d.ts +6 -0
- package/dist/Authorization/Oauth/Discovery/Keys/get.js +11 -0
- package/dist/Authorization/Oauth/Discovery/Keys/index.d.ts +1 -0
- package/dist/Authorization/Oauth/Discovery/Keys/index.js +1 -0
- package/dist/Authorization/Oauth/Discovery/Keys/read.d.ts +7 -0
- package/dist/Authorization/Oauth/Discovery/Keys/read.js +12 -0
- package/dist/Authorization/Oauth/Discovery/index.d.ts +1 -0
- package/dist/Authorization/Oauth/Discovery/index.js +1 -0
- package/dist/Authorization/Oauth/Introspect/create.d.ts +5 -0
- package/dist/Authorization/Oauth/Introspect/create.js +13 -0
- package/dist/Authorization/Oauth/Introspect/index.d.ts +1 -0
- package/dist/Authorization/Oauth/Introspect/index.js +1 -0
- package/dist/Authorization/Oauth/Introspect/post.d.ts +5 -0
- package/dist/Authorization/Oauth/Introspect/post.js +19 -0
- package/dist/Authorization/Oauth/Revoke/create.d.ts +5 -0
- package/dist/Authorization/Oauth/Revoke/create.js +13 -0
- package/dist/Authorization/Oauth/Revoke/index.d.ts +1 -0
- package/dist/Authorization/Oauth/Revoke/index.js +1 -0
- package/dist/Authorization/Oauth/Revoke/post.d.ts +5 -0
- package/dist/Authorization/Oauth/Revoke/post.js +19 -0
- package/dist/Authorization/Oauth/Token/create.d.ts +5 -0
- package/dist/Authorization/Oauth/Token/create.js +13 -0
- package/dist/Authorization/Oauth/Token/index.d.ts +1 -0
- package/dist/Authorization/Oauth/Token/index.js +1 -0
- package/dist/Authorization/Oauth/Token/post.d.ts +5 -0
- package/dist/Authorization/Oauth/Token/post.js +19 -0
- package/dist/Authorization/Oauth/Userinfo/get.d.ts +6 -0
- package/dist/Authorization/Oauth/Userinfo/get.js +11 -0
- package/dist/Authorization/Oauth/Userinfo/index.d.ts +1 -0
- package/dist/Authorization/Oauth/Userinfo/index.js +1 -0
- package/dist/Authorization/Oauth/Userinfo/read.d.ts +7 -0
- package/dist/Authorization/Oauth/Userinfo/read.js +12 -0
- package/dist/Authorization/Oauth/index.d.ts +6 -0
- package/dist/Authorization/Oauth/index.js +6 -0
- package/dist/Authorization/WellKnown/OpenidConfiguration/get.d.ts +6 -0
- package/dist/Authorization/WellKnown/OpenidConfiguration/get.js +11 -0
- package/dist/Authorization/WellKnown/OpenidConfiguration/index.d.ts +1 -0
- package/dist/Authorization/WellKnown/OpenidConfiguration/index.js +1 -0
- package/dist/Authorization/WellKnown/OpenidConfiguration/read.d.ts +7 -0
- package/dist/Authorization/WellKnown/OpenidConfiguration/read.js +12 -0
- package/dist/Authorization/WellKnown/index.d.ts +1 -0
- package/dist/Authorization/WellKnown/index.js +1 -0
- package/dist/Authorization/client.d.ts +5 -0
- package/dist/Authorization/client.js +20 -0
- package/dist/Authorization/index.d.ts +2 -0
- package/dist/Authorization/index.js +2 -0
- package/dist/Client.d.ts +6 -7
- package/dist/Client.js +2 -18
- package/dist/ClientWrapper.d.ts +5 -0
- package/dist/ClientWrapper.js +13 -0
- package/dist/Data/Academics/Assignments/Grades/list.d.ts +3 -2
- package/dist/Data/Academics/Assignments/Grades/list.js +1 -1
- package/dist/Data/Academics/Assignments/Grades/read.d.ts +3 -2
- package/dist/Data/Academics/Assignments/Grades/read.js +1 -1
- package/dist/Data/Academics/Assignments/Grades/update.d.ts +2 -1
- package/dist/Data/Academics/Assignments/Grades/update.js +1 -1
- package/dist/Data/Academics/CalendarRotationDays/list.d.ts +3 -2
- package/dist/Data/Academics/CalendarRotationDays/list.js +1 -1
- package/dist/Data/Academics/CalendarRotationDays/read.d.ts +3 -2
- package/dist/Data/Academics/CalendarRotationDays/read.js +1 -1
- package/dist/Data/Academics/ClassAttendanceStatuses/list.d.ts +3 -2
- package/dist/Data/Academics/ClassAttendanceStatuses/list.js +1 -1
- package/dist/Data/Academics/ClassAttendanceStatuses/read.d.ts +3 -2
- package/dist/Data/Academics/ClassAttendanceStatuses/read.js +1 -1
- package/dist/Data/Academics/ClassAttendanceStatuses/update.d.ts +2 -1
- package/dist/Data/Academics/ClassAttendanceStatuses/update.js +1 -1
- package/dist/Data/Academics/ClassSchedules/list.d.ts +3 -2
- package/dist/Data/Academics/ClassSchedules/list.js +1 -1
- package/dist/Data/Academics/Classes/Assignments/create.d.ts +2 -1
- package/dist/Data/Academics/Classes/Assignments/create.js +1 -1
- package/dist/Data/Academics/Classes/Assignments/delete.d.ts +2 -1
- package/dist/Data/Academics/Classes/Assignments/delete.js +1 -1
- package/dist/Data/Academics/Classes/Assignments/list.d.ts +3 -2
- package/dist/Data/Academics/Classes/Assignments/list.js +1 -1
- package/dist/Data/Academics/Classes/Assignments/read.d.ts +3 -2
- package/dist/Data/Academics/Classes/Assignments/read.js +1 -1
- package/dist/Data/Academics/Classes/Assignments/update.d.ts +2 -1
- package/dist/Data/Academics/Classes/Assignments/update.js +1 -1
- package/dist/Data/Academics/Classes/MeetingTimes/list.d.ts +3 -2
- package/dist/Data/Academics/Classes/MeetingTimes/list.js +1 -1
- package/dist/Data/Academics/Classes/MeetingTimes/read.d.ts +3 -2
- package/dist/Data/Academics/Classes/MeetingTimes/read.js +1 -1
- package/dist/Data/Academics/Classes/create.d.ts +2 -1
- package/dist/Data/Academics/Classes/create.js +1 -1
- package/dist/Data/Academics/Classes/list.d.ts +3 -2
- package/dist/Data/Academics/Classes/list.js +1 -1
- package/dist/Data/Academics/Classes/read.d.ts +3 -2
- package/dist/Data/Academics/Classes/read.js +1 -1
- package/dist/Data/Academics/Classes/update.d.ts +2 -1
- package/dist/Data/Academics/Classes/update.js +1 -1
- package/dist/Data/Academics/Config/BlockGroups/list.d.ts +3 -2
- package/dist/Data/Academics/Config/BlockGroups/list.js +1 -1
- package/dist/Data/Academics/Config/BlockGroups/read.d.ts +3 -2
- package/dist/Data/Academics/Config/BlockGroups/read.js +1 -1
- package/dist/Data/Academics/Config/BlockSchedules/list.d.ts +3 -2
- package/dist/Data/Academics/Config/BlockSchedules/list.js +1 -1
- package/dist/Data/Academics/Config/BlockSchedules/read.d.ts +3 -2
- package/dist/Data/Academics/Config/BlockSchedules/read.js +1 -1
- package/dist/Data/Academics/Config/BlockTimes/list.d.ts +3 -2
- package/dist/Data/Academics/Config/BlockTimes/list.js +1 -1
- package/dist/Data/Academics/Config/BlockTimes/read.d.ts +3 -2
- package/dist/Data/Academics/Config/BlockTimes/read.js +1 -1
- package/dist/Data/Academics/Config/Blocks/list.d.ts +3 -2
- package/dist/Data/Academics/Config/Blocks/list.js +1 -1
- package/dist/Data/Academics/Config/Blocks/read.d.ts +3 -2
- package/dist/Data/Academics/Config/Blocks/read.js +1 -1
- package/dist/Data/Academics/Config/BlocksByBlockGroups/list.d.ts +3 -2
- package/dist/Data/Academics/Config/BlocksByBlockGroups/list.js +1 -1
- package/dist/Data/Academics/Config/BlocksByBlockGroups/read.d.ts +3 -2
- package/dist/Data/Academics/Config/BlocksByBlockGroups/read.js +1 -1
- package/dist/Data/Academics/Config/GradeLevels/list.d.ts +3 -2
- package/dist/Data/Academics/Config/GradeLevels/list.js +1 -1
- package/dist/Data/Academics/Config/GradingPeriods/list.d.ts +3 -2
- package/dist/Data/Academics/Config/GradingPeriods/list.js +1 -1
- package/dist/Data/Academics/Config/GradingPeriods/read.d.ts +3 -2
- package/dist/Data/Academics/Config/GradingPeriods/read.js +1 -1
- package/dist/Data/Academics/Config/RotationDays/list.d.ts +3 -2
- package/dist/Data/Academics/Config/RotationDays/list.js +1 -1
- package/dist/Data/Academics/Config/RotationDays/read.d.ts +3 -2
- package/dist/Data/Academics/Config/RotationDays/read.js +1 -1
- package/dist/Data/Academics/Courses/create.d.ts +2 -1
- package/dist/Data/Academics/Courses/create.js +1 -1
- package/dist/Data/Academics/Courses/list.d.ts +3 -2
- package/dist/Data/Academics/Courses/list.js +1 -1
- package/dist/Data/Academics/Courses/read.d.ts +3 -2
- package/dist/Data/Academics/Courses/read.js +1 -1
- package/dist/Data/Academics/Courses/update.d.ts +2 -1
- package/dist/Data/Academics/Courses/update.js +1 -1
- package/dist/Data/Academics/Departments/list.d.ts +3 -2
- package/dist/Data/Academics/Departments/list.js +1 -1
- package/dist/Data/Academics/Departments/read.d.ts +3 -2
- package/dist/Data/Academics/Departments/read.js +1 -1
- package/dist/Data/Academics/Enrollments/create.d.ts +2 -1
- package/dist/Data/Academics/Enrollments/create.js +1 -1
- package/dist/Data/Academics/Enrollments/list.d.ts +3 -2
- package/dist/Data/Academics/Enrollments/list.js +1 -1
- package/dist/Data/Academics/Enrollments/read.d.ts +3 -2
- package/dist/Data/Academics/Enrollments/read.js +1 -1
- package/dist/Data/Academics/Enrollments/update.d.ts +2 -1
- package/dist/Data/Academics/Enrollments/update.js +1 -1
- package/dist/Data/Academics/NumericGrades/list.d.ts +3 -2
- package/dist/Data/Academics/NumericGrades/list.js +1 -1
- package/dist/Data/Academics/NumericGrades/read.d.ts +3 -2
- package/dist/Data/Academics/NumericGrades/read.js +1 -1
- package/dist/Data/Academics/NumericGrades/update.d.ts +2 -1
- package/dist/Data/Academics/NumericGrades/update.js +1 -1
- package/dist/Data/Academics/Permissions/list.d.ts +3 -2
- package/dist/Data/Academics/Permissions/list.js +1 -1
- package/dist/Data/Academics/Permissions/read.d.ts +3 -2
- package/dist/Data/Academics/Permissions/read.js +1 -1
- package/dist/Data/Academics/QualitativeGrades/list.d.ts +3 -2
- package/dist/Data/Academics/QualitativeGrades/list.js +1 -1
- package/dist/Data/Academics/QualitativeGrades/read.d.ts +3 -2
- package/dist/Data/Academics/QualitativeGrades/read.js +1 -1
- package/dist/Data/Academics/QualitativeGrades/update.d.ts +2 -1
- package/dist/Data/Academics/QualitativeGrades/update.js +1 -1
- package/dist/Data/Academics/Rooms/list.d.ts +3 -2
- package/dist/Data/Academics/Rooms/list.js +1 -1
- package/dist/Data/Academics/Rooms/read.d.ts +3 -2
- package/dist/Data/Academics/Rooms/read.js +1 -1
- package/dist/Data/Academics/RubricCategories/create.d.ts +2 -1
- package/dist/Data/Academics/RubricCategories/create.js +1 -1
- package/dist/Data/Academics/RubricCategories/list.d.ts +3 -2
- package/dist/Data/Academics/RubricCategories/list.js +1 -1
- package/dist/Data/Academics/RubricCategories/read.d.ts +3 -2
- package/dist/Data/Academics/RubricCategories/read.js +1 -1
- package/dist/Data/Academics/RubricCategories/update.d.ts +2 -1
- package/dist/Data/Academics/RubricCategories/update.js +1 -1
- package/dist/Data/Academics/RubricCriteria/create.d.ts +2 -1
- package/dist/Data/Academics/RubricCriteria/create.js +1 -1
- package/dist/Data/Academics/RubricCriteria/list.d.ts +3 -2
- package/dist/Data/Academics/RubricCriteria/list.js +1 -1
- package/dist/Data/Academics/RubricCriteria/read.d.ts +3 -2
- package/dist/Data/Academics/RubricCriteria/read.js +1 -1
- package/dist/Data/Academics/RubricCriteria/update.d.ts +2 -1
- package/dist/Data/Academics/RubricCriteria/update.js +1 -1
- package/dist/Data/Academics/RubricScaleLevels/create.d.ts +2 -1
- package/dist/Data/Academics/RubricScaleLevels/create.js +1 -1
- package/dist/Data/Academics/RubricScaleLevels/list.d.ts +3 -2
- package/dist/Data/Academics/RubricScaleLevels/list.js +1 -1
- package/dist/Data/Academics/RubricScaleLevels/read.d.ts +3 -2
- package/dist/Data/Academics/RubricScaleLevels/read.js +1 -1
- package/dist/Data/Academics/RubricScaleLevels/update.d.ts +2 -1
- package/dist/Data/Academics/RubricScaleLevels/update.js +1 -1
- package/dist/Data/Academics/RubricScales/create.d.ts +2 -1
- package/dist/Data/Academics/RubricScales/create.js +1 -1
- package/dist/Data/Academics/RubricScales/list.d.ts +3 -2
- package/dist/Data/Academics/RubricScales/list.js +1 -1
- package/dist/Data/Academics/RubricScales/read.d.ts +3 -2
- package/dist/Data/Academics/RubricScales/read.js +1 -1
- package/dist/Data/Academics/RubricScales/update.d.ts +2 -1
- package/dist/Data/Academics/RubricScales/update.js +1 -1
- package/dist/Data/Academics/Rubrics/create.d.ts +2 -1
- package/dist/Data/Academics/Rubrics/create.js +1 -1
- package/dist/Data/Academics/Rubrics/list.d.ts +3 -2
- package/dist/Data/Academics/Rubrics/list.js +1 -1
- package/dist/Data/Academics/Rubrics/read.d.ts +3 -2
- package/dist/Data/Academics/Rubrics/read.js +1 -1
- package/dist/Data/Academics/Rubrics/update.d.ts +2 -1
- package/dist/Data/Academics/Rubrics/update.js +1 -1
- package/dist/Data/Academics/StudentAlerts/list.d.ts +3 -2
- package/dist/Data/Academics/StudentAlerts/list.js +1 -1
- package/dist/Data/Academics/StudentAlerts/read.d.ts +3 -2
- package/dist/Data/Academics/StudentAlerts/read.js +1 -1
- package/dist/Data/Academics/StudentAlerts/update.d.ts +2 -1
- package/dist/Data/Academics/StudentAlerts/update.js +1 -1
- package/dist/Data/Academics/StudentAssignments/list.d.ts +3 -2
- package/dist/Data/Academics/StudentAssignments/list.js +1 -1
- package/dist/Data/Academics/StudentAssignments/read.d.ts +3 -2
- package/dist/Data/Academics/StudentAssignments/read.js +1 -1
- package/dist/Data/Academics/StudentDailySchedules/list.d.ts +3 -2
- package/dist/Data/Academics/StudentDailySchedules/list.js +1 -1
- package/dist/Data/Academics/Subjects/list.d.ts +3 -2
- package/dist/Data/Academics/Subjects/list.js +1 -1
- package/dist/Data/Academics/Subjects/read.d.ts +3 -2
- package/dist/Data/Academics/Subjects/read.js +1 -1
- package/dist/Data/Academics/TeacherDailySchedules/list.d.ts +3 -2
- package/dist/Data/Academics/TeacherDailySchedules/list.js +1 -1
- package/dist/Data/Admission/Applicants/Relationships/create.d.ts +2 -1
- package/dist/Data/Admission/Applicants/Relationships/create.js +1 -1
- package/dist/Data/Admission/Applicants/Relationships/list.d.ts +3 -2
- package/dist/Data/Admission/Applicants/Relationships/list.js +1 -1
- package/dist/Data/Admission/Applicants/Relationships/read.d.ts +3 -2
- package/dist/Data/Admission/Applicants/Relationships/read.js +1 -1
- package/dist/Data/Admission/Applicants/Relationships/update.d.ts +2 -1
- package/dist/Data/Admission/Applicants/Relationships/update.js +1 -1
- package/dist/Data/Admission/Applicants/create.d.ts +2 -1
- package/dist/Data/Admission/Applicants/create.js +1 -1
- package/dist/Data/Admission/Applicants/list.d.ts +3 -2
- package/dist/Data/Admission/Applicants/list.js +1 -1
- package/dist/Data/Admission/Applicants/read.d.ts +3 -2
- package/dist/Data/Admission/Applicants/read.js +1 -1
- package/dist/Data/Admission/Applicants/update.d.ts +2 -1
- package/dist/Data/Admission/Applicants/update.js +1 -1
- package/dist/Data/Admission/Applications/Checklists/list.d.ts +3 -2
- package/dist/Data/Admission/Applications/Checklists/list.js +1 -1
- package/dist/Data/Admission/Applications/Checklists/read.d.ts +3 -2
- package/dist/Data/Admission/Applications/Checklists/read.js +1 -1
- package/dist/Data/Admission/Applications/Checklists/update.d.ts +2 -1
- package/dist/Data/Admission/Applications/Checklists/update.js +1 -1
- package/dist/Data/Admission/Applications/create.d.ts +2 -1
- package/dist/Data/Admission/Applications/create.js +1 -1
- package/dist/Data/Admission/Applications/list.d.ts +3 -2
- package/dist/Data/Admission/Applications/list.js +1 -1
- package/dist/Data/Admission/Applications/read.d.ts +3 -2
- package/dist/Data/Admission/Applications/read.js +1 -1
- package/dist/Data/Admission/Applications/update.d.ts +2 -1
- package/dist/Data/Admission/Applications/update.js +1 -1
- package/dist/Data/Admission/Citizenships/create.d.ts +2 -1
- package/dist/Data/Admission/Citizenships/create.js +1 -1
- package/dist/Data/Admission/Citizenships/list.d.ts +3 -2
- package/dist/Data/Admission/Citizenships/list.js +1 -1
- package/dist/Data/Admission/Citizenships/read.d.ts +3 -2
- package/dist/Data/Admission/Citizenships/read.js +1 -1
- package/dist/Data/Admission/Citizenships/update.d.ts +2 -1
- package/dist/Data/Admission/Citizenships/update.js +1 -1
- package/dist/Data/Admission/Config/Years/Checklists/list.d.ts +3 -2
- package/dist/Data/Admission/Config/Years/Checklists/list.js +1 -1
- package/dist/Data/Admission/Config/Years/Checklists/read.d.ts +3 -2
- package/dist/Data/Admission/Config/Years/Checklists/read.js +1 -1
- package/dist/Data/Admission/Config/Years/list.d.ts +3 -2
- package/dist/Data/Admission/Config/Years/list.js +1 -1
- package/dist/Data/Admission/Config/Years/read.d.ts +3 -2
- package/dist/Data/Admission/Config/Years/read.js +1 -1
- package/dist/Data/Admission/Households/Members/list.d.ts +3 -2
- package/dist/Data/Admission/Households/Members/list.js +1 -1
- package/dist/Data/Admission/Households/list.d.ts +3 -2
- package/dist/Data/Admission/Households/list.js +1 -1
- package/dist/Data/Admission/Households/read.d.ts +3 -2
- package/dist/Data/Admission/Households/read.js +1 -1
- package/dist/Data/Admission/Households/update.d.ts +2 -1
- package/dist/Data/Admission/Households/update.js +1 -1
- package/dist/Data/Admission/Languages/create.d.ts +2 -1
- package/dist/Data/Admission/Languages/create.js +1 -1
- package/dist/Data/Admission/Languages/list.d.ts +3 -2
- package/dist/Data/Admission/Languages/list.js +1 -1
- package/dist/Data/Admission/Languages/read.d.ts +3 -2
- package/dist/Data/Admission/Languages/read.js +1 -1
- package/dist/Data/Admission/Languages/update.d.ts +2 -1
- package/dist/Data/Admission/Languages/update.js +1 -1
- package/dist/Data/Admission/Relatives/Relationships/create.d.ts +2 -1
- package/dist/Data/Admission/Relatives/Relationships/create.js +1 -1
- package/dist/Data/Admission/Relatives/Relationships/list.d.ts +3 -2
- package/dist/Data/Admission/Relatives/Relationships/list.js +1 -1
- package/dist/Data/Admission/Relatives/Relationships/read.d.ts +3 -2
- package/dist/Data/Admission/Relatives/Relationships/read.js +1 -1
- package/dist/Data/Admission/Relatives/Relationships/update.d.ts +2 -1
- package/dist/Data/Admission/Relatives/Relationships/update.js +1 -1
- package/dist/Data/Admission/Relatives/create.d.ts +2 -1
- package/dist/Data/Admission/Relatives/create.js +1 -1
- package/dist/Data/Admission/Relatives/list.d.ts +3 -2
- package/dist/Data/Admission/Relatives/list.js +1 -1
- package/dist/Data/Admission/Relatives/read.d.ts +3 -2
- package/dist/Data/Admission/Relatives/read.js +1 -1
- package/dist/Data/Admission/Relatives/update.d.ts +2 -1
- package/dist/Data/Admission/Relatives/update.js +1 -1
- package/dist/Data/Alumni/Demographics/list.d.ts +3 -2
- package/dist/Data/Alumni/Demographics/list.js +1 -1
- package/dist/Data/Alumni/Demographics/read.d.ts +3 -2
- package/dist/Data/Alumni/Demographics/read.js +1 -1
- package/dist/Data/Athletics/Coaches/list.d.ts +3 -2
- package/dist/Data/Athletics/Coaches/list.js +1 -1
- package/dist/Data/Athletics/Rosters/create.d.ts +2 -1
- package/dist/Data/Athletics/Rosters/create.js +1 -1
- package/dist/Data/Athletics/Rosters/list.d.ts +3 -2
- package/dist/Data/Athletics/Rosters/list.js +1 -1
- package/dist/Data/Athletics/Rosters/read.d.ts +3 -2
- package/dist/Data/Athletics/Rosters/read.js +1 -1
- package/dist/Data/Athletics/Rosters/update.d.ts +2 -1
- package/dist/Data/Athletics/Rosters/update.js +1 -1
- package/dist/Data/Athletics/Sports/create.d.ts +2 -1
- package/dist/Data/Athletics/Sports/create.js +1 -1
- package/dist/Data/Athletics/Sports/list.d.ts +3 -2
- package/dist/Data/Athletics/Sports/list.js +1 -1
- package/dist/Data/Athletics/Sports/read.d.ts +3 -2
- package/dist/Data/Athletics/Sports/read.js +1 -1
- package/dist/Data/Athletics/Sports/update.d.ts +2 -1
- package/dist/Data/Athletics/Sports/update.js +1 -1
- package/dist/Data/Athletics/Team/PracticeSchedules/list.d.ts +3 -2
- package/dist/Data/Athletics/Team/PracticeSchedules/list.js +1 -1
- package/dist/Data/Athletics/Teams/create.d.ts +2 -1
- package/dist/Data/Athletics/Teams/create.js +1 -1
- package/dist/Data/Athletics/Teams/list.d.ts +3 -2
- package/dist/Data/Athletics/Teams/list.js +1 -1
- package/dist/Data/Athletics/Teams/read.d.ts +3 -2
- package/dist/Data/Athletics/Teams/read.js +1 -1
- package/dist/Data/Athletics/Teams/update.d.ts +2 -1
- package/dist/Data/Athletics/Teams/update.js +1 -1
- package/dist/Data/AttendanceStatusCodes/list.d.ts +3 -2
- package/dist/Data/AttendanceStatusCodes/list.js +1 -1
- package/dist/Data/Behavior/create.d.ts +2 -1
- package/dist/Data/Behavior/create.js +1 -1
- package/dist/Data/Behavior/list.d.ts +3 -2
- package/dist/Data/Behavior/list.js +1 -1
- package/dist/Data/Behavior/read.d.ts +3 -2
- package/dist/Data/Behavior/read.js +1 -1
- package/dist/Data/Behavior/update.d.ts +2 -1
- package/dist/Data/Behavior/update.js +1 -1
- package/dist/Data/BehaviorIncidentTypes/list.d.ts +3 -2
- package/dist/Data/BehaviorIncidentTypes/list.js +1 -1
- package/dist/Data/BehaviorIncidentTypes/read.d.ts +3 -2
- package/dist/Data/BehaviorIncidentTypes/read.js +1 -1
- package/dist/Data/BehaviorIncidentTypes/update.d.ts +2 -1
- package/dist/Data/BehaviorIncidentTypes/update.js +1 -1
- package/dist/Data/Boarding/Dorms/Attendance/list.d.ts +3 -2
- package/dist/Data/Boarding/Dorms/Attendance/list.js +1 -1
- package/dist/Data/Boarding/Dorms/Attendance/read.d.ts +3 -2
- package/dist/Data/Boarding/Dorms/Attendance/read.js +1 -1
- package/dist/Data/Boarding/Dorms/Attendance/update.d.ts +2 -1
- package/dist/Data/Boarding/Dorms/Attendance/update.js +1 -1
- package/dist/Data/Boarding/Dorms/Students/list.d.ts +3 -2
- package/dist/Data/Boarding/Dorms/Students/list.js +1 -1
- package/dist/Data/Boarding/Dorms/Students/read.d.ts +3 -2
- package/dist/Data/Boarding/Dorms/Students/read.js +1 -1
- package/dist/Data/Boarding/Dorms/Students/update.d.ts +2 -1
- package/dist/Data/Boarding/Dorms/Students/update.js +1 -1
- package/dist/Data/Boarding/Dorms/list.d.ts +3 -2
- package/dist/Data/Boarding/Dorms/list.js +1 -1
- package/dist/Data/Boarding/Dorms/read.d.ts +3 -2
- package/dist/Data/Boarding/Dorms/read.js +1 -1
- package/dist/Data/Calendars/ParentCalendars/list.d.ts +3 -2
- package/dist/Data/Calendars/ParentCalendars/list.js +1 -1
- package/dist/Data/Calendars/StudentCalendars/list.d.ts +3 -2
- package/dist/Data/Calendars/StudentCalendars/list.js +1 -1
- package/dist/Data/ClassPermissions/list.d.ts +3 -2
- package/dist/Data/ClassPermissions/list.js +1 -1
- package/dist/Data/Classes/Attendance/list.d.ts +3 -2
- package/dist/Data/Classes/Attendance/list.js +1 -1
- package/dist/Data/Classes/Attendance/read.d.ts +3 -2
- package/dist/Data/Classes/Attendance/read.js +1 -1
- package/dist/Data/Classes/Attendance/update.d.ts +2 -1
- package/dist/Data/Classes/Attendance/update.js +1 -1
- package/dist/Data/Classes/list.d.ts +3 -2
- package/dist/Data/Classes/list.js +1 -1
- package/dist/Data/Classes/read.d.ts +3 -2
- package/dist/Data/Classes/read.js +1 -1
- package/dist/Data/ContactInfo/list.d.ts +3 -2
- package/dist/Data/ContactInfo/list.js +1 -1
- package/dist/Data/ContactInfo/read.d.ts +3 -2
- package/dist/Data/ContactInfo/read.js +1 -1
- package/dist/Data/ContactInfo/update.d.ts +2 -1
- package/dist/Data/ContactInfo/update.js +1 -1
- package/dist/Data/ConvertParentToStaff/create.d.ts +2 -1
- package/dist/Data/ConvertParentToStaff/create.js +1 -1
- package/dist/Data/Courses/list.d.ts +3 -2
- package/dist/Data/Courses/list.js +1 -1
- package/dist/Data/Courses/read.d.ts +3 -2
- package/dist/Data/Courses/read.js +1 -1
- package/dist/Data/Courses/update.d.ts +2 -1
- package/dist/Data/Courses/update.js +1 -1
- package/dist/Data/Development/Constituents/list.d.ts +3 -2
- package/dist/Data/Development/Constituents/list.js +1 -1
- package/dist/Data/Development/Constituents/read.d.ts +3 -2
- package/dist/Data/Development/Constituents/read.js +1 -1
- package/dist/Data/Development/Gifts/list.d.ts +3 -2
- package/dist/Data/Development/Gifts/list.js +1 -1
- package/dist/Data/Development/Gifts/read.d.ts +3 -2
- package/dist/Data/Development/Gifts/read.js +1 -1
- package/dist/Data/Directory/Configurations/list.d.ts +3 -2
- package/dist/Data/Directory/Configurations/list.js +1 -1
- package/dist/Data/Directory/Household/list.d.ts +3 -2
- package/dist/Data/Directory/Household/list.js +1 -1
- package/dist/Data/Directory/Preferences/Household/list.d.ts +3 -2
- package/dist/Data/Directory/Preferences/Household/list.js +1 -1
- package/dist/Data/Directory/Preferences/Household/read.d.ts +3 -2
- package/dist/Data/Directory/Preferences/Household/read.js +1 -1
- package/dist/Data/Directory/Preferences/Household/update.d.ts +2 -1
- package/dist/Data/Directory/Preferences/Household/update.js +1 -1
- package/dist/Data/Directory/Preferences/People/list.d.ts +3 -2
- package/dist/Data/Directory/Preferences/People/list.js +1 -1
- package/dist/Data/Directory/Preferences/People/read.d.ts +3 -2
- package/dist/Data/Directory/Preferences/People/read.js +1 -1
- package/dist/Data/Directory/Preferences/People/update.d.ts +2 -1
- package/dist/Data/Directory/Preferences/People/update.js +1 -1
- package/dist/Data/Directory/StaffFaculty/list.d.ts +3 -2
- package/dist/Data/Directory/StaffFaculty/list.js +1 -1
- package/dist/Data/Directory/Student/list.d.ts +3 -2
- package/dist/Data/Directory/Student/list.js +1 -1
- package/dist/Data/EmergencyContacts/create.d.ts +2 -1
- package/dist/Data/EmergencyContacts/create.js +1 -1
- package/dist/Data/EmergencyContacts/delete.d.ts +5 -0
- package/dist/Data/EmergencyContacts/delete.js +11 -0
- package/dist/Data/EmergencyContacts/index.d.ts +1 -0
- package/dist/Data/EmergencyContacts/index.js +1 -0
- package/dist/Data/EmergencyContacts/list.d.ts +3 -2
- package/dist/Data/EmergencyContacts/list.js +1 -1
- package/dist/Data/EmergencyContacts/read.d.ts +3 -2
- package/dist/Data/EmergencyContacts/read.js +1 -1
- package/dist/Data/EmergencyContacts/update.d.ts +2 -1
- package/dist/Data/EmergencyContacts/update.js +1 -1
- package/dist/Data/Ethnicities/list.d.ts +3 -2
- package/dist/Data/Ethnicities/list.js +1 -1
- package/dist/Data/EventGroups/create.d.ts +2 -1
- package/dist/Data/EventGroups/create.js +1 -1
- package/dist/Data/EventGroups/delete.d.ts +5 -0
- package/dist/Data/EventGroups/delete.js +11 -0
- package/dist/Data/EventGroups/index.d.ts +1 -0
- package/dist/Data/EventGroups/index.js +1 -0
- package/dist/Data/EventGroups/list.d.ts +3 -2
- package/dist/Data/EventGroups/list.js +1 -1
- package/dist/Data/EventGroups/read.d.ts +3 -2
- package/dist/Data/EventGroups/read.js +1 -1
- package/dist/Data/EventGroupsMembers/list.d.ts +3 -2
- package/dist/Data/EventGroupsMembers/list.js +1 -1
- package/dist/Data/EventRepresentatives/list.d.ts +3 -2
- package/dist/Data/EventRepresentatives/list.js +1 -1
- package/dist/Data/Events/Athletics/create.d.ts +2 -1
- package/dist/Data/Events/Athletics/create.js +1 -1
- package/dist/Data/Events/Athletics/list.d.ts +3 -2
- package/dist/Data/Events/Athletics/list.js +1 -1
- package/dist/Data/Events/Athletics/read.d.ts +3 -2
- package/dist/Data/Events/Athletics/read.js +1 -1
- package/dist/Data/Events/Athletics/update.d.ts +2 -1
- package/dist/Data/Events/Athletics/update.js +1 -1
- package/dist/Data/Events/AthleticsOpponents/list.d.ts +3 -2
- package/dist/Data/Events/AthleticsOpponents/list.js +1 -1
- package/dist/Data/Events/AthleticsOpponents/read.d.ts +3 -2
- package/dist/Data/Events/AthleticsOpponents/read.js +1 -1
- package/dist/Data/Events/AthleticsScores/read.d.ts +3 -2
- package/dist/Data/Events/AthleticsScores/read.js +1 -1
- package/dist/Data/Events/AthleticsScores/update.d.ts +2 -1
- package/dist/Data/Events/AthleticsScores/update.js +1 -1
- package/dist/Data/Events/EventAttendance/create.d.ts +2 -1
- package/dist/Data/Events/EventAttendance/create.js +1 -1
- package/dist/Data/Events/EventAttendance/delete.d.ts +5 -0
- package/dist/Data/Events/EventAttendance/delete.js +11 -0
- package/dist/Data/Events/EventAttendance/index.d.ts +1 -0
- package/dist/Data/Events/EventAttendance/index.js +1 -0
- package/dist/Data/Events/EventAttendance/list.d.ts +3 -2
- package/dist/Data/Events/EventAttendance/list.js +1 -1
- package/dist/Data/Events/EventAttendance/read.d.ts +3 -2
- package/dist/Data/Events/EventAttendance/read.js +1 -1
- package/dist/Data/Events/EventAttendance/update.d.ts +2 -1
- package/dist/Data/Events/EventAttendance/update.js +1 -1
- package/dist/Data/Events/GroupEvents/create.d.ts +2 -1
- package/dist/Data/Events/GroupEvents/create.js +1 -1
- package/dist/Data/Events/GroupEvents/list.d.ts +3 -2
- package/dist/Data/Events/GroupEvents/list.js +1 -1
- package/dist/Data/Events/GroupEvents/read.d.ts +3 -2
- package/dist/Data/Events/GroupEvents/read.js +1 -1
- package/dist/Data/Events/GroupEvents/update.d.ts +2 -1
- package/dist/Data/Events/GroupEvents/update.js +1 -1
- package/dist/Data/ExtendedCare/Classes/Attendance/list.d.ts +3 -2
- package/dist/Data/ExtendedCare/Classes/Attendance/list.js +1 -1
- package/dist/Data/ExtendedCare/Classes/Attendance/read.d.ts +3 -2
- package/dist/Data/ExtendedCare/Classes/Attendance/read.js +1 -1
- package/dist/Data/ExtendedCare/Classes/MeetingTimes/list.d.ts +3 -2
- package/dist/Data/ExtendedCare/Classes/MeetingTimes/list.js +1 -1
- package/dist/Data/ExtendedCare/Classes/MeetingTimes/read.d.ts +3 -2
- package/dist/Data/ExtendedCare/Classes/MeetingTimes/read.js +1 -1
- package/dist/Data/ExtendedCare/Classes/create.d.ts +2 -1
- package/dist/Data/ExtendedCare/Classes/create.js +1 -1
- package/dist/Data/ExtendedCare/Classes/list.d.ts +3 -2
- package/dist/Data/ExtendedCare/Classes/list.js +1 -1
- package/dist/Data/ExtendedCare/Classes/read.d.ts +3 -2
- package/dist/Data/ExtendedCare/Classes/read.js +1 -1
- package/dist/Data/ExtendedCare/Classes/update.d.ts +2 -1
- package/dist/Data/ExtendedCare/Classes/update.js +1 -1
- package/dist/Data/ExtendedCare/Courses/create.d.ts +2 -1
- package/dist/Data/ExtendedCare/Courses/create.js +1 -1
- package/dist/Data/ExtendedCare/Courses/list.d.ts +3 -2
- package/dist/Data/ExtendedCare/Courses/list.js +1 -1
- package/dist/Data/ExtendedCare/Courses/read.d.ts +3 -2
- package/dist/Data/ExtendedCare/Courses/read.js +1 -1
- package/dist/Data/ExtendedCare/Courses/update.d.ts +2 -1
- package/dist/Data/ExtendedCare/Courses/update.js +1 -1
- package/dist/Data/ExtendedCare/Registrations/list.d.ts +3 -2
- package/dist/Data/ExtendedCare/Registrations/list.js +1 -1
- package/dist/Data/ExtendedCare/Registrations/read.d.ts +3 -2
- package/dist/Data/ExtendedCare/Registrations/read.js +1 -1
- package/dist/Data/ExternalUserAccounts/create.d.ts +2 -1
- package/dist/Data/ExternalUserAccounts/create.js +1 -1
- package/dist/Data/ExternalUserAccounts/list.d.ts +3 -2
- package/dist/Data/ExternalUserAccounts/list.js +1 -1
- package/dist/Data/ExternalUserAccounts/read.d.ts +3 -2
- package/dist/Data/ExternalUserAccounts/read.js +1 -1
- package/dist/Data/ExternalUserAccounts/update.d.ts +2 -1
- package/dist/Data/ExternalUserAccounts/update.js +1 -1
- package/dist/Data/Finance/ApDisbursementItems/list.d.ts +3 -2
- package/dist/Data/Finance/ApDisbursementItems/list.js +2 -2
- package/dist/Data/Finance/ApDisbursementItems/read.d.ts +3 -2
- package/dist/Data/Finance/ApDisbursementItems/read.js +2 -2
- package/dist/Data/Finance/ApDisbursementItems/update.d.ts +2 -1
- package/dist/Data/Finance/ApDisbursementItems/update.js +2 -2
- package/dist/Data/Finance/ApDisbursements/ApDisbursementItems/create.d.ts +2 -1
- package/dist/Data/Finance/ApDisbursements/ApDisbursementItems/create.js +2 -2
- package/dist/Data/Finance/ApDisbursements/create.d.ts +2 -1
- package/dist/Data/Finance/ApDisbursements/create.js +2 -2
- package/dist/Data/Finance/ApDisbursements/index.d.ts +1 -1
- package/dist/Data/Finance/ApDisbursements/index.js +1 -1
- package/dist/Data/Finance/ApDisbursements/list.d.ts +3 -2
- package/dist/Data/Finance/ApDisbursements/list.js +2 -2
- package/dist/Data/Finance/ApDisbursements/read.d.ts +3 -2
- package/dist/Data/Finance/ApDisbursements/read.js +2 -2
- package/dist/Data/Finance/ApDisbursements/update.d.ts +2 -1
- package/dist/Data/Finance/ApDisbursements/update.js +2 -2
- package/dist/Data/Finance/ApInvoiceItems/list.d.ts +3 -2
- package/dist/Data/Finance/ApInvoiceItems/list.js +2 -2
- package/dist/Data/Finance/ApInvoiceItems/read.d.ts +3 -2
- package/dist/Data/Finance/ApInvoiceItems/read.js +2 -2
- package/dist/Data/Finance/ApInvoiceItems/update.d.ts +2 -1
- package/dist/Data/Finance/ApInvoiceItems/update.js +2 -2
- package/dist/Data/Finance/ApInvoices/ApInvoiceItems/create.d.ts +2 -1
- package/dist/Data/Finance/ApInvoices/ApInvoiceItems/create.js +2 -2
- package/dist/Data/Finance/ApInvoices/create.d.ts +2 -1
- package/dist/Data/Finance/ApInvoices/create.js +2 -2
- package/dist/Data/Finance/ApInvoices/index.d.ts +1 -1
- package/dist/Data/Finance/ApInvoices/index.js +1 -1
- package/dist/Data/Finance/ApInvoices/list.d.ts +3 -2
- package/dist/Data/Finance/ApInvoices/list.js +2 -2
- package/dist/Data/Finance/ApInvoices/read.d.ts +3 -2
- package/dist/Data/Finance/ApInvoices/read.js +2 -2
- package/dist/Data/Finance/ApInvoices/update.d.ts +2 -1
- package/dist/Data/Finance/ApInvoices/update.js +2 -2
- package/dist/Data/Finance/GlAccounts/list.d.ts +3 -2
- package/dist/Data/Finance/GlAccounts/list.js +2 -2
- package/dist/Data/Finance/GlAccounts/read.d.ts +3 -2
- package/dist/Data/Finance/GlAccounts/read.js +2 -2
- package/dist/Data/Finance/PostApInvoices/update.d.ts +2 -1
- package/dist/Data/Finance/PostApInvoices/update.js +2 -2
- package/dist/Data/Finance/Projects/list.d.ts +3 -2
- package/dist/Data/Finance/Projects/list.js +1 -1
- package/dist/Data/Finance/Projects/read.d.ts +3 -2
- package/dist/Data/Finance/Projects/read.js +1 -1
- package/dist/Data/Finance/PurchaseRequestWorkflowGlAccounts/list.d.ts +3 -2
- package/dist/Data/Finance/PurchaseRequestWorkflowGlAccounts/list.js +2 -2
- package/dist/Data/Finance/PurchaseRequestWorkflows/list.d.ts +3 -2
- package/dist/Data/Finance/PurchaseRequestWorkflows/list.js +1 -1
- package/dist/Data/Finance/PurchaseRequestWorkflows/read.d.ts +3 -2
- package/dist/Data/Finance/PurchaseRequestWorkflows/read.js +1 -1
- package/dist/Data/Finance/TaxTypes/list.d.ts +3 -2
- package/dist/Data/Finance/TaxTypes/list.js +1 -1
- package/dist/Data/Finance/TaxTypes/read.d.ts +3 -2
- package/dist/Data/Finance/TaxTypes/read.js +1 -1
- package/dist/Data/Finance/Vendors/create.d.ts +2 -1
- package/dist/Data/Finance/Vendors/create.js +1 -1
- package/dist/Data/Finance/Vendors/list.d.ts +3 -2
- package/dist/Data/Finance/Vendors/list.js +1 -1
- package/dist/Data/Finance/Vendors/read.d.ts +3 -2
- package/dist/Data/Finance/Vendors/read.js +1 -1
- package/dist/Data/Finance/Vendors/update.d.ts +2 -1
- package/dist/Data/Finance/Vendors/update.js +1 -1
- package/dist/Data/Finance/index.d.ts +7 -7
- package/dist/Data/Finance/index.js +7 -7
- package/dist/Data/Genders/list.d.ts +3 -2
- package/dist/Data/Genders/list.js +1 -1
- package/dist/Data/Health/AllPatients/Conditions/list.d.ts +3 -2
- package/dist/Data/Health/AllPatients/Conditions/list.js +1 -1
- package/dist/Data/Health/Patients/Conditions/create.d.ts +2 -1
- package/dist/Data/Health/Patients/Conditions/create.js +1 -1
- package/dist/Data/Health/Patients/Conditions/list.d.ts +3 -2
- package/dist/Data/Health/Patients/Conditions/list.js +1 -1
- package/dist/Data/Health/Patients/Conditions/read.d.ts +3 -2
- package/dist/Data/Health/Patients/Conditions/read.js +1 -1
- package/dist/Data/Health/Patients/Conditions/update.d.ts +2 -1
- package/dist/Data/Health/Patients/Conditions/update.js +1 -1
- package/dist/Data/Health/Patients/Medications/create.d.ts +2 -1
- package/dist/Data/Health/Patients/Medications/create.js +1 -1
- package/dist/Data/Health/Patients/Medications/list.d.ts +3 -2
- package/dist/Data/Health/Patients/Medications/list.js +1 -1
- package/dist/Data/Health/Patients/Medications/read.d.ts +3 -2
- package/dist/Data/Health/Patients/Medications/read.js +1 -1
- package/dist/Data/Health/Patients/Medications/update.d.ts +2 -1
- package/dist/Data/Health/Patients/Medications/update.js +1 -1
- package/dist/Data/Health/Patients/list.d.ts +3 -2
- package/dist/Data/Health/Patients/list.js +1 -1
- package/dist/Data/Health/Patients/read.d.ts +3 -2
- package/dist/Data/Health/Patients/read.js +1 -1
- package/dist/Data/Health/Patients/update.d.ts +2 -1
- package/dist/Data/Health/Patients/update.js +1 -1
- package/dist/Data/HouseholdVehicles/list.d.ts +3 -2
- package/dist/Data/HouseholdVehicles/list.js +1 -1
- package/dist/Data/HouseholdVehicles/read.d.ts +3 -2
- package/dist/Data/HouseholdVehicles/read.js +1 -1
- package/dist/Data/Households/create.d.ts +2 -1
- package/dist/Data/Households/create.js +1 -1
- package/dist/Data/Households/list.d.ts +3 -2
- package/dist/Data/Households/list.js +1 -1
- package/dist/Data/Households/read.d.ts +3 -2
- package/dist/Data/Households/read.js +1 -1
- package/dist/Data/Households/update.d.ts +2 -1
- package/dist/Data/Households/update.js +1 -1
- package/dist/Data/MasterAttendance/list.d.ts +3 -2
- package/dist/Data/MasterAttendance/list.js +1 -1
- package/dist/Data/MasterAttendance/read.d.ts +3 -2
- package/dist/Data/MasterAttendance/read.js +1 -1
- package/dist/Data/MasterAttendance/update.d.ts +2 -1
- package/dist/Data/MasterAttendance/update.js +1 -1
- package/dist/Data/News/list.d.ts +3 -2
- package/dist/Data/News/list.js +1 -1
- package/dist/Data/News/read.d.ts +3 -2
- package/dist/Data/News/read.js +1 -1
- package/dist/Data/NonAcademics/Classes/create.d.ts +2 -1
- package/dist/Data/NonAcademics/Classes/create.js +1 -1
- package/dist/Data/NonAcademics/Classes/list.d.ts +3 -2
- package/dist/Data/NonAcademics/Classes/list.js +1 -1
- package/dist/Data/NonAcademics/Classes/read.d.ts +3 -2
- package/dist/Data/NonAcademics/Classes/read.js +1 -1
- package/dist/Data/NonAcademics/Classes/update.d.ts +2 -1
- package/dist/Data/NonAcademics/Classes/update.js +1 -1
- package/dist/Data/NonAcademics/Courses/create.d.ts +2 -1
- package/dist/Data/NonAcademics/Courses/create.js +1 -1
- package/dist/Data/NonAcademics/Courses/list.d.ts +3 -2
- package/dist/Data/NonAcademics/Courses/list.js +1 -1
- package/dist/Data/NonAcademics/Courses/read.d.ts +3 -2
- package/dist/Data/NonAcademics/Courses/read.js +1 -1
- package/dist/Data/NonAcademics/Courses/update.d.ts +2 -1
- package/dist/Data/NonAcademics/Courses/update.js +1 -1
- package/dist/Data/Parents/list.d.ts +3 -2
- package/dist/Data/Parents/list.js +1 -1
- package/dist/Data/Parents/read.d.ts +3 -2
- package/dist/Data/Parents/read.js +1 -1
- package/dist/Data/People/Relationships/list.d.ts +3 -2
- package/dist/Data/People/Relationships/list.js +1 -1
- package/dist/Data/PersonAccounts/create.d.ts +2 -1
- package/dist/Data/PersonAccounts/create.js +1 -1
- package/dist/Data/PersonAccounts/delete.d.ts +5 -0
- package/dist/Data/PersonAccounts/delete.js +11 -0
- package/dist/Data/PersonAccounts/index.d.ts +1 -0
- package/dist/Data/PersonAccounts/index.js +1 -0
- package/dist/Data/PersonAccounts/list.d.ts +3 -2
- package/dist/Data/PersonAccounts/list.js +1 -1
- package/dist/Data/PersonAccounts/read.d.ts +3 -2
- package/dist/Data/PersonAccounts/read.js +1 -1
- package/dist/Data/PersonCitizenships/list.d.ts +3 -2
- package/dist/Data/PersonCitizenships/list.js +1 -1
- package/dist/Data/PersonCitizenships/read.d.ts +3 -2
- package/dist/Data/PersonCitizenships/read.js +1 -1
- package/dist/Data/PersonEnrollmentHistory/list.d.ts +3 -2
- package/dist/Data/PersonEnrollmentHistory/list.js +1 -1
- package/dist/Data/PersonEnrollmentHistory/read.d.ts +3 -2
- package/dist/Data/PersonEnrollmentHistory/read.js +1 -1
- package/dist/Data/PersonEthnicities/list.d.ts +3 -2
- package/dist/Data/PersonEthnicities/list.js +1 -1
- package/dist/Data/PersonPhotos/list.d.ts +3 -2
- package/dist/Data/PersonPhotos/list.js +1 -1
- package/dist/Data/PersonProfileCodes/create.d.ts +2 -1
- package/dist/Data/PersonProfileCodes/create.js +1 -1
- package/dist/Data/PersonProfileCodes/delete.d.ts +5 -0
- package/dist/Data/PersonProfileCodes/delete.js +11 -0
- package/dist/Data/PersonProfileCodes/index.d.ts +1 -0
- package/dist/Data/PersonProfileCodes/index.js +1 -0
- package/dist/Data/PersonProfileCodes/list.d.ts +3 -2
- package/dist/Data/PersonProfileCodes/list.js +1 -1
- package/dist/Data/PersonProfileCodes/read.d.ts +3 -2
- package/dist/Data/PersonProfileCodes/read.js +1 -1
- package/dist/Data/PersonReferenceNumber/create.d.ts +2 -1
- package/dist/Data/PersonReferenceNumber/create.js +1 -1
- package/dist/Data/PersonReferenceNumber/delete.d.ts +5 -0
- package/dist/Data/PersonReferenceNumber/delete.js +11 -0
- package/dist/Data/PersonReferenceNumber/index.d.ts +1 -0
- package/dist/Data/PersonReferenceNumber/index.js +1 -0
- package/dist/Data/PersonReferenceNumber/list.d.ts +3 -2
- package/dist/Data/PersonReferenceNumber/list.js +1 -1
- package/dist/Data/PersonReferenceNumber/read.d.ts +3 -2
- package/dist/Data/PersonReferenceNumber/read.js +1 -1
- package/dist/Data/PersonReferenceNumber/update.d.ts +2 -1
- package/dist/Data/PersonReferenceNumber/update.js +1 -1
- package/dist/Data/PersonRoles/create.d.ts +2 -1
- package/dist/Data/PersonRoles/create.js +1 -1
- package/dist/Data/PersonRoles/delete.d.ts +5 -0
- package/dist/Data/PersonRoles/delete.js +11 -0
- package/dist/Data/PersonRoles/index.d.ts +1 -0
- package/dist/Data/PersonRoles/index.js +1 -0
- package/dist/Data/PersonRoles/list.d.ts +3 -2
- package/dist/Data/PersonRoles/list.js +1 -1
- package/dist/Data/PersonRoles/read.d.ts +3 -2
- package/dist/Data/PersonRoles/read.js +1 -1
- package/dist/Data/PersonVisas/list.d.ts +3 -2
- package/dist/Data/PersonVisas/list.js +1 -1
- package/dist/Data/PersonVisas/read.d.ts +3 -2
- package/dist/Data/PersonVisas/read.js +1 -1
- package/dist/Data/PersonVisas/update.d.ts +2 -1
- package/dist/Data/PersonVisas/update.js +1 -1
- package/dist/Data/PortalMembership/list.d.ts +3 -2
- package/dist/Data/PortalMembership/list.js +1 -1
- package/dist/Data/PortalMembership/read.d.ts +3 -2
- package/dist/Data/PortalMembership/read.js +1 -1
- package/dist/Data/PortalMembership/update.d.ts +2 -1
- package/dist/Data/PortalMembership/update.js +1 -1
- package/dist/Data/Programs/Classes/Attendance/list.d.ts +3 -2
- package/dist/Data/Programs/Classes/Attendance/list.js +1 -1
- package/dist/Data/Programs/Classes/Attendance/read.d.ts +3 -2
- package/dist/Data/Programs/Classes/Attendance/read.js +1 -1
- package/dist/Data/Programs/Classes/Attendance/update.d.ts +2 -1
- package/dist/Data/Programs/Classes/Attendance/update.js +1 -1
- package/dist/Data/Programs/Classes/MeetingTimes/list.d.ts +3 -2
- package/dist/Data/Programs/Classes/MeetingTimes/list.js +1 -1
- package/dist/Data/Programs/Classes/MeetingTimes/read.d.ts +3 -2
- package/dist/Data/Programs/Classes/MeetingTimes/read.js +1 -1
- package/dist/Data/Programs/Classes/create.d.ts +2 -1
- package/dist/Data/Programs/Classes/create.js +1 -1
- package/dist/Data/Programs/Classes/list.d.ts +3 -2
- package/dist/Data/Programs/Classes/list.js +1 -1
- package/dist/Data/Programs/Classes/read.d.ts +3 -2
- package/dist/Data/Programs/Classes/read.js +1 -1
- package/dist/Data/Programs/Classes/update.d.ts +2 -1
- package/dist/Data/Programs/Classes/update.js +1 -1
- package/dist/Data/Programs/Courses/create.d.ts +2 -1
- package/dist/Data/Programs/Courses/create.js +1 -1
- package/dist/Data/Programs/Courses/list.d.ts +3 -2
- package/dist/Data/Programs/Courses/list.js +1 -1
- package/dist/Data/Programs/Courses/read.d.ts +3 -2
- package/dist/Data/Programs/Courses/read.js +1 -1
- package/dist/Data/Programs/Courses/update.d.ts +2 -1
- package/dist/Data/Programs/Courses/update.js +1 -1
- package/dist/Data/Programs/Enrollments/create.d.ts +2 -1
- package/dist/Data/Programs/Enrollments/create.js +1 -1
- package/dist/Data/Programs/Enrollments/list.d.ts +3 -2
- package/dist/Data/Programs/Enrollments/list.js +1 -1
- package/dist/Data/Programs/Enrollments/read.d.ts +3 -2
- package/dist/Data/Programs/Enrollments/read.js +1 -1
- package/dist/Data/Programs/Enrollments/update.d.ts +2 -1
- package/dist/Data/Programs/Enrollments/update.js +1 -1
- package/dist/Data/Relationships/list.d.ts +3 -2
- package/dist/Data/Relationships/list.js +1 -1
- package/dist/Data/Relationships/read.d.ts +3 -2
- package/dist/Data/Relationships/read.js +1 -1
- package/dist/Data/ReportCard/Classes/Curriculum/list.d.ts +3 -2
- package/dist/Data/ReportCard/Classes/Curriculum/list.js +1 -1
- package/dist/Data/ReportCard/Classes/Curriculum/read.d.ts +3 -2
- package/dist/Data/ReportCard/Classes/Curriculum/read.js +1 -1
- package/dist/Data/ReportCard/Classes/Teachers/list.d.ts +3 -2
- package/dist/Data/ReportCard/Classes/Teachers/list.js +1 -1
- package/dist/Data/ReportCard/Classes/Teachers/read.d.ts +3 -2
- package/dist/Data/ReportCard/Classes/Teachers/read.js +1 -1
- package/dist/Data/ReportCard/Documents/list.d.ts +3 -2
- package/dist/Data/ReportCard/Documents/list.js +1 -1
- package/dist/Data/ReportCard/Documents/read.d.ts +3 -2
- package/dist/Data/ReportCard/Documents/read.js +1 -1
- package/dist/Data/ReportCard/Enrollments/Attendance/list.d.ts +3 -2
- package/dist/Data/ReportCard/Enrollments/Attendance/list.js +1 -1
- package/dist/Data/ReportCard/Enrollments/NumericGrades/list.d.ts +3 -2
- package/dist/Data/ReportCard/Enrollments/NumericGrades/list.js +1 -1
- package/dist/Data/ReportCard/Enrollments/NumericGrades/read.d.ts +3 -2
- package/dist/Data/ReportCard/Enrollments/NumericGrades/read.js +1 -1
- package/dist/Data/ReportCard/Enrollments/QualitativeGrades/list.d.ts +3 -2
- package/dist/Data/ReportCard/Enrollments/QualitativeGrades/list.js +1 -1
- package/dist/Data/ReportCard/Enrollments/QualitativeGrades/read.d.ts +3 -2
- package/dist/Data/ReportCard/Enrollments/QualitativeGrades/read.js +1 -1
- package/dist/Data/ReportCard/Enrollments/list.d.ts +3 -2
- package/dist/Data/ReportCard/Enrollments/list.js +1 -1
- package/dist/Data/ReportCard/Enrollments/read.d.ts +3 -2
- package/dist/Data/ReportCard/Enrollments/read.js +1 -1
- package/dist/Data/ReportCard/Students/AcademicClassifications/list.d.ts +3 -2
- package/dist/Data/ReportCard/Students/AcademicClassifications/list.js +1 -1
- package/dist/Data/ReportCard/Students/AcademicClassifications/read.d.ts +3 -2
- package/dist/Data/ReportCard/Students/AcademicClassifications/read.js +1 -1
- package/dist/Data/ReportCard/Students/Gpas/list.d.ts +3 -2
- package/dist/Data/ReportCard/Students/Gpas/list.js +1 -1
- package/dist/Data/ReportCard/Students/Gpas/read.d.ts +3 -2
- package/dist/Data/ReportCard/Students/Gpas/read.js +1 -1
- package/dist/Data/ReportCard/Students/index.d.ts +1 -1
- package/dist/Data/ReportCard/Students/index.js +1 -1
- package/dist/Data/ReportCards/Students/Attendance/list.d.ts +3 -2
- package/dist/Data/ReportCards/Students/Attendance/list.js +1 -1
- package/dist/Data/ResidentStatuses/list.d.ts +3 -2
- package/dist/Data/ResidentStatuses/list.js +1 -1
- package/dist/Data/ResourceReservations/Reservations/create.d.ts +2 -1
- package/dist/Data/ResourceReservations/Reservations/create.js +1 -1
- package/dist/Data/ResourceReservations/Reservations/list.d.ts +3 -2
- package/dist/Data/ResourceReservations/Reservations/list.js +1 -1
- package/dist/Data/ResourceReservations/Reservations/read.d.ts +3 -2
- package/dist/Data/ResourceReservations/Reservations/read.js +1 -1
- package/dist/Data/ResourceReservations/Reservations/update.d.ts +2 -1
- package/dist/Data/ResourceReservations/Reservations/update.js +1 -1
- package/dist/Data/ResourceReservations/Resources/create.d.ts +2 -1
- package/dist/Data/ResourceReservations/Resources/create.js +1 -1
- package/dist/Data/ResourceReservations/Resources/list.d.ts +3 -2
- package/dist/Data/ResourceReservations/Resources/list.js +1 -1
- package/dist/Data/ResourceReservations/Resources/read.d.ts +3 -2
- package/dist/Data/ResourceReservations/Resources/read.js +1 -1
- package/dist/Data/ResourceReservations/Resources/update.d.ts +2 -1
- package/dist/Data/ResourceReservations/Resources/update.js +1 -1
- package/dist/Data/SecurityRoles/create.d.ts +2 -1
- package/dist/Data/SecurityRoles/create.js +1 -1
- package/dist/Data/SecurityRoles/delete.d.ts +5 -0
- package/dist/Data/SecurityRoles/delete.js +11 -0
- package/dist/Data/SecurityRoles/index.d.ts +1 -0
- package/dist/Data/SecurityRoles/index.js +1 -0
- package/dist/Data/SecurityRoles/list.d.ts +3 -2
- package/dist/Data/SecurityRoles/list.js +1 -1
- package/dist/Data/StaffFaculty/create.d.ts +2 -1
- package/dist/Data/StaffFaculty/create.js +1 -1
- package/dist/Data/StaffFaculty/list.d.ts +3 -2
- package/dist/Data/StaffFaculty/list.js +1 -1
- package/dist/Data/StaffFaculty/read.d.ts +3 -2
- package/dist/Data/StaffFaculty/read.js +1 -1
- package/dist/Data/StaffFaculty/update.d.ts +2 -1
- package/dist/Data/StaffFaculty/update.js +1 -1
- package/dist/Data/StandardizedTests/ScoreTypes/create.d.ts +2 -1
- package/dist/Data/StandardizedTests/ScoreTypes/create.js +1 -1
- package/dist/Data/StandardizedTests/ScoreTypes/list.d.ts +3 -2
- package/dist/Data/StandardizedTests/ScoreTypes/list.js +1 -1
- package/dist/Data/StandardizedTests/ScoreTypes/read.d.ts +3 -2
- package/dist/Data/StandardizedTests/ScoreTypes/read.js +1 -1
- package/dist/Data/StandardizedTests/ScoreTypes/update.d.ts +2 -1
- package/dist/Data/StandardizedTests/ScoreTypes/update.js +1 -1
- package/dist/Data/StandardizedTests/Scores/list.d.ts +3 -2
- package/dist/Data/StandardizedTests/Scores/list.js +1 -1
- package/dist/Data/StandardizedTests/Scores/read.d.ts +3 -2
- package/dist/Data/StandardizedTests/Scores/read.js +1 -1
- package/dist/Data/StandardizedTests/Scores/update.d.ts +2 -1
- package/dist/Data/StandardizedTests/Scores/update.js +1 -1
- package/dist/Data/StandardizedTests/TestTypes/create.d.ts +2 -1
- package/dist/Data/StandardizedTests/TestTypes/create.js +1 -1
- package/dist/Data/StandardizedTests/TestTypes/list.d.ts +3 -2
- package/dist/Data/StandardizedTests/TestTypes/list.js +1 -1
- package/dist/Data/StandardizedTests/TestTypes/read.d.ts +3 -2
- package/dist/Data/StandardizedTests/TestTypes/read.js +1 -1
- package/dist/Data/StandardizedTests/TestTypes/update.d.ts +2 -1
- package/dist/Data/StandardizedTests/TestTypes/update.js +1 -1
- package/dist/Data/StandardizedTests/Tests/create.d.ts +2 -1
- package/dist/Data/StandardizedTests/Tests/create.js +1 -1
- package/dist/Data/StandardizedTests/Tests/list.d.ts +3 -2
- package/dist/Data/StandardizedTests/Tests/list.js +1 -1
- package/dist/Data/StandardizedTests/Tests/read.d.ts +3 -2
- package/dist/Data/StandardizedTests/Tests/read.js +1 -1
- package/dist/Data/StandardizedTests/Tests/update.d.ts +2 -1
- package/dist/Data/StandardizedTests/Tests/update.js +1 -1
- package/dist/Data/StudentLogistics/Categories/list.d.ts +3 -2
- package/dist/Data/StudentLogistics/Categories/list.js +1 -1
- package/dist/Data/StudentLogistics/DropIns/list.d.ts +3 -2
- package/dist/Data/StudentLogistics/DropIns/list.js +1 -1
- package/dist/Data/StudentLogistics/Reasons/list.d.ts +3 -2
- package/dist/Data/StudentLogistics/Reasons/list.js +1 -1
- package/dist/Data/StudentLogisticsRequests/create.d.ts +2 -1
- package/dist/Data/StudentLogisticsRequests/create.js +1 -1
- package/dist/Data/StudentLogisticsRequests/delete.d.ts +5 -0
- package/dist/Data/StudentLogisticsRequests/delete.js +11 -0
- package/dist/Data/StudentLogisticsRequests/index.d.ts +1 -0
- package/dist/Data/StudentLogisticsRequests/index.js +1 -0
- package/dist/Data/StudentLogisticsRequests/list.d.ts +3 -2
- package/dist/Data/StudentLogisticsRequests/list.js +1 -1
- package/dist/Data/StudentLogisticsRequests/read.d.ts +3 -2
- package/dist/Data/StudentLogisticsRequests/read.js +1 -1
- package/dist/Data/StudentLogisticsRequests/update.d.ts +2 -1
- package/dist/Data/StudentLogisticsRequests/update.js +1 -1
- package/dist/Data/Students/list.d.ts +3 -2
- package/dist/Data/Students/list.js +1 -1
- package/dist/Data/Students/read.d.ts +3 -2
- package/dist/Data/Students/read.js +1 -1
- package/dist/Data/Summer/Classes/Attendance/list.d.ts +3 -2
- package/dist/Data/Summer/Classes/Attendance/list.js +1 -1
- package/dist/Data/Summer/Classes/Attendance/read.d.ts +3 -2
- package/dist/Data/Summer/Classes/Attendance/read.js +1 -1
- package/dist/Data/Summer/Classes/Attendance/update.d.ts +2 -1
- package/dist/Data/Summer/Classes/Attendance/update.js +1 -1
- package/dist/Data/Summer/Classes/MeetingTimes/list.d.ts +3 -2
- package/dist/Data/Summer/Classes/MeetingTimes/list.js +1 -1
- package/dist/Data/Summer/Classes/MeetingTimes/read.d.ts +3 -2
- package/dist/Data/Summer/Classes/MeetingTimes/read.js +1 -1
- package/dist/Data/Summer/Classes/create.d.ts +2 -1
- package/dist/Data/Summer/Classes/create.js +1 -1
- package/dist/Data/Summer/Classes/list.d.ts +3 -2
- package/dist/Data/Summer/Classes/list.js +1 -1
- package/dist/Data/Summer/Classes/read.d.ts +3 -2
- package/dist/Data/Summer/Classes/read.js +1 -1
- package/dist/Data/Summer/Classes/update.d.ts +2 -1
- package/dist/Data/Summer/Classes/update.js +1 -1
- package/dist/Data/Summer/Courses/create.d.ts +2 -1
- package/dist/Data/Summer/Courses/create.js +1 -1
- package/dist/Data/Summer/Courses/list.d.ts +3 -2
- package/dist/Data/Summer/Courses/list.js +1 -1
- package/dist/Data/Summer/Courses/read.d.ts +3 -2
- package/dist/Data/Summer/Courses/read.js +1 -1
- package/dist/Data/Summer/Courses/update.d.ts +2 -1
- package/dist/Data/Summer/Courses/update.js +1 -1
- package/dist/Data/Summer/Enrollments/create.d.ts +2 -1
- package/dist/Data/Summer/Enrollments/create.js +1 -1
- package/dist/Data/Summer/Enrollments/list.d.ts +3 -2
- package/dist/Data/Summer/Enrollments/list.js +1 -1
- package/dist/Data/Summer/Enrollments/read.d.ts +3 -2
- package/dist/Data/Summer/Enrollments/read.js +1 -1
- package/dist/Data/Summer/Enrollments/update.d.ts +2 -1
- package/dist/Data/Summer/Enrollments/update.js +1 -1
- package/dist/Data/Transcripts/AcademicClassifications/list.d.ts +3 -2
- package/dist/Data/Transcripts/AcademicClassifications/list.js +1 -1
- package/dist/Data/Transcripts/AcademicClassifications/read.d.ts +3 -2
- package/dist/Data/Transcripts/AcademicClassifications/read.js +1 -1
- package/dist/Data/Transcripts/Gpas/list.d.ts +3 -2
- package/dist/Data/Transcripts/Gpas/list.js +1 -1
- package/dist/Data/Transcripts/Gpas/read.d.ts +3 -2
- package/dist/Data/Transcripts/Gpas/read.js +1 -1
- package/dist/Data/Transcripts/StudentInfo/list.d.ts +3 -2
- package/dist/Data/Transcripts/StudentInfo/list.js +1 -1
- package/dist/Data/Transcripts/StudentInfo/read.d.ts +3 -2
- package/dist/Data/Transcripts/StudentInfo/read.js +1 -1
- package/dist/Data/Transcripts/TranscriptItems/list.d.ts +3 -2
- package/dist/Data/Transcripts/TranscriptItems/list.js +1 -1
- package/dist/Data/Transcripts/index.d.ts +1 -1
- package/dist/Data/Transcripts/index.js +1 -1
- package/dist/Data/Transportation/BusRoutes/list.d.ts +3 -2
- package/dist/Data/Transportation/BusRoutes/list.js +1 -1
- package/dist/Data/Transportation/BusRoutes/read.d.ts +3 -2
- package/dist/Data/Transportation/BusRoutes/read.js +1 -1
- package/dist/Data/Transportation/BusStops/list.d.ts +3 -2
- package/dist/Data/Transportation/BusStops/list.js +1 -1
- package/dist/Data/Transportation/BusStops/read.d.ts +3 -2
- package/dist/Data/Transportation/BusStops/read.js +1 -1
- package/dist/Data/Transportation/BusTrips/list.d.ts +3 -2
- package/dist/Data/Transportation/BusTrips/list.js +1 -1
- package/dist/Data/Transportation/BusTrips/read.d.ts +3 -2
- package/dist/Data/Transportation/BusTrips/read.js +1 -1
- package/dist/Data/Transportation/Schedules/list.d.ts +3 -2
- package/dist/Data/Transportation/Schedules/list.js +1 -1
- package/dist/Data/Transportation/Schedules/read.d.ts +3 -2
- package/dist/Data/Transportation/Schedules/read.js +1 -1
- package/dist/Data/Transportation/Trips/list.d.ts +3 -2
- package/dist/Data/Transportation/Trips/list.js +1 -1
- package/dist/Data/Transportation/Trips/read.d.ts +3 -2
- package/dist/Data/Transportation/Trips/read.js +1 -1
- package/dist/Data/VolunteerCoordinator/Volunteers/list.d.ts +3 -2
- package/dist/Data/VolunteerCoordinator/Volunteers/list.js +1 -1
- package/dist/Data/VolunteerCoordinator/Volunteers/read.d.ts +3 -2
- package/dist/Data/VolunteerCoordinator/Volunteers/read.js +1 -1
- package/dist/Data/WithdrawalReasons/list.d.ts +3 -2
- package/dist/Data/WithdrawalReasons/list.js +1 -1
- package/dist/Data/client.d.ts +5 -0
- package/dist/Data/client.js +20 -0
- package/dist/Files/ApInvoices/Files/create.d.ts +3 -2
- package/dist/Files/ApInvoices/Files/create.js +2 -2
- package/dist/Files/ApInvoices/Files/delete.d.ts +5 -0
- package/dist/Files/ApInvoices/Files/delete.js +11 -0
- package/dist/Files/ApInvoices/Files/index.d.ts +4 -0
- package/dist/Files/ApInvoices/Files/index.js +4 -0
- package/dist/Files/ApInvoices/Files/list.d.ts +5 -5
- package/dist/Files/ApInvoices/Files/list.js +5 -5
- package/dist/Files/ApInvoices/Files/read.d.ts +5 -4
- package/dist/Files/ApInvoices/Files/read.js +2 -2
- package/dist/Files/ApInvoices/index.d.ts +1 -0
- package/dist/Files/ApInvoices/index.js +1 -0
- package/dist/Files/ApplicantFile/create.d.ts +3 -2
- package/dist/Files/ApplicantFile/create.js +1 -1
- package/dist/Files/ApplicantFile/index.d.ts +3 -0
- package/dist/Files/ApplicantFile/index.js +3 -0
- package/dist/Files/ApplicantFile/list.d.ts +5 -5
- package/dist/Files/ApplicantFile/list.js +4 -4
- package/dist/Files/ApplicantFile/read.d.ts +5 -4
- package/dist/Files/ApplicantFile/read.js +1 -1
- package/dist/Files/PersonPhoto/create.d.ts +3 -2
- package/dist/Files/PersonPhoto/create.js +1 -1
- package/dist/Files/PersonPhoto/index.d.ts +2 -0
- package/dist/Files/PersonPhoto/index.js +2 -0
- package/dist/Files/PersonPhoto/read.d.ts +5 -4
- package/dist/Files/PersonPhoto/read.js +1 -1
- package/dist/Files/client.d.ts +5 -0
- package/dist/Files/client.js +20 -0
- package/dist/Files/index.d.ts +3 -0
- package/dist/Files/index.js +3 -0
- package/dist/index.d.ts +4 -2
- package/dist/index.js +4 -2
- package/dist/spec/Authorization-API.d.ts +628 -0
- package/dist/spec/Authorization-API.js +5 -0
- package/dist/spec/Data-API.d.ts +4 -4
- package/dist/types/EndpointOptions.d.ts +11 -8
- package/dist/types/EndpointOptions.js +1 -0
- package/dist/types/OpenAPIModule.d.ts +2 -0
- package/dist/types/OpenAPIModule.js +1 -0
- package/dist/types/OperationObject.d.ts +2 -0
- package/dist/types/OperationObject.js +1 -0
- package/dist/types/OperationsObject.d.ts +2 -0
- package/dist/types/OperationsObject.js +1 -0
- package/dist/types/RequestBody.d.ts +4 -5
- package/dist/types/RequestParameters.d.ts +5 -6
- package/dist/types/ResponseBody.d.ts +3 -4
- package/package.json +10 -10
- package/spec/Authorization-API.yaml +732 -0
- package/spec/Data-API.yaml +4 -4
- package/spec/Files-API.yaml +1041 -0
- package/templates/client.handlebars +25 -0
- package/templates/create.handlebars +5 -2
- package/templates/delete.handlebars +5 -2
- package/templates/get.handlebars +24 -0
- package/templates/list.handlebars +6 -3
- package/templates/post.handlebars +31 -0
- package/templates/read.handlebars +6 -3
- package/templates/update.handlebars +5 -2
|
@@ -0,0 +1,732 @@
|
|
|
1
|
+
openapi: 3.0.3
|
|
2
|
+
info:
|
|
3
|
+
title: Authorization API
|
|
4
|
+
version: '1.0'
|
|
5
|
+
description: |-
|
|
6
|
+
Schools can create OAuth Applications for vendors in Veracross. OAuth Applications allow for vendors to use Veracross OAuth SSO to enable users to log in to vendor sites with their Veracross Account. Using SSO provides several benefits for Veracross users:
|
|
7
|
+
|
|
8
|
+
- _User experience_: If all of a school's vendors are integrated via OAuth SSO, then Veracross users only need to manage one account. (Note: Veracross OAuth SSO will work for all Veracross account types, including MFA, External Identity Providers (Google/Okta/Azure, etc), and school domain accounts).
|
|
9
|
+
- _Security_: No user passwords are shared to vendors. Vendors also benefit from Veracross' existing security infrastructure.
|
|
10
|
+
- _History_: All logins via OAuth SSO are tracked in the Login Log.
|
|
11
|
+
contact:
|
|
12
|
+
name: Veracross
|
|
13
|
+
url: 'https://www.veracross.com/api'
|
|
14
|
+
servers:
|
|
15
|
+
- url: 'https://accounts.veracross.com/{school_route}'
|
|
16
|
+
description: Authorization Base URL
|
|
17
|
+
variables:
|
|
18
|
+
school_route:
|
|
19
|
+
description: The url path value for the individual school the integration is with
|
|
20
|
+
default: '{school_route}'
|
|
21
|
+
components:
|
|
22
|
+
schemas:
|
|
23
|
+
ErrorResponse:
|
|
24
|
+
type: object
|
|
25
|
+
properties:
|
|
26
|
+
error:
|
|
27
|
+
type: string
|
|
28
|
+
description: An error code
|
|
29
|
+
error_description:
|
|
30
|
+
type: string
|
|
31
|
+
description: The description of the error
|
|
32
|
+
error_id:
|
|
33
|
+
type: string
|
|
34
|
+
description: A unique ID for this specific error. Please provide this error id when you ask for help with an error.
|
|
35
|
+
required:
|
|
36
|
+
- error
|
|
37
|
+
- error_description
|
|
38
|
+
EmptyObject:
|
|
39
|
+
type: object
|
|
40
|
+
properties: {}
|
|
41
|
+
requestBodies:
|
|
42
|
+
TokenAndCredentials:
|
|
43
|
+
content:
|
|
44
|
+
application/x-www-form-urlencoded:
|
|
45
|
+
schema:
|
|
46
|
+
type: object
|
|
47
|
+
properties:
|
|
48
|
+
client_id:
|
|
49
|
+
type: string
|
|
50
|
+
client_secret:
|
|
51
|
+
type: string
|
|
52
|
+
token:
|
|
53
|
+
type: string
|
|
54
|
+
required:
|
|
55
|
+
- client_id
|
|
56
|
+
- client_secret
|
|
57
|
+
- token
|
|
58
|
+
responses:
|
|
59
|
+
Unauthorized:
|
|
60
|
+
description: Unauthorized
|
|
61
|
+
content:
|
|
62
|
+
application/json:
|
|
63
|
+
schema:
|
|
64
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
65
|
+
examples:
|
|
66
|
+
Error Example:
|
|
67
|
+
summary: Invalid Client
|
|
68
|
+
value:
|
|
69
|
+
error: invalid_client
|
|
70
|
+
error_description: The requested client id is unknown or unauthorized.
|
|
71
|
+
error_id: 896204e2-89e9-46c9-2fd0-ef74df63d513
|
|
72
|
+
UnsupportedMediaType:
|
|
73
|
+
description: |-
|
|
74
|
+
Unsupported media type.
|
|
75
|
+
This happens when the requests lacks the header `application/x-www-form-urlencoded`.
|
|
76
|
+
content:
|
|
77
|
+
application/json:
|
|
78
|
+
schema:
|
|
79
|
+
$ref: '#/components/schemas/EmptyObject'
|
|
80
|
+
examples:
|
|
81
|
+
UnsupportedMediaType:
|
|
82
|
+
value: {}
|
|
83
|
+
parameters:
|
|
84
|
+
ContentTypeFormUrlEncoded:
|
|
85
|
+
schema:
|
|
86
|
+
type: string
|
|
87
|
+
in: header
|
|
88
|
+
name: Content-Type
|
|
89
|
+
description: Needs to be `application/x-www-form-urlencoded`
|
|
90
|
+
required: true
|
|
91
|
+
paths:
|
|
92
|
+
/oauth/token:
|
|
93
|
+
post:
|
|
94
|
+
summary: Create Access Token
|
|
95
|
+
tags:
|
|
96
|
+
- OAuth
|
|
97
|
+
responses:
|
|
98
|
+
'200':
|
|
99
|
+
description: Success
|
|
100
|
+
content:
|
|
101
|
+
application/json:
|
|
102
|
+
examples:
|
|
103
|
+
Client Credentials:
|
|
104
|
+
value:
|
|
105
|
+
access_token: v3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv
|
|
106
|
+
created_at: 1599229410
|
|
107
|
+
expires_in: 3600
|
|
108
|
+
scope: 'example.object:list another.thing:create'
|
|
109
|
+
token_type: Bearer
|
|
110
|
+
Authorization Code with `sso` scope:
|
|
111
|
+
value:
|
|
112
|
+
access_token: v3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv
|
|
113
|
+
created_at: 1599229410
|
|
114
|
+
expires_in: 3600
|
|
115
|
+
refresh_token: v3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv
|
|
116
|
+
scope: 'sso example.object:list another.thing:create'
|
|
117
|
+
token_type: Bearer
|
|
118
|
+
Authorization Code with `openid` scope:
|
|
119
|
+
value:
|
|
120
|
+
access_token: v3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv
|
|
121
|
+
created_at: 1599229410
|
|
122
|
+
expires_in: 3600
|
|
123
|
+
refresh_token: v3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv
|
|
124
|
+
scope: 'openid example.object:list another.thing:create'
|
|
125
|
+
id_token: JwT0k3nJwT0k3nJwT0k3n.JwT0k3nJwT0k3nJwT0k3nJwT0k3nJwT0k3nJwT0k3n.JwT0k3nJwT0k3nJwT0k3n
|
|
126
|
+
token_type: Bearer
|
|
127
|
+
Refresh Token:
|
|
128
|
+
value:
|
|
129
|
+
access_token: v3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv
|
|
130
|
+
created_at: 1599229410
|
|
131
|
+
expires_in: 3600
|
|
132
|
+
refresh_token: v3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv
|
|
133
|
+
scope: 'example.object:list another.thing:create'
|
|
134
|
+
token_type: Bearer
|
|
135
|
+
schema:
|
|
136
|
+
type: object
|
|
137
|
+
properties:
|
|
138
|
+
access_token:
|
|
139
|
+
type: string
|
|
140
|
+
created_at:
|
|
141
|
+
type: number
|
|
142
|
+
expires_in:
|
|
143
|
+
type: number
|
|
144
|
+
scope:
|
|
145
|
+
type: string
|
|
146
|
+
refresh_token:
|
|
147
|
+
type: string
|
|
148
|
+
token_type:
|
|
149
|
+
type: string
|
|
150
|
+
id_token:
|
|
151
|
+
type: string
|
|
152
|
+
description: JWT string returned only with the Authorization Code grant type when the `openid` scope is requested. The JWT contains the user info (equivalent to the User Info endpoint). The JWT's signature may be verified using the public key provided by the JWKS endpoint.
|
|
153
|
+
required:
|
|
154
|
+
- access_token
|
|
155
|
+
- created_at
|
|
156
|
+
- expires_in
|
|
157
|
+
- scope
|
|
158
|
+
- token_type
|
|
159
|
+
headers: {}
|
|
160
|
+
'400':
|
|
161
|
+
description: Bad Request
|
|
162
|
+
content:
|
|
163
|
+
application/json:
|
|
164
|
+
schema:
|
|
165
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
166
|
+
examples:
|
|
167
|
+
Error Example:
|
|
168
|
+
value:
|
|
169
|
+
error: invalid_request
|
|
170
|
+
error_description: 'Missing required parameter: grant_type.'
|
|
171
|
+
error_id: 896204e2-89e9-46c9-2fd0-ef74df63d513
|
|
172
|
+
'401':
|
|
173
|
+
$ref: '#/components/responses/Unauthorized'
|
|
174
|
+
'415':
|
|
175
|
+
$ref: '#/components/responses/UnsupportedMediaType'
|
|
176
|
+
operationId: create-access-token
|
|
177
|
+
requestBody:
|
|
178
|
+
content:
|
|
179
|
+
application/x-www-form-urlencoded:
|
|
180
|
+
schema:
|
|
181
|
+
type: object
|
|
182
|
+
properties:
|
|
183
|
+
grant_type:
|
|
184
|
+
type: string
|
|
185
|
+
enum:
|
|
186
|
+
- client_credentials
|
|
187
|
+
- authorization_code
|
|
188
|
+
- refresh_token
|
|
189
|
+
client_id:
|
|
190
|
+
type: string
|
|
191
|
+
client_secret:
|
|
192
|
+
type: string
|
|
193
|
+
description: required for all grant types. Treat the client_secret as confidential.
|
|
194
|
+
scope:
|
|
195
|
+
type: string
|
|
196
|
+
description: list of scopes for this access token
|
|
197
|
+
code:
|
|
198
|
+
type: string
|
|
199
|
+
description: required only for authorization_code as grant_type
|
|
200
|
+
redirect_uri:
|
|
201
|
+
type: string
|
|
202
|
+
description: required only for authorization_code as grant_type
|
|
203
|
+
required:
|
|
204
|
+
- grant_type
|
|
205
|
+
- client_id
|
|
206
|
+
- client_secret
|
|
207
|
+
examples:
|
|
208
|
+
Client Credentials:
|
|
209
|
+
value:
|
|
210
|
+
grant_type: client_credentials
|
|
211
|
+
client_id: v3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4c
|
|
212
|
+
client_secret: v3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv
|
|
213
|
+
scope: 'example.object:list another.thing:create'
|
|
214
|
+
Authorization Code:
|
|
215
|
+
value:
|
|
216
|
+
grant_type: authorization_code
|
|
217
|
+
client_id: v3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4c
|
|
218
|
+
client_secret: v3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv
|
|
219
|
+
scope: sso
|
|
220
|
+
code: c0d3c0d3c0d3c0d3c0d3c0d3c0d3c0d3
|
|
221
|
+
Refresh Token:
|
|
222
|
+
value:
|
|
223
|
+
grant_type: refresh_token
|
|
224
|
+
client_id: v3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4c
|
|
225
|
+
client_secret: v3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv
|
|
226
|
+
refresh_token: v3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv3r4cr0ssv
|
|
227
|
+
description: |-
|
|
228
|
+
<!--
|
|
229
|
+
type: tab
|
|
230
|
+
title: Client Credentials
|
|
231
|
+
-->
|
|
232
|
+
#### Client Credentials
|
|
233
|
+
This grant type is suitable for "server to server" authentication where data access happens independent of any specific user's session.
|
|
234
|
+
|
|
235
|
+
<!--
|
|
236
|
+
type: tab
|
|
237
|
+
title: Authorization Code
|
|
238
|
+
-->
|
|
239
|
+
#### Authorization Code
|
|
240
|
+
This grant type should be used during SSO to exchange the provided authorization code for an access token that is associated with an individual user. Review [Creating a SSO integration](../../../../docs/guides/creating-an-sso-integration.md) for additional details.
|
|
241
|
+
|
|
242
|
+
<!--
|
|
243
|
+
type: tab
|
|
244
|
+
title: Refresh Token
|
|
245
|
+
-->
|
|
246
|
+
#### Refresh Token
|
|
247
|
+
This grant type is used to create a new access token when the former access token has expired. Refresh Tokens should only be used once.
|
|
248
|
+
<!-- type: tab-end -->
|
|
249
|
+
description: |-
|
|
250
|
+
All requests to the Data API must be made with an access token. Review [Access Tokens](../../../../docs/concepts/access-tokens.md) for additional details.
|
|
251
|
+
|
|
252
|
+
#### Endpoint applies to:
|
|
253
|
+
|
|
254
|
+
| Grant Type | Applicable |
|
|
255
|
+
|------------|------------|
|
|
256
|
+
| Client Credentials | ✅ |
|
|
257
|
+
| Authorization Code | ✅ |
|
|
258
|
+
| Refresh Token | ✅ |
|
|
259
|
+
|
|
260
|
+
#### Related links
|
|
261
|
+
- https://tools.ietf.org/html/rfc6749#section-3.2
|
|
262
|
+
- https://www.oauth.com/oauth2-servers/accessing-data/obtaining-an-access-token/
|
|
263
|
+
- https://www.oauth.com/oauth2-servers/making-authenticated-requests/refreshing-an-access-token/
|
|
264
|
+
parameters:
|
|
265
|
+
- $ref: '#/components/parameters/ContentTypeFormUrlEncoded'
|
|
266
|
+
parameters: []
|
|
267
|
+
/oauth/introspect:
|
|
268
|
+
post:
|
|
269
|
+
summary: Token Introspection
|
|
270
|
+
operationId: post-oauth-introspect
|
|
271
|
+
responses:
|
|
272
|
+
'200':
|
|
273
|
+
description: OK
|
|
274
|
+
content:
|
|
275
|
+
application/json:
|
|
276
|
+
schema:
|
|
277
|
+
type: object
|
|
278
|
+
properties:
|
|
279
|
+
active:
|
|
280
|
+
type: boolean
|
|
281
|
+
scope:
|
|
282
|
+
type: string
|
|
283
|
+
client_id:
|
|
284
|
+
type: string
|
|
285
|
+
nullable: true
|
|
286
|
+
description: null when used on token issued with authorization_code as grant_type
|
|
287
|
+
token_type:
|
|
288
|
+
type: string
|
|
289
|
+
exp:
|
|
290
|
+
type: integer
|
|
291
|
+
iat:
|
|
292
|
+
type: integer
|
|
293
|
+
required:
|
|
294
|
+
- active
|
|
295
|
+
examples:
|
|
296
|
+
With valid access token:
|
|
297
|
+
value:
|
|
298
|
+
active: true
|
|
299
|
+
scope: 'example.object:list another.thing:create'
|
|
300
|
+
client_id: null
|
|
301
|
+
token_type: Bearer
|
|
302
|
+
exp: 1600821466
|
|
303
|
+
iat: 1600817866
|
|
304
|
+
With invalid token:
|
|
305
|
+
value:
|
|
306
|
+
active: false
|
|
307
|
+
'401':
|
|
308
|
+
$ref: '#/components/responses/Unauthorized'
|
|
309
|
+
'415':
|
|
310
|
+
$ref: '#/components/responses/UnsupportedMediaType'
|
|
311
|
+
requestBody:
|
|
312
|
+
$ref: '#/components/requestBodies/TokenAndCredentials'
|
|
313
|
+
tags:
|
|
314
|
+
- OAuth
|
|
315
|
+
description: |-
|
|
316
|
+
The Token Introspection extension defines a mechanism for resource servers to obtain information about access tokens. With this spec, resource servers can check the validity of access tokens, and find out other information such as which user and which scopes are associated with the token.
|
|
317
|
+
|
|
318
|
+
#### Endpoint applies to:
|
|
319
|
+
|
|
320
|
+
| Grant Type | Applicable |
|
|
321
|
+
|------------|------------|
|
|
322
|
+
| Client Credentials | ✅ |
|
|
323
|
+
| Authorization Code | ✅ |
|
|
324
|
+
| Refresh Token | ✅ |
|
|
325
|
+
|
|
326
|
+
#### Related links
|
|
327
|
+
- https://tools.ietf.org/html/rfc7662
|
|
328
|
+
- https://www.oauth.com/oauth2-servers/token-introspection-endpoint/
|
|
329
|
+
- https://oauth.net/2/token-introspection/
|
|
330
|
+
parameters:
|
|
331
|
+
- $ref: '#/components/parameters/ContentTypeFormUrlEncoded'
|
|
332
|
+
/oauth/revoke:
|
|
333
|
+
post:
|
|
334
|
+
summary: Revoke Token
|
|
335
|
+
operationId: post-oauth-revoke
|
|
336
|
+
description: |
|
|
337
|
+
Post with client credentials to revoke an access token. The authorization server responds with HTTP status code 200 if the token has been revoked successfully or if the client submitted an invalid token.
|
|
338
|
+
|
|
339
|
+
<!-- theme: warning -->
|
|
340
|
+
> Note: per the OAuth spec, attempting to revoke an invalid token has no effect.
|
|
341
|
+
|
|
342
|
+
The content of the response body should be ignored by the client as all necessary information is conveyed in the response code.
|
|
343
|
+
|
|
344
|
+
A revoked token can no longer be used for any other endpoint. The response codes/bodies may vary depending on the endpoint. For example, Token Info (`GET /oauth/token/info`) returns `401 Unauthorized`, whereas Token Introspection (`POST /oauth/introspect`) still returns `200 OK`, but `active: false` in the body.
|
|
345
|
+
|
|
346
|
+
#### Endpoint applies to:
|
|
347
|
+
| Grant Type | Applicable |
|
|
348
|
+
|------------|------------|
|
|
349
|
+
| Client Credentials | ✅ |
|
|
350
|
+
| Authorization Code | ✅ |
|
|
351
|
+
| Refresh Token | ✅ |
|
|
352
|
+
|
|
353
|
+
#### Related links
|
|
354
|
+
- https://tools.ietf.org/html/rfc7009
|
|
355
|
+
- https://www.oauth.com/oauth2-servers/listing-authorizations/revoking-access/
|
|
356
|
+
- https://oauth.net/2/token-revocation/
|
|
357
|
+
requestBody:
|
|
358
|
+
$ref: '#/components/requestBodies/TokenAndCredentials'
|
|
359
|
+
responses:
|
|
360
|
+
'200':
|
|
361
|
+
description: OK
|
|
362
|
+
content:
|
|
363
|
+
application/json:
|
|
364
|
+
schema:
|
|
365
|
+
$ref: '#/components/schemas/EmptyObject'
|
|
366
|
+
examples:
|
|
367
|
+
Success:
|
|
368
|
+
value: {}
|
|
369
|
+
'401':
|
|
370
|
+
$ref: '#/components/responses/Unauthorized'
|
|
371
|
+
'415':
|
|
372
|
+
$ref: '#/components/responses/UnsupportedMediaType'
|
|
373
|
+
tags:
|
|
374
|
+
- OAuth
|
|
375
|
+
parameters:
|
|
376
|
+
- $ref: '#/components/parameters/ContentTypeFormUrlEncoded'
|
|
377
|
+
/oauth/authorize:
|
|
378
|
+
get:
|
|
379
|
+
responses:
|
|
380
|
+
'200':
|
|
381
|
+
description: Responds HTML with Veracross login form if the browser isn't authorized yet. Otherwise it goes directly to the `redirect_uri`
|
|
382
|
+
summary: Authorize
|
|
383
|
+
tags:
|
|
384
|
+
- OAuth
|
|
385
|
+
operationId: get-oauth-authorize
|
|
386
|
+
parameters:
|
|
387
|
+
- schema:
|
|
388
|
+
type: string
|
|
389
|
+
in: query
|
|
390
|
+
name: client_id
|
|
391
|
+
required: true
|
|
392
|
+
description: This is the client_id from your OAuth Application. It will be different for each school that you work with.
|
|
393
|
+
- schema:
|
|
394
|
+
type: string
|
|
395
|
+
in: query
|
|
396
|
+
required: true
|
|
397
|
+
name: redirect_uri
|
|
398
|
+
description: |-
|
|
399
|
+
Veracross will redirect to this URI upon successful login. It needs to be URL encoded, HTTPS, and registered on your OAuth Application.
|
|
400
|
+
|
|
401
|
+
It redirects with the `code` parameter which will be exchanged for the `access_token`.
|
|
402
|
+
- schema:
|
|
403
|
+
type: string
|
|
404
|
+
in: query
|
|
405
|
+
name: response_type
|
|
406
|
+
required: true
|
|
407
|
+
description: Needs to be `code`
|
|
408
|
+
- $ref: '#/components/parameters/ContentTypeFormUrlEncoded'
|
|
409
|
+
- schema:
|
|
410
|
+
type: string
|
|
411
|
+
in: query
|
|
412
|
+
name: scope
|
|
413
|
+
description: 'List of requested scopes (separated by spaces). To complete SSO, the `sso` scope must be requested. All requested scopes must already be enabled by the school on your OAuth Application.'
|
|
414
|
+
required: true
|
|
415
|
+
description: |-
|
|
416
|
+
This endpoint starts the OAuth SSO flow. The response is an HTML page intended for humans (in contrast to other endpoints, which are intended for servers). Users can log in to a vendor site with their existing Veracross account.
|
|
417
|
+
|
|
418
|
+
<!--
|
|
419
|
+
focus: false
|
|
420
|
+
-->
|
|
421
|
+

|
|
422
|
+
|
|
423
|
+
As a vendor, you need to formulate this URL with the proper parameters:
|
|
424
|
+
1. The `client_id` string that identifies your site as a Veracross OAuth Application.
|
|
425
|
+
2. One of the already registered `redirect_uri` that Veracross will redirect users to upon successful login (remember, this value should be URL encoded in the request).
|
|
426
|
+
3. `response_type=code`, which means that upon successful login, Veracross systems will also give you an **authorization code** that you will use to exchange for an **access token** to use with subsequent requests.
|
|
427
|
+
4. The `scope`, which specifies a list of scopes, separated by spaces, for the scopes for which you want to authorize the user, for example `scope = sso`.
|
|
428
|
+
|
|
429
|
+
> Note: Using SSO requires having an OAuth Application [registered at each school](https://community.veracross.com/s/article/Creating-an-OAuth-Application-School-Workflow). Vendors must provide the `redirect_uri`s and `scope`s they require, and will receive the corresponding OAuth `client_id` and `client_secret` values.
|
|
430
|
+
|
|
431
|
+
Unlike most public OAuth implementations (eg, "Log In with Facebook", "Log In with Google", etc), Veracross users won't see a separate "approval" screen when logging in. This is intentional; at Veracross, SSO to a vendor site is pre-approved with the set up of the OAuth Application by an administrator, and no separate approval from end users is necessary.
|
|
432
|
+
|
|
433
|
+
#### Endpoint applies to:
|
|
434
|
+
|
|
435
|
+
| Grant Type | Applicable |
|
|
436
|
+
|------------|------------|
|
|
437
|
+
| Client Credentials | ❌ |
|
|
438
|
+
| Authorization Code | ✅ |
|
|
439
|
+
| Refresh Token | ❌ |
|
|
440
|
+
|
|
441
|
+
#### Related links:
|
|
442
|
+
- https://tools.ietf.org/html/rfc6749#section-3.1
|
|
443
|
+
- https://www.oauth.com/oauth2-servers/accessing-data/authorization-request/
|
|
444
|
+
parameters: []
|
|
445
|
+
/oauth/userinfo:
|
|
446
|
+
get:
|
|
447
|
+
summary: User Info
|
|
448
|
+
tags:
|
|
449
|
+
- OAuth
|
|
450
|
+
- OIDC
|
|
451
|
+
responses:
|
|
452
|
+
'200':
|
|
453
|
+
description: OK
|
|
454
|
+
content:
|
|
455
|
+
application/json:
|
|
456
|
+
schema:
|
|
457
|
+
type: object
|
|
458
|
+
properties:
|
|
459
|
+
sub:
|
|
460
|
+
type: string
|
|
461
|
+
preferred_username:
|
|
462
|
+
type: string
|
|
463
|
+
email:
|
|
464
|
+
type: string
|
|
465
|
+
nullable: true
|
|
466
|
+
roles:
|
|
467
|
+
type: array
|
|
468
|
+
nullable: true
|
|
469
|
+
items:
|
|
470
|
+
type: string
|
|
471
|
+
required:
|
|
472
|
+
- sub
|
|
473
|
+
- preferred_username
|
|
474
|
+
examples:
|
|
475
|
+
Success:
|
|
476
|
+
value:
|
|
477
|
+
sub: '1234'
|
|
478
|
+
preferred_username: john.doe
|
|
479
|
+
email: john.doe@example.com
|
|
480
|
+
roles:
|
|
481
|
+
- Parent
|
|
482
|
+
- Coach
|
|
483
|
+
- Staff
|
|
484
|
+
- Faculty
|
|
485
|
+
- Donor
|
|
486
|
+
'401':
|
|
487
|
+
description: Unauthorized
|
|
488
|
+
content:
|
|
489
|
+
application/json:
|
|
490
|
+
examples:
|
|
491
|
+
Unauthorized:
|
|
492
|
+
value: ''
|
|
493
|
+
'403':
|
|
494
|
+
description: |-
|
|
495
|
+
Forbidden.
|
|
496
|
+
This happens when the access token lacks a required scope.
|
|
497
|
+
'404':
|
|
498
|
+
description: |-
|
|
499
|
+
Not Found.
|
|
500
|
+
There was no user associated with the provided access token. This can happen if the request uses an access token created with the Client Credentials grant type; since those exist apart from an individual user identity, there's no user info that can be provided. User info requests should only be made with Authorization Code access tokens.
|
|
501
|
+
'415':
|
|
502
|
+
$ref: '#/components/responses/UnsupportedMediaType'
|
|
503
|
+
parameters:
|
|
504
|
+
- schema:
|
|
505
|
+
type: string
|
|
506
|
+
example: Bearer your-access-token-here
|
|
507
|
+
in: header
|
|
508
|
+
name: Authorization
|
|
509
|
+
required: true
|
|
510
|
+
description: The access token
|
|
511
|
+
- $ref: '#/components/parameters/ContentTypeFormUrlEncoded'
|
|
512
|
+
description: |-
|
|
513
|
+
The access token is used to retrieve info about the user that has logged in, such as their Veracross Account ID and username.
|
|
514
|
+
|
|
515
|
+
> Note: `sub` is the internal account id, and uniquely identifies a user at a school. It must be combined with the school route to become globally unique. For example, different users at different schools might have the same `sub` value. Also note that schools may configure their own format for `preferred_username`, so it should only be used for display purposes (eg, some schools use email, some schools use other id's, etc)
|
|
516
|
+
|
|
517
|
+
#### Endpoint applies to:
|
|
518
|
+
|
|
519
|
+
| Grant Type | Applicable |
|
|
520
|
+
|------------|------------|
|
|
521
|
+
| Client Credentials | ❌ |
|
|
522
|
+
| Authorization Code | ✅ |
|
|
523
|
+
| Refresh Token | ❌ |
|
|
524
|
+
|
|
525
|
+
#### Related links
|
|
526
|
+
- https://www.oauth.com/oauth2-servers/signing-in-with-google/verifying-the-user-info/
|
|
527
|
+
- https://openid.net/specs/openid-connect-core-1_0.html#UserInfo
|
|
528
|
+
- https://community.veracross.com/s/article/Person-Role-Definitions
|
|
529
|
+
operationId: get-oauth-userinfo
|
|
530
|
+
/oauth/discovery/keys:
|
|
531
|
+
get:
|
|
532
|
+
summary: JSON Web Key Set (JWKS)
|
|
533
|
+
tags:
|
|
534
|
+
- OIDC
|
|
535
|
+
description: |-
|
|
536
|
+
The JSON Web Key Set (JWKS) endpoint returns the public keys used to verify JSON Web Tokens (JWTs) issued by the authorization server.
|
|
537
|
+
This endpoint is commonly used in OpenID Connect 1.0 (OIDC) flows to verify the authenticity and integrity of ID tokens.
|
|
538
|
+
|
|
539
|
+
#### Related links
|
|
540
|
+
- https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
|
|
541
|
+
- https://www.rfc-editor.org/rfc/rfc7517.html
|
|
542
|
+
- https://datatracker.ietf.org/doc/html/rfc7518
|
|
543
|
+
- https://openid.net/specs/openid-connect-core-1_0.html#AuthorizationExamples
|
|
544
|
+
operationId: jwks
|
|
545
|
+
responses:
|
|
546
|
+
'200':
|
|
547
|
+
description: OK
|
|
548
|
+
content:
|
|
549
|
+
application/json:
|
|
550
|
+
schema:
|
|
551
|
+
type: object
|
|
552
|
+
properties:
|
|
553
|
+
keys:
|
|
554
|
+
type: array
|
|
555
|
+
items:
|
|
556
|
+
type: object
|
|
557
|
+
properties:
|
|
558
|
+
kty:
|
|
559
|
+
type: string
|
|
560
|
+
description: 'Key type parameter identifies the cryptographic algorithm family used with the key, such as "RSA" or "EC"'
|
|
561
|
+
'n':
|
|
562
|
+
type: string
|
|
563
|
+
description: Modulus parameter of the RSA public key
|
|
564
|
+
e:
|
|
565
|
+
type: string
|
|
566
|
+
description: Exponent parameter of the RSA public key
|
|
567
|
+
kid:
|
|
568
|
+
type: string
|
|
569
|
+
description: Key ID parameter is used to match a specific key. It is typically used to identify the key in a set of keys
|
|
570
|
+
use:
|
|
571
|
+
type: string
|
|
572
|
+
description: 'Intended use of the public key, such as "sig" for signature or "enc" for encryption'
|
|
573
|
+
enum:
|
|
574
|
+
- sig
|
|
575
|
+
- enc
|
|
576
|
+
alg:
|
|
577
|
+
type: string
|
|
578
|
+
description: 'Algorithm intended for use with the key, such as "RS256" for RSA SHA-256'
|
|
579
|
+
required:
|
|
580
|
+
- kty
|
|
581
|
+
- kid
|
|
582
|
+
- use
|
|
583
|
+
- alg
|
|
584
|
+
required:
|
|
585
|
+
- keys
|
|
586
|
+
examples:
|
|
587
|
+
Success:
|
|
588
|
+
value:
|
|
589
|
+
keys:
|
|
590
|
+
- kty: RSA
|
|
591
|
+
'n': y0ur_modulus_h3r3
|
|
592
|
+
e: AQAB
|
|
593
|
+
kid: y0ur_key_id_h3r3
|
|
594
|
+
use: sig
|
|
595
|
+
alg: RS256
|
|
596
|
+
/.well-known/openid-configuration:
|
|
597
|
+
get:
|
|
598
|
+
summary: OpenID Provider Configuration
|
|
599
|
+
operationId: openid-configuration
|
|
600
|
+
tags:
|
|
601
|
+
- OIDC
|
|
602
|
+
description: |-
|
|
603
|
+
The OpenID Provider Configuration endpoint provides metadata about the OpenID Provider (OP). This metadata includes information such as the issuer identifier, authorization endpoint, token endpoint, userinfo endpoint, and supported scopes and claims.
|
|
604
|
+
|
|
605
|
+
Clients can use this metadata to dynamically configure themselves to interact with the OP without requiring manual configuration.
|
|
606
|
+
|
|
607
|
+
#### Related links
|
|
608
|
+
- https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationRequest
|
|
609
|
+
- https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
|
|
610
|
+
responses:
|
|
611
|
+
'200':
|
|
612
|
+
description: OK
|
|
613
|
+
content:
|
|
614
|
+
application/json:
|
|
615
|
+
schema:
|
|
616
|
+
type: object
|
|
617
|
+
properties:
|
|
618
|
+
issuer:
|
|
619
|
+
type: string
|
|
620
|
+
description: Issuer URL
|
|
621
|
+
authorization_endpoint:
|
|
622
|
+
type: string
|
|
623
|
+
description: Authorization endpoint URL
|
|
624
|
+
token_endpoint:
|
|
625
|
+
type: string
|
|
626
|
+
description: Token endpoint URL
|
|
627
|
+
revocation_endpoint:
|
|
628
|
+
type: string
|
|
629
|
+
description: Revocation endpoint URL
|
|
630
|
+
introspection_endpoint:
|
|
631
|
+
type: string
|
|
632
|
+
description: Introspection endpoint URL
|
|
633
|
+
userinfo_endpoint:
|
|
634
|
+
type: string
|
|
635
|
+
description: User Info endpoint URL
|
|
636
|
+
jwks_uri:
|
|
637
|
+
type: string
|
|
638
|
+
description: JWKS endpoint URL
|
|
639
|
+
scopes_supported:
|
|
640
|
+
type: array
|
|
641
|
+
description: List of supported scopes (this might not be an exhaustive list)
|
|
642
|
+
items:
|
|
643
|
+
type: string
|
|
644
|
+
response_types_supported:
|
|
645
|
+
type: array
|
|
646
|
+
description: List of supported OAuth2 `response_type` values
|
|
647
|
+
items:
|
|
648
|
+
type: string
|
|
649
|
+
response_modes_supported:
|
|
650
|
+
type: array
|
|
651
|
+
description: List of supported Oauth2 `response_mode` values
|
|
652
|
+
items:
|
|
653
|
+
type: string
|
|
654
|
+
grant_types_supported:
|
|
655
|
+
type: array
|
|
656
|
+
description: List of supported OAuth2 `grant_type` values
|
|
657
|
+
items:
|
|
658
|
+
type: string
|
|
659
|
+
token_endpoint_auth_methods_supported:
|
|
660
|
+
type: array
|
|
661
|
+
description: List of supported OAuth2 Client Authentication methods in the token endpoint
|
|
662
|
+
items:
|
|
663
|
+
type: string
|
|
664
|
+
subject_types_supported:
|
|
665
|
+
type: array
|
|
666
|
+
description: List of supported Subject Identifier types
|
|
667
|
+
items:
|
|
668
|
+
type: string
|
|
669
|
+
id_token_signing_alg_values_supported:
|
|
670
|
+
type: array
|
|
671
|
+
description: List of supported JWS signing algorithms (`alg` values) for the ID token
|
|
672
|
+
items:
|
|
673
|
+
type: string
|
|
674
|
+
claim_types_supported:
|
|
675
|
+
type: array
|
|
676
|
+
description: List of supported Claim Types
|
|
677
|
+
items:
|
|
678
|
+
type: string
|
|
679
|
+
claims_supported:
|
|
680
|
+
type: array
|
|
681
|
+
description: List of supported Claim Names we MAY be able to supply values for (this might not be an exhaustive list)
|
|
682
|
+
items:
|
|
683
|
+
type: string
|
|
684
|
+
required:
|
|
685
|
+
- issuer
|
|
686
|
+
- authorization_endpoint
|
|
687
|
+
- token_endpoint
|
|
688
|
+
- jwks_uri
|
|
689
|
+
- response_types_supported
|
|
690
|
+
- subject_types_supported
|
|
691
|
+
- id_token_signing_alg_values_supported
|
|
692
|
+
examples:
|
|
693
|
+
Success:
|
|
694
|
+
value:
|
|
695
|
+
issuer: 'http://accounts.veracross.com/your-school'
|
|
696
|
+
authorization_endpoint: 'http://accounts.veracross.com/your-school/oauth/authorize'
|
|
697
|
+
token_endpoint: 'http://accounts.veracross.com/your-school/oauth/token'
|
|
698
|
+
revocation_endpoint: 'http://accounts.veracross.com/your-school/oauth/revoke'
|
|
699
|
+
introspection_endpoint: 'http://accounts.veracross.com/your-school/oauth/instrospect'
|
|
700
|
+
userinfo_endpoint: 'http://accounts.veracross.com/your-school/oauth/userinfo'
|
|
701
|
+
jwks_uri: 'http://accounts.veracross.com/your-school/oauth/discovery/keys'
|
|
702
|
+
scopes_supported:
|
|
703
|
+
- openid
|
|
704
|
+
response_types_supported:
|
|
705
|
+
- code
|
|
706
|
+
response_modes_supported:
|
|
707
|
+
- query
|
|
708
|
+
- fragment
|
|
709
|
+
- form_post
|
|
710
|
+
grant_types_supported:
|
|
711
|
+
- authorization_code
|
|
712
|
+
- client_credentials
|
|
713
|
+
- refresh_token
|
|
714
|
+
token_endpoint_auth_methods_supported:
|
|
715
|
+
- client_secret_post
|
|
716
|
+
subject_types_supported:
|
|
717
|
+
- public
|
|
718
|
+
id_token_signing_alg_values_supported:
|
|
719
|
+
- RS256
|
|
720
|
+
claim_types_supported:
|
|
721
|
+
- normal
|
|
722
|
+
claims_supported:
|
|
723
|
+
- iss
|
|
724
|
+
- sub
|
|
725
|
+
- aud
|
|
726
|
+
- exp
|
|
727
|
+
- iat
|
|
728
|
+
- preferred_username
|
|
729
|
+
- email
|
|
730
|
+
- roles
|
|
731
|
+
tags:
|
|
732
|
+
- name: OAuth
|