courses

package
v4.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 24, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for courses API

func (*Client) GetCourse

func (a *Client) GetCourse(params *GetCourseParams, authInfo runtime.ClientAuthInfoWriter) (*GetCourseOK, error)

GetCourse Returns a specific course

func (*Client) GetCourses

func (a *Client) GetCourses(params *GetCoursesParams, authInfo runtime.ClientAuthInfoWriter) (*GetCoursesOK, error)

GetCourses Returns a list of courses

func (*Client) GetDistrictForCourse

func (a *Client) GetDistrictForCourse(params *GetDistrictForCourseParams, authInfo runtime.ClientAuthInfoWriter) (*GetDistrictForCourseOK, error)

GetDistrictForCourse Returns the district for a course

func (*Client) GetResourcesForCourse

func (a *Client) GetResourcesForCourse(params *GetResourcesForCourseParams, authInfo runtime.ClientAuthInfoWriter) (*GetResourcesForCourseOK, error)

GetResourcesForCourse Returns the resources for a course

func (*Client) GetSchoolsForCourse

func (a *Client) GetSchoolsForCourse(params *GetSchoolsForCourseParams, authInfo runtime.ClientAuthInfoWriter) (*GetSchoolsForCourseOK, error)

GetSchoolsForCourse Returns the schools for a course

func (*Client) GetSectionsForCourse

func (a *Client) GetSectionsForCourse(params *GetSectionsForCourseParams, authInfo runtime.ClientAuthInfoWriter) (*GetSectionsForCourseOK, error)

GetSectionsForCourse Returns the sections for a course

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientService

type ClientService interface {
	GetCourse(params *GetCourseParams, authInfo runtime.ClientAuthInfoWriter) (*GetCourseOK, error)

	GetCourses(params *GetCoursesParams, authInfo runtime.ClientAuthInfoWriter) (*GetCoursesOK, error)

	GetDistrictForCourse(params *GetDistrictForCourseParams, authInfo runtime.ClientAuthInfoWriter) (*GetDistrictForCourseOK, error)

	GetResourcesForCourse(params *GetResourcesForCourseParams, authInfo runtime.ClientAuthInfoWriter) (*GetResourcesForCourseOK, error)

	GetSchoolsForCourse(params *GetSchoolsForCourseParams, authInfo runtime.ClientAuthInfoWriter) (*GetSchoolsForCourseOK, error)

	GetSectionsForCourse(params *GetSectionsForCourseParams, authInfo runtime.ClientAuthInfoWriter) (*GetSectionsForCourseOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new courses API client.

type GetCourseNotFound

type GetCourseNotFound struct {
	Payload *models.NotFound
}
GetCourseNotFound describes a response with status code 404, with default header values.

Entity Not Found

func NewGetCourseNotFound

func NewGetCourseNotFound() *GetCourseNotFound

NewGetCourseNotFound creates a GetCourseNotFound with default headers values

func (*GetCourseNotFound) Error

func (o *GetCourseNotFound) Error() string

func (*GetCourseNotFound) GetPayload

func (o *GetCourseNotFound) GetPayload() *models.NotFound

type GetCourseOK

type GetCourseOK struct {
	Payload *models.CourseResponse
}
GetCourseOK describes a response with status code 200, with default header values.

OK Response

func NewGetCourseOK

func NewGetCourseOK() *GetCourseOK

NewGetCourseOK creates a GetCourseOK with default headers values

func (*GetCourseOK) Error

func (o *GetCourseOK) Error() string

func (*GetCourseOK) GetPayload

func (o *GetCourseOK) GetPayload() *models.CourseResponse

type GetCourseParams

type GetCourseParams struct {

	// ID.
	ID string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetCourseParams contains all the parameters to send to the API endpoint

for the get course operation.

Typically these are written to a http.Request.

func NewGetCourseParams

func NewGetCourseParams() *GetCourseParams

NewGetCourseParams creates a new GetCourseParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetCourseParamsWithContext

func NewGetCourseParamsWithContext(ctx context.Context) *GetCourseParams

NewGetCourseParamsWithContext creates a new GetCourseParams object with the ability to set a context for a request.

func NewGetCourseParamsWithHTTPClient

func NewGetCourseParamsWithHTTPClient(client *http.Client) *GetCourseParams

NewGetCourseParamsWithHTTPClient creates a new GetCourseParams object with the ability to set a custom HTTPClient for a request.

func NewGetCourseParamsWithTimeout

func NewGetCourseParamsWithTimeout(timeout time.Duration) *GetCourseParams

NewGetCourseParamsWithTimeout creates a new GetCourseParams object with the ability to set a timeout on a request.

func (*GetCourseParams) SetContext

func (o *GetCourseParams) SetContext(ctx context.Context)

SetContext adds the context to the get course params

func (*GetCourseParams) SetDefaults

func (o *GetCourseParams) SetDefaults()

SetDefaults hydrates default values in the get course params (not the query body).

All values with no default are reset to their zero value.

func (*GetCourseParams) SetHTTPClient

func (o *GetCourseParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get course params

func (*GetCourseParams) SetID

func (o *GetCourseParams) SetID(id string)

SetID adds the id to the get course params

func (*GetCourseParams) SetTimeout

func (o *GetCourseParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get course params

func (*GetCourseParams) WithContext

func (o *GetCourseParams) WithContext(ctx context.Context) *GetCourseParams

WithContext adds the context to the get course params

func (*GetCourseParams) WithDefaults

func (o *GetCourseParams) WithDefaults() *GetCourseParams

WithDefaults hydrates default values in the get course params (not the query body).

All values with no default are reset to their zero value.

func (*GetCourseParams) WithHTTPClient

func (o *GetCourseParams) WithHTTPClient(client *http.Client) *GetCourseParams

WithHTTPClient adds the HTTPClient to the get course params

func (*GetCourseParams) WithID

func (o *GetCourseParams) WithID(id string) *GetCourseParams

WithID adds the id to the get course params

func (*GetCourseParams) WithTimeout

func (o *GetCourseParams) WithTimeout(timeout time.Duration) *GetCourseParams

WithTimeout adds the timeout to the get course params

func (*GetCourseParams) WriteToRequest

func (o *GetCourseParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetCourseReader

type GetCourseReader struct {
	// contains filtered or unexported fields
}

GetCourseReader is a Reader for the GetCourse structure.

func (*GetCourseReader) ReadResponse

func (o *GetCourseReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetCoursesOK

type GetCoursesOK struct {
	Payload *models.CoursesResponse
}
GetCoursesOK describes a response with status code 200, with default header values.

OK Response

func NewGetCoursesOK

func NewGetCoursesOK() *GetCoursesOK

NewGetCoursesOK creates a GetCoursesOK with default headers values

func (*GetCoursesOK) Error

func (o *GetCoursesOK) Error() string

func (*GetCoursesOK) GetPayload

func (o *GetCoursesOK) GetPayload() *models.CoursesResponse

type GetCoursesParams

type GetCoursesParams struct {

	// Count.
	Count *string

	// EndingBefore.
	EndingBefore *string

	// Limit.
	Limit *int64

	// StartingAfter.
	StartingAfter *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetCoursesParams contains all the parameters to send to the API endpoint

for the get courses operation.

Typically these are written to a http.Request.

func NewGetCoursesParams

func NewGetCoursesParams() *GetCoursesParams

NewGetCoursesParams creates a new GetCoursesParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetCoursesParamsWithContext

func NewGetCoursesParamsWithContext(ctx context.Context) *GetCoursesParams

NewGetCoursesParamsWithContext creates a new GetCoursesParams object with the ability to set a context for a request.

func NewGetCoursesParamsWithHTTPClient

func NewGetCoursesParamsWithHTTPClient(client *http.Client) *GetCoursesParams

NewGetCoursesParamsWithHTTPClient creates a new GetCoursesParams object with the ability to set a custom HTTPClient for a request.

func NewGetCoursesParamsWithTimeout

func NewGetCoursesParamsWithTimeout(timeout time.Duration) *GetCoursesParams

NewGetCoursesParamsWithTimeout creates a new GetCoursesParams object with the ability to set a timeout on a request.

func (*GetCoursesParams) SetContext

func (o *GetCoursesParams) SetContext(ctx context.Context)

SetContext adds the context to the get courses params

func (*GetCoursesParams) SetCount

func (o *GetCoursesParams) SetCount(count *string)

SetCount adds the count to the get courses params

func (*GetCoursesParams) SetDefaults

func (o *GetCoursesParams) SetDefaults()

SetDefaults hydrates default values in the get courses params (not the query body).

All values with no default are reset to their zero value.

func (*GetCoursesParams) SetEndingBefore

func (o *GetCoursesParams) SetEndingBefore(endingBefore *string)

SetEndingBefore adds the endingBefore to the get courses params

func (*GetCoursesParams) SetHTTPClient

func (o *GetCoursesParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get courses params

func (*GetCoursesParams) SetLimit

func (o *GetCoursesParams) SetLimit(limit *int64)

SetLimit adds the limit to the get courses params

func (*GetCoursesParams) SetStartingAfter

func (o *GetCoursesParams) SetStartingAfter(startingAfter *string)

SetStartingAfter adds the startingAfter to the get courses params

func (*GetCoursesParams) SetTimeout

func (o *GetCoursesParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get courses params

func (*GetCoursesParams) WithContext

func (o *GetCoursesParams) WithContext(ctx context.Context) *GetCoursesParams

WithContext adds the context to the get courses params

func (*GetCoursesParams) WithCount

func (o *GetCoursesParams) WithCount(count *string) *GetCoursesParams

WithCount adds the count to the get courses params

func (*GetCoursesParams) WithDefaults

func (o *GetCoursesParams) WithDefaults() *GetCoursesParams

WithDefaults hydrates default values in the get courses params (not the query body).

All values with no default are reset to their zero value.

func (*GetCoursesParams) WithEndingBefore

func (o *GetCoursesParams) WithEndingBefore(endingBefore *string) *GetCoursesParams

WithEndingBefore adds the endingBefore to the get courses params

func (*GetCoursesParams) WithHTTPClient

func (o *GetCoursesParams) WithHTTPClient(client *http.Client) *GetCoursesParams

WithHTTPClient adds the HTTPClient to the get courses params

func (*GetCoursesParams) WithLimit

func (o *GetCoursesParams) WithLimit(limit *int64) *GetCoursesParams

WithLimit adds the limit to the get courses params

func (*GetCoursesParams) WithStartingAfter

func (o *GetCoursesParams) WithStartingAfter(startingAfter *string) *GetCoursesParams

WithStartingAfter adds the startingAfter to the get courses params

func (*GetCoursesParams) WithTimeout

func (o *GetCoursesParams) WithTimeout(timeout time.Duration) *GetCoursesParams

WithTimeout adds the timeout to the get courses params

func (*GetCoursesParams) WriteToRequest

func (o *GetCoursesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetCoursesReader

type GetCoursesReader struct {
	// contains filtered or unexported fields
}

GetCoursesReader is a Reader for the GetCourses structure.

func (*GetCoursesReader) ReadResponse

func (o *GetCoursesReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetDistrictForCourseNotFound

type GetDistrictForCourseNotFound struct {
	Payload *models.NotFound
}
GetDistrictForCourseNotFound describes a response with status code 404, with default header values.

Entity Not Found

func NewGetDistrictForCourseNotFound

func NewGetDistrictForCourseNotFound() *GetDistrictForCourseNotFound

NewGetDistrictForCourseNotFound creates a GetDistrictForCourseNotFound with default headers values

func (*GetDistrictForCourseNotFound) Error

func (*GetDistrictForCourseNotFound) GetPayload

func (o *GetDistrictForCourseNotFound) GetPayload() *models.NotFound

type GetDistrictForCourseOK

type GetDistrictForCourseOK struct {
	Payload *models.DistrictResponse
}
GetDistrictForCourseOK describes a response with status code 200, with default header values.

OK Response

func NewGetDistrictForCourseOK

func NewGetDistrictForCourseOK() *GetDistrictForCourseOK

NewGetDistrictForCourseOK creates a GetDistrictForCourseOK with default headers values

func (*GetDistrictForCourseOK) Error

func (o *GetDistrictForCourseOK) Error() string

func (*GetDistrictForCourseOK) GetPayload

type GetDistrictForCourseParams

type GetDistrictForCourseParams struct {

	// ID.
	ID string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetDistrictForCourseParams contains all the parameters to send to the API endpoint

for the get district for course operation.

Typically these are written to a http.Request.

func NewGetDistrictForCourseParams

func NewGetDistrictForCourseParams() *GetDistrictForCourseParams

NewGetDistrictForCourseParams creates a new GetDistrictForCourseParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetDistrictForCourseParamsWithContext

func NewGetDistrictForCourseParamsWithContext(ctx context.Context) *GetDistrictForCourseParams

NewGetDistrictForCourseParamsWithContext creates a new GetDistrictForCourseParams object with the ability to set a context for a request.

func NewGetDistrictForCourseParamsWithHTTPClient

func NewGetDistrictForCourseParamsWithHTTPClient(client *http.Client) *GetDistrictForCourseParams

NewGetDistrictForCourseParamsWithHTTPClient creates a new GetDistrictForCourseParams object with the ability to set a custom HTTPClient for a request.

func NewGetDistrictForCourseParamsWithTimeout

func NewGetDistrictForCourseParamsWithTimeout(timeout time.Duration) *GetDistrictForCourseParams

NewGetDistrictForCourseParamsWithTimeout creates a new GetDistrictForCourseParams object with the ability to set a timeout on a request.

func (*GetDistrictForCourseParams) SetContext

func (o *GetDistrictForCourseParams) SetContext(ctx context.Context)

SetContext adds the context to the get district for course params

func (*GetDistrictForCourseParams) SetDefaults

func (o *GetDistrictForCourseParams) SetDefaults()

SetDefaults hydrates default values in the get district for course params (not the query body).

All values with no default are reset to their zero value.

func (*GetDistrictForCourseParams) SetHTTPClient

func (o *GetDistrictForCourseParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get district for course params

func (*GetDistrictForCourseParams) SetID

func (o *GetDistrictForCourseParams) SetID(id string)

SetID adds the id to the get district for course params

func (*GetDistrictForCourseParams) SetTimeout

func (o *GetDistrictForCourseParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get district for course params

func (*GetDistrictForCourseParams) WithContext

WithContext adds the context to the get district for course params

func (*GetDistrictForCourseParams) WithDefaults

WithDefaults hydrates default values in the get district for course params (not the query body).

All values with no default are reset to their zero value.

func (*GetDistrictForCourseParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the get district for course params

func (*GetDistrictForCourseParams) WithID

WithID adds the id to the get district for course params

func (*GetDistrictForCourseParams) WithTimeout

WithTimeout adds the timeout to the get district for course params

func (*GetDistrictForCourseParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetDistrictForCourseReader

type GetDistrictForCourseReader struct {
	// contains filtered or unexported fields
}

GetDistrictForCourseReader is a Reader for the GetDistrictForCourse structure.

func (*GetDistrictForCourseReader) ReadResponse

func (o *GetDistrictForCourseReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetResourcesForCourseNotFound

type GetResourcesForCourseNotFound struct {
	Payload *models.NotFound
}
GetResourcesForCourseNotFound describes a response with status code 404, with default header values.

Entity Not Found

func NewGetResourcesForCourseNotFound

func NewGetResourcesForCourseNotFound() *GetResourcesForCourseNotFound

NewGetResourcesForCourseNotFound creates a GetResourcesForCourseNotFound with default headers values

func (*GetResourcesForCourseNotFound) Error

func (*GetResourcesForCourseNotFound) GetPayload

type GetResourcesForCourseOK

type GetResourcesForCourseOK struct {
	Payload *models.ResourcesResponse
}
GetResourcesForCourseOK describes a response with status code 200, with default header values.

OK Response

func NewGetResourcesForCourseOK

func NewGetResourcesForCourseOK() *GetResourcesForCourseOK

NewGetResourcesForCourseOK creates a GetResourcesForCourseOK with default headers values

func (*GetResourcesForCourseOK) Error

func (o *GetResourcesForCourseOK) Error() string

func (*GetResourcesForCourseOK) GetPayload

type GetResourcesForCourseParams

type GetResourcesForCourseParams struct {

	// EndingBefore.
	EndingBefore *string

	// ID.
	ID string

	// Limit.
	Limit *int64

	// StartingAfter.
	StartingAfter *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetResourcesForCourseParams contains all the parameters to send to the API endpoint

for the get resources for course operation.

Typically these are written to a http.Request.

func NewGetResourcesForCourseParams

func NewGetResourcesForCourseParams() *GetResourcesForCourseParams

NewGetResourcesForCourseParams creates a new GetResourcesForCourseParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetResourcesForCourseParamsWithContext

func NewGetResourcesForCourseParamsWithContext(ctx context.Context) *GetResourcesForCourseParams

NewGetResourcesForCourseParamsWithContext creates a new GetResourcesForCourseParams object with the ability to set a context for a request.

func NewGetResourcesForCourseParamsWithHTTPClient

func NewGetResourcesForCourseParamsWithHTTPClient(client *http.Client) *GetResourcesForCourseParams

NewGetResourcesForCourseParamsWithHTTPClient creates a new GetResourcesForCourseParams object with the ability to set a custom HTTPClient for a request.

func NewGetResourcesForCourseParamsWithTimeout

func NewGetResourcesForCourseParamsWithTimeout(timeout time.Duration) *GetResourcesForCourseParams

NewGetResourcesForCourseParamsWithTimeout creates a new GetResourcesForCourseParams object with the ability to set a timeout on a request.

func (*GetResourcesForCourseParams) SetContext

func (o *GetResourcesForCourseParams) SetContext(ctx context.Context)

SetContext adds the context to the get resources for course params

func (*GetResourcesForCourseParams) SetDefaults

func (o *GetResourcesForCourseParams) SetDefaults()

SetDefaults hydrates default values in the get resources for course params (not the query body).

All values with no default are reset to their zero value.

func (*GetResourcesForCourseParams) SetEndingBefore

func (o *GetResourcesForCourseParams) SetEndingBefore(endingBefore *string)

SetEndingBefore adds the endingBefore to the get resources for course params

func (*GetResourcesForCourseParams) SetHTTPClient

func (o *GetResourcesForCourseParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get resources for course params

func (*GetResourcesForCourseParams) SetID

func (o *GetResourcesForCourseParams) SetID(id string)

SetID adds the id to the get resources for course params

func (*GetResourcesForCourseParams) SetLimit

func (o *GetResourcesForCourseParams) SetLimit(limit *int64)

SetLimit adds the limit to the get resources for course params

func (*GetResourcesForCourseParams) SetStartingAfter

func (o *GetResourcesForCourseParams) SetStartingAfter(startingAfter *string)

SetStartingAfter adds the startingAfter to the get resources for course params

func (*GetResourcesForCourseParams) SetTimeout

func (o *GetResourcesForCourseParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get resources for course params

func (*GetResourcesForCourseParams) WithContext

WithContext adds the context to the get resources for course params

func (*GetResourcesForCourseParams) WithDefaults

WithDefaults hydrates default values in the get resources for course params (not the query body).

All values with no default are reset to their zero value.

func (*GetResourcesForCourseParams) WithEndingBefore

func (o *GetResourcesForCourseParams) WithEndingBefore(endingBefore *string) *GetResourcesForCourseParams

WithEndingBefore adds the endingBefore to the get resources for course params

func (*GetResourcesForCourseParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the get resources for course params

func (*GetResourcesForCourseParams) WithID

WithID adds the id to the get resources for course params

func (*GetResourcesForCourseParams) WithLimit

WithLimit adds the limit to the get resources for course params

func (*GetResourcesForCourseParams) WithStartingAfter

func (o *GetResourcesForCourseParams) WithStartingAfter(startingAfter *string) *GetResourcesForCourseParams

WithStartingAfter adds the startingAfter to the get resources for course params

func (*GetResourcesForCourseParams) WithTimeout

WithTimeout adds the timeout to the get resources for course params

func (*GetResourcesForCourseParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetResourcesForCourseReader

type GetResourcesForCourseReader struct {
	// contains filtered or unexported fields
}

GetResourcesForCourseReader is a Reader for the GetResourcesForCourse structure.

func (*GetResourcesForCourseReader) ReadResponse

func (o *GetResourcesForCourseReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetSchoolsForCourseNotFound

type GetSchoolsForCourseNotFound struct {
	Payload *models.NotFound
}
GetSchoolsForCourseNotFound describes a response with status code 404, with default header values.

Entity Not Found

func NewGetSchoolsForCourseNotFound

func NewGetSchoolsForCourseNotFound() *GetSchoolsForCourseNotFound

NewGetSchoolsForCourseNotFound creates a GetSchoolsForCourseNotFound with default headers values

func (*GetSchoolsForCourseNotFound) Error

func (*GetSchoolsForCourseNotFound) GetPayload

func (o *GetSchoolsForCourseNotFound) GetPayload() *models.NotFound

type GetSchoolsForCourseOK

type GetSchoolsForCourseOK struct {
	Payload *models.SchoolsResponse
}
GetSchoolsForCourseOK describes a response with status code 200, with default header values.

OK Response

func NewGetSchoolsForCourseOK

func NewGetSchoolsForCourseOK() *GetSchoolsForCourseOK

NewGetSchoolsForCourseOK creates a GetSchoolsForCourseOK with default headers values

func (*GetSchoolsForCourseOK) Error

func (o *GetSchoolsForCourseOK) Error() string

func (*GetSchoolsForCourseOK) GetPayload

func (o *GetSchoolsForCourseOK) GetPayload() *models.SchoolsResponse

type GetSchoolsForCourseParams

type GetSchoolsForCourseParams struct {

	// EndingBefore.
	EndingBefore *string

	// ID.
	ID string

	// Limit.
	Limit *int64

	// StartingAfter.
	StartingAfter *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetSchoolsForCourseParams contains all the parameters to send to the API endpoint

for the get schools for course operation.

Typically these are written to a http.Request.

func NewGetSchoolsForCourseParams

func NewGetSchoolsForCourseParams() *GetSchoolsForCourseParams

NewGetSchoolsForCourseParams creates a new GetSchoolsForCourseParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetSchoolsForCourseParamsWithContext

func NewGetSchoolsForCourseParamsWithContext(ctx context.Context) *GetSchoolsForCourseParams

NewGetSchoolsForCourseParamsWithContext creates a new GetSchoolsForCourseParams object with the ability to set a context for a request.

func NewGetSchoolsForCourseParamsWithHTTPClient

func NewGetSchoolsForCourseParamsWithHTTPClient(client *http.Client) *GetSchoolsForCourseParams

NewGetSchoolsForCourseParamsWithHTTPClient creates a new GetSchoolsForCourseParams object with the ability to set a custom HTTPClient for a request.

func NewGetSchoolsForCourseParamsWithTimeout

func NewGetSchoolsForCourseParamsWithTimeout(timeout time.Duration) *GetSchoolsForCourseParams

NewGetSchoolsForCourseParamsWithTimeout creates a new GetSchoolsForCourseParams object with the ability to set a timeout on a request.

func (*GetSchoolsForCourseParams) SetContext

func (o *GetSchoolsForCourseParams) SetContext(ctx context.Context)

SetContext adds the context to the get schools for course params

func (*GetSchoolsForCourseParams) SetDefaults

func (o *GetSchoolsForCourseParams) SetDefaults()

SetDefaults hydrates default values in the get schools for course params (not the query body).

All values with no default are reset to their zero value.

func (*GetSchoolsForCourseParams) SetEndingBefore

func (o *GetSchoolsForCourseParams) SetEndingBefore(endingBefore *string)

SetEndingBefore adds the endingBefore to the get schools for course params

func (*GetSchoolsForCourseParams) SetHTTPClient

func (o *GetSchoolsForCourseParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get schools for course params

func (*GetSchoolsForCourseParams) SetID

func (o *GetSchoolsForCourseParams) SetID(id string)

SetID adds the id to the get schools for course params

func (*GetSchoolsForCourseParams) SetLimit

func (o *GetSchoolsForCourseParams) SetLimit(limit *int64)

SetLimit adds the limit to the get schools for course params

func (*GetSchoolsForCourseParams) SetStartingAfter

func (o *GetSchoolsForCourseParams) SetStartingAfter(startingAfter *string)

SetStartingAfter adds the startingAfter to the get schools for course params

func (*GetSchoolsForCourseParams) SetTimeout

func (o *GetSchoolsForCourseParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get schools for course params

func (*GetSchoolsForCourseParams) WithContext

WithContext adds the context to the get schools for course params

func (*GetSchoolsForCourseParams) WithDefaults

WithDefaults hydrates default values in the get schools for course params (not the query body).

All values with no default are reset to their zero value.

func (*GetSchoolsForCourseParams) WithEndingBefore

func (o *GetSchoolsForCourseParams) WithEndingBefore(endingBefore *string) *GetSchoolsForCourseParams

WithEndingBefore adds the endingBefore to the get schools for course params

func (*GetSchoolsForCourseParams) WithHTTPClient

func (o *GetSchoolsForCourseParams) WithHTTPClient(client *http.Client) *GetSchoolsForCourseParams

WithHTTPClient adds the HTTPClient to the get schools for course params

func (*GetSchoolsForCourseParams) WithID

WithID adds the id to the get schools for course params

func (*GetSchoolsForCourseParams) WithLimit

WithLimit adds the limit to the get schools for course params

func (*GetSchoolsForCourseParams) WithStartingAfter

func (o *GetSchoolsForCourseParams) WithStartingAfter(startingAfter *string) *GetSchoolsForCourseParams

WithStartingAfter adds the startingAfter to the get schools for course params

func (*GetSchoolsForCourseParams) WithTimeout

WithTimeout adds the timeout to the get schools for course params

func (*GetSchoolsForCourseParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetSchoolsForCourseReader

type GetSchoolsForCourseReader struct {
	// contains filtered or unexported fields
}

GetSchoolsForCourseReader is a Reader for the GetSchoolsForCourse structure.

func (*GetSchoolsForCourseReader) ReadResponse

func (o *GetSchoolsForCourseReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetSectionsForCourseNotFound

type GetSectionsForCourseNotFound struct {
	Payload *models.NotFound
}
GetSectionsForCourseNotFound describes a response with status code 404, with default header values.

Entity Not Found

func NewGetSectionsForCourseNotFound

func NewGetSectionsForCourseNotFound() *GetSectionsForCourseNotFound

NewGetSectionsForCourseNotFound creates a GetSectionsForCourseNotFound with default headers values

func (*GetSectionsForCourseNotFound) Error

func (*GetSectionsForCourseNotFound) GetPayload

func (o *GetSectionsForCourseNotFound) GetPayload() *models.NotFound

type GetSectionsForCourseOK

type GetSectionsForCourseOK struct {
	Payload *models.SectionsResponse
}
GetSectionsForCourseOK describes a response with status code 200, with default header values.

OK Response

func NewGetSectionsForCourseOK

func NewGetSectionsForCourseOK() *GetSectionsForCourseOK

NewGetSectionsForCourseOK creates a GetSectionsForCourseOK with default headers values

func (*GetSectionsForCourseOK) Error

func (o *GetSectionsForCourseOK) Error() string

func (*GetSectionsForCourseOK) GetPayload

type GetSectionsForCourseParams

type GetSectionsForCourseParams struct {

	// EndingBefore.
	EndingBefore *string

	// ID.
	ID string

	// Limit.
	Limit *int64

	// StartingAfter.
	StartingAfter *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetSectionsForCourseParams contains all the parameters to send to the API endpoint

for the get sections for course operation.

Typically these are written to a http.Request.

func NewGetSectionsForCourseParams

func NewGetSectionsForCourseParams() *GetSectionsForCourseParams

NewGetSectionsForCourseParams creates a new GetSectionsForCourseParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetSectionsForCourseParamsWithContext

func NewGetSectionsForCourseParamsWithContext(ctx context.Context) *GetSectionsForCourseParams

NewGetSectionsForCourseParamsWithContext creates a new GetSectionsForCourseParams object with the ability to set a context for a request.

func NewGetSectionsForCourseParamsWithHTTPClient

func NewGetSectionsForCourseParamsWithHTTPClient(client *http.Client) *GetSectionsForCourseParams

NewGetSectionsForCourseParamsWithHTTPClient creates a new GetSectionsForCourseParams object with the ability to set a custom HTTPClient for a request.

func NewGetSectionsForCourseParamsWithTimeout

func NewGetSectionsForCourseParamsWithTimeout(timeout time.Duration) *GetSectionsForCourseParams

NewGetSectionsForCourseParamsWithTimeout creates a new GetSectionsForCourseParams object with the ability to set a timeout on a request.

func (*GetSectionsForCourseParams) SetContext

func (o *GetSectionsForCourseParams) SetContext(ctx context.Context)

SetContext adds the context to the get sections for course params

func (*GetSectionsForCourseParams) SetDefaults

func (o *GetSectionsForCourseParams) SetDefaults()

SetDefaults hydrates default values in the get sections for course params (not the query body).

All values with no default are reset to their zero value.

func (*GetSectionsForCourseParams) SetEndingBefore

func (o *GetSectionsForCourseParams) SetEndingBefore(endingBefore *string)

SetEndingBefore adds the endingBefore to the get sections for course params

func (*GetSectionsForCourseParams) SetHTTPClient

func (o *GetSectionsForCourseParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get sections for course params

func (*GetSectionsForCourseParams) SetID

func (o *GetSectionsForCourseParams) SetID(id string)

SetID adds the id to the get sections for course params

func (*GetSectionsForCourseParams) SetLimit

func (o *GetSectionsForCourseParams) SetLimit(limit *int64)

SetLimit adds the limit to the get sections for course params

func (*GetSectionsForCourseParams) SetStartingAfter

func (o *GetSectionsForCourseParams) SetStartingAfter(startingAfter *string)

SetStartingAfter adds the startingAfter to the get sections for course params

func (*GetSectionsForCourseParams) SetTimeout

func (o *GetSectionsForCourseParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get sections for course params

func (*GetSectionsForCourseParams) WithContext

WithContext adds the context to the get sections for course params

func (*GetSectionsForCourseParams) WithDefaults

WithDefaults hydrates default values in the get sections for course params (not the query body).

All values with no default are reset to their zero value.

func (*GetSectionsForCourseParams) WithEndingBefore

func (o *GetSectionsForCourseParams) WithEndingBefore(endingBefore *string) *GetSectionsForCourseParams

WithEndingBefore adds the endingBefore to the get sections for course params

func (*GetSectionsForCourseParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the get sections for course params

func (*GetSectionsForCourseParams) WithID

WithID adds the id to the get sections for course params

func (*GetSectionsForCourseParams) WithLimit

WithLimit adds the limit to the get sections for course params

func (*GetSectionsForCourseParams) WithStartingAfter

func (o *GetSectionsForCourseParams) WithStartingAfter(startingAfter *string) *GetSectionsForCourseParams

WithStartingAfter adds the startingAfter to the get sections for course params

func (*GetSectionsForCourseParams) WithTimeout

WithTimeout adds the timeout to the get sections for course params

func (*GetSectionsForCourseParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetSectionsForCourseReader

type GetSectionsForCourseReader struct {
	// contains filtered or unexported fields
}

GetSectionsForCourseReader is a Reader for the GetSectionsForCourse structure.

func (*GetSectionsForCourseReader) ReadResponse

func (o *GetSectionsForCourseReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL