strongmind-oneroster-client 2.0.2__tar.gz

strongmind-oneroster-client-2.0.2/PKG-INFO

@@ -0,0 +1,14 @@
+Metadata-Version: 2.1
+Name: strongmind-oneroster-client
+Version: 2.0.2
+Summary: OneRoster Client
+Home-page: UNKNOWN
+Author: Team Platform
+Author-email: platform@strongmind.com
+License: UNKNOWN
+Keywords: Swagger,OneRoster OpenAPI (JSON) Definition
+Platform: UNKNOWN
+
+    The OneRoster service binding is available in WSDL/XSD and REST/JSON. The model is based upon the IMS PSM modelling approach.  # noqa: E501
+    
+

strongmind-oneroster-client-2.0.2/README.md

@@ -0,0 +1,233 @@
+# oneroster_client
+The OneRoster service binding is available in WSDL/XSD and REST/JSON. The model is based upon the IMS PSM modelling approach.
+
+This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.1
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
+For more information, please visit [http://www.imsglobal.org](http://www.imsglobal.org)
+
+## Requirements.
+
+Python 2.7 and 3.4+
+
+## Installation & Usage
+
+### Install Azure artifacts keyring to get access to StrongMind pip packages
+`pip install twine keyring artifacts-keyring`
+
+### pip install
+
+```sh
+pip install oneroster_client --extra-index-url https://pkgs.dev.azure.com/strongmind/Strongmind/_packaging/StrongMindPackages/pypi/simple/
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import oneroster_client 
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+
+```python
+import oneroster_client
+```
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+from __future__ import print_function
+import time
+import oneroster_client
+from oneroster_client.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: OAuth2Security
+configuration = oneroster_client.Configuration()
+configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = oneroster_client.AcademicSessionsManagementApi(oneroster_client.ApiClient(configuration))
+sourced_id = 'sourced_id_example' # str | The unique identifier for this academic session.
+
+try:
+    # The REST read request message for the getAcademicSession() API call.
+    api_response = api_instance.get_academic_session(sourced_id)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling AcademicSessionsManagementApi->get_academic_session: %s\n" % e)
+
+# Configure OAuth2 access token for authorization: OAuth2Security
+configuration = oneroster_client.Configuration()
+configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = oneroster_client.AcademicSessionsManagementApi(oneroster_client.ApiClient(configuration))
+limit = 100 # int | To define the download segmentation value i.e. the maximum number of records to be contained in the response. (optional) (default to 100)
+offset = 0 # int | The number of the first record to be supplied in the segmented response message. (optional) (default to 0)
+continuation_token = 'continuation_token_example' # str | Allows the client to resume retrieving results from where the previous page left off (optional)
+sort = 'sort_example' # str | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. (optional)
+order_by = 'order_by_example' # str | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). (optional)
+filter = 'filter_example' # str | The filtering rules to be applied when identifying the records to be supplied in the response message. (optional)
+fields = ['fields_example'] # list[str] | To identify the range of fields that should be supplied in the response message. (optional)
+
+try:
+    # The REST read request message for the getAcademicSessions() API call.
+    api_response = api_instance.get_academic_sessions(limit=limit, offset=offset, continuation_token=continuation_token, sort=sort, order_by=order_by, filter=filter, fields=fields)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling AcademicSessionsManagementApi->get_academic_sessions: %s\n" % e)
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to */*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AcademicSessionsManagementApi* | [**get_academic_session**](docs/AcademicSessionsManagementApi.md#get_academic_session) | **GET** /academicSessions/{sourcedId} | The REST read request message for the getAcademicSession() API call.
+*AcademicSessionsManagementApi* | [**get_academic_sessions**](docs/AcademicSessionsManagementApi.md#get_academic_sessions) | **GET** /academicSessions | The REST read request message for the getAcademicSessions() API call.
+*CategoriesManagementApi* | [**delete_category**](docs/CategoriesManagementApi.md#delete_category) | **DELETE** /categories/{sourcedId} | The REST delete request message for the deleteCategory() API call.
+*CategoriesManagementApi* | [**get_categories**](docs/CategoriesManagementApi.md#get_categories) | **GET** /categories | The REST read request message for the getCategories() API call.
+*CategoriesManagementApi* | [**get_category**](docs/CategoriesManagementApi.md#get_category) | **GET** /categories/{sourcedId} | The REST read request message for the getCategory() API call.
+*CategoriesManagementApi* | [**put_category**](docs/CategoriesManagementApi.md#put_category) | **PUT** /categories/{sourcedId} | The REST create request message for the putCategory() API call.
+*ClassesManagementApi* | [**get_class**](docs/ClassesManagementApi.md#get_class) | **GET** /classes/{sourcedId} | The REST read request message for the getClass() API call.
+*ClassesManagementApi* | [**get_classes**](docs/ClassesManagementApi.md#get_classes) | **GET** /classes | The REST read request message for the getClasses() API call.
+*ClassesManagementApi* | [**get_classes_for_course**](docs/ClassesManagementApi.md#get_classes_for_course) | **GET** /courses/{courseSourcedId}/classes | The REST read request message for the getClassesForCourse() API call.
+*ClassesManagementApi* | [**get_classes_for_school**](docs/ClassesManagementApi.md#get_classes_for_school) | **GET** /schools/{schoolSourcedId}/classes | The REST read request message for the getClassesForSchool() API call.
+*ClassesManagementApi* | [**get_classes_for_student**](docs/ClassesManagementApi.md#get_classes_for_student) | **GET** /students/{studentSourcedId}/classes | The REST read request message for the getClassesForStudent() API call.
+*ClassesManagementApi* | [**get_classes_for_teacher**](docs/ClassesManagementApi.md#get_classes_for_teacher) | **GET** /teachers/{teacherSourcedId}/classes | The REST read request message for the getClassesForTeacher() API call.
+*ClassesManagementApi* | [**get_classes_for_term**](docs/ClassesManagementApi.md#get_classes_for_term) | **GET** /terms/{termSourcedId}/classes | The REST read request message for the getClassesForTerm() API call.
+*ClassesManagementApi* | [**get_classes_for_user**](docs/ClassesManagementApi.md#get_classes_for_user) | **GET** /users/{userSourcedId}/classes | The REST read request message for the getClassesForUser() API call.
+*CoursesManagementApi* | [**get_course**](docs/CoursesManagementApi.md#get_course) | **GET** /courses/{sourcedId} | The REST read request message for the getCourse() API call.
+*CoursesManagementApi* | [**get_courses**](docs/CoursesManagementApi.md#get_courses) | **GET** /courses | The REST read request message for the getCourses() API call.
+*CoursesManagementApi* | [**get_courses_for_school**](docs/CoursesManagementApi.md#get_courses_for_school) | **GET** /schools/{schoolSourcedId}/courses | The REST read request message for the getCoursesForSchool() API call.
+*DemographicsManagementApi* | [**get_demographic**](docs/DemographicsManagementApi.md#get_demographic) | **GET** /demographics/{sourcedId} | The REST read request message for the getDemographic() API call.
+*DemographicsManagementApi* | [**get_demographics**](docs/DemographicsManagementApi.md#get_demographics) | **GET** /demographics | The REST read request message for the getDemographics() API call.
+*EnrollmentsManagementApi* | [**get_enrollment**](docs/EnrollmentsManagementApi.md#get_enrollment) | **GET** /enrollments/{sourcedId} | The REST read request message for the getEnrollment() API call.
+*EnrollmentsManagementApi* | [**get_enrollments**](docs/EnrollmentsManagementApi.md#get_enrollments) | **GET** /enrollments | The REST read request message for the getEnrollments() API call.
+*EnrollmentsManagementApi* | [**get_enrollments_for_class_in_school**](docs/EnrollmentsManagementApi.md#get_enrollments_for_class_in_school) | **GET** /schools/{schoolSourcedId}/classes/{classSourcedId}/enrollments | The REST read request message for the getEnrollmentsForClassInSchool() API call.
+*EnrollmentsManagementApi* | [**get_enrollments_for_school**](docs/EnrollmentsManagementApi.md#get_enrollments_for_school) | **GET** /schools/{schoolSourcedId}/enrollments | The REST read request message for the getEnrollmentsForSchool() API call.
+*GradingPeriodsManagementApi* | [**get_grading_period**](docs/GradingPeriodsManagementApi.md#get_grading_period) | **GET** /gradingPeriods/{sourcedId} | The REST read request message for the getGradingPeriod() API call.
+*GradingPeriodsManagementApi* | [**get_grading_periods**](docs/GradingPeriodsManagementApi.md#get_grading_periods) | **GET** /gradingPeriods | The REST read request message for the getGradingPeriods() API call.
+*GradingPeriodsManagementApi* | [**get_grading_periods_for_term**](docs/GradingPeriodsManagementApi.md#get_grading_periods_for_term) | **GET** /terms/{termSourcedId}/gradingPeriods | The REST read request message for the getGradingPeriodsForTerm() API call.
+*LineItemsManagementApi* | [**delete_line_item**](docs/LineItemsManagementApi.md#delete_line_item) | **DELETE** /lineItems/{sourcedId} | The REST delete request message for the deleteLineItem() API call.
+*LineItemsManagementApi* | [**get_line_item**](docs/LineItemsManagementApi.md#get_line_item) | **GET** /lineItems/{sourcedId} | The REST read request message for the getLineItem() API call.
+*LineItemsManagementApi* | [**get_line_items**](docs/LineItemsManagementApi.md#get_line_items) | **GET** /lineItems | The REST read request message for the getLineItems() API call.
+*LineItemsManagementApi* | [**get_line_items_for_class**](docs/LineItemsManagementApi.md#get_line_items_for_class) | **GET** /classes/{classSourcedId}/lineitems | The REST read request message for the getLineItemsForClass() API call.
+*LineItemsManagementApi* | [**put_line_item**](docs/LineItemsManagementApi.md#put_line_item) | **PUT** /lineItems/{sourcedId} | The REST create request message for the putLineItem() API call.
+*OrgsManagementApi* | [**get_org**](docs/OrgsManagementApi.md#get_org) | **GET** /orgs/{sourcedId} | The REST read request message for the getOrg() API call.
+*OrgsManagementApi* | [**get_orgs**](docs/OrgsManagementApi.md#get_orgs) | **GET** /orgs | The REST read request message for the getOrgs() API call.
+*ResourcesManagementApi* | [**get_resource**](docs/ResourcesManagementApi.md#get_resource) | **GET** /resources/{sourcedId} | The REST read request message for the getResource() API call.
+*ResourcesManagementApi* | [**get_resources**](docs/ResourcesManagementApi.md#get_resources) | **GET** /resources | The REST read request message for the getResources() API call.
+*ResourcesManagementApi* | [**get_resources_for_class**](docs/ResourcesManagementApi.md#get_resources_for_class) | **GET** /classes/{classSourcedId}/resources | The REST read request message for the getResourcesForClass() API call.
+*ResourcesManagementApi* | [**get_resources_for_course**](docs/ResourcesManagementApi.md#get_resources_for_course) | **GET** /courses/{courseSourcedId}/resources | The REST read request message for the getResourcesForCourse() API call.
+*ResultsManagementApi* | [**delete_result**](docs/ResultsManagementApi.md#delete_result) | **DELETE** /results/{sourcedId} | The REST delete request message for the deleteResult() API call.
+*ResultsManagementApi* | [**get_result**](docs/ResultsManagementApi.md#get_result) | **GET** /results/{sourcedId} | The REST read request message for the getResult() API call.
+*ResultsManagementApi* | [**get_results**](docs/ResultsManagementApi.md#get_results) | **GET** /results | The REST read request message for the getResults() API call.
+*ResultsManagementApi* | [**get_results_for_class**](docs/ResultsManagementApi.md#get_results_for_class) | **GET** /classes/{classSourcedId}/results | The REST read request message for the getResultsForClass() API call.
+*ResultsManagementApi* | [**get_results_for_line_item_for_class**](docs/ResultsManagementApi.md#get_results_for_line_item_for_class) | **GET** /classes/{classSourcedId}/lineItems/{lineItemSourcedId}/results | The REST read request message for the getResultsForLineItemForClass() API call.
+*ResultsManagementApi* | [**get_results_for_student_for_class**](docs/ResultsManagementApi.md#get_results_for_student_for_class) | **GET** /classes/{classSourcedId}/students/{studentSourcedId}/results | The REST read request message for the getResultsForStudentForClass() API call.
+*ResultsManagementApi* | [**put_result**](docs/ResultsManagementApi.md#put_result) | **PUT** /results/{sourcedId} | The REST create request message for the putResult() API call.
+*SchoolsManagementApi* | [**get_school**](docs/SchoolsManagementApi.md#get_school) | **GET** /schools/{sourcedId} | The REST read request message for the getSchool() API call.
+*SchoolsManagementApi* | [**get_schools**](docs/SchoolsManagementApi.md#get_schools) | **GET** /schools | The REST read request message for the getSchools() API call.
+*StudentsManagementApi* | [**get_student**](docs/StudentsManagementApi.md#get_student) | **GET** /students/{sourcedId} | The REST read request message for the getStudent() API call.
+*StudentsManagementApi* | [**get_students**](docs/StudentsManagementApi.md#get_students) | **GET** /students | The REST read request message for the getStudents() API call.
+*StudentsManagementApi* | [**get_students_for_class**](docs/StudentsManagementApi.md#get_students_for_class) | **GET** /classes/{classSourcedId}/students | The REST read request message for the getStudentsForClass() API call.
+*StudentsManagementApi* | [**get_students_for_class_in_school**](docs/StudentsManagementApi.md#get_students_for_class_in_school) | **GET** /schools/{schoolSourcedId}/classes/{classSourcedId}/students | The REST read request message for the getStudentsForClassInSchool() API call.
+*StudentsManagementApi* | [**get_students_for_school**](docs/StudentsManagementApi.md#get_students_for_school) | **GET** /schools/{schoolSourcedId}/students | The REST read request message for the getStudentsForSchool() API call.
+*TeachersManagementApi* | [**get_teacher**](docs/TeachersManagementApi.md#get_teacher) | **GET** /teachers/{sourcedId} | The REST read request message for the getTeacher() API call.
+*TeachersManagementApi* | [**get_teachers**](docs/TeachersManagementApi.md#get_teachers) | **GET** /teachers | The REST read request message for the getTeachers() API call.
+*TeachersManagementApi* | [**get_teachers_for_class**](docs/TeachersManagementApi.md#get_teachers_for_class) | **GET** /classes/{classSourcedId}/teachers | The REST read request message for the getTeachersForClass() API call.
+*TeachersManagementApi* | [**get_teachers_for_class_in_school**](docs/TeachersManagementApi.md#get_teachers_for_class_in_school) | **GET** /schools/{schoolSourcedId}/classes/{classSourcedId}/teachers | The REST read request message for the getTeachersForClassInSchool() API call.
+*TeachersManagementApi* | [**get_teachers_for_school**](docs/TeachersManagementApi.md#get_teachers_for_school) | **GET** /schools/{schoolSourcedId}/teachers | The REST read request message for the getTeachersForSchool() API call.
+*TermsManagementApi* | [**get_term**](docs/TermsManagementApi.md#get_term) | **GET** /terms/{sourcedId} | The REST read request message for the getTerm() API call.
+*TermsManagementApi* | [**get_terms**](docs/TermsManagementApi.md#get_terms) | **GET** /terms | The REST read request message for the getTerms() API call.
+*TermsManagementApi* | [**get_terms_for_school**](docs/TermsManagementApi.md#get_terms_for_school) | **GET** /schools/{schoolSourcedId}/terms | The REST read request message for the getTermsForSchool() API call.
+*UsersManagementApi* | [**get_user**](docs/UsersManagementApi.md#get_user) | **GET** /users/{sourcedId} | The REST read request message for the getUser() API call.
+*UsersManagementApi* | [**get_users**](docs/UsersManagementApi.md#get_users) | **GET** /users | The REST read request message for the getUsers() API call.
+
+## Documentation For Models
+
+ - [AcademicSessionType](docs/AcademicSessionType.md)
+ - [AcademicSessionTypeAllOf](docs/AcademicSessionTypeAllOf.md)
+ - [BaseType](docs/BaseType.md)
+ - [CategoriesType](docs/CategoriesType.md)
+ - [CategoryType](docs/CategoryType.md)
+ - [CategoryTypeAllOf](docs/CategoryTypeAllOf.md)
+ - [ClassType](docs/ClassType.md)
+ - [ClassTypeAllOf](docs/ClassTypeAllOf.md)
+ - [ClassesType](docs/ClassesType.md)
+ - [CourseType](docs/CourseType.md)
+ - [CourseTypeAllOf](docs/CourseTypeAllOf.md)
+ - [CoursesType](docs/CoursesType.md)
+ - [DemographicType](docs/DemographicType.md)
+ - [DemographicTypeAllOf](docs/DemographicTypeAllOf.md)
+ - [DemographicsType](docs/DemographicsType.md)
+ - [EnrollmentType](docs/EnrollmentType.md)
+ - [EnrollmentTypeAllOf](docs/EnrollmentTypeAllOf.md)
+ - [EnrollmentsType](docs/EnrollmentsType.md)
+ - [GUIDRefType](docs/GUIDRefType.md)
+ - [GUIDType](docs/GUIDType.md)
+ - [IdentifierType](docs/IdentifierType.md)
+ - [ImsxCodeMinorFieldType](docs/ImsxCodeMinorFieldType.md)
+ - [ImsxCodeMinorType](docs/ImsxCodeMinorType.md)
+ - [ImsxStatusInfoType](docs/ImsxStatusInfoType.md)
+ - [LineItemType](docs/LineItemType.md)
+ - [LineItemTypeAllOf](docs/LineItemTypeAllOf.md)
+ - [LineItemsType](docs/LineItemsType.md)
+ - [MetadataType](docs/MetadataType.md)
+ - [MultipleAcademicSessionsType](docs/MultipleAcademicSessionsType.md)
+ - [OrgType](docs/OrgType.md)
+ - [OrgTypeAllOf](docs/OrgTypeAllOf.md)
+ - [OrgsType](docs/OrgsType.md)
+ - [ResourceType](docs/ResourceType.md)
+ - [ResourceTypeAllOf](docs/ResourceTypeAllOf.md)
+ - [ResourcesType](docs/ResourcesType.md)
+ - [ResultType](docs/ResultType.md)
+ - [ResultTypeAllOf](docs/ResultTypeAllOf.md)
+ - [ResultsType](docs/ResultsType.md)
+ - [SingleAcademicSessionType](docs/SingleAcademicSessionType.md)
+ - [SingleCategoryType](docs/SingleCategoryType.md)
+ - [SingleClassType](docs/SingleClassType.md)
+ - [SingleCourseType](docs/SingleCourseType.md)
+ - [SingleDemographicsType](docs/SingleDemographicsType.md)
+ - [SingleEnrollmentType](docs/SingleEnrollmentType.md)
+ - [SingleLineItemType](docs/SingleLineItemType.md)
+ - [SingleOrgType](docs/SingleOrgType.md)
+ - [SingleResourceType](docs/SingleResourceType.md)
+ - [SingleResultType](docs/SingleResultType.md)
+ - [SingleUserType](docs/SingleUserType.md)
+ - [UserIdType](docs/UserIdType.md)
+ - [UserType](docs/UserType.md)
+ - [UserTypeAllOf](docs/UserTypeAllOf.md)
+ - [UsersType](docs/UsersType.md)
+
+## Documentation For Authorization
+
+
+## OAuth2Security
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+ - **StrongMind.Platform.OneRoster.Read**: Read access to OneRoster resources
+
+
+## Author
+
+platform@strongmind.com

strongmind-oneroster-client-2.0.2/oneroster_client/__init__.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    OneRoster OpenAPI (JSON) Definition
+
+    The OneRoster service binding is available in WSDL/XSD and REST/JSON. The model is based upon the IMS PSM modelling approach.  # noqa: E501
+
+    OpenAPI spec version: 1.1
+    Contact: lmattson@imsglobal.org
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+# import apis into sdk package
+from oneroster_client.api.academic_sessions_management_api import AcademicSessionsManagementApi
+from oneroster_client.api.categories_management_api import CategoriesManagementApi
+from oneroster_client.api.classes_management_api import ClassesManagementApi
+from oneroster_client.api.courses_management_api import CoursesManagementApi
+from oneroster_client.api.demographics_management_api import DemographicsManagementApi
+from oneroster_client.api.enrollments_management_api import EnrollmentsManagementApi
+from oneroster_client.api.grading_periods_management_api import GradingPeriodsManagementApi
+from oneroster_client.api.line_items_management_api import LineItemsManagementApi
+from oneroster_client.api.orgs_management_api import OrgsManagementApi
+from oneroster_client.api.resources_management_api import ResourcesManagementApi
+from oneroster_client.api.results_management_api import ResultsManagementApi
+from oneroster_client.api.schools_management_api import SchoolsManagementApi
+from oneroster_client.api.students_management_api import StudentsManagementApi
+from oneroster_client.api.teachers_management_api import TeachersManagementApi
+from oneroster_client.api.terms_management_api import TermsManagementApi
+from oneroster_client.api.users_management_api import UsersManagementApi
+# import ApiClient
+from oneroster_client.api_client import ApiClient
+from oneroster_client.configuration import Configuration
+# import models into sdk package
+from oneroster_client.models.academic_session_type import AcademicSessionType
+from oneroster_client.models.academic_session_type_all_of import AcademicSessionTypeAllOf
+from oneroster_client.models.base_type import BaseType
+from oneroster_client.models.categories_type import CategoriesType
+from oneroster_client.models.category_type import CategoryType
+from oneroster_client.models.category_type_all_of import CategoryTypeAllOf
+from oneroster_client.models.class_type import ClassType
+from oneroster_client.models.class_type_all_of import ClassTypeAllOf
+from oneroster_client.models.classes_type import ClassesType
+from oneroster_client.models.course_type import CourseType
+from oneroster_client.models.course_type_all_of import CourseTypeAllOf
+from oneroster_client.models.courses_type import CoursesType
+from oneroster_client.models.demographic_type import DemographicType
+from oneroster_client.models.demographic_type_all_of import DemographicTypeAllOf
+from oneroster_client.models.demographics_type import DemographicsType
+from oneroster_client.models.enrollment_type import EnrollmentType
+from oneroster_client.models.enrollment_type_all_of import EnrollmentTypeAllOf
+from oneroster_client.models.enrollments_type import EnrollmentsType
+from oneroster_client.models.guid_ref_type import GUIDRefType
+from oneroster_client.models.guid_type import GUIDType
+from oneroster_client.models.identifier_type import IdentifierType
+from oneroster_client.models.imsx_code_minor_field_type import ImsxCodeMinorFieldType
+from oneroster_client.models.imsx_code_minor_type import ImsxCodeMinorType
+from oneroster_client.models.imsx_status_info_type import ImsxStatusInfoType
+from oneroster_client.models.line_item_type import LineItemType
+from oneroster_client.models.line_item_type_all_of import LineItemTypeAllOf
+from oneroster_client.models.line_items_type import LineItemsType
+from oneroster_client.models.metadata_type import MetadataType
+from oneroster_client.models.multiple_academic_sessions_type import MultipleAcademicSessionsType
+from oneroster_client.models.org_type import OrgType
+from oneroster_client.models.org_type_all_of import OrgTypeAllOf
+from oneroster_client.models.orgs_type import OrgsType
+from oneroster_client.models.resource_type import ResourceType
+from oneroster_client.models.resource_type_all_of import ResourceTypeAllOf
+from oneroster_client.models.resources_type import ResourcesType
+from oneroster_client.models.result_type import ResultType
+from oneroster_client.models.result_type_all_of import ResultTypeAllOf
+from oneroster_client.models.results_type import ResultsType
+from oneroster_client.models.single_academic_session_type import SingleAcademicSessionType
+from oneroster_client.models.single_category_type import SingleCategoryType
+from oneroster_client.models.single_class_type import SingleClassType
+from oneroster_client.models.single_course_type import SingleCourseType
+from oneroster_client.models.single_demographics_type import SingleDemographicsType
+from oneroster_client.models.single_enrollment_type import SingleEnrollmentType
+from oneroster_client.models.single_line_item_type import SingleLineItemType
+from oneroster_client.models.single_org_type import SingleOrgType
+from oneroster_client.models.single_resource_type import SingleResourceType
+from oneroster_client.models.single_result_type import SingleResultType
+from oneroster_client.models.single_user_type import SingleUserType
+from oneroster_client.models.user_id_type import UserIdType
+from oneroster_client.models.user_type import UserType
+from oneroster_client.models.user_type_all_of import UserTypeAllOf
+from oneroster_client.models.users_type import UsersType

strongmind-oneroster-client-2.0.2/oneroster_client/api/__init__.py

@@ -0,0 +1,21 @@
+from __future__ import absolute_import
+
+# flake8: noqa
+
+# import apis into api package
+from oneroster_client.api.academic_sessions_management_api import AcademicSessionsManagementApi
+from oneroster_client.api.categories_management_api import CategoriesManagementApi
+from oneroster_client.api.classes_management_api import ClassesManagementApi
+from oneroster_client.api.courses_management_api import CoursesManagementApi
+from oneroster_client.api.demographics_management_api import DemographicsManagementApi
+from oneroster_client.api.enrollments_management_api import EnrollmentsManagementApi
+from oneroster_client.api.grading_periods_management_api import GradingPeriodsManagementApi
+from oneroster_client.api.line_items_management_api import LineItemsManagementApi
+from oneroster_client.api.orgs_management_api import OrgsManagementApi
+from oneroster_client.api.resources_management_api import ResourcesManagementApi
+from oneroster_client.api.results_management_api import ResultsManagementApi
+from oneroster_client.api.schools_management_api import SchoolsManagementApi
+from oneroster_client.api.students_management_api import StudentsManagementApi
+from oneroster_client.api.teachers_management_api import TeachersManagementApi
+from oneroster_client.api.terms_management_api import TermsManagementApi
+from oneroster_client.api.users_management_api import UsersManagementApi

strongmind-oneroster-client-2.0.2/oneroster_client/api/academic_sessions_management_api.py

@@ -0,0 +1,244 @@
+# coding: utf-8
+
+"""
+    OneRoster OpenAPI (JSON) Definition
+
+    The OneRoster service binding is available in WSDL/XSD and REST/JSON. The model is based upon the IMS PSM modelling approach.  # noqa: E501
+
+    OpenAPI spec version: 1.1
+    Contact: lmattson@imsglobal.org
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+import re  # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from oneroster_client.api_client import ApiClient
+
+
+class AcademicSessionsManagementApi(object):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    Ref: https://github.com/swagger-api/swagger-codegen
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def get_academic_session(self, sourced_id, **kwargs):  # noqa: E501
+        """The REST read request message for the getAcademicSession() API call.  # noqa: E501
+
+        To read, get, a specific academic session.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_academic_session(sourced_id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str sourced_id: The unique identifier for this academic session. (required)
+        :return: SingleAcademicSessionType
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_academic_session_with_http_info(sourced_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.get_academic_session_with_http_info(sourced_id, **kwargs)  # noqa: E501
+            return data
+
+    def get_academic_session_with_http_info(self, sourced_id, **kwargs):  # noqa: E501
+        """The REST read request message for the getAcademicSession() API call.  # noqa: E501
+
+        To read, get, a specific academic session.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_academic_session_with_http_info(sourced_id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str sourced_id: The unique identifier for this academic session. (required)
+        :return: SingleAcademicSessionType
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['sourced_id']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_academic_session" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'sourced_id' is set
+        if ('sourced_id' not in params or
+                params['sourced_id'] is None):
+            raise ValueError("Missing the required parameter `sourced_id` when calling `get_academic_session`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'sourced_id' in params:
+            path_params['sourcedId'] = params['sourced_id']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['OAuth2Security']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/academicSessions/{sourcedId}', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='SingleAcademicSessionType',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
+    def get_academic_sessions(self, **kwargs):  # noqa: E501
+        """The REST read request message for the getAcademicSessions() API call.  # noqa: E501
+
+        To read, get, a collection of academic sessions i.e. all academic sessions.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_academic_sessions(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int limit: To define the download segmentation value i.e. the maximum number of records to be contained in the response.
+        :param int offset: The number of the first record to be supplied in the segmented response message.
+        :param str continuation_token: Allows the client to resume retrieving results from where the previous page left off
+        :param str sort: Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
+        :param str order_by: The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
+        :param str filter: The filtering rules to be applied when identifying the records to be supplied in the response message.
+        :param list[str] fields: To identify the range of fields that should be supplied in the response message.
+        :return: MultipleAcademicSessionsType
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_academic_sessions_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.get_academic_sessions_with_http_info(**kwargs)  # noqa: E501
+            return data
+
+    def get_academic_sessions_with_http_info(self, **kwargs):  # noqa: E501
+        """The REST read request message for the getAcademicSessions() API call.  # noqa: E501
+
+        To read, get, a collection of academic sessions i.e. all academic sessions.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_academic_sessions_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int limit: To define the download segmentation value i.e. the maximum number of records to be contained in the response.
+        :param int offset: The number of the first record to be supplied in the segmented response message.
+        :param str continuation_token: Allows the client to resume retrieving results from where the previous page left off
+        :param str sort: Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
+        :param str order_by: The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
+        :param str filter: The filtering rules to be applied when identifying the records to be supplied in the response message.
+        :param list[str] fields: To identify the range of fields that should be supplied in the response message.
+        :return: MultipleAcademicSessionsType
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['limit', 'offset', 'continuation_token', 'sort', 'order_by', 'filter', 'fields']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_academic_sessions" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'limit' in params:
+            query_params.append(('limit', params['limit']))  # noqa: E501
+        if 'offset' in params:
+            query_params.append(('offset', params['offset']))  # noqa: E501
+        if 'continuation_token' in params:
+            query_params.append(('continuationToken', params['continuation_token']))  # noqa: E501
+        if 'sort' in params:
+            query_params.append(('sort', params['sort']))  # noqa: E501
+        if 'order_by' in params:
+            query_params.append(('orderBy', params['order_by']))  # noqa: E501
+        if 'filter' in params:
+            query_params.append(('filter', params['filter']))  # noqa: E501
+        if 'fields' in params:
+            query_params.append(('fields', params['fields']))  # noqa: E501
+            collection_formats['fields'] = 'csv'  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['OAuth2Security']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/academicSessions', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='MultipleAcademicSessionsType',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)