API Reference Cyphi v#0.1.0

Base module for Cypher Learning Api 3.0 Client

Provides struct and type for a Answer

Provides struct and type for a Assessment

Provides struct and type for a Assistant

Provides struct and types for a AttendanceSession

Provides struct and type for a Award

Provides struct and type for a Badge

Provides struct and type for a BadgeHistory

Provides struct and type for a BadgeMetadata

Provides API endpoints related to badges

Provides struct and type for a Batch

Provides struct and type for a BatchResults

Provides API endpoints related to batches

Provides struct and type for a Certificate

Provides struct and type for a CertificateMetadata

Provides API endpoints related to certificates

This module serves as the central interface for interacting with the Cypher Learning Matrix OpenAPI. It handles request construction (headers, authentication, and encoding), executes network calls via a configurable adapter, and transforms JSON responses into Elixir structs.

Prepares and encodes HTTP request options for the Cyphi.Client.

Handles the decoding and casting of HTTP responses into Elixir structs.

Provides struct and types for a Course

Provides struct and types for a CourseMetadata

Provides struct and types for a CourseTemplate

Provides struct and types for a CourseTemplateMetadata

Provides API endpoints related to course templates

Provides API endpoints related to courses

Provides API endpoints related to e commerce

Provides API endpoints related to enrollments

Provides struct and type for a Game

Provides API endpoints related to games

Provides struct and types for a Grade

Provides struct and types for a Group

Provides struct and type for a GroupMembership

Provides struct and types for a GroupMetadata

Provides API endpoints related to groups

Defines the behaviour for HTTP adapters used by Cyphi.Client.

Provides struct and type for a Instructor

Provides struct and types for a JobTitle

Provides API endpoints related to job titles

Provides struct and types for a Learner

Provides struct and type for a Level

Provides struct and type for a LevelHistory

Provides struct and type for a Module

Provides struct and type for a Order

Provides struct and types for a Organization

Provides API endpoints related to organizations

Provides struct and type for a Player

Provides struct and type for a PlayerLevel

Provides struct and type for a PointHistory

Provides struct and type for a ScormAnswer

Provides struct and type for a Section

Provides struct and type for a Session

Provides struct and types for a User

Provides struct and types for a UserAttendance

Provides API endpoints related to users

Provides struct and type for a Visit

Provides struct and type for a Webhook

Provides API endpoints related to webhooks