Go API client for eduframe

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: v1
• Package version: 0.1.0
• Generator version: 7.10.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import eduframe "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value eduframe.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), eduframe.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value eduframe.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), eduframe.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using eduframe.ContextOperationServerIndices and eduframe.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), eduframe.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), eduframe.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.eduframe.nl/api/v1

Class	Method	HTTP request	Description
AccountsAPI	CreateAccount	Post /accounts	Create an account
AccountsAPI	GetAccountById	Get /accounts/{id}	Get a single account
AccountsAPI	GetAccounts	Get /accounts	Get all accounts
AccountsAPI	UpdateAccount	Patch /accounts/{id}	Update an account
AffiliationsAPI	CreateAffiliation	Post /affiliations	Create an affiliation affiliations
AffiliationsAPI	DeleteAffiliationById	Delete /affiliations/{id}	Delete an affiliation
AffiliationsAPI	GetAffiliations	Get /affiliations	Get all affiliations
AffiliationsAPI	UpdateAffiliationById	Patch /affiliations/{id}	Update an affiliation.
AttendancesAPI	GetAttendances	Get /attendances	Get all attendance records
AttendancesAPI	SetAttendance	Post /attendances/upsert	Set an attendance.
AuthenticationsAPI	CreateAuthentication	Post /authentications	Create an authentication.
AuthenticationsAPI	DeleteAuthenticationFromUser	Delete /users/{user_id}/authentications/{id}	Remove an authentication from a user. NOTE: It is impossible to remove the last authentication for a user.
AuthenticationsAPI	GetAuthenticationsByUserId	Get /users/{user_id}/authentications	Get the authentications of an user
CatalogProductsAPI	GetCatalogProductById	Get /catalog/products/{id}	Get a catalog product record
CatalogProductsAPI	GetCatalogProducts	Get /catalog/products	Get all catalog products
CatalogProductsAPI	UpdateCatalogProductById	Patch /catalog/products/{id}	Update a catalog product
CatalogVariantsAPI	GetCatalogVariantById	Get /catalog/variants/{id}	Get a catalog variant record
CatalogVariantsAPI	GetCatalogVariants	Get /catalog/variants	Get all catalog variants
CatalogVariantsAPI	UpdateCatalogVariantById	Patch /catalog/variants/{id}	Update a catalog variant
CategoriesAPI	CreateCategory	Post /categories	Create a category.
CategoriesAPI	GetCategories	Get /categories	Get all category records
CategoriesAPI	GetCategoryById	Get /categories/{id}	Get a category record
CategoriesAPI	UpdateCategoryById	Patch /categories/{id}	Update a category.
CommentsAPI	CreateComment	Post /comments	Create a comment.
CommentsAPI	DeleteCommentById	Delete /comments/{id}	Delete a comment.
CommentsAPI	UpdateCommentById	Patch /comments/{id}	Update a comment.
CourseLocationsAPI	CreateCourseLocation	Post /course_locations	Create a course location.
CourseLocationsAPI	DeleteCourseLocationById	Delete /course_locations/{id}	Delete a course location.
CourseLocationsAPI	GetCourseLocationById	Get /course_locations/{id}	Get a course location record
CourseLocationsAPI	GetCourseLocations	Get /course_locations	Get all course location records
CourseLocationsAPI	UpdateCourseLocationById	Patch /course_locations/{id}	Update a course location.
CourseTabsAPI	GetCourseTabs	Get /course_tabs	Get all course tab records
CourseVariantsAPI	CreateCourseVariant	Post /course_variants	Create a course variant
CourseVariantsAPI	GetCourseVariantById	Get /course_variants/{id}	Get a course variant record
CourseVariantsAPI	GetCourseVariants	Get /course_variants	Get all course variant records
CoursesAPI	CreateCourse	Post /courses	Create a course.
CoursesAPI	GetCourseById	Get /courses/{id}	Get a course record
CoursesAPI	GetCourses	Get /courses	Get all course records
CoursesAPI	UpdateCourseById	Patch /courses/{id}	Update a course.
CreditCategoriesAPI	GetCreditCategories	Get /credit_categories	Get all credit category records
CreditsAPI	GetCredits	Get /credits	Get all credit records
CustomAssociationsAPI	GetAssociationsOfObject	Get /custom/{object_type}/associations	Get all associations of an system object
CustomFieldOptionsAPI	AddOptionToCustomField	Post /custom/{object_type}/fields/{field_slug}/options	Add an option to a custom field
CustomFieldOptionsAPI	DeleteOptionOfCustomField	Delete /custom/{object_type}/fields/{field_slug}/options/{option_id}	Delete an option from custom field
CustomFieldOptionsAPI	GetOptionOfCustomField	Get /custom/{object_type}/fields/{field_slug}/options/{option_id}	Get an option of a custom field
CustomFieldOptionsAPI	GetOptionsOfCustomField	Get /custom/{object_type}/fields/{field_slug}/options	Get all options of a custom field
CustomFieldOptionsAPI	UpdateOptionOfCustomField	Patch /custom/{object_type}/fields/{field_slug}/options/{option_id}	Update an option of a custom field
CustomObjectsAPI	GetCustomObjectByObjectId	Get /custom/objects/{object_id}	Get a custom object by object_id
CustomObjectsAPI	GetCustomObjects	Get /custom/objects	Get all custom objects
CustomRecordsAPI	CreateCustomRecord	Post /custom/objects/{object_id}/records	Create a custom record
CustomRecordsAPI	DeleteCustomRecord	Delete /custom/objects/{object_id}/records/{record_id}	Delete a custom record
CustomRecordsAPI	GetCustomRecord	Get /custom/objects/{object_id}/records/{record_id}	Get a custom record
CustomRecordsAPI	GetCustomRecords	Get /custom/objects/{object_id}/records	Get all custom records
CustomRecordsAPI	UpdateCustomRecord	Patch /custom/objects/{object_id}/records/{record_id}	Update a custom record
DiscountCodesAPI	GetDiscountCodes	Get /discount_codes	Get all discount codes
EducatorsAPI	GetCurrentEducator	Get /educators/current	Get an educator record
EnrollmentsAPI	CancelEnrollmentById	Put /enrollments/{id}/cancel	Cancel an enrollment
EnrollmentsAPI	GetEnrollmentById	Get /enrollments/{id}	Get an enrollment record
EnrollmentsAPI	GetEnrollments	Get /enrollments	Get all enrollment records
EnrollmentsAPI	UpdateEnrollmentById	Patch /enrollments/{id}	Update an enrollment
GradesAPI	CreateGrade	Post /grades	Create a grade
GradesAPI	DeleteGradeById	Delete /grades/{id}	Delete a grade.
GradesAPI	GetGradeById	Get /grades/{id}	Get a grade record
GradesAPI	UpdateGradeById	Patch /grades/{id}	Update a grade
InvoiceVatsAPI	CreateInvoiceVat	Post /invoice_vats	Create an invoice vat.
InvoiceVatsAPI	GetInvoiceVats	Get /invoice_vats	Get all invoice vat records
InvoicesAPI	CreateInvoice	Post /invoices	Create an invoice.
InvoicesAPI	GetInvoiceById	Get /invoices/{id}	Get an invoice record
InvoicesAPI	GetInvoicePdfById	Get /invoices/{id}/pdf	Get the base64 encoded version of the invoice PDF
InvoicesAPI	GetInvoices	Get /invoices	Get all invoice records
InvoicesAPI	OpenInvoiceById	Post /invoices/{id}/open	Changes the state from concept to open. This will assign the actual invoice number so it's ready for sending. If the current state is not concept, this endpoint does nothing.
LabelsAPI	AddLabelToOrder	Post /orders/{id}/labels	Add label to an order
LabelsAPI	CreateLabel	Post /labels	Create a label
LabelsAPI	DeleteLabelById	Delete /labels/{id}	Delete a label
LabelsAPI	GetLabelById	Get /labels/{id}	Get a label
LabelsAPI	GetLabels	Get /labels	Get all labels
LabelsAPI	UpdateLabelById	Patch /labels/{id}	Update a label
LeadsAPI	CreateLead	Post /leads	Create a lead.
LeadsAPI	DeleteLeadById	Delete /leads/{id}	Delete a lead.
LeadsAPI	GetLeadById	Get /leads/{id}	Get one lead record
LeadsAPI	GetLeads	Get /leads	Get all lead records
MaterialGroupsAPI	CreateMaterialGroup	Post /material_groups	Create a material group.
MaterialGroupsAPI	DeleteMaterialGroupById	Delete /material_groups/{id}	Delete a material group.
MaterialGroupsAPI	GetMaterialGroupById	Get /material_groups/{id}	Get a material group record
MaterialGroupsAPI	GetMaterialGroups	Get /material_groups	Get all material group records
MaterialGroupsAPI	UpdateMaterialGroupById	Patch /material_groups/{id}	Update a material group.
MaterialsAPI	CreateMaterial	Post /materials	Create a material.
MaterialsAPI	DeleteMaterialById	Delete /materials/{id}	Delete a material.
MaterialsAPI	GetMaterials	Get /materials	Get all material records
MaterialsAPI	UpdateMaterialById	Patch /materials/{id}	Update a material.
MeetingLocationsAPI	CreateMeetingLocation	Post /meeting_locations	Create a meeting location.
MeetingLocationsAPI	DeleteMeetingLocationById	Delete /meeting_locations/{id}	Delete a course location.
MeetingLocationsAPI	GetMeetingLocationById	Get /meeting_locations/{id}	Get an meeting location
MeetingLocationsAPI	GetMeetingLocations	Get /meeting_locations	Get all meeting location records
MeetingLocationsAPI	UpdateMeetingLocationById	Patch /meeting_locations/{id}	Update a meeting location.
MeetingsAPI	DeleteMeetingById	Delete /meetings/{id}	Delete a meeting.
MeetingsAPI	GetMeetingById	Get /meetings/{id}	Get an meeting record
MeetingsAPI	GetMeetings	Get /meetings	Get all meeting records
MeetingsAPI	GetMeetingsByPlannedCourseId	Get /planned_courses/{planned_course_id}/meetings	Get all meeting records of a planned course
OrdersAPI	ApproveOrderById	Put /orders/{id}/approve	Approve an order
OrdersAPI	CancelOrderById	Put /orders/{id}/cancel	Cancel an order
OrdersAPI	CreateOrder	Post /orders	Create an order.
OrdersAPI	DenyOrderById	Put /orders/{id}/deny	Deny an order
OrdersAPI	GetOrderById	Get /orders/{id}	Get an order record
OrdersAPI	GetOrders	Get /orders	Get all order records
PaymentMethodsAPI	GetPaymentMethods	Get /payment_methods	Get all payment method records available for customers
PaymentOptionsAPI	GetPaymentOptions	Get /payment_options	Get all payment option records
PaymentsAPI	CreateInvoicePaymentByInvoiceId	Post /invoices/{invoice_id}/payments	Create a payment.
PaymentsAPI	DeleteInvoicePaymentByIdAndInvoiceId	Delete /invoices/{invoice_id}/payments/{id}	Delete a payment.
PaymentsAPI	GetInvoicePaymentsByInvoiceId	Get /invoices/{invoice_id}/payments	Get all payment records of an invoice
PaymentsAPI	GetPaymentById	Get /payments/{id}	Get one payment record
PlannedCoursesAPI	CancelPlannedCourseById	Put /planned_courses/{id}/cancel	Cancel a planned course.
PlannedCoursesAPI	CreatePlannedCourse	Post /planned_courses	Create a planned course.
PlannedCoursesAPI	GetPlannedCourseById	Get /planned_courses/{id}	Get a planned course record
PlannedCoursesAPI	GetPlannedCourses	Get /planned_courses	Get all planned course records
PlannedCoursesAPI	GetPlannedCoursesByCourseId	Get /courses/{course_id}/planned_courses	Get all planned course records of a single course
PlannedCoursesAPI	GetPlannedCoursesByIdAndCourseId	Get /courses/{course_id}/planned_courses/{id}	Get a planned course record of a single course
PlannedCoursesAPI	UpdatePlannedCourseById	Patch /planned_courses/{id}	Update a planned course.
PlanningConflictsAPI	GetPlanningConflicts	Get /planning/conflicts	Get all conflicts
PlanningEventsAPI	DeletePlanningEventById	Delete /planning/events/{id}	Delete a planning event.
PlanningEventsAPI	GetPlanningEventById	Get /planning/events/{id}	Get an planning event record
PlanningEventsAPI	GetPlanningEvents	Get /planning/events	Get all planning event records
PlanningLocationsAPI	GetPlanningLocations	Get /planning/locations	Get all locations that are available
PlanningMaterialsAPI	GetPlanningMaterials	Get /planning/materials	Get all materials that are available
PlanningMaterialsAPI	GetPlanningMaterialsOfMeeting	Get /meetings/{id}/materials	Get all planning materials of a meeting
PlanningMaterialsAPI	GetPlanningMaterialsOfPlaningEvent	Get /planning/events/{id}/materials	Get all planning materials of a planning event
PlanningTeachersAPI	GetPlanningTeachers	Get /planning/teachers	Get all teachers that are available
ProgramEditionsAPI	CreateProgramEdition	Post /program/editions	Create a program edition
ProgramEditionsAPI	DeleteProgramEditionById	Delete /program/editions/{id}	Delete a program edition
ProgramEditionsAPI	GetElementsOfProgramEdition	Get /program/editions/{id}/elements	Get the elements of a program edition
ProgramEditionsAPI	GetProgramEditionById	Get /program/editions/{id}	Get a program edition
ProgramEditionsAPI	GetProgramEditions	Get /program/editions	Get all program editions
ProgramEditionsAPI	UpdateProgramEditionById	Patch /program/editions/{id}	Update a program edition
ProgramElementsAPI	CreateProgramElement	Post /program/elements	Create a program element
ProgramElementsAPI	DeleteProgramElementById	Delete /program/elements/{id}	Delete a element
ProgramElementsAPI	GetProgramElementById	Get /program/elements/{id}	Get an element
ProgramElementsAPI	GetProgramElements	Get /program/elements	Get all elements
ProgramElementsAPI	UpdateProgramElementById	Patch /program/elements/{id}	Update an element
ProgramEnrollmentsAPI	AwardCertificateToProgramEnrollmentById	Put /program/enrollments/{id}/award_certificate	Awards a certificate to a program enrollment
ProgramEnrollmentsAPI	CancelProgramEnrollmentById	Put /program/enrollments/{id}/cancel	Cancel a program enrollment
ProgramEnrollmentsAPI	DeleteCertificateFromProgramEnrollmentById	Post /program/enrollments/{id}/delete_certificate	Deletes a certificate from a program enrollment
ProgramEnrollmentsAPI	GetProgramEnrollmentById	Get /program/enrollments/{id}	Get a program enrollment record
ProgramEnrollmentsAPI	GetProgramEnrollments	Get /program/enrollments	Get all program enrollments
ProgramProgramsAPI	CreateProgram	Post /program/programs	Create a program
ProgramProgramsAPI	DeleteProgramById	Delete /program/programs/{id}	Delete a program
ProgramProgramsAPI	GetProgramById	Get /program/programs/{id}	Get a program
ProgramProgramsAPI	GetPrograms	Get /program/programs	Get all programs
ProgramProgramsAPI	UpdateProgramById	Patch /program/programs/{id}	Update a program
ReferralsAPI	GetReferrals	Get /referrals	Get all referral records
SignupQuestionsAPI	GetSignupQuestions	Get /signup_questions	Get all signup_question records
TasksAPI	CreateTask	Post /tasks	Create a task.
TasksAPI	DeleteTaskById	Delete /tasks/{id}	Delete a task.
TasksAPI	GetTaskById	Get /tasks/{id}	Get a task record
TasksAPI	GetTasks	Get /tasks	Get all task records
TasksAPI	UpdateTaskById	Patch /tasks/{id}	Update a task.
TeacherEnrollmentsAPI	CreateTeacherEnrollment	Post /teacher_enrollments	Enroll a teacher to a planned_course.
TeacherEnrollmentsAPI	CreateTeacherEnrollmentByPlannedCourseId	Post /planned_courses/{planned_course_id}/teacher_enrollments	Enroll a teacher to the given planned course.
TeacherEnrollmentsAPI	DeleteTeacherEnrollmentById	Delete /teacher_enrollments/{id}	Delete a teacher enrollment.
TeacherEnrollmentsAPI	GetTeacherEnrollments	Get /teacher_enrollments	Get all teacher enrollments.
TeacherEnrollmentsAPI	GetTeacherEnrollmentsByPlannedCourseId	Get /planned_courses/{planned_course_id}/teacher_enrollments	Get all teacher enrollments for given planned course.
TeacherEnrollmentsAPI	UpdateTeacherEnrollmentById	Patch /teacher_enrollments/{id}	Update a teacher enrollment.
TeacherRolesAPI	CreateTeacherRole	Post /teacher_roles	Create a teacher role.
TeacherRolesAPI	DeleteTeacherRoleById	Delete /teacher_roles/{id}	Delete a teacher role.
TeacherRolesAPI	GetTeacherRoleById	Get /teacher_roles/{id}	Get a teacher role
TeacherRolesAPI	GetTeacherRoles	Get /teacher_roles	Get all teacher roles
TeacherRolesAPI	UpdateTeacherRoleById	Patch /teacher_roles/{id}	Update a teacher role.
TeachersAPI	ActivateTeacherById	Post /teachers/{id}/activate	Mark teacher as active
TeachersAPI	CreateTeacher	Post /teachers	Create a new teacher
TeachersAPI	DeactivateTeacherById	Post /teachers/{id}/deactivate	Mark teacher as inactive
TeachersAPI	GetTeacherById	Get /teachers/{id}	Get a teacher record
TeachersAPI	GetTeachers	Get /teachers	Get all teacher records
ThesesAPI	GetTheses	Get /theses	Get all thesis records
UsersAPI	CreateUser	Post /users	Create a user.
UsersAPI	GetUserById	Get /users/{id}	Get an user record
UsersAPI	GetUsers	Get /users	Get all user records
UsersAPI	UpdateUserById	Patch /users/{id}	Update a user.
WebhookNotificationsAPI	GetWebhookNotificationsByWebhookId	Get /webhooks/{webhook_id}/notifications	Get the notifications for a specific webhook
WebhookNotificationsAPI	GetWebhookNotificationsFailed	Get /webhooks/{webhook_id}/notifications/failed	Get the failed webhook notifications
WebhooksAPI	CreateWebhook	Post /webhooks	Register a webhook.
WebhooksAPI	DeleteWebhookById	Delete /webhooks/{id}	Delete a webhook.
WebhooksAPI	GetWebhookById	Get /webhooks/{id}	Get a registered webhook
WebhooksAPI	GetWebhooks	Get /webhooks	Get all registered webhooks
WebhooksAPI	UpdateWebhookById	Patch /webhooks/{id}	Update a webhook.

Documentation For Models

• Account
• AccountType
• AccountWithIncludes
• AddLabelToOrderRequest
• Address
• AddressPatchPayload
• AddressPayload
• Affiliation
• Attendance
• AttendanceState
• Authentication
• AuthenticationProviderType
• AvailabilityState
• AwardCertificateToProgramEnrollmentByIdRequest
• Category
• Comment
• CommentType
• CostScheme
• Country
• Course
• CourseLead
• CourseLocation
• CourseLocationWithIncludes
• CoursePatchPayload
• CoursePatchPayloadCourseTabContentsAttributesInner
• CoursePayload
• CoursePayloadCourseTabContentsAttributesInner
• CourseTab
• CourseTabContent
• CourseVariant
• CourseWithIncludes
• CreateAccountRequest
• CreateAccountRequestSignupAnswersAttributesInner
• CreateAccountRequestSignupAnswersAttributesInnerValue
• CreateAffiliationRequest
• CreateAuthenticationRequest
• CreateCategoryRequest
• CreateCommentRequest
• CreateCourseLocationRequest
• CreateCourseVariantRequest
• CreateGradeRequest
• CreateInvoicePaymentByInvoiceIdRequest
• CreateInvoiceRequest
• CreateInvoiceRequestInvoiceItemsAttributesInner
• CreateInvoiceVatRequest
• CreateLabelRequest
• CreateLeadRequest
• CreateLeadRequestLeadProductsInner
• CreateMaterialGroupRequest
• CreateMaterialRequest
• CreateMeetingLocationRequest
• CreateOrderRequest
• CreateProgramElementRequest
• CreateTaskRequest
• CreateTeacher201Response
• CreateTeacherEnrollmentByPlannedCourseIdRequest
• CreateTeacherEnrollmentRequest
• CreateTeacherRequest
• CreateTeacherRoleRequest
• CreateUserRequest
• CreateWebhookRequest
• Credit
• CreditCategory
• CreditCategoryWithIncludes
• CreditType
• Currency
• CustomAssociation
• CustomAssociationWithRecords
• CustomAssociationsRecordsPayload
• CustomFieldOption
• CustomFieldOptionPatchPayload
• CustomFieldOptionPayload
• CustomFieldValue
• CustomObject
• CustomObjectField
• CustomObjectWithFields
• CustomRecord
• CustomRecordPatchPayload
• CustomRecordPayload
• DiscountCode
• Edition
• EditionWithIncludes
• Educator
• EducatorWithIncludes
• Element
• Enrollment
• EnrollmentStatus
• EnrollmentWithIncludes
• Error
• Grade
• GraduationState
• Invoice
• InvoiceItem
• InvoiceStatus
• InvoiceVat
• InvoiceVatWithIncludes
• InvoiceWithIncludes
• InvoiceWithIncludesAllOfInvoiceItems
• Label
• Lead
• LeadProduct
• LeadWithIncludes
• Locale
• Material
• MaterialGroup
• MaterialWithIncludes
• Meeting
• MeetingLocation
• MeetingLocationWithIncludes
• MeetingWithIncludes
• Order
• OrderItem
• OrderStatus
• OrderWithIncludes
• Payment
• PaymentMethod
• PaymentOption
• PaymentWithFixedIncludes
• PaymentWithIncludes
• PersonalProgramElement
• PlannedCourse
• PlannedCoursePatchPayload
• PlannedCoursePayload
• PlannedCourseStatus
• PlannedCourseWithIncludes
• PlanningAttendee
• PlanningConflict
• PlanningEvent
• PlanningEventWithIncludes
• PlanningMaterial
• PluginData
• PluginDataWithIncludes
• Product
• ProductWithIncludes
• ProductableType
• Program
• ProgramEditionBaseElement
• ProgramEditionBlockElement
• ProgramEditionBlockElementItem
• ProgramEditionCourseElement
• ProgramEditionElectiveElement
• ProgramEditionElement
• ProgramEditionEvaluationElement
• ProgramEditionPatchPayload
• ProgramEditionPayload
• ProgramEditionThesisElement
• ProgramEnrollment
• ProgramEnrollmentWithIncludes
• ProgramProgramPatchPayload
• ProgramProgramPatchPayloadCourseTabContentsAttributesInner
• ProgramProgramPayload
• ProgramWithIncludes
• Referral
• SetAttendanceRequest
• SignupQuestion
• SignupQuestionFieldType
• Task
• Teacher
• TeacherEnrollment
• TeacherRole
• TeacherWithIncludes
• Thesis
• UpdateAccountRequest
• UpdateAffiliationByIdRequest
• UpdateCatalogProductByIdRequest
• UpdateCatalogProductByIdRequestCourseTabContentsAttributesInner
• UpdateCatalogVariantByIdRequest
• UpdateCategoryByIdRequest
• UpdateCommentByIdRequest
• UpdateCourseLocationByIdRequest
• UpdateEnrollmentByIdRequest
• UpdateGradeByIdRequest
• UpdateLabelByIdRequest
• UpdateMaterialByIdRequest
• UpdateMaterialGroupByIdRequest
• UpdateMeetingLocationByIdRequest
• UpdateProgramElementByIdRequest
• UpdateTaskByIdRequest
• UpdateTeacherEnrollmentByIdRequest
• UpdateUserByIdRequest
• UpdateWebhookByIdRequest
• UsaState
• User
• UserWithIncludes
• Variant
• VariantWithIncludes
• VariantableType
• Webhook
• WebhookEvent
• WebhookNotificationFailed
• WebhookNotificationWithIncludes
• WebhookNotificationWithIncludesSendAttemptsInner

Documentation For Authorization

Authentication schemes defined for the API:

Bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Bearer and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		eduframe.ContextAPIKeys,
		map[string]eduframe.APIKey{
			"Bearer": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author