Skip to content

Commit

Permalink
revised
Browse files Browse the repository at this point in the history
  • Loading branch information
battis committed Feb 25, 2024
1 parent e7b97bd commit f04ccf9
Show file tree
Hide file tree
Showing 133 changed files with 1,808 additions and 1,996 deletions.
9 changes: 5 additions & 4 deletions src/SKY/OneRoster/Endpoints/academicSessions.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,19 @@ public function getAll(): AcademicSessionsOutputModel
/**
* Returns a specific academic session.
*
* @param string $id sourcedId for the academic session
* @param array{id: string} $params An associative array
* - id: sourcedId for the academic session
*
* @return \Blackbaud\SKY\OneRoster\Components\AcademicSessionOutputModel
* OK - It was possible to read the collection.
*
* @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required
* parameters are not defined
*/
public function get(string $id): AcademicSessionOutputModel
public function get(array $params): AcademicSessionOutputModel
{
assert($id !== null, new ArgumentException("Parameter `id` is required"));
assert(isset($params['id']), new ArgumentException("Parameter `id` is required"));

return new AcademicSessionOutputModel($this->send("get", ["{id}" => $id], []));
return new AcademicSessionOutputModel($this->send("get", ["{id}" => $params['id']], []));
}
}
20 changes: 11 additions & 9 deletions src/SKY/OneRoster/Endpoints/categories.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,25 +32,27 @@ public function getAll(): CategoriesOutputModel
/**
* Returns a specific category.
*
* @param string $id sourcedId for the category
* @param array{id: string} $params An associative array
* - id: sourcedId for the category
*
* @return \Blackbaud\SKY\OneRoster\Components\CategoryOutputModel OK - It
* was possible to read the resource.
*
* @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required
* parameters are not defined
*/
public function get(string $id): CategoryOutputModel
public function get(array $params): CategoryOutputModel
{
assert($id !== null, new ArgumentException("Parameter `id` is required"));
assert(isset($params['id']), new ArgumentException("Parameter `id` is required"));

return new CategoryOutputModel($this->send("get", ["{id}" => $id], []));
return new CategoryOutputModel($this->send("get", ["{id}" => $params['id']], []));
}

/**
* Returns the category object that was created or updated.
*
* @param string $id sourcedId for the category
* @param array{id: string} $params An associative array
* - id: sourcedId for the category
* @param \Blackbaud\SKY\OneRoster\Components\CategoryInputModel
* $requestBody input model for a category
*
Expand All @@ -60,11 +62,11 @@ public function get(string $id): CategoryOutputModel
* @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required
* parameters are not defined
*/
public function put(string $id, CategoryInputModel $requestBody): CategoryOutputModel
public function put(array $params, CategoryInputModel $requestBody): CategoryOutputModel
{
assert($id !== null, new ArgumentException("Parameter `id` is required"));
assert($requestBody !== null, new ArgumentException("Parameter `requestBody` is required"));
assert(isset($params['id']), new ArgumentException("Parameter `id` is required"));
assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required"));

return new CategoryOutputModel($this->send("put", ["{id}" => $id], [], $requestBody));
return new CategoryOutputModel($this->send("put", ["{id}" => $params['id']], [], $requestBody));
}
}
9 changes: 5 additions & 4 deletions src/SKY/OneRoster/Endpoints/classes.php
Original file line number Diff line number Diff line change
Expand Up @@ -85,18 +85,19 @@ public function getAll(): ClassesOutputModel
/**
* Returns a specific class.
*
* @param string $id sourcedId for the class
* @param array{id: string} $params An associative array
* - id: sourcedId for the class
*
* @return \Blackbaud\SKY\OneRoster\Components\ClassOutputModel OK - It
* was possible to read the resource.
*
* @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required
* parameters are not defined
*/
public function get(string $id): ClassOutputModel
public function get(array $params): ClassOutputModel
{
assert($id !== null, new ArgumentException("Parameter `id` is required"));
assert(isset($params['id']), new ArgumentException("Parameter `id` is required"));

return new ClassOutputModel($this->send("get", ["{id}" => $id], []));
return new ClassOutputModel($this->send("get", ["{id}" => $params['id']], []));
}
}
12 changes: 7 additions & 5 deletions src/SKY/OneRoster/Endpoints/classes/categories.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,22 @@ class Categories extends BaseEndpoint
protected string $url = "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/classes/{class_id}/categories";

/**
* Returns a collection of categories for a specified `class_id`.
* Returns a collection of categories for a specified
* <code>class_id</code>.
*
* @param string $class_id sourcedId for the category
* @param array{class_id: string} $params An associative array
* - class_id: sourcedId for the category
*
* @return \Blackbaud\SKY\OneRoster\Components\CategoriesOutputModel OK -
* It was possible to read the resource.
*
* @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required
* parameters are not defined
*/
public function getByClass(string $class_id): CategoriesOutputModel
public function getByClass(array $params): CategoriesOutputModel
{
assert($class_id !== null, new ArgumentException("Parameter `class_id` is required"));
assert(isset($params['class_id']), new ArgumentException("Parameter `class_id` is required"));

return new CategoriesOutputModel($this->send("get", ["{class_id}" => $class_id], []));
return new CategoriesOutputModel($this->send("get", ["{class_id}" => $params['class_id']], []));
}
}
12 changes: 7 additions & 5 deletions src/SKY/OneRoster/Endpoints/classes/lineItems.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,20 +37,22 @@ class LineItems extends BaseEndpoint
protected Results $_results = null;

/**
* Returns a collection of lineItems for the specified `class_id`.
* Returns a collection of lineItems for the specified
* <code>class_id</code>.
*
* @param string $class_id sourcedId for the class
* @param array{class_id: string} $params An associative array
* - class_id: sourcedId for the class
*
* @return \Blackbaud\SKY\OneRoster\Components\LineItemsOutputModel OK -
* It was possible to read the resource.
*
* @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required
* parameters are not defined
*/
public function getByClass(string $class_id): LineItemsOutputModel
public function getByClass(array $params): LineItemsOutputModel
{
assert($class_id !== null, new ArgumentException("Parameter `class_id` is required"));
assert(isset($params['class_id']), new ArgumentException("Parameter `class_id` is required"));

return new LineItemsOutputModel($this->send("get", ["{class_id}" => $class_id], []));
return new LineItemsOutputModel($this->send("get", ["{class_id}" => $params['class_id']], []));
}
}
20 changes: 11 additions & 9 deletions src/SKY/OneRoster/Endpoints/classes/lineItems/results.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,26 @@ class Results extends BaseEndpoint
protected string $url = "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/classes/{class_id}/lineItems/{li_id}/results";

/**
* Returns a collection of results for the specified `class_id` and
* `li_id`.
* Returns a collection of results for the specified <code>class_id</code>
* and <code>li_id</code>.
*
* @param string $class_id sourcedId for the class
* @param string $li_id sourcedId for the lineItem
* @param array{class_id: string, li_id: string} $params An associative
* array
* - class_id: sourcedId for the class
* - li_id: sourcedId for the lineItem
*
* @return \Blackbaud\SKY\OneRoster\Components\ResultsOutputModelSvc OK -
* It was possible to read the resource.
*
* @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required
* parameters are not defined
*/
public function getByClassAndLi(string $class_id, string $li_id): ResultsOutputModelSvc
public function getByClassAndLi(array $params): ResultsOutputModelSvc
{
assert($class_id !== null, new ArgumentException("Parameter `class_id` is required"));
assert($li_id !== null, new ArgumentException("Parameter `li_id` is required"));
assert(isset($params['class_id']), new ArgumentException("Parameter `class_id` is required"));
assert(isset($params['li_id']), new ArgumentException("Parameter `li_id` is required"));

return new ResultsOutputModelSvc($this->send("get", ["{class_id}" => $class_id,
"{li_id}" => $li_id], []));
return new ResultsOutputModelSvc($this->send("get", ["{class_id}" => $params['class_id'],
"{li_id}" => $params['li_id']], []));
}
}
11 changes: 6 additions & 5 deletions src/SKY/OneRoster/Endpoints/classes/results.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,21 @@ class Results extends BaseEndpoint
protected string $url = "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/classes/{class_id}/results";

/**
* Returns a collection of results for a specified `class_id`.
* Returns a collection of results for a specified <code>class_id</code>.
*
* @param string $class_id sourcedId for the class
* @param array{class_id: string} $params An associative array
* - class_id: sourcedId for the class
*
* @return \Blackbaud\SKY\OneRoster\Components\ResultsOutputModelSvc OK -
* It was possible to read the resource.
*
* @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required
* parameters are not defined
*/
public function getByClass(string $class_id): ResultsOutputModelSvc
public function getByClass(array $params): ResultsOutputModelSvc
{
assert($class_id !== null, new ArgumentException("Parameter `class_id` is required"));
assert(isset($params['class_id']), new ArgumentException("Parameter `class_id` is required"));

return new ResultsOutputModelSvc($this->send("get", ["{class_id}" => $class_id], []));
return new ResultsOutputModelSvc($this->send("get", ["{class_id}" => $params['class_id']], []));
}
}
12 changes: 7 additions & 5 deletions src/SKY/OneRoster/Endpoints/classes/students.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,19 +37,21 @@ class Students extends BaseEndpoint
protected Results $_results = null;

/**
* Returns a collection of student user data for the specified `class_id`.
* Returns a collection of student user data for the specified
* <code>class_id</code>.
*
* @param string $class_id sourcedId for the class
* @param array{class_id: string} $params An associative array
* - class_id: sourcedId for the class
*
* @return \Blackbaud\SKY\OneRoster\Components\UsersOutputModel Success
*
* @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required
* parameters are not defined
*/
public function getByClass(string $class_id): UsersOutputModel
public function getByClass(array $params): UsersOutputModel
{
assert($class_id !== null, new ArgumentException("Parameter `class_id` is required"));
assert(isset($params['class_id']), new ArgumentException("Parameter `class_id` is required"));

return new UsersOutputModel($this->send("get", ["{class_id}" => $class_id], []));
return new UsersOutputModel($this->send("get", ["{class_id}" => $params['class_id']], []));
}
}
20 changes: 11 additions & 9 deletions src/SKY/OneRoster/Endpoints/classes/students/results.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,26 @@ class Results extends BaseEndpoint
protected string $url = "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/classes/{class_id}/students/{student_id}/results";

/**
* Returns a collection of results for a specified `class_id` and
* `student_id`.
* Returns a collection of results for a specified <code>class_id</code>
* and <code>student_id</code>.
*
* @param string $class_id sourcedId for the class
* @param string $student_id sourcedId for the student
* @param array{class_id: string, student_id: string} $params An
* associative array
* - class_id: sourcedId for the class
* - student_id: sourcedId for the student
*
* @return \Blackbaud\SKY\OneRoster\Components\ResultsOutputModelSvc OK -
* It was possible to read the resource.
*
* @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required
* parameters are not defined
*/
public function getByClassAndStudent(string $class_id, string $student_id): ResultsOutputModelSvc
public function getByClassAndStudent(array $params): ResultsOutputModelSvc
{
assert($class_id !== null, new ArgumentException("Parameter `class_id` is required"));
assert($student_id !== null, new ArgumentException("Parameter `student_id` is required"));
assert(isset($params['class_id']), new ArgumentException("Parameter `class_id` is required"));
assert(isset($params['student_id']), new ArgumentException("Parameter `student_id` is required"));

return new ResultsOutputModelSvc($this->send("get", ["{class_id}" => $class_id,
"{student_id}" => $student_id], []));
return new ResultsOutputModelSvc($this->send("get", ["{class_id}" => $params['class_id'],
"{student_id}" => $params['student_id']], []));
}
}
19 changes: 9 additions & 10 deletions src/SKY/OneRoster/Endpoints/classes/teachers.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,26 +17,25 @@ class Teachers extends BaseEndpoint
protected string $url = "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/classes/{class_id}/teachers";

/**
* Returns a collection of teacher user data for the specified `class_id`.
* Returns a collection of teacher user data for the specified
* <code>class_id</code>. <br />
*
* Roles returned include:
*
* Roles returned include:
* <ul><li>Teacher</li><li>Pending Teacher</li></ul>
*
* - Teacher
*
* - Pending Teacher
*
* @param string $class_id sourcedId for the class
* @param array{class_id: string} $params An associative array
* - class_id: sourcedId for the class
*
* @return \Blackbaud\SKY\OneRoster\Components\UsersOutputModel Success
*
* @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required
* parameters are not defined
*/
public function getByClass(string $class_id): UsersOutputModel
public function getByClass(array $params): UsersOutputModel
{
assert($class_id !== null, new ArgumentException("Parameter `class_id` is required"));
assert(isset($params['class_id']), new ArgumentException("Parameter `class_id` is required"));

return new UsersOutputModel($this->send("get", ["{class_id}" => $class_id], []));
return new UsersOutputModel($this->send("get", ["{class_id}" => $params['class_id']], []));
}
}
9 changes: 5 additions & 4 deletions src/SKY/OneRoster/Endpoints/courses.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,19 @@ public function getAll(): CoursesOutputModel
/**
* Returns a specific course.
*
* @param string $id sourcedId for the course
* @param array{id: string} $params An associative array
* - id: sourcedId for the course
*
* @return \Blackbaud\SKY\OneRoster\Components\CourseOutputModel OK - It
* was possible to read the resource.
*
* @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required
* parameters are not defined
*/
public function get(string $id): CourseOutputModel
public function get(array $params): CourseOutputModel
{
assert($id !== null, new ArgumentException("Parameter `id` is required"));
assert(isset($params['id']), new ArgumentException("Parameter `id` is required"));

return new CourseOutputModel($this->send("get", ["{id}" => $id], []));
return new CourseOutputModel($this->send("get", ["{id}" => $params['id']], []));
}
}
12 changes: 7 additions & 5 deletions src/SKY/OneRoster/Endpoints/demographics.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,22 @@ public function getAll(): DemographicsOutputModel
}

/**
* Returns a single user's demographic data for the specified `id`..
* Returns a single user's demographic data for the specified
* <code>id</code>..
*
* @param string $id sourcedId for the user
* @param array{id: string} $params An associative array
* - id: sourcedId for the user
*
* @return \Blackbaud\SKY\OneRoster\Components\DemographicOutputModel
* Success
*
* @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required
* parameters are not defined
*/
public function get(string $id): DemographicOutputModel
public function get(array $params): DemographicOutputModel
{
assert($id !== null, new ArgumentException("Parameter `id` is required"));
assert(isset($params['id']), new ArgumentException("Parameter `id` is required"));

return new DemographicOutputModel($this->send("get", ["{id}" => $id], []));
return new DemographicOutputModel($this->send("get", ["{id}" => $params['id']], []));
}
}
9 changes: 5 additions & 4 deletions src/SKY/OneRoster/Endpoints/enrollments.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,19 @@ public function getAll(): EnrollmentsOutputModel
/**
* Returns a specific enrollment.
*
* @param string $id sourcedId for the enrollment
* @param array{id: string} $params An associative array
* - id: sourcedId for the enrollment
*
* @return \Blackbaud\SKY\OneRoster\Components\EnrollmentOutputModel OK -
* It was possible to read the resource.
*
* @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required
* parameters are not defined
*/
public function get(string $id): EnrollmentOutputModel
public function get(array $params): EnrollmentOutputModel
{
assert($id !== null, new ArgumentException("Parameter `id` is required"));
assert(isset($params['id']), new ArgumentException("Parameter `id` is required"));

return new EnrollmentOutputModel($this->send("get", ["{id}" => $id], []));
return new EnrollmentOutputModel($this->send("get", ["{id}" => $params['id']], []));
}
}
Loading

0 comments on commit f04ccf9

Please sign in to comment.