Ballerina library

clever.data

Module clever.data

OverviewPrerequisitesQuickstart

API

Client

Definitions

BadRequest
ClientHttp1Settings
ConnectionConfig
Credentials
District
DistrictAdmin
DistrictAdminResponse
DistrictAdminsResponse
DistrictResponse
DistrictsResponse
DistrictStatus
DistrictStatusResponse
DistrictStatusResponses
GradeLevelsResponse
InternalError
Location
Name
NotFound
OAuth2RefreshTokenGrantConfig
Principal
ProxyConfig
School
SchoolAdmin
SchoolAdminResponse
SchoolAdminsResponse
SchoolResponse
SchoolsResponse
Section
SectionResponse
SectionsResponse
Student
StudentContact
StudentContactResponse
StudentContactsForStudentResponse
StudentContactsResponse
StudentResponse
StudentsResponse
Teacher
TeacherResponse
TeachersResponse
Term

ballerinax/clever.data Ballerina library

1.5.1

Overview

This is a generated connector for Clever Data API v1.2 OpenAPI specification.

Clever Data API provides the capability to retrieve information from Clever.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the Clever Data connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/clever.data module into the Ballerina project.

Copy
import ballerinax/clever.data;

Step 2: Create a new connector instance

Create a data:ClientConfig with the tokens obtained, and initialize the connector with it.

Copy
data:ClientConfig configuration = {
    auth: {
        token : "<TOKEN>"
    }
};

data:Client cleverClient = check new (configuration);

Step 3: Invoke connector operation

  1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.
    Following is an example on how to get contacts using the connector. 
    Copy
    public function main() returns error? {
    data:StudentContactsResponse response = check cleverClient->getContacts();
}
  2. Use bal run command to compile and run the Ballerina program.

Clients

clever.data: Client

Isolated

This is a generated connector for Clever Data API v1.2 OpenAPI specification. Clever Data API provides the capability to retrieve information from Clever data store.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create a Clever account and obtain tokens by following this guide.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string "https://api.clever.com/v1.2" - URL of the target service

getContacts

Isolated FunctionRemote Function
function getContacts(int? 'limit, string? startingAfter, string? endingBefore) returns StudentContactsResponse|error

Returns a list of student contacts.

Parameters
  • 'limit int? (default ()) - Number of contacts
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
Return Type

getContact

Isolated FunctionRemote Function
function getContact(string id) returns StudentContactResponse|error

Returns a specific student contact.

Parameters
Return Type

getDistrictForStudentContact

Isolated FunctionRemote Function
function getDistrictForStudentContact(string id) returns DistrictResponse|error

Returns the district for a student contact.

Parameters
Return Type

getStudentForContact

Isolated FunctionRemote Function
function getStudentForContact(string id) returns StudentResponse|error

Returns the student for a student contact.

Parameters
Return Type

getDistrictAdmins

Isolated FunctionRemote Function
function getDistrictAdmins(string? startingAfter, string? endingBefore, string? showLinks) returns DistrictAdminsResponse|error

Returns a list of district admins.

Parameters
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
  • showLinks string? (default ()) - Show links
Return Type

getDistrictAdmin

Isolated FunctionRemote Function
function getDistrictAdmin(string id) returns DistrictAdminResponse|error

Returns a specific district admin.

Parameters
  • id string - District admin ID
Return Type

getDistricts

Isolated FunctionRemote Function
function getDistricts() returns DistrictsResponse|error

Returns a list of districts.

Return Type

getDistrict

Isolated FunctionRemote Function
function getDistrict(string id, string? include) returns DistrictResponse|error

Returns a specific district.

Parameters
  • include string? (default ()) - Includes
Return Type

getAdminsForDistrict

Isolated FunctionRemote Function
function getAdminsForDistrict(string id) returns DistrictAdminsResponse|error

Returns the admins for a district.

Parameters
Return Type

getSchoolsForDistrict

Isolated FunctionRemote Function
function getSchoolsForDistrict(string id, int? 'limit, string? startingAfter, string? endingBefore, string? 'where) returns SchoolsResponse|error

Returns the schools for a district.

Parameters
  • 'limit int? (default ()) - Number of schools
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
  • 'where string? (default ()) - Location
Return Type

getSectionsForDistrict

Isolated FunctionRemote Function
function getSectionsForDistrict(string id, int? 'limit, string? startingAfter, string? endingBefore, string? 'where) returns SectionsResponse|error

Returns the sections for a district.

Parameters
  • 'limit int? (default ()) - Number of sections
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
  • 'where string? (default ()) - Location
Return Type

getDistrictStatus

Isolated FunctionRemote Function
function getDistrictStatus(string id) returns DistrictStatusResponses|error

Returns the status of the district.

Parameters
Return Type

getStudentsForDistrict

Isolated FunctionRemote Function
function getStudentsForDistrict(string id, int? 'limit, string? startingAfter, string? endingBefore, string? 'where) returns StudentsResponse|error

Returns the students for a district.

Parameters
  • 'limit int? (default ()) - Number of students
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
  • 'where string? (default ()) - Location
Return Type

getTeachersForDistrict

Isolated FunctionRemote Function
function getTeachersForDistrict(string id, int? 'limit, string? startingAfter, string? endingBefore, string? 'where) returns TeachersResponse|error

Returns the teachers for a district.

Parameters
  • 'limit int? (default ()) - Number of teachers
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
  • 'where string? (default ()) - Location
Return Type

getSchoolAdmins

Isolated FunctionRemote Function
function getSchoolAdmins(int? 'limit, string? startingAfter, string? endingBefore, string? 'where) returns SchoolAdminsResponse|error

Returns a list of school admins.

Parameters
  • 'limit int? (default ()) - Number of admins
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
  • 'where string? (default ()) - Location
Return Type

getSchoolAdmin

Isolated FunctionRemote Function
function getSchoolAdmin(string id, string? include) returns SchoolAdminResponse|error

Returns a specific school admin.

Parameters
  • include string? (default ()) - Include
Return Type

getSchoolsForSchoolAdmin

Isolated FunctionRemote Function
function getSchoolsForSchoolAdmin(string id, int? 'limit, string? startingAfter, string? endingBefore) returns SchoolsResponse|error

Returns the schools for a school admin.

Parameters
  • 'limit int? (default ()) - Number of schools
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
Return Type

getSchools

Isolated FunctionRemote Function
function getSchools(int? 'limit, string? startingAfter, string? endingBefore, string? 'where) returns SchoolsResponse|error

Returns a list of schools.

Parameters
  • 'limit int? (default ()) - Number of schools
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
  • 'where string? (default ()) - Location
Return Type

getSchool

Isolated FunctionRemote Function
function getSchool(string id) returns SchoolResponse|error

Returns a specific school.

Parameters
Return Type

getDistrictForSchool

Isolated FunctionRemote Function
function getDistrictForSchool(string id) returns DistrictResponse|error

Returns the district for a school.

Parameters
Return Type

getSectionsForSchool

Isolated FunctionRemote Function
function getSectionsForSchool(string id, int? 'limit, string? startingAfter, string? endingBefore, string? 'where) returns SectionsResponse|error

Returns the sections for a school.

Parameters
  • 'limit int? (default ()) - Number of sections
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
  • 'where string? (default ()) - Location
Return Type

getStudentsForSchool

Isolated FunctionRemote Function
function getStudentsForSchool(string id, int? 'limit, string? startingAfter, string? endingBefore, string? 'where) returns StudentsResponse|error

Returns the students for a school.

Parameters
  • 'limit int? (default ()) - Number of students
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
  • 'where string? (default ()) - Location
Return Type

getTeachersForSchool

Isolated FunctionRemote Function
function getTeachersForSchool(string id, int? 'limit, string? startingAfter, string? endingBefore, string? 'where) returns TeachersResponse|error

Returns the teachers for a school.

Parameters
  • 'limit int? (default ()) - Number of schools
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
  • 'where string? (default ()) - Location
Return Type

getSections

Isolated FunctionRemote Function
function getSections(int? 'limit, string? startingAfter, string? endingBefore, string? 'where) returns SectionsResponse|error

Returns a list of sections.

Parameters
  • 'limit int? (default ()) - Number of sections
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
  • 'where string? (default ()) - Location
Return Type

getSection

Isolated FunctionRemote Function
function getSection(string id) returns SectionResponse|error

Returns a specific section.

Parameters
Return Type

getDistrictForSection

Isolated FunctionRemote Function
function getDistrictForSection(string id) returns DistrictResponse|error

Returns the district for a section.

Parameters
Return Type

getSchoolForSection

Isolated FunctionRemote Function
function getSchoolForSection(string id) returns SchoolResponse|error

Returns the school for a section

Parameters
Return Type

getStudentsForSection

Isolated FunctionRemote Function
function getStudentsForSection(string id, int? 'limit, string? startingAfter, string? endingBefore) returns StudentsResponse|error

Returns the students for a section.

Parameters
  • 'limit int? (default ()) - Number of students
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
Return Type

getTeacherForSection

Isolated FunctionRemote Function
function getTeacherForSection(string id) returns TeacherResponse|error

Returns the primary teacher for a section.

Parameters
Return Type

getTeachersForSection

Isolated FunctionRemote Function
function getTeachersForSection(string id, int? 'limit, string? startingAfter, string? endingBefore) returns TeachersResponse|error

Returns the teachers for a section.

Parameters
  • 'limit int? (default ()) - Number of teachers
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
Return Type

getStudents

Isolated FunctionRemote Function
function getStudents(int? 'limit, string? startingAfter, string? endingBefore, string? 'where) returns StudentsResponse|error

Returns a list of students.

Parameters
  • 'limit int? (default ()) - Number of students
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
  • 'where string? (default ()) - Location
Return Type

getStudent

Isolated FunctionRemote Function
function getStudent(string id, string? include) returns StudentResponse|error

Returns a specific student.

Parameters
  • include string? (default ()) - Include
Return Type

getContactsForStudent

Isolated FunctionRemote Function
function getContactsForStudent(string id, int? 'limit) returns StudentContactsForStudentResponse|error

Returns the contacts for a student.

Parameters
  • 'limit int? (default ()) - Number of contacts
Return Type

getDistrictForStudent

Isolated FunctionRemote Function
function getDistrictForStudent(string id) returns DistrictResponse|error

Returns the district for a student.

Parameters
Return Type

getSchoolForStudent

Isolated FunctionRemote Function
function getSchoolForStudent(string id) returns SchoolResponse|error

Returns the primary school for a student.

Parameters
Return Type

getSectionsForStudent

Isolated FunctionRemote Function
function getSectionsForStudent(string id, int? 'limit, string? startingAfter, string? endingBefore) returns SectionsResponse|error

Returns the sections for a student.

Parameters
  • 'limit int? (default ()) - Number of students
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
Return Type

getTeachersForStudent

Isolated FunctionRemote Function
function getTeachersForStudent(string id, int? 'limit, string? startingAfter, string? endingBefore) returns TeachersResponse|error

Returns the teachers for a student.

Parameters
  • 'limit int? (default ()) - Number of teachers
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
Return Type

getTeachers

Isolated FunctionRemote Function
function getTeachers(int? 'limit, string? startingAfter, string? endingBefore, string? 'where) returns TeachersResponse|error

Returns a list of teachers.

Parameters
  • 'limit int? (default ()) - Number of teachers
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
  • 'where string? (default ()) - Location
Return Type

getTeacher

Isolated FunctionRemote Function
function getTeacher(string id, string? include) returns TeacherResponse|error

Returns a specific teacher.

Parameters
  • include string? (default ()) - Include
Return Type

getDistrictForTeacher

Isolated FunctionRemote Function
function getDistrictForTeacher(string id) returns DistrictResponse|error

Returns the district for a teacher.

Parameters
Return Type

getGradeLevelsForTeacher

Isolated FunctionRemote Function
function getGradeLevelsForTeacher(string id) returns GradeLevelsResponse|error

Returns the grade levels for sections a teacher teaches.

Parameters
Return Type

getSchoolForTeacher

Isolated FunctionRemote Function
function getSchoolForTeacher(string id) returns SchoolResponse|error

Retrieves school info for a teacher.

Parameters
Return Type

getSectionsForTeacher

Isolated FunctionRemote Function
function getSectionsForTeacher(string id, int? 'limit, string? startingAfter, string? endingBefore) returns SectionsResponse|error

Returns the sections for a teacher.

Parameters
  • 'limit int? (default ()) - Number of sections
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
Return Type

getStudentsForTeacher

Isolated FunctionRemote Function
function getStudentsForTeacher(string id, int? 'limit, string? startingAfter, string? endingBefore) returns StudentsResponse|error

Returns the students for a teacher.

Parameters
  • 'limit int? (default ()) - Number of students
  • startingAfter string? (default ()) - Starting after
  • endingBefore string? (default ()) - Ending before
Return Type

Records

clever.data: BadRequest

Fields

clever.data: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

clever.data: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

clever.data: Credentials

Fields

clever.data: District

Fields

clever.data: DistrictAdmin

Fields

clever.data: DistrictAdminResponse

Fields

clever.data: DistrictAdminsResponse

Fields

clever.data: DistrictResponse

Fields

clever.data: DistrictsResponse

Fields

clever.data: DistrictStatus

Fields

clever.data: DistrictStatusResponse

Fields

clever.data: DistrictStatusResponses

Fields

clever.data: GradeLevelsResponse

Fields

clever.data: InternalError

Fields

clever.data: Location

Fields

clever.data: Name

Fields

clever.data: NotFound

Fields

clever.data: OAuth2RefreshTokenGrantConfig

Closed record

OAuth2 Refresh Token Grant Configs

Fields
  • refreshUrl string(default "https://clever.com/oauth/tokens") - Refresh URL

clever.data: Principal

Fields

clever.data: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

clever.data: School

Fields

clever.data: SchoolAdmin

Fields

clever.data: SchoolAdminResponse

Fields

clever.data: SchoolAdminsResponse

Fields

clever.data: SchoolResponse

Fields

clever.data: SchoolsResponse

Fields

clever.data: Section

Fields

clever.data: SectionResponse

Fields

clever.data: SectionsResponse

Fields

clever.data: Student

Fields

clever.data: StudentContact

Fields

clever.data: StudentContactResponse

Fields

clever.data: StudentContactsForStudentResponse

Fields

clever.data: StudentContactsResponse

Fields

clever.data: StudentResponse

Fields

clever.data: StudentsResponse

Fields

clever.data: Teacher

Fields

clever.data: TeacherResponse

Fields

clever.data: TeachersResponse

Fields

clever.data: Term

Fields

Import

import ballerinax/clever.data;Copy

Metadata

Released date: 12 months ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Source repository

Keywords

Education/Elearning

Cost/Paid

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC