sdk

package
v0.1.2 Latest Latest
Warning

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

Go to latest
Published: Nov 15, 2026 License: AGPL-3.0 Imports: 10 Imported by: 0

Documentation

Overview

Package sdk provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewApplyDecisionRequest

func NewApplyDecisionRequest(server string, id string, params *ApplyDecisionParams, body ApplyDecisionJSONRequestBody) (*http.Request, error)

NewApplyDecisionRequest calls the generic ApplyDecision builder with application/json body

func NewApplyDecisionRequestWithBody

func NewApplyDecisionRequestWithBody(server string, id string, params *ApplyDecisionParams, contentType string, body io.Reader) (*http.Request, error)

NewApplyDecisionRequestWithBody constructs an http.Request for the ApplyDecision method, with any body, and a specified content type

func NewAttachFileRequest

func NewAttachFileRequest(server string, id string, params *AttachFileParams, body AttachFileJSONRequestBody) (*http.Request, error)

NewAttachFileRequest calls the generic AttachFile builder with application/json body

func NewAttachFileRequestWithBody

func NewAttachFileRequestWithBody(server string, id string, params *AttachFileParams, contentType string, body io.Reader) (*http.Request, error)

NewAttachFileRequestWithBody constructs an http.Request for the AttachFile method, with any body, and a specified content type

func NewChangeStateRequest

func NewChangeStateRequest(server string, id string, params *ChangeStateParams, body ChangeStateJSONRequestBody) (*http.Request, error)

NewChangeStateRequest calls the generic ChangeState builder with application/json body

func NewChangeStateRequestWithBody

func NewChangeStateRequestWithBody(server string, id string, params *ChangeStateParams, contentType string, body io.Reader) (*http.Request, error)

NewChangeStateRequestWithBody constructs an http.Request for the ChangeState method, with any body, and a specified content type

func NewCreateDraftRequest

func NewCreateDraftRequest(server string, params *CreateDraftParams, body CreateDraftJSONRequestBody) (*http.Request, error)

NewCreateDraftRequest calls the generic CreateDraft builder with application/json body

func NewCreateDraftRequestWithBody

func NewCreateDraftRequestWithBody(server string, params *CreateDraftParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateDraftRequestWithBody constructs an http.Request for the CreateDraft method, with any body, and a specified content type

func NewCreatePackageRequest

func NewCreatePackageRequest(server string, params *CreatePackageParams, body CreatePackageJSONRequestBody) (*http.Request, error)

NewCreatePackageRequest calls the generic CreatePackage builder with application/json body

func NewCreatePackageRequestWithBody

func NewCreatePackageRequestWithBody(server string, params *CreatePackageParams, contentType string, body io.Reader) (*http.Request, error)

NewCreatePackageRequestWithBody constructs an http.Request for the CreatePackage method, with any body, and a specified content type

func NewCreateRequestRequest

func NewCreateRequestRequest(server string, id string, params *CreateRequestParams, body CreateRequestJSONRequestBody) (*http.Request, error)

NewCreateRequestRequest calls the generic CreateRequest builder with application/json body

func NewCreateRequestRequestWithBody

func NewCreateRequestRequestWithBody(server string, id string, params *CreateRequestParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateRequestRequestWithBody constructs an http.Request for the CreateRequest method, with any body, and a specified content type

func NewDownloadPackagePartRequest

func NewDownloadPackagePartRequest(server string, id string, part string) (*http.Request, error)

NewDownloadPackagePartRequest constructs an http.Request for the DownloadPackagePart method

func NewDownloadResourceRequest

func NewDownloadResourceRequest(server string, id string) (*http.Request, error)

NewDownloadResourceRequest constructs an http.Request for the DownloadResource method

func NewDownloadReviewFileRequest

func NewDownloadReviewFileRequest(server string, version string) (*http.Request, error)

NewDownloadReviewFileRequest constructs an http.Request for the DownloadReviewFile method

func NewGetCapabilitiesRequest

func NewGetCapabilitiesRequest(server string) (*http.Request, error)

NewGetCapabilitiesRequest constructs an http.Request for the GetCapabilities method

func NewGetCoverageRequest

func NewGetCoverageRequest(server string, id string) (*http.Request, error)

NewGetCoverageRequest constructs an http.Request for the GetCoverage method

func NewGetOwnResourceSummaryRequest added in v0.1.1

func NewGetOwnResourceSummaryRequest(server string) (*http.Request, error)

NewGetOwnResourceSummaryRequest constructs an http.Request for the GetOwnResourceSummary method

func NewGetPackageRequest

func NewGetPackageRequest(server string, id string) (*http.Request, error)

NewGetPackageRequest constructs an http.Request for the GetPackage method

func NewGetResourceCountsRequest added in v0.1.1

func NewGetResourceCountsRequest(server string, params *GetResourceCountsParams) (*http.Request, error)

NewGetResourceCountsRequest constructs an http.Request for the GetResourceCounts method

func NewGetResourceRequest

func NewGetResourceRequest(server string, id string) (*http.Request, error)

NewGetResourceRequest constructs an http.Request for the GetResource method

func NewGetResourceRequestRequest

func NewGetResourceRequestRequest(server string, id string) (*http.Request, error)

NewGetResourceRequestRequest constructs an http.Request for the GetResourceRequest method

func NewListCategoriesRequest

func NewListCategoriesRequest(server string, params *ListCategoriesParams) (*http.Request, error)

NewListCategoriesRequest constructs an http.Request for the ListCategories method

func NewListDirectoriesRequest

func NewListDirectoriesRequest(server string, params *ListDirectoriesParams) (*http.Request, error)

NewListDirectoriesRequest constructs an http.Request for the ListDirectories method

func NewListGrantsRequest

func NewListGrantsRequest(server string, id string, params *ListGrantsParams) (*http.Request, error)

NewListGrantsRequest constructs an http.Request for the ListGrants method

func NewListManagedResourcesRequest

func NewListManagedResourcesRequest(server string, params *ListManagedResourcesParams) (*http.Request, error)

NewListManagedResourcesRequest constructs an http.Request for the ListManagedResources method

func NewListOwnResourcesRequest

func NewListOwnResourcesRequest(server string, params *ListOwnResourcesParams) (*http.Request, error)

NewListOwnResourcesRequest constructs an http.Request for the ListOwnResources method

func NewListRequestsRequest

func NewListRequestsRequest(server string, params *ListRequestsParams) (*http.Request, error)

NewListRequestsRequest constructs an http.Request for the ListRequests method

func NewListResourcesRequest

func NewListResourcesRequest(server string, params *ListResourcesParams) (*http.Request, error)

NewListResourcesRequest constructs an http.Request for the ListResources method

func NewMyResourcesReferencesRequest

func NewMyResourcesReferencesRequest(server string, params *MyResourcesReferencesParams) (*http.Request, error)

NewMyResourcesReferencesRequest constructs an http.Request for the MyResourcesReferences method

func NewPreviewResourceRequest

func NewPreviewResourceRequest(server string, id string) (*http.Request, error)

NewPreviewResourceRequest constructs an http.Request for the PreviewResource method

func NewPutCategoryRequest

func NewPutCategoryRequest(server string, id string, params *PutCategoryParams, body PutCategoryJSONRequestBody) (*http.Request, error)

NewPutCategoryRequest calls the generic PutCategory builder with application/json body

func NewPutCategoryRequestWithBody

func NewPutCategoryRequestWithBody(server string, id string, params *PutCategoryParams, contentType string, body io.Reader) (*http.Request, error)

NewPutCategoryRequestWithBody constructs an http.Request for the PutCategory method, with any body, and a specified content type

func NewPutCoverageRequest

func NewPutCoverageRequest(server string, id string, params *PutCoverageParams, body PutCoverageJSONRequestBody) (*http.Request, error)

NewPutCoverageRequest calls the generic PutCoverage builder with application/json body

func NewPutCoverageRequestWithBody

func NewPutCoverageRequestWithBody(server string, id string, params *PutCoverageParams, contentType string, body io.Reader) (*http.Request, error)

NewPutCoverageRequestWithBody constructs an http.Request for the PutCoverage method, with any body, and a specified content type

func NewPutDirectoryRequest

func NewPutDirectoryRequest(server string, id string, params *PutDirectoryParams, body PutDirectoryJSONRequestBody) (*http.Request, error)

NewPutDirectoryRequest calls the generic PutDirectory builder with application/json body

func NewPutDirectoryRequestWithBody

func NewPutDirectoryRequestWithBody(server string, id string, params *PutDirectoryParams, contentType string, body io.Reader) (*http.Request, error)

NewPutDirectoryRequestWithBody constructs an http.Request for the PutDirectory method, with any body, and a specified content type

func NewPutGrantRequest

func NewPutGrantRequest(server string, id string, grant string, params *PutGrantParams, body PutGrantJSONRequestBody) (*http.Request, error)

NewPutGrantRequest calls the generic PutGrant builder with application/json body

func NewPutGrantRequestWithBody

func NewPutGrantRequestWithBody(server string, id string, grant string, params *PutGrantParams, contentType string, body io.Reader) (*http.Request, error)

NewPutGrantRequestWithBody constructs an http.Request for the PutGrant method, with any body, and a specified content type

func NewRetryPendingRequest

func NewRetryPendingRequest(server string, id string, params *RetryPendingParams, body RetryPendingJSONRequestBody) (*http.Request, error)

NewRetryPendingRequest calls the generic RetryPending builder with application/json body

func NewRetryPendingRequestWithBody

func NewRetryPendingRequestWithBody(server string, id string, params *RetryPendingParams, contentType string, body io.Reader) (*http.Request, error)

NewRetryPendingRequestWithBody constructs an http.Request for the RetryPending method, with any body, and a specified content type

func NewRetryResourceRequestRequest

func NewRetryResourceRequestRequest(server string, id string, params *RetryResourceRequestParams, body RetryResourceRequestJSONRequestBody) (*http.Request, error)

NewRetryResourceRequestRequest calls the generic RetryResourceRequest builder with application/json body

func NewRetryResourceRequestRequestWithBody

func NewRetryResourceRequestRequestWithBody(server string, id string, params *RetryResourceRequestParams, contentType string, body io.Reader) (*http.Request, error)

NewRetryResourceRequestRequestWithBody constructs an http.Request for the RetryResourceRequest method, with any body, and a specified content type

func NewReviewResourceRequest

func NewReviewResourceRequest(server string, version string) (*http.Request, error)

NewReviewResourceRequest constructs an http.Request for the ReviewResource method

func NewSubmitResourceRequest

func NewSubmitResourceRequest(server string, id string, params *SubmitResourceParams, body SubmitResourceJSONRequestBody) (*http.Request, error)

NewSubmitResourceRequest calls the generic SubmitResource builder with application/json body

func NewSubmitResourceRequestWithBody

func NewSubmitResourceRequestWithBody(server string, id string, params *SubmitResourceParams, contentType string, body io.Reader) (*http.Request, error)

NewSubmitResourceRequestWithBody constructs an http.Request for the SubmitResource method, with any body, and a specified content type

func NewUpdateDraftRequest

func NewUpdateDraftRequest(server string, id string, params *UpdateDraftParams, body UpdateDraftJSONRequestBody) (*http.Request, error)

NewUpdateDraftRequest calls the generic UpdateDraft builder with application/json body

func NewUpdateDraftRequestWithBody

func NewUpdateDraftRequestWithBody(server string, id string, params *UpdateDraftParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateDraftRequestWithBody constructs an http.Request for the UpdateDraft method, with any body, and a specified content type

Types

type ApplyDecisionJSONRequestBody

type ApplyDecisionJSONRequestBody = Decision

ApplyDecisionJSONRequestBody defines body for ApplyDecision for application/json ContentType.

type ApplyDecisionParams

type ApplyDecisionParams struct {
	IdempotencyKey string `json:"Idempotency-Key"`
}

ApplyDecisionParams defines parameters for ApplyDecision.

type ApplyDecisionResponse

type ApplyDecisionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *Resource
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseApplyDecisionResponse

func ParseApplyDecisionResponse(rsp *http.Response) (*ApplyDecisionResponse, error)

ParseApplyDecisionResponse parses an HTTP response from a ApplyDecisionWithResponse call

func (ApplyDecisionResponse) ContentType

func (r ApplyDecisionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ApplyDecisionResponse) GetBody

func (r ApplyDecisionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ApplyDecisionResponse) GetJSON202

func (r ApplyDecisionResponse) GetJSON202() *Resource

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (ApplyDecisionResponse) GetJSON400

func (r ApplyDecisionResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ApplyDecisionResponse) GetJSON401

func (r ApplyDecisionResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ApplyDecisionResponse) GetJSON403

func (r ApplyDecisionResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ApplyDecisionResponse) GetJSON404

func (r ApplyDecisionResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ApplyDecisionResponse) GetJSON409

func (r ApplyDecisionResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (ApplyDecisionResponse) GetJSON413

func (r ApplyDecisionResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (ApplyDecisionResponse) GetJSON503

func (r ApplyDecisionResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (ApplyDecisionResponse) Status

func (r ApplyDecisionResponse) Status() string

Status returns HTTPResponse.Status

func (ApplyDecisionResponse) StatusCode

func (r ApplyDecisionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Associations

type Associations struct {
	CourseId   *string `json:"course_id,omitempty"`
	OfferingId *string `json:"offering_id,omitempty"`
	SchoolId   string  `json:"school_id"`
	TeacherId  *string `json:"teacher_id,omitempty"`
	TermId     *string `json:"term_id,omitempty"`
}

Associations defines model for Associations.

type AttachFileJSONRequestBody

type AttachFileJSONRequestBody = FileLink

AttachFileJSONRequestBody defines body for AttachFile for application/json ContentType.

type AttachFileParams

type AttachFileParams struct {
	IdempotencyKey string `json:"Idempotency-Key"`
}

AttachFileParams defines parameters for AttachFile.

type AttachFileResponse

type AttachFileResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Resource
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseAttachFileResponse

func ParseAttachFileResponse(rsp *http.Response) (*AttachFileResponse, error)

ParseAttachFileResponse parses an HTTP response from a AttachFileWithResponse call

func (AttachFileResponse) ContentType

func (r AttachFileResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AttachFileResponse) GetBody

func (r AttachFileResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (AttachFileResponse) GetJSON200

func (r AttachFileResponse) GetJSON200() *Resource

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (AttachFileResponse) GetJSON400

func (r AttachFileResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (AttachFileResponse) GetJSON401

func (r AttachFileResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (AttachFileResponse) GetJSON403

func (r AttachFileResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (AttachFileResponse) GetJSON404

func (r AttachFileResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (AttachFileResponse) GetJSON409

func (r AttachFileResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (AttachFileResponse) GetJSON413

func (r AttachFileResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (AttachFileResponse) GetJSON503

func (r AttachFileResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (AttachFileResponse) Status

func (r AttachFileResponse) Status() string

Status returns HTTPResponse.Status

func (AttachFileResponse) StatusCode

func (r AttachFileResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Capabilities

type Capabilities struct {
	AllowedTypes    []string `json:"allowed_types"`
	MaxFileSize     int64    `json:"max_file_size"`
	MaxPackageBytes int64    `json:"max_package_bytes"`
	MaxPackageFiles int64    `json:"max_package_files"`

	// PurchaseAvailable Resources supports purchase delivery. Backend must also check billing availability and merge prices.
	PurchaseAvailable bool            `json:"purchase_available"`
	Terms             Terms           `json:"terms"`
	UploadProfiles    []UploadProfile `json:"upload_profiles"`
}

Capabilities defines model for Capabilities.

type Category

type Category struct {
	Enabled  bool              `json:"enabled"`
	Fields   []Field           `json:"fields"`
	GroupBy  string            `json:"group_by"`
	Id       string            `json:"id"`
	Names    map[string]string `json:"names"`
	Order    int64             `json:"order"`
	Revision int64             `json:"revision"`
}

Category defines model for Category.

type CategoryPage

type CategoryPage struct {
	Items      []Category `json:"items"`
	NextCursor string     `json:"next_cursor"`
}

CategoryPage defines model for CategoryPage.

type CategoryWrite

type CategoryWrite struct {
	Enabled  bool              `json:"enabled"`
	Fields   []Field           `json:"fields"`
	GroupBy  string            `json:"group_by"`
	Names    map[string]string `json:"names"`
	Order    int64             `json:"order"`
	Revision int64             `json:"revision"`
}

CategoryWrite defines model for CategoryWrite.

type ChangeStateJSONRequestBody

type ChangeStateJSONRequestBody = StateChange

ChangeStateJSONRequestBody defines body for ChangeState for application/json ContentType.

type ChangeStateParams

type ChangeStateParams struct {
	IdempotencyKey string `json:"Idempotency-Key"`
}

ChangeStateParams defines parameters for ChangeState.

type ChangeStateResponse

type ChangeStateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Resource
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseChangeStateResponse

func ParseChangeStateResponse(rsp *http.Response) (*ChangeStateResponse, error)

ParseChangeStateResponse parses an HTTP response from a ChangeStateWithResponse call

func (ChangeStateResponse) ContentType

func (r ChangeStateResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ChangeStateResponse) GetBody

func (r ChangeStateResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ChangeStateResponse) GetJSON200

func (r ChangeStateResponse) GetJSON200() *Resource

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ChangeStateResponse) GetJSON400

func (r ChangeStateResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ChangeStateResponse) GetJSON401

func (r ChangeStateResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ChangeStateResponse) GetJSON403

func (r ChangeStateResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ChangeStateResponse) GetJSON404

func (r ChangeStateResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ChangeStateResponse) GetJSON409

func (r ChangeStateResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (ChangeStateResponse) GetJSON413

func (r ChangeStateResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (ChangeStateResponse) GetJSON503

func (r ChangeStateResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (ChangeStateResponse) Status

func (r ChangeStateResponse) Status() string

Status returns HTTPResponse.Status

func (ChangeStateResponse) StatusCode

func (r ChangeStateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) ApplyDecision

func (c *Client) ApplyDecision(ctx context.Context, id string, params *ApplyDecisionParams, body ApplyDecisionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ApplyDecision ApplyDecision

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/resources/items/{id}/decisions (the `ApplyDecision` operationId).

func (*Client) ApplyDecisionWithBody

func (c *Client) ApplyDecisionWithBody(ctx context.Context, id string, params *ApplyDecisionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ApplyDecisionWithBody ApplyDecision

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/resources/items/{id}/decisions (the `ApplyDecision` operationId).

func (*Client) AttachFile

func (c *Client) AttachFile(ctx context.Context, id string, params *AttachFileParams, body AttachFileJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

AttachFile AttachFile

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/resources/items/{id}/file (the `AttachFile` operationId).

func (*Client) AttachFileWithBody

func (c *Client) AttachFileWithBody(ctx context.Context, id string, params *AttachFileParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

AttachFileWithBody AttachFile

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/resources/items/{id}/file (the `AttachFile` operationId).

func (*Client) ChangeState

func (c *Client) ChangeState(ctx context.Context, id string, params *ChangeStateParams, body ChangeStateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ChangeState ChangeState

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/resources/items/{id}/state (the `ChangeState` operationId).

func (*Client) ChangeStateWithBody

func (c *Client) ChangeStateWithBody(ctx context.Context, id string, params *ChangeStateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ChangeStateWithBody ChangeState

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/resources/items/{id}/state (the `ChangeState` operationId).

func (*Client) CreateDraft

func (c *Client) CreateDraft(ctx context.Context, params *CreateDraftParams, body CreateDraftJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateDraft CreateDraft

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/resources (the `CreateDraft` operationId).

func (*Client) CreateDraftWithBody

func (c *Client) CreateDraftWithBody(ctx context.Context, params *CreateDraftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateDraftWithBody CreateDraft

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/resources (the `CreateDraft` operationId).

func (*Client) CreatePackage

func (c *Client) CreatePackage(ctx context.Context, params *CreatePackageParams, body CreatePackageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreatePackage CreatePackage

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/resources/packages (the `CreatePackage` operationId).

func (*Client) CreatePackageWithBody

func (c *Client) CreatePackageWithBody(ctx context.Context, params *CreatePackageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreatePackageWithBody CreatePackage

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/resources/packages (the `CreatePackage` operationId).

func (*Client) CreateRequest

func (c *Client) CreateRequest(ctx context.Context, id string, params *CreateRequestParams, body CreateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateRequest CreateRequest

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/resources/items/{id}/requests (the `CreateRequest` operationId).

func (*Client) CreateRequestWithBody

func (c *Client) CreateRequestWithBody(ctx context.Context, id string, params *CreateRequestParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateRequestWithBody CreateRequest

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/resources/items/{id}/requests (the `CreateRequest` operationId).

func (*Client) DownloadPackagePart

func (c *Client) DownloadPackagePart(ctx context.Context, id string, part string, reqEditors ...RequestEditorFn) (*http.Response, error)

DownloadPackagePart DownloadPackagePart

Corresponds with GET /api/v1/resources/packages/{id}/parts/{part} (the `DownloadPackagePart` operationId).

func (*Client) DownloadResource

func (c *Client) DownloadResource(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

DownloadResource DownloadResource

Checks current content admission, configured eligibility, entitlements and resource state before returning any file bytes. Missing conditions return 403; unknown dependencies return 503. Same policy as preview.

Corresponds with GET /api/v1/resources/items/{id}/download (the `DownloadResource` operationId).

func (*Client) DownloadReviewFile

func (c *Client) DownloadReviewFile(ctx context.Context, version string, reqEditors ...RequestEditorFn) (*http.Response, error)

DownloadReviewFile Download quarantined file for an authorized current review

Corresponds with GET /api/v1/resources/review/{version}/file (the `DownloadReviewFile` operationId).

func (*Client) GetCapabilities

func (c *Client) GetCapabilities(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

GetCapabilities GetCapabilities

Corresponds with GET /api/v1/resources/capabilities (the `GetCapabilities` operationId).

func (*Client) GetCoverage

func (c *Client) GetCoverage(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetCoverage Read actual coverage for a billing plan ID

Corresponds with GET /api/v1/resources/coverage/{id} (the `GetCoverage` operationId).

func (*Client) GetOwnResourceSummary added in v0.1.1

func (c *Client) GetOwnResourceSummary(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

GetOwnResourceSummary ListOwnResources

Authenticated owner only. resource_count matches the owned list across current states; published_count is the published subset. No owner parameter is accepted.

Corresponds with GET /api/v1/resources/me/summary (the `GetOwnResourceSummary` operationId).

func (*Client) GetPackage

func (c *Client) GetPackage(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetPackage GetPackage

Corresponds with GET /api/v1/resources/packages/{id} (the `GetPackage` operationId).

func (*Client) GetResource

func (c *Client) GetResource(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetResource GetResource

Requires content admission for ordinary published metadata. The owner and currently authorized scoped managers may read their own records without content admission. File access always uses the separate current download policy.

Corresponds with GET /api/v1/resources/items/{id} (the `GetResource` operationId).

func (*Client) GetResourceCounts added in v0.1.1

func (c *Client) GetResourceCounts(ctx context.Context, params *GetResourceCountsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetResourceCounts ListResources

Current-visible published resource counts using the same predicates as ListResources, before pagination. Counts describe discoverable metadata, independently of download entitlement. Each requested course must belong to the authorized school. No cross-request cache.

Corresponds with GET /api/v1/resources/counts (the `GetResourceCounts` operationId).

func (*Client) GetResourceRequest

func (c *Client) GetResourceRequest(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetResourceRequest GetResource

Corresponds with GET /api/v1/resources/requests/{id} (the `GetResourceRequest` operationId).

func (*Client) ListCategories

func (c *Client) ListCategories(ctx context.Context, params *ListCategoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListCategories ListCategories

Requires current content admission in the served school: valid campus eligibility or verified teacher status. Missing admission returns 403; unavailable required facts return 503. No preview, content, counts or statistics are returned on rejection.

Corresponds with GET /api/v1/resources/categories (the `ListCategories` operationId).

func (*Client) ListDirectories

func (c *Client) ListDirectories(ctx context.Context, params *ListDirectoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListDirectories ListDirectories

Requires current content admission in the served school: valid campus eligibility or verified teacher status. Missing admission returns 403; unavailable required facts return 503. No preview, content, counts or statistics are returned on rejection.

Corresponds with GET /api/v1/resources/directories (the `ListDirectories` operationId).

func (*Client) ListGrants

func (c *Client) ListGrants(ctx context.Context, id string, params *ListGrantsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListGrants ListGrants

Corresponds with GET /api/v1/resources/items/{id}/grants (the `ListGrants` operationId).

func (*Client) ListManagedResources

func (c *Client) ListManagedResources(ctx context.Context, params *ListManagedResourcesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListManagedResources List resources within the administrators school scope

Corresponds with GET /api/v1/resources/manage (the `ListManagedResources` operationId).

func (*Client) ListOwnResources

func (c *Client) ListOwnResources(ctx context.Context, params *ListOwnResourcesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListOwnResources ListOwnResources

Corresponds with GET /api/v1/resources/me (the `ListOwnResources` operationId).

func (*Client) ListRequests

func (c *Client) ListRequests(ctx context.Context, params *ListRequestsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListRequests List own request receipts

Corresponds with GET /api/v1/resources/requests (the `ListRequests` operationId).

func (*Client) ListResources

func (c *Client) ListResources(ctx context.Context, params *ListResourcesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListResources ListResources

Requires current content admission in the served school: valid campus eligibility or verified teacher status. Missing admission returns 403; unavailable required facts return 503. No preview, content, counts or statistics are returned on rejection.

Corresponds with GET /api/v1/resources (the `ListResources` operationId).

func (*Client) MyResourcesReferences

func (c *Client) MyResourcesReferences(ctx context.Context, params *MyResourcesReferencesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

MyResourcesReferences performs a GET /api/v1/resources/me/references (the `MyResourcesReferences` operationId) request.

Returns only catalog names referenced by the caller own uploaded resources and versions. Requests and complaints do not grant access to catalog associations. Unowned IDs reject the whole batch with 404; current content admission is not required.

func (*Client) PreviewResource

func (c *Client) PreviewResource(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

PreviewResource PreviewResource

Authenticated inline file bytes, with the exact same current content, eligibility, entitlement and resource-state checks as download. No partial preview or conversion bypass. Errors return no file bytes.

Corresponds with GET /api/v1/resources/items/{id}/preview (the `PreviewResource` operationId).

func (*Client) PutCategory

func (c *Client) PutCategory(ctx context.Context, id string, params *PutCategoryParams, body PutCategoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PutCategory PutCategory

Takes a body of the `application/json` content type.

Corresponds with PUT /api/v1/resources/categories/{id} (the `PutCategory` operationId).

func (*Client) PutCategoryWithBody

func (c *Client) PutCategoryWithBody(ctx context.Context, id string, params *PutCategoryParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PutCategoryWithBody PutCategory

Takes any type of body and a specified content type.

Corresponds with PUT /api/v1/resources/categories/{id} (the `PutCategory` operationId).

func (*Client) PutCoverage

func (c *Client) PutCoverage(ctx context.Context, id string, params *PutCoverageParams, body PutCoverageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PutCoverage Replace plan coverage with revision control; coverage.manage permission required

Takes a body of the `application/json` content type.

Corresponds with PUT /api/v1/resources/coverage/{id} (the `PutCoverage` operationId).

func (*Client) PutCoverageWithBody

func (c *Client) PutCoverageWithBody(ctx context.Context, id string, params *PutCoverageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PutCoverageWithBody Replace plan coverage with revision control; coverage.manage permission required

Takes any type of body and a specified content type.

Corresponds with PUT /api/v1/resources/coverage/{id} (the `PutCoverage` operationId).

func (*Client) PutDirectory

func (c *Client) PutDirectory(ctx context.Context, id string, params *PutDirectoryParams, body PutDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PutDirectory PutDirectory

Takes a body of the `application/json` content type.

Corresponds with PUT /api/v1/resources/directories/{id} (the `PutDirectory` operationId).

func (*Client) PutDirectoryWithBody

func (c *Client) PutDirectoryWithBody(ctx context.Context, id string, params *PutDirectoryParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PutDirectoryWithBody PutDirectory

Takes any type of body and a specified content type.

Corresponds with PUT /api/v1/resources/directories/{id} (the `PutDirectory` operationId).

func (*Client) PutGrant

func (c *Client) PutGrant(ctx context.Context, id string, grant string, params *PutGrantParams, body PutGrantJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PutGrant PutGrant

Takes a body of the `application/json` content type.

Corresponds with PUT /api/v1/resources/items/{id}/grants/{grant} (the `PutGrant` operationId).

func (*Client) PutGrantWithBody

func (c *Client) PutGrantWithBody(ctx context.Context, id string, grant string, params *PutGrantParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PutGrantWithBody PutGrant

Takes any type of body and a specified content type.

Corresponds with PUT /api/v1/resources/items/{id}/grants/{grant} (the `PutGrant` operationId).

func (*Client) RetryPending

func (c *Client) RetryPending(ctx context.Context, id string, params *RetryPendingParams, body RetryPendingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

RetryPending Resume an exhausted publication operation

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/resources/items/{id}/retry (the `RetryPending` operationId).

func (*Client) RetryPendingWithBody

func (c *Client) RetryPendingWithBody(ctx context.Context, id string, params *RetryPendingParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

RetryPendingWithBody Resume an exhausted publication operation

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/resources/items/{id}/retry (the `RetryPending` operationId).

func (*Client) RetryResourceRequest

func (c *Client) RetryResourceRequest(ctx context.Context, id string, params *RetryResourceRequestParams, body RetryResourceRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

RetryResourceRequest SubmitResource

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/resources/requests/{id}/retry (the `RetryResourceRequest` operationId).

func (*Client) RetryResourceRequestWithBody

func (c *Client) RetryResourceRequestWithBody(ctx context.Context, id string, params *RetryResourceRequestParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

RetryResourceRequestWithBody SubmitResource

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/resources/requests/{id}/retry (the `RetryResourceRequest` operationId).

func (*Client) ReviewResource

func (c *Client) ReviewResource(ctx context.Context, version string, reqEditors ...RequestEditorFn) (*http.Response, error)

ReviewResource Inspect current resource for a scoped moderator

Corresponds with GET /api/v1/resources/review/{version} (the `ReviewResource` operationId).

func (*Client) SubmitResource

func (c *Client) SubmitResource(ctx context.Context, id string, params *SubmitResourceParams, body SubmitResourceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SubmitResource SubmitResource

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/resources/items/{id}/submit (the `SubmitResource` operationId).

func (*Client) SubmitResourceWithBody

func (c *Client) SubmitResourceWithBody(ctx context.Context, id string, params *SubmitResourceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SubmitResourceWithBody SubmitResource

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/resources/items/{id}/submit (the `SubmitResource` operationId).

func (*Client) UpdateDraft

func (c *Client) UpdateDraft(ctx context.Context, id string, params *UpdateDraftParams, body UpdateDraftJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateDraft UpdateDraft

Takes a body of the `application/json` content type.

Corresponds with PUT /api/v1/resources/items/{id} (the `UpdateDraft` operationId).

func (*Client) UpdateDraftWithBody

func (c *Client) UpdateDraftWithBody(ctx context.Context, id string, params *UpdateDraftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateDraftWithBody UpdateDraft

Takes any type of body and a specified content type.

Corresponds with PUT /api/v1/resources/items/{id} (the `UpdateDraft` operationId).

type ClientInterface

type ClientInterface interface {

	// ListResources ListResources
	//
	// Requires current content admission in the served school: valid campus eligibility or verified teacher status. Missing admission returns 403; unavailable required facts return 503. No preview, content, counts or statistics are returned on rejection.
	//
	// Corresponds with GET /api/v1/resources (the `ListResources` operationId).
	ListResources(ctx context.Context, params *ListResourcesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDraftWithBody CreateDraft
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/resources (the `CreateDraft` operationId).
	CreateDraftWithBody(ctx context.Context, params *CreateDraftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDraft CreateDraft
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/resources (the `CreateDraft` operationId).
	CreateDraft(ctx context.Context, params *CreateDraftParams, body CreateDraftJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCapabilities GetCapabilities
	//
	// Corresponds with GET /api/v1/resources/capabilities (the `GetCapabilities` operationId).
	GetCapabilities(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListCategories ListCategories
	//
	// Requires current content admission in the served school: valid campus eligibility or verified teacher status. Missing admission returns 403; unavailable required facts return 503. No preview, content, counts or statistics are returned on rejection.
	//
	// Corresponds with GET /api/v1/resources/categories (the `ListCategories` operationId).
	ListCategories(ctx context.Context, params *ListCategoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutCategoryWithBody PutCategory
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/v1/resources/categories/{id} (the `PutCategory` operationId).
	PutCategoryWithBody(ctx context.Context, id string, params *PutCategoryParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutCategory PutCategory
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/v1/resources/categories/{id} (the `PutCategory` operationId).
	PutCategory(ctx context.Context, id string, params *PutCategoryParams, body PutCategoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetResourceCounts ListResources
	//
	// Current-visible published resource counts using the same predicates as ListResources, before pagination. Counts describe discoverable metadata, independently of download entitlement. Each requested course must belong to the authorized school. No cross-request cache.
	//
	// Corresponds with GET /api/v1/resources/counts (the `GetResourceCounts` operationId).
	GetResourceCounts(ctx context.Context, params *GetResourceCountsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCoverage Read actual coverage for a billing plan ID
	//
	// Corresponds with GET /api/v1/resources/coverage/{id} (the `GetCoverage` operationId).
	GetCoverage(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutCoverageWithBody Replace plan coverage with revision control; coverage.manage permission required
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/v1/resources/coverage/{id} (the `PutCoverage` operationId).
	PutCoverageWithBody(ctx context.Context, id string, params *PutCoverageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutCoverage Replace plan coverage with revision control; coverage.manage permission required
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/v1/resources/coverage/{id} (the `PutCoverage` operationId).
	PutCoverage(ctx context.Context, id string, params *PutCoverageParams, body PutCoverageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListDirectories ListDirectories
	//
	// Requires current content admission in the served school: valid campus eligibility or verified teacher status. Missing admission returns 403; unavailable required facts return 503. No preview, content, counts or statistics are returned on rejection.
	//
	// Corresponds with GET /api/v1/resources/directories (the `ListDirectories` operationId).
	ListDirectories(ctx context.Context, params *ListDirectoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutDirectoryWithBody PutDirectory
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/v1/resources/directories/{id} (the `PutDirectory` operationId).
	PutDirectoryWithBody(ctx context.Context, id string, params *PutDirectoryParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutDirectory PutDirectory
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/v1/resources/directories/{id} (the `PutDirectory` operationId).
	PutDirectory(ctx context.Context, id string, params *PutDirectoryParams, body PutDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetResource GetResource
	//
	// Requires content admission for ordinary published metadata. The owner and currently authorized scoped managers may read their own records without content admission. File access always uses the separate current download policy.
	//
	// Corresponds with GET /api/v1/resources/items/{id} (the `GetResource` operationId).
	GetResource(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateDraftWithBody UpdateDraft
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/v1/resources/items/{id} (the `UpdateDraft` operationId).
	UpdateDraftWithBody(ctx context.Context, id string, params *UpdateDraftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateDraft UpdateDraft
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/v1/resources/items/{id} (the `UpdateDraft` operationId).
	UpdateDraft(ctx context.Context, id string, params *UpdateDraftParams, body UpdateDraftJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ApplyDecisionWithBody ApplyDecision
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/resources/items/{id}/decisions (the `ApplyDecision` operationId).
	ApplyDecisionWithBody(ctx context.Context, id string, params *ApplyDecisionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ApplyDecision ApplyDecision
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/resources/items/{id}/decisions (the `ApplyDecision` operationId).
	ApplyDecision(ctx context.Context, id string, params *ApplyDecisionParams, body ApplyDecisionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DownloadResource DownloadResource
	//
	// Checks current content admission, configured eligibility, entitlements and resource state before returning any file bytes. Missing conditions return 403; unknown dependencies return 503. Same policy as preview.
	//
	// Corresponds with GET /api/v1/resources/items/{id}/download (the `DownloadResource` operationId).
	DownloadResource(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AttachFileWithBody AttachFile
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/resources/items/{id}/file (the `AttachFile` operationId).
	AttachFileWithBody(ctx context.Context, id string, params *AttachFileParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AttachFile AttachFile
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/resources/items/{id}/file (the `AttachFile` operationId).
	AttachFile(ctx context.Context, id string, params *AttachFileParams, body AttachFileJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListGrants ListGrants
	//
	// Corresponds with GET /api/v1/resources/items/{id}/grants (the `ListGrants` operationId).
	ListGrants(ctx context.Context, id string, params *ListGrantsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutGrantWithBody PutGrant
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/v1/resources/items/{id}/grants/{grant} (the `PutGrant` operationId).
	PutGrantWithBody(ctx context.Context, id string, grant string, params *PutGrantParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutGrant PutGrant
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/v1/resources/items/{id}/grants/{grant} (the `PutGrant` operationId).
	PutGrant(ctx context.Context, id string, grant string, params *PutGrantParams, body PutGrantJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PreviewResource PreviewResource
	//
	// Authenticated inline file bytes, with the exact same current content, eligibility, entitlement and resource-state checks as download. No partial preview or conversion bypass. Errors return no file bytes.
	//
	// Corresponds with GET /api/v1/resources/items/{id}/preview (the `PreviewResource` operationId).
	PreviewResource(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateRequestWithBody CreateRequest
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/resources/items/{id}/requests (the `CreateRequest` operationId).
	CreateRequestWithBody(ctx context.Context, id string, params *CreateRequestParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateRequest CreateRequest
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/resources/items/{id}/requests (the `CreateRequest` operationId).
	CreateRequest(ctx context.Context, id string, params *CreateRequestParams, body CreateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetryPendingWithBody Resume an exhausted publication operation
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/resources/items/{id}/retry (the `RetryPending` operationId).
	RetryPendingWithBody(ctx context.Context, id string, params *RetryPendingParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetryPending Resume an exhausted publication operation
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/resources/items/{id}/retry (the `RetryPending` operationId).
	RetryPending(ctx context.Context, id string, params *RetryPendingParams, body RetryPendingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ChangeStateWithBody ChangeState
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/resources/items/{id}/state (the `ChangeState` operationId).
	ChangeStateWithBody(ctx context.Context, id string, params *ChangeStateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ChangeState ChangeState
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/resources/items/{id}/state (the `ChangeState` operationId).
	ChangeState(ctx context.Context, id string, params *ChangeStateParams, body ChangeStateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SubmitResourceWithBody SubmitResource
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/resources/items/{id}/submit (the `SubmitResource` operationId).
	SubmitResourceWithBody(ctx context.Context, id string, params *SubmitResourceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SubmitResource SubmitResource
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/resources/items/{id}/submit (the `SubmitResource` operationId).
	SubmitResource(ctx context.Context, id string, params *SubmitResourceParams, body SubmitResourceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListManagedResources List resources within the administrators school scope
	//
	// Corresponds with GET /api/v1/resources/manage (the `ListManagedResources` operationId).
	ListManagedResources(ctx context.Context, params *ListManagedResourcesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListOwnResources ListOwnResources
	//
	// Corresponds with GET /api/v1/resources/me (the `ListOwnResources` operationId).
	ListOwnResources(ctx context.Context, params *ListOwnResourcesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MyResourcesReferences performs a GET /api/v1/resources/me/references (the `MyResourcesReferences` operationId) request.
	//
	// Returns only catalog names referenced by the caller own uploaded resources and versions. Requests and complaints do not grant access to catalog associations. Unowned IDs reject the whole batch with 404; current content admission is not required.
	MyResourcesReferences(ctx context.Context, params *MyResourcesReferencesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOwnResourceSummary ListOwnResources
	//
	// Authenticated owner only. resource_count matches the owned list across current states; published_count is the published subset. No owner parameter is accepted.
	//
	// Corresponds with GET /api/v1/resources/me/summary (the `GetOwnResourceSummary` operationId).
	GetOwnResourceSummary(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreatePackageWithBody CreatePackage
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/resources/packages (the `CreatePackage` operationId).
	CreatePackageWithBody(ctx context.Context, params *CreatePackageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreatePackage CreatePackage
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/resources/packages (the `CreatePackage` operationId).
	CreatePackage(ctx context.Context, params *CreatePackageParams, body CreatePackageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPackage GetPackage
	//
	// Corresponds with GET /api/v1/resources/packages/{id} (the `GetPackage` operationId).
	GetPackage(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DownloadPackagePart DownloadPackagePart
	//
	// Corresponds with GET /api/v1/resources/packages/{id}/parts/{part} (the `DownloadPackagePart` operationId).
	DownloadPackagePart(ctx context.Context, id string, part string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListRequests List own request receipts
	//
	// Corresponds with GET /api/v1/resources/requests (the `ListRequests` operationId).
	ListRequests(ctx context.Context, params *ListRequestsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetResourceRequest GetResource
	//
	// Corresponds with GET /api/v1/resources/requests/{id} (the `GetResourceRequest` operationId).
	GetResourceRequest(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetryResourceRequestWithBody SubmitResource
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/resources/requests/{id}/retry (the `RetryResourceRequest` operationId).
	RetryResourceRequestWithBody(ctx context.Context, id string, params *RetryResourceRequestParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetryResourceRequest SubmitResource
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/resources/requests/{id}/retry (the `RetryResourceRequest` operationId).
	RetryResourceRequest(ctx context.Context, id string, params *RetryResourceRequestParams, body RetryResourceRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReviewResource Inspect current resource for a scoped moderator
	//
	// Corresponds with GET /api/v1/resources/review/{version} (the `ReviewResource` operationId).
	ReviewResource(ctx context.Context, version string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DownloadReviewFile Download quarantined file for an authorized current review
	//
	// Corresponds with GET /api/v1/resources/review/{version}/file (the `DownloadReviewFile` operationId).
	DownloadReviewFile(ctx context.Context, version string, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) ApplyDecisionWithBodyWithResponse

func (c *ClientWithResponses) ApplyDecisionWithBodyWithResponse(ctx context.Context, id string, params *ApplyDecisionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ApplyDecisionResponse, error)

ApplyDecisionWithBodyWithResponse ApplyDecision

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/items/{id}/decisions (the `ApplyDecision` operationId).

func (*ClientWithResponses) ApplyDecisionWithResponse

func (c *ClientWithResponses) ApplyDecisionWithResponse(ctx context.Context, id string, params *ApplyDecisionParams, body ApplyDecisionJSONRequestBody, reqEditors ...RequestEditorFn) (*ApplyDecisionResponse, error)

ApplyDecisionWithResponse ApplyDecision

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/items/{id}/decisions (the `ApplyDecision` operationId).

func (*ClientWithResponses) AttachFileWithBodyWithResponse

func (c *ClientWithResponses) AttachFileWithBodyWithResponse(ctx context.Context, id string, params *AttachFileParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachFileResponse, error)

AttachFileWithBodyWithResponse AttachFile

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/items/{id}/file (the `AttachFile` operationId).

func (*ClientWithResponses) AttachFileWithResponse

func (c *ClientWithResponses) AttachFileWithResponse(ctx context.Context, id string, params *AttachFileParams, body AttachFileJSONRequestBody, reqEditors ...RequestEditorFn) (*AttachFileResponse, error)

AttachFileWithResponse AttachFile

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/items/{id}/file (the `AttachFile` operationId).

func (*ClientWithResponses) ChangeStateWithBodyWithResponse

func (c *ClientWithResponses) ChangeStateWithBodyWithResponse(ctx context.Context, id string, params *ChangeStateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ChangeStateResponse, error)

ChangeStateWithBodyWithResponse ChangeState

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/items/{id}/state (the `ChangeState` operationId).

func (*ClientWithResponses) ChangeStateWithResponse

func (c *ClientWithResponses) ChangeStateWithResponse(ctx context.Context, id string, params *ChangeStateParams, body ChangeStateJSONRequestBody, reqEditors ...RequestEditorFn) (*ChangeStateResponse, error)

ChangeStateWithResponse ChangeState

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/items/{id}/state (the `ChangeState` operationId).

func (*ClientWithResponses) CreateDraftWithBodyWithResponse

func (c *ClientWithResponses) CreateDraftWithBodyWithResponse(ctx context.Context, params *CreateDraftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDraftResponse, error)

CreateDraftWithBodyWithResponse CreateDraft

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources (the `CreateDraft` operationId).

func (*ClientWithResponses) CreateDraftWithResponse

func (c *ClientWithResponses) CreateDraftWithResponse(ctx context.Context, params *CreateDraftParams, body CreateDraftJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDraftResponse, error)

CreateDraftWithResponse CreateDraft

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources (the `CreateDraft` operationId).

func (*ClientWithResponses) CreatePackageWithBodyWithResponse

func (c *ClientWithResponses) CreatePackageWithBodyWithResponse(ctx context.Context, params *CreatePackageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreatePackageResponse, error)

CreatePackageWithBodyWithResponse CreatePackage

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/packages (the `CreatePackage` operationId).

func (*ClientWithResponses) CreatePackageWithResponse

func (c *ClientWithResponses) CreatePackageWithResponse(ctx context.Context, params *CreatePackageParams, body CreatePackageJSONRequestBody, reqEditors ...RequestEditorFn) (*CreatePackageResponse, error)

CreatePackageWithResponse CreatePackage

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/packages (the `CreatePackage` operationId).

func (*ClientWithResponses) CreateRequestWithBodyWithResponse

func (c *ClientWithResponses) CreateRequestWithBodyWithResponse(ctx context.Context, id string, params *CreateRequestParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRequestResponse, error)

CreateRequestWithBodyWithResponse CreateRequest

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/items/{id}/requests (the `CreateRequest` operationId).

func (*ClientWithResponses) CreateRequestWithResponse

func (c *ClientWithResponses) CreateRequestWithResponse(ctx context.Context, id string, params *CreateRequestParams, body CreateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRequestResponse, error)

CreateRequestWithResponse CreateRequest

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/items/{id}/requests (the `CreateRequest` operationId).

func (*ClientWithResponses) DownloadPackagePartWithResponse

func (c *ClientWithResponses) DownloadPackagePartWithResponse(ctx context.Context, id string, part string, reqEditors ...RequestEditorFn) (*DownloadPackagePartResponse, error)

DownloadPackagePartWithResponse DownloadPackagePart

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/packages/{id}/parts/{part} (the `DownloadPackagePart` operationId).

func (*ClientWithResponses) DownloadResourceWithResponse

func (c *ClientWithResponses) DownloadResourceWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*DownloadResourceResponse, error)

DownloadResourceWithResponse DownloadResource

Checks current content admission, configured eligibility, entitlements and resource state before returning any file bytes. Missing conditions return 403; unknown dependencies return 503. Same policy as preview.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/items/{id}/download (the `DownloadResource` operationId).

func (*ClientWithResponses) DownloadReviewFileWithResponse

func (c *ClientWithResponses) DownloadReviewFileWithResponse(ctx context.Context, version string, reqEditors ...RequestEditorFn) (*DownloadReviewFileResponse, error)

DownloadReviewFileWithResponse Download quarantined file for an authorized current review

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/review/{version}/file (the `DownloadReviewFile` operationId).

func (*ClientWithResponses) GetCapabilitiesWithResponse

func (c *ClientWithResponses) GetCapabilitiesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCapabilitiesResponse, error)

GetCapabilitiesWithResponse GetCapabilities

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/capabilities (the `GetCapabilities` operationId).

func (*ClientWithResponses) GetCoverageWithResponse

func (c *ClientWithResponses) GetCoverageWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetCoverageResponse, error)

GetCoverageWithResponse Read actual coverage for a billing plan ID

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/coverage/{id} (the `GetCoverage` operationId).

func (*ClientWithResponses) GetOwnResourceSummaryWithResponse added in v0.1.1

func (c *ClientWithResponses) GetOwnResourceSummaryWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOwnResourceSummaryResponse, error)

GetOwnResourceSummaryWithResponse ListOwnResources

Authenticated owner only. resource_count matches the owned list across current states; published_count is the published subset. No owner parameter is accepted.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/me/summary (the `GetOwnResourceSummary` operationId).

func (*ClientWithResponses) GetPackageWithResponse

func (c *ClientWithResponses) GetPackageWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetPackageResponse, error)

GetPackageWithResponse GetPackage

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/packages/{id} (the `GetPackage` operationId).

func (*ClientWithResponses) GetResourceCountsWithResponse added in v0.1.1

func (c *ClientWithResponses) GetResourceCountsWithResponse(ctx context.Context, params *GetResourceCountsParams, reqEditors ...RequestEditorFn) (*GetResourceCountsResponse, error)

GetResourceCountsWithResponse ListResources

Current-visible published resource counts using the same predicates as ListResources, before pagination. Counts describe discoverable metadata, independently of download entitlement. Each requested course must belong to the authorized school. No cross-request cache.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/counts (the `GetResourceCounts` operationId).

func (*ClientWithResponses) GetResourceRequestWithResponse

func (c *ClientWithResponses) GetResourceRequestWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetResourceRequestResponse, error)

GetResourceRequestWithResponse GetResource

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/requests/{id} (the `GetResourceRequest` operationId).

func (*ClientWithResponses) GetResourceWithResponse

func (c *ClientWithResponses) GetResourceWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetResourceResponse, error)

GetResourceWithResponse GetResource

Requires content admission for ordinary published metadata. The owner and currently authorized scoped managers may read their own records without content admission. File access always uses the separate current download policy.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/items/{id} (the `GetResource` operationId).

func (*ClientWithResponses) ListCategoriesWithResponse

func (c *ClientWithResponses) ListCategoriesWithResponse(ctx context.Context, params *ListCategoriesParams, reqEditors ...RequestEditorFn) (*ListCategoriesResponse, error)

ListCategoriesWithResponse ListCategories

Requires current content admission in the served school: valid campus eligibility or verified teacher status. Missing admission returns 403; unavailable required facts return 503. No preview, content, counts or statistics are returned on rejection.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/categories (the `ListCategories` operationId).

func (*ClientWithResponses) ListDirectoriesWithResponse

func (c *ClientWithResponses) ListDirectoriesWithResponse(ctx context.Context, params *ListDirectoriesParams, reqEditors ...RequestEditorFn) (*ListDirectoriesResponse, error)

ListDirectoriesWithResponse ListDirectories

Requires current content admission in the served school: valid campus eligibility or verified teacher status. Missing admission returns 403; unavailable required facts return 503. No preview, content, counts or statistics are returned on rejection.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/directories (the `ListDirectories` operationId).

func (*ClientWithResponses) ListGrantsWithResponse

func (c *ClientWithResponses) ListGrantsWithResponse(ctx context.Context, id string, params *ListGrantsParams, reqEditors ...RequestEditorFn) (*ListGrantsResponse, error)

ListGrantsWithResponse ListGrants

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/items/{id}/grants (the `ListGrants` operationId).

func (*ClientWithResponses) ListManagedResourcesWithResponse

func (c *ClientWithResponses) ListManagedResourcesWithResponse(ctx context.Context, params *ListManagedResourcesParams, reqEditors ...RequestEditorFn) (*ListManagedResourcesResponse, error)

ListManagedResourcesWithResponse List resources within the administrators school scope

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/manage (the `ListManagedResources` operationId).

func (*ClientWithResponses) ListOwnResourcesWithResponse

func (c *ClientWithResponses) ListOwnResourcesWithResponse(ctx context.Context, params *ListOwnResourcesParams, reqEditors ...RequestEditorFn) (*ListOwnResourcesResponse, error)

ListOwnResourcesWithResponse ListOwnResources

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/me (the `ListOwnResources` operationId).

func (*ClientWithResponses) ListRequestsWithResponse

func (c *ClientWithResponses) ListRequestsWithResponse(ctx context.Context, params *ListRequestsParams, reqEditors ...RequestEditorFn) (*ListRequestsResponse, error)

ListRequestsWithResponse List own request receipts

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/requests (the `ListRequests` operationId).

func (*ClientWithResponses) ListResourcesWithResponse

func (c *ClientWithResponses) ListResourcesWithResponse(ctx context.Context, params *ListResourcesParams, reqEditors ...RequestEditorFn) (*ListResourcesResponse, error)

ListResourcesWithResponse ListResources

Requires current content admission in the served school: valid campus eligibility or verified teacher status. Missing admission returns 403; unavailable required facts return 503. No preview, content, counts or statistics are returned on rejection.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources (the `ListResources` operationId).

func (*ClientWithResponses) MyResourcesReferencesWithResponse

func (c *ClientWithResponses) MyResourcesReferencesWithResponse(ctx context.Context, params *MyResourcesReferencesParams, reqEditors ...RequestEditorFn) (*MyResourcesReferencesResponse, error)

MyResourcesReferencesWithResponse performs a GET /api/v1/resources/me/references (the `MyResourcesReferences` operationId) request.

Returns only catalog names referenced by the caller own uploaded resources and versions. Requests and complaints do not grant access to catalog associations. Unowned IDs reject the whole batch with 404; current content admission is not required.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) PreviewResourceWithResponse

func (c *ClientWithResponses) PreviewResourceWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*PreviewResourceResponse, error)

PreviewResourceWithResponse PreviewResource

Authenticated inline file bytes, with the exact same current content, eligibility, entitlement and resource-state checks as download. No partial preview or conversion bypass. Errors return no file bytes.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/items/{id}/preview (the `PreviewResource` operationId).

func (*ClientWithResponses) PutCategoryWithBodyWithResponse

func (c *ClientWithResponses) PutCategoryWithBodyWithResponse(ctx context.Context, id string, params *PutCategoryParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutCategoryResponse, error)

PutCategoryWithBodyWithResponse PutCategory

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/resources/categories/{id} (the `PutCategory` operationId).

func (*ClientWithResponses) PutCategoryWithResponse

func (c *ClientWithResponses) PutCategoryWithResponse(ctx context.Context, id string, params *PutCategoryParams, body PutCategoryJSONRequestBody, reqEditors ...RequestEditorFn) (*PutCategoryResponse, error)

PutCategoryWithResponse PutCategory

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/resources/categories/{id} (the `PutCategory` operationId).

func (*ClientWithResponses) PutCoverageWithBodyWithResponse

func (c *ClientWithResponses) PutCoverageWithBodyWithResponse(ctx context.Context, id string, params *PutCoverageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutCoverageResponse, error)

PutCoverageWithBodyWithResponse Replace plan coverage with revision control; coverage.manage permission required

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/resources/coverage/{id} (the `PutCoverage` operationId).

func (*ClientWithResponses) PutCoverageWithResponse

func (c *ClientWithResponses) PutCoverageWithResponse(ctx context.Context, id string, params *PutCoverageParams, body PutCoverageJSONRequestBody, reqEditors ...RequestEditorFn) (*PutCoverageResponse, error)

PutCoverageWithResponse Replace plan coverage with revision control; coverage.manage permission required

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/resources/coverage/{id} (the `PutCoverage` operationId).

func (*ClientWithResponses) PutDirectoryWithBodyWithResponse

func (c *ClientWithResponses) PutDirectoryWithBodyWithResponse(ctx context.Context, id string, params *PutDirectoryParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutDirectoryResponse, error)

PutDirectoryWithBodyWithResponse PutDirectory

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/resources/directories/{id} (the `PutDirectory` operationId).

func (*ClientWithResponses) PutDirectoryWithResponse

func (c *ClientWithResponses) PutDirectoryWithResponse(ctx context.Context, id string, params *PutDirectoryParams, body PutDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*PutDirectoryResponse, error)

PutDirectoryWithResponse PutDirectory

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/resources/directories/{id} (the `PutDirectory` operationId).

func (*ClientWithResponses) PutGrantWithBodyWithResponse

func (c *ClientWithResponses) PutGrantWithBodyWithResponse(ctx context.Context, id string, grant string, params *PutGrantParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutGrantResponse, error)

PutGrantWithBodyWithResponse PutGrant

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/resources/items/{id}/grants/{grant} (the `PutGrant` operationId).

func (*ClientWithResponses) PutGrantWithResponse

func (c *ClientWithResponses) PutGrantWithResponse(ctx context.Context, id string, grant string, params *PutGrantParams, body PutGrantJSONRequestBody, reqEditors ...RequestEditorFn) (*PutGrantResponse, error)

PutGrantWithResponse PutGrant

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/resources/items/{id}/grants/{grant} (the `PutGrant` operationId).

func (*ClientWithResponses) RetryPendingWithBodyWithResponse

func (c *ClientWithResponses) RetryPendingWithBodyWithResponse(ctx context.Context, id string, params *RetryPendingParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RetryPendingResponse, error)

RetryPendingWithBodyWithResponse Resume an exhausted publication operation

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/items/{id}/retry (the `RetryPending` operationId).

func (*ClientWithResponses) RetryPendingWithResponse

func (c *ClientWithResponses) RetryPendingWithResponse(ctx context.Context, id string, params *RetryPendingParams, body RetryPendingJSONRequestBody, reqEditors ...RequestEditorFn) (*RetryPendingResponse, error)

RetryPendingWithResponse Resume an exhausted publication operation

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/items/{id}/retry (the `RetryPending` operationId).

func (*ClientWithResponses) RetryResourceRequestWithBodyWithResponse

func (c *ClientWithResponses) RetryResourceRequestWithBodyWithResponse(ctx context.Context, id string, params *RetryResourceRequestParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RetryResourceRequestResponse, error)

RetryResourceRequestWithBodyWithResponse SubmitResource

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/requests/{id}/retry (the `RetryResourceRequest` operationId).

func (*ClientWithResponses) RetryResourceRequestWithResponse

RetryResourceRequestWithResponse SubmitResource

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/requests/{id}/retry (the `RetryResourceRequest` operationId).

func (*ClientWithResponses) ReviewResourceWithResponse

func (c *ClientWithResponses) ReviewResourceWithResponse(ctx context.Context, version string, reqEditors ...RequestEditorFn) (*ReviewResourceResponse, error)

ReviewResourceWithResponse Inspect current resource for a scoped moderator

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/resources/review/{version} (the `ReviewResource` operationId).

func (*ClientWithResponses) SubmitResourceWithBodyWithResponse

func (c *ClientWithResponses) SubmitResourceWithBodyWithResponse(ctx context.Context, id string, params *SubmitResourceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SubmitResourceResponse, error)

SubmitResourceWithBodyWithResponse SubmitResource

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/items/{id}/submit (the `SubmitResource` operationId).

func (*ClientWithResponses) SubmitResourceWithResponse

func (c *ClientWithResponses) SubmitResourceWithResponse(ctx context.Context, id string, params *SubmitResourceParams, body SubmitResourceJSONRequestBody, reqEditors ...RequestEditorFn) (*SubmitResourceResponse, error)

SubmitResourceWithResponse SubmitResource

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/resources/items/{id}/submit (the `SubmitResource` operationId).

func (*ClientWithResponses) UpdateDraftWithBodyWithResponse

func (c *ClientWithResponses) UpdateDraftWithBodyWithResponse(ctx context.Context, id string, params *UpdateDraftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDraftResponse, error)

UpdateDraftWithBodyWithResponse UpdateDraft

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/resources/items/{id} (the `UpdateDraft` operationId).

func (*ClientWithResponses) UpdateDraftWithResponse

func (c *ClientWithResponses) UpdateDraftWithResponse(ctx context.Context, id string, params *UpdateDraftParams, body UpdateDraftJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDraftResponse, error)

UpdateDraftWithResponse UpdateDraft

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/resources/items/{id} (the `UpdateDraft` operationId).

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {

	// ListResourcesWithResponse ListResources
	//
	// Requires current content admission in the served school: valid campus eligibility or verified teacher status. Missing admission returns 403; unavailable required facts return 503. No preview, content, counts or statistics are returned on rejection.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources (the `ListResources` operationId).
	ListResourcesWithResponse(ctx context.Context, params *ListResourcesParams, reqEditors ...RequestEditorFn) (*ListResourcesResponse, error)

	// CreateDraftWithBodyWithResponse CreateDraft
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources (the `CreateDraft` operationId).
	CreateDraftWithBodyWithResponse(ctx context.Context, params *CreateDraftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDraftResponse, error)

	// CreateDraftWithResponse CreateDraft
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources (the `CreateDraft` operationId).
	CreateDraftWithResponse(ctx context.Context, params *CreateDraftParams, body CreateDraftJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDraftResponse, error)

	// GetCapabilitiesWithResponse GetCapabilities
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/capabilities (the `GetCapabilities` operationId).
	GetCapabilitiesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCapabilitiesResponse, error)

	// ListCategoriesWithResponse ListCategories
	//
	// Requires current content admission in the served school: valid campus eligibility or verified teacher status. Missing admission returns 403; unavailable required facts return 503. No preview, content, counts or statistics are returned on rejection.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/categories (the `ListCategories` operationId).
	ListCategoriesWithResponse(ctx context.Context, params *ListCategoriesParams, reqEditors ...RequestEditorFn) (*ListCategoriesResponse, error)

	// PutCategoryWithBodyWithResponse PutCategory
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/resources/categories/{id} (the `PutCategory` operationId).
	PutCategoryWithBodyWithResponse(ctx context.Context, id string, params *PutCategoryParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutCategoryResponse, error)

	// PutCategoryWithResponse PutCategory
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/resources/categories/{id} (the `PutCategory` operationId).
	PutCategoryWithResponse(ctx context.Context, id string, params *PutCategoryParams, body PutCategoryJSONRequestBody, reqEditors ...RequestEditorFn) (*PutCategoryResponse, error)

	// GetResourceCountsWithResponse ListResources
	//
	// Current-visible published resource counts using the same predicates as ListResources, before pagination. Counts describe discoverable metadata, independently of download entitlement. Each requested course must belong to the authorized school. No cross-request cache.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/counts (the `GetResourceCounts` operationId).
	GetResourceCountsWithResponse(ctx context.Context, params *GetResourceCountsParams, reqEditors ...RequestEditorFn) (*GetResourceCountsResponse, error)

	// GetCoverageWithResponse Read actual coverage for a billing plan ID
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/coverage/{id} (the `GetCoverage` operationId).
	GetCoverageWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetCoverageResponse, error)

	// PutCoverageWithBodyWithResponse Replace plan coverage with revision control; coverage.manage permission required
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/resources/coverage/{id} (the `PutCoverage` operationId).
	PutCoverageWithBodyWithResponse(ctx context.Context, id string, params *PutCoverageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutCoverageResponse, error)

	// PutCoverageWithResponse Replace plan coverage with revision control; coverage.manage permission required
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/resources/coverage/{id} (the `PutCoverage` operationId).
	PutCoverageWithResponse(ctx context.Context, id string, params *PutCoverageParams, body PutCoverageJSONRequestBody, reqEditors ...RequestEditorFn) (*PutCoverageResponse, error)

	// ListDirectoriesWithResponse ListDirectories
	//
	// Requires current content admission in the served school: valid campus eligibility or verified teacher status. Missing admission returns 403; unavailable required facts return 503. No preview, content, counts or statistics are returned on rejection.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/directories (the `ListDirectories` operationId).
	ListDirectoriesWithResponse(ctx context.Context, params *ListDirectoriesParams, reqEditors ...RequestEditorFn) (*ListDirectoriesResponse, error)

	// PutDirectoryWithBodyWithResponse PutDirectory
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/resources/directories/{id} (the `PutDirectory` operationId).
	PutDirectoryWithBodyWithResponse(ctx context.Context, id string, params *PutDirectoryParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutDirectoryResponse, error)

	// PutDirectoryWithResponse PutDirectory
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/resources/directories/{id} (the `PutDirectory` operationId).
	PutDirectoryWithResponse(ctx context.Context, id string, params *PutDirectoryParams, body PutDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*PutDirectoryResponse, error)

	// GetResourceWithResponse GetResource
	//
	// Requires content admission for ordinary published metadata. The owner and currently authorized scoped managers may read their own records without content admission. File access always uses the separate current download policy.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/items/{id} (the `GetResource` operationId).
	GetResourceWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetResourceResponse, error)

	// UpdateDraftWithBodyWithResponse UpdateDraft
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/resources/items/{id} (the `UpdateDraft` operationId).
	UpdateDraftWithBodyWithResponse(ctx context.Context, id string, params *UpdateDraftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDraftResponse, error)

	// UpdateDraftWithResponse UpdateDraft
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/resources/items/{id} (the `UpdateDraft` operationId).
	UpdateDraftWithResponse(ctx context.Context, id string, params *UpdateDraftParams, body UpdateDraftJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDraftResponse, error)

	// ApplyDecisionWithBodyWithResponse ApplyDecision
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/items/{id}/decisions (the `ApplyDecision` operationId).
	ApplyDecisionWithBodyWithResponse(ctx context.Context, id string, params *ApplyDecisionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ApplyDecisionResponse, error)

	// ApplyDecisionWithResponse ApplyDecision
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/items/{id}/decisions (the `ApplyDecision` operationId).
	ApplyDecisionWithResponse(ctx context.Context, id string, params *ApplyDecisionParams, body ApplyDecisionJSONRequestBody, reqEditors ...RequestEditorFn) (*ApplyDecisionResponse, error)

	// DownloadResourceWithResponse DownloadResource
	//
	// Checks current content admission, configured eligibility, entitlements and resource state before returning any file bytes. Missing conditions return 403; unknown dependencies return 503. Same policy as preview.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/items/{id}/download (the `DownloadResource` operationId).
	DownloadResourceWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*DownloadResourceResponse, error)

	// AttachFileWithBodyWithResponse AttachFile
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/items/{id}/file (the `AttachFile` operationId).
	AttachFileWithBodyWithResponse(ctx context.Context, id string, params *AttachFileParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachFileResponse, error)

	// AttachFileWithResponse AttachFile
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/items/{id}/file (the `AttachFile` operationId).
	AttachFileWithResponse(ctx context.Context, id string, params *AttachFileParams, body AttachFileJSONRequestBody, reqEditors ...RequestEditorFn) (*AttachFileResponse, error)

	// ListGrantsWithResponse ListGrants
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/items/{id}/grants (the `ListGrants` operationId).
	ListGrantsWithResponse(ctx context.Context, id string, params *ListGrantsParams, reqEditors ...RequestEditorFn) (*ListGrantsResponse, error)

	// PutGrantWithBodyWithResponse PutGrant
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/resources/items/{id}/grants/{grant} (the `PutGrant` operationId).
	PutGrantWithBodyWithResponse(ctx context.Context, id string, grant string, params *PutGrantParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutGrantResponse, error)

	// PutGrantWithResponse PutGrant
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/resources/items/{id}/grants/{grant} (the `PutGrant` operationId).
	PutGrantWithResponse(ctx context.Context, id string, grant string, params *PutGrantParams, body PutGrantJSONRequestBody, reqEditors ...RequestEditorFn) (*PutGrantResponse, error)

	// PreviewResourceWithResponse PreviewResource
	//
	// Authenticated inline file bytes, with the exact same current content, eligibility, entitlement and resource-state checks as download. No partial preview or conversion bypass. Errors return no file bytes.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/items/{id}/preview (the `PreviewResource` operationId).
	PreviewResourceWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*PreviewResourceResponse, error)

	// CreateRequestWithBodyWithResponse CreateRequest
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/items/{id}/requests (the `CreateRequest` operationId).
	CreateRequestWithBodyWithResponse(ctx context.Context, id string, params *CreateRequestParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRequestResponse, error)

	// CreateRequestWithResponse CreateRequest
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/items/{id}/requests (the `CreateRequest` operationId).
	CreateRequestWithResponse(ctx context.Context, id string, params *CreateRequestParams, body CreateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRequestResponse, error)

	// RetryPendingWithBodyWithResponse Resume an exhausted publication operation
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/items/{id}/retry (the `RetryPending` operationId).
	RetryPendingWithBodyWithResponse(ctx context.Context, id string, params *RetryPendingParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RetryPendingResponse, error)

	// RetryPendingWithResponse Resume an exhausted publication operation
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/items/{id}/retry (the `RetryPending` operationId).
	RetryPendingWithResponse(ctx context.Context, id string, params *RetryPendingParams, body RetryPendingJSONRequestBody, reqEditors ...RequestEditorFn) (*RetryPendingResponse, error)

	// ChangeStateWithBodyWithResponse ChangeState
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/items/{id}/state (the `ChangeState` operationId).
	ChangeStateWithBodyWithResponse(ctx context.Context, id string, params *ChangeStateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ChangeStateResponse, error)

	// ChangeStateWithResponse ChangeState
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/items/{id}/state (the `ChangeState` operationId).
	ChangeStateWithResponse(ctx context.Context, id string, params *ChangeStateParams, body ChangeStateJSONRequestBody, reqEditors ...RequestEditorFn) (*ChangeStateResponse, error)

	// SubmitResourceWithBodyWithResponse SubmitResource
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/items/{id}/submit (the `SubmitResource` operationId).
	SubmitResourceWithBodyWithResponse(ctx context.Context, id string, params *SubmitResourceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SubmitResourceResponse, error)

	// SubmitResourceWithResponse SubmitResource
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/items/{id}/submit (the `SubmitResource` operationId).
	SubmitResourceWithResponse(ctx context.Context, id string, params *SubmitResourceParams, body SubmitResourceJSONRequestBody, reqEditors ...RequestEditorFn) (*SubmitResourceResponse, error)

	// ListManagedResourcesWithResponse List resources within the administrators school scope
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/manage (the `ListManagedResources` operationId).
	ListManagedResourcesWithResponse(ctx context.Context, params *ListManagedResourcesParams, reqEditors ...RequestEditorFn) (*ListManagedResourcesResponse, error)

	// ListOwnResourcesWithResponse ListOwnResources
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/me (the `ListOwnResources` operationId).
	ListOwnResourcesWithResponse(ctx context.Context, params *ListOwnResourcesParams, reqEditors ...RequestEditorFn) (*ListOwnResourcesResponse, error)

	// MyResourcesReferencesWithResponse performs a GET /api/v1/resources/me/references (the `MyResourcesReferences` operationId) request.
	//
	// Returns only catalog names referenced by the caller own uploaded resources and versions. Requests and complaints do not grant access to catalog associations. Unowned IDs reject the whole batch with 404; current content admission is not required.
	//
	// Returns a wrapper object for the known response body format(s).
	MyResourcesReferencesWithResponse(ctx context.Context, params *MyResourcesReferencesParams, reqEditors ...RequestEditorFn) (*MyResourcesReferencesResponse, error)

	// GetOwnResourceSummaryWithResponse ListOwnResources
	//
	// Authenticated owner only. resource_count matches the owned list across current states; published_count is the published subset. No owner parameter is accepted.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/me/summary (the `GetOwnResourceSummary` operationId).
	GetOwnResourceSummaryWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOwnResourceSummaryResponse, error)

	// CreatePackageWithBodyWithResponse CreatePackage
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/packages (the `CreatePackage` operationId).
	CreatePackageWithBodyWithResponse(ctx context.Context, params *CreatePackageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreatePackageResponse, error)

	// CreatePackageWithResponse CreatePackage
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/packages (the `CreatePackage` operationId).
	CreatePackageWithResponse(ctx context.Context, params *CreatePackageParams, body CreatePackageJSONRequestBody, reqEditors ...RequestEditorFn) (*CreatePackageResponse, error)

	// GetPackageWithResponse GetPackage
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/packages/{id} (the `GetPackage` operationId).
	GetPackageWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetPackageResponse, error)

	// DownloadPackagePartWithResponse DownloadPackagePart
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/packages/{id}/parts/{part} (the `DownloadPackagePart` operationId).
	DownloadPackagePartWithResponse(ctx context.Context, id string, part string, reqEditors ...RequestEditorFn) (*DownloadPackagePartResponse, error)

	// ListRequestsWithResponse List own request receipts
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/requests (the `ListRequests` operationId).
	ListRequestsWithResponse(ctx context.Context, params *ListRequestsParams, reqEditors ...RequestEditorFn) (*ListRequestsResponse, error)

	// GetResourceRequestWithResponse GetResource
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/requests/{id} (the `GetResourceRequest` operationId).
	GetResourceRequestWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetResourceRequestResponse, error)

	// RetryResourceRequestWithBodyWithResponse SubmitResource
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/requests/{id}/retry (the `RetryResourceRequest` operationId).
	RetryResourceRequestWithBodyWithResponse(ctx context.Context, id string, params *RetryResourceRequestParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RetryResourceRequestResponse, error)

	// RetryResourceRequestWithResponse SubmitResource
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/resources/requests/{id}/retry (the `RetryResourceRequest` operationId).
	RetryResourceRequestWithResponse(ctx context.Context, id string, params *RetryResourceRequestParams, body RetryResourceRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*RetryResourceRequestResponse, error)

	// ReviewResourceWithResponse Inspect current resource for a scoped moderator
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/review/{version} (the `ReviewResource` operationId).
	ReviewResourceWithResponse(ctx context.Context, version string, reqEditors ...RequestEditorFn) (*ReviewResourceResponse, error)

	// DownloadReviewFileWithResponse Download quarantined file for an authorized current review
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/resources/review/{version}/file (the `DownloadReviewFile` operationId).
	DownloadReviewFileWithResponse(ctx context.Context, version string, reqEditors ...RequestEditorFn) (*DownloadReviewFileResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type Command

type Command struct {
	Revision int64 `json:"revision"`
}

Command defines model for Command.

type Consent struct {
	Accepted bool   `json:"accepted"`
	Digest   string `json:"digest"`
	Version  string `json:"version"`
}

Consent defines model for Consent.

type CourseResourceCount added in v0.1.1

type CourseResourceCount struct {
	Count    int    `json:"count"`
	CourseId string `json:"course_id"`
}

CourseResourceCount defines model for CourseResourceCount.

type Coverage

type Coverage struct {
	PlanId   string         `json:"plan_id"`
	Revision int64          `json:"revision"`
	Rules    []CoverageRule `json:"rules"`
}

Coverage defines model for Coverage.

type CoverageRule

type CoverageRule struct {
	CategoryId  *string `json:"category_id,omitempty"`
	DirectoryId *string `json:"directory_id,omitempty"`
	SchoolId    string  `json:"school_id"`
}

CoverageRule defines model for CoverageRule.

type CreateDraftJSONRequestBody

type CreateDraftJSONRequestBody = DraftWrite

CreateDraftJSONRequestBody defines body for CreateDraft for application/json ContentType.

type CreateDraftParams

type CreateDraftParams struct {
	IdempotencyKey string `json:"Idempotency-Key"`
}

CreateDraftParams defines parameters for CreateDraft.

type CreateDraftResponse

type CreateDraftResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Resource
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseCreateDraftResponse

func ParseCreateDraftResponse(rsp *http.Response) (*CreateDraftResponse, error)

ParseCreateDraftResponse parses an HTTP response from a CreateDraftWithResponse call

func (CreateDraftResponse) ContentType

func (r CreateDraftResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateDraftResponse) GetBody

func (r CreateDraftResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateDraftResponse) GetJSON200

func (r CreateDraftResponse) GetJSON200() *Resource

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (CreateDraftResponse) GetJSON400

func (r CreateDraftResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CreateDraftResponse) GetJSON401

func (r CreateDraftResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateDraftResponse) GetJSON403

func (r CreateDraftResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (CreateDraftResponse) GetJSON404

func (r CreateDraftResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (CreateDraftResponse) GetJSON409

func (r CreateDraftResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (CreateDraftResponse) GetJSON413

func (r CreateDraftResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (CreateDraftResponse) GetJSON503

func (r CreateDraftResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (CreateDraftResponse) Status

func (r CreateDraftResponse) Status() string

Status returns HTTPResponse.Status

func (CreateDraftResponse) StatusCode

func (r CreateDraftResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreatePackageJSONRequestBody

type CreatePackageJSONRequestBody = PackageRequest

CreatePackageJSONRequestBody defines body for CreatePackage for application/json ContentType.

type CreatePackageParams

type CreatePackageParams struct {
	IdempotencyKey string `json:"Idempotency-Key"`
}

CreatePackageParams defines parameters for CreatePackage.

type CreatePackageResponse

type CreatePackageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Package
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseCreatePackageResponse

func ParseCreatePackageResponse(rsp *http.Response) (*CreatePackageResponse, error)

ParseCreatePackageResponse parses an HTTP response from a CreatePackageWithResponse call

func (CreatePackageResponse) ContentType

func (r CreatePackageResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreatePackageResponse) GetBody

func (r CreatePackageResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreatePackageResponse) GetJSON200

func (r CreatePackageResponse) GetJSON200() *Package

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (CreatePackageResponse) GetJSON400

func (r CreatePackageResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CreatePackageResponse) GetJSON401

func (r CreatePackageResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreatePackageResponse) GetJSON403

func (r CreatePackageResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (CreatePackageResponse) GetJSON404

func (r CreatePackageResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (CreatePackageResponse) GetJSON409

func (r CreatePackageResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (CreatePackageResponse) GetJSON413

func (r CreatePackageResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (CreatePackageResponse) GetJSON503

func (r CreatePackageResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (CreatePackageResponse) Status

func (r CreatePackageResponse) Status() string

Status returns HTTPResponse.Status

func (CreatePackageResponse) StatusCode

func (r CreatePackageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateRequestJSONRequestBody

type CreateRequestJSONRequestBody = Request

CreateRequestJSONRequestBody defines body for CreateRequest for application/json ContentType.

type CreateRequestParams

type CreateRequestParams struct {
	IdempotencyKey string `json:"Idempotency-Key"`
}

CreateRequestParams defines parameters for CreateRequest.

type CreateRequestResponse

type CreateRequestResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *RequestReceipt
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *struct {
		Code *string `json:"code,omitempty"`
	}
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseCreateRequestResponse

func ParseCreateRequestResponse(rsp *http.Response) (*CreateRequestResponse, error)

ParseCreateRequestResponse parses an HTTP response from a CreateRequestWithResponse call

func (CreateRequestResponse) ContentType

func (r CreateRequestResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateRequestResponse) GetBody

func (r CreateRequestResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateRequestResponse) GetJSON202

func (r CreateRequestResponse) GetJSON202() *RequestReceipt

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (CreateRequestResponse) GetJSON400

func (r CreateRequestResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CreateRequestResponse) GetJSON401

func (r CreateRequestResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateRequestResponse) GetJSON403

func (r CreateRequestResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (CreateRequestResponse) GetJSON404

func (r CreateRequestResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (CreateRequestResponse) GetJSON409

func (r CreateRequestResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (CreateRequestResponse) GetJSON413

func (r CreateRequestResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (CreateRequestResponse) GetJSON429

func (r CreateRequestResponse) GetJSON429() *struct {
	Code *string `json:"code,omitempty"`
}

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (CreateRequestResponse) GetJSON503

func (r CreateRequestResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (CreateRequestResponse) Status

func (r CreateRequestResponse) Status() string

Status returns HTTPResponse.Status

func (CreateRequestResponse) StatusCode

func (r CreateRequestResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Decision

type Decision struct {
	Action    DecisionAction `json:"action"`
	Id        string         `json:"id"`
	Reason    string         `json:"reason"`
	Revision  int64          `json:"revision"`
	VersionId string         `json:"version_id"`
}

Decision defines model for Decision.

type DecisionAction

type DecisionAction string

DecisionAction defines model for Decision.Action.

const (
	Approve DecisionAction = "approve"
	Reject  DecisionAction = "reject"
)

Defines values for DecisionAction.

func (DecisionAction) Valid

func (e DecisionAction) Valid() bool

Valid indicates whether the value is a known member of the DecisionAction enum.

type Directory

type Directory struct {
	CourseId *string           `json:"course_id,omitempty"`
	Enabled  bool              `json:"enabled"`
	Id       string            `json:"id"`
	Names    map[string]string `json:"names"`
	ParentId *string           `json:"parent_id,omitempty"`
	Revision int64             `json:"revision"`
	SchoolId string            `json:"school_id"`
}

Directory defines model for Directory.

type DirectoryPage

type DirectoryPage struct {
	Items      []Directory `json:"items"`
	NextCursor string      `json:"next_cursor"`
}

DirectoryPage defines model for DirectoryPage.

type DirectoryWrite

type DirectoryWrite struct {
	CourseId *string           `json:"course_id,omitempty"`
	Enabled  bool              `json:"enabled"`
	Names    map[string]string `json:"names"`
	ParentId *string           `json:"parent_id,omitempty"`
	Revision int64             `json:"revision"`
	SchoolId string            `json:"school_id"`
}

DirectoryWrite defines model for DirectoryWrite.

type DownloadPackagePartResponse

type DownloadPackagePartResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseDownloadPackagePartResponse

func ParseDownloadPackagePartResponse(rsp *http.Response) (*DownloadPackagePartResponse, error)

ParseDownloadPackagePartResponse parses an HTTP response from a DownloadPackagePartWithResponse call

func (DownloadPackagePartResponse) ContentType

func (r DownloadPackagePartResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DownloadPackagePartResponse) GetBody

func (r DownloadPackagePartResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DownloadPackagePartResponse) GetJSON400

func (r DownloadPackagePartResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (DownloadPackagePartResponse) GetJSON401

func (r DownloadPackagePartResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DownloadPackagePartResponse) GetJSON403

func (r DownloadPackagePartResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DownloadPackagePartResponse) GetJSON404

func (r DownloadPackagePartResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DownloadPackagePartResponse) GetJSON409

func (r DownloadPackagePartResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (DownloadPackagePartResponse) GetJSON413

func (r DownloadPackagePartResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (DownloadPackagePartResponse) GetJSON503

func (r DownloadPackagePartResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (DownloadPackagePartResponse) Status

Status returns HTTPResponse.Status

func (DownloadPackagePartResponse) StatusCode

func (r DownloadPackagePartResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DownloadResourceResponse

type DownloadResourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseDownloadResourceResponse

func ParseDownloadResourceResponse(rsp *http.Response) (*DownloadResourceResponse, error)

ParseDownloadResourceResponse parses an HTTP response from a DownloadResourceWithResponse call

func (DownloadResourceResponse) ContentType

func (r DownloadResourceResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DownloadResourceResponse) GetBody

func (r DownloadResourceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DownloadResourceResponse) GetJSON400

func (r DownloadResourceResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (DownloadResourceResponse) GetJSON401

func (r DownloadResourceResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DownloadResourceResponse) GetJSON403

func (r DownloadResourceResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DownloadResourceResponse) GetJSON404

func (r DownloadResourceResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DownloadResourceResponse) GetJSON409

func (r DownloadResourceResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (DownloadResourceResponse) GetJSON413

func (r DownloadResourceResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (DownloadResourceResponse) GetJSON503

func (r DownloadResourceResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (DownloadResourceResponse) Status

func (r DownloadResourceResponse) Status() string

Status returns HTTPResponse.Status

func (DownloadResourceResponse) StatusCode

func (r DownloadResourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DownloadReviewFileResponse

type DownloadReviewFileResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseDownloadReviewFileResponse

func ParseDownloadReviewFileResponse(rsp *http.Response) (*DownloadReviewFileResponse, error)

ParseDownloadReviewFileResponse parses an HTTP response from a DownloadReviewFileWithResponse call

func (DownloadReviewFileResponse) ContentType

func (r DownloadReviewFileResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DownloadReviewFileResponse) GetBody

func (r DownloadReviewFileResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DownloadReviewFileResponse) GetJSON400

func (r DownloadReviewFileResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (DownloadReviewFileResponse) GetJSON401

func (r DownloadReviewFileResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DownloadReviewFileResponse) GetJSON403

func (r DownloadReviewFileResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DownloadReviewFileResponse) GetJSON404

func (r DownloadReviewFileResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DownloadReviewFileResponse) GetJSON409

func (r DownloadReviewFileResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (DownloadReviewFileResponse) GetJSON413

func (r DownloadReviewFileResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (DownloadReviewFileResponse) GetJSON503

func (r DownloadReviewFileResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (DownloadReviewFileResponse) Status

Status returns HTTPResponse.Status

func (DownloadReviewFileResponse) StatusCode

func (r DownloadReviewFileResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DraftWrite

type DraftWrite struct {
	Metadata Metadata `json:"metadata"`
	Revision int64    `json:"revision"`
}

DraftWrite defines model for DraftWrite.

type Field

type Field struct {
	Filterable bool              `json:"filterable"`
	Groupable  bool              `json:"groupable"`
	Key        string            `json:"key"`
	Kind       FieldKind         `json:"kind"`
	Max        *int64            `json:"max,omitempty"`
	MaxLength  *int64            `json:"max_length,omitempty"`
	Min        *int64            `json:"min,omitempty"`
	Names      map[string]string `json:"names"`
	Options    *[]Option         `json:"options,omitempty"`
	Required   bool              `json:"required"`
}

Field defines model for Field.

type FieldKind

type FieldKind string

FieldKind defines model for Field.Kind.

const (
	Choice  FieldKind = "choice"
	Integer FieldKind = "integer"
	Text    FieldKind = "text"
)

Defines values for FieldKind.

func (FieldKind) Valid

func (e FieldKind) Valid() bool

Valid indicates whether the value is a known member of the FieldKind enum.

type File

type File struct {
	ContentType string `json:"content_type"`
	Filename    string `json:"filename"`
	Sha256      string `json:"sha256"`
	Size        int64  `json:"size"`
	VersionId   string `json:"version_id"`
}

File defines model for File.

type FileLink struct {
	MediaVersionId string `json:"media_version_id"`
	Revision       int64  `json:"revision"`
}

FileLink defines model for FileLink.

type GetCapabilitiesResponse

type GetCapabilitiesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Capabilities
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseGetCapabilitiesResponse

func ParseGetCapabilitiesResponse(rsp *http.Response) (*GetCapabilitiesResponse, error)

ParseGetCapabilitiesResponse parses an HTTP response from a GetCapabilitiesWithResponse call

func (GetCapabilitiesResponse) ContentType

func (r GetCapabilitiesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetCapabilitiesResponse) GetBody

func (r GetCapabilitiesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetCapabilitiesResponse) GetJSON200

func (r GetCapabilitiesResponse) GetJSON200() *Capabilities

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetCapabilitiesResponse) GetJSON400

func (r GetCapabilitiesResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetCapabilitiesResponse) GetJSON401

func (r GetCapabilitiesResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetCapabilitiesResponse) GetJSON403

func (r GetCapabilitiesResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetCapabilitiesResponse) GetJSON404

func (r GetCapabilitiesResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetCapabilitiesResponse) GetJSON409

func (r GetCapabilitiesResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (GetCapabilitiesResponse) GetJSON413

func (r GetCapabilitiesResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (GetCapabilitiesResponse) GetJSON503

func (r GetCapabilitiesResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (GetCapabilitiesResponse) Status

func (r GetCapabilitiesResponse) Status() string

Status returns HTTPResponse.Status

func (GetCapabilitiesResponse) StatusCode

func (r GetCapabilitiesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCoverageResponse

type GetCoverageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Coverage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseGetCoverageResponse

func ParseGetCoverageResponse(rsp *http.Response) (*GetCoverageResponse, error)

ParseGetCoverageResponse parses an HTTP response from a GetCoverageWithResponse call

func (GetCoverageResponse) ContentType

func (r GetCoverageResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetCoverageResponse) GetBody

func (r GetCoverageResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetCoverageResponse) GetJSON200

func (r GetCoverageResponse) GetJSON200() *Coverage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetCoverageResponse) GetJSON400

func (r GetCoverageResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetCoverageResponse) GetJSON401

func (r GetCoverageResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetCoverageResponse) GetJSON403

func (r GetCoverageResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetCoverageResponse) GetJSON404

func (r GetCoverageResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetCoverageResponse) GetJSON409

func (r GetCoverageResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (GetCoverageResponse) GetJSON413

func (r GetCoverageResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (GetCoverageResponse) GetJSON503

func (r GetCoverageResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (GetCoverageResponse) Status

func (r GetCoverageResponse) Status() string

Status returns HTTPResponse.Status

func (GetCoverageResponse) StatusCode

func (r GetCoverageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOwnResourceSummaryResponse added in v0.1.1

type GetOwnResourceSummaryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *OwnResourceSummary
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseGetOwnResourceSummaryResponse added in v0.1.1

func ParseGetOwnResourceSummaryResponse(rsp *http.Response) (*GetOwnResourceSummaryResponse, error)

ParseGetOwnResourceSummaryResponse parses an HTTP response from a GetOwnResourceSummaryWithResponse call

func (GetOwnResourceSummaryResponse) ContentType added in v0.1.1

func (r GetOwnResourceSummaryResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetOwnResourceSummaryResponse) GetBody added in v0.1.1

func (r GetOwnResourceSummaryResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetOwnResourceSummaryResponse) GetJSON200 added in v0.1.1

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetOwnResourceSummaryResponse) GetJSON400 added in v0.1.1

func (r GetOwnResourceSummaryResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetOwnResourceSummaryResponse) GetJSON401 added in v0.1.1

func (r GetOwnResourceSummaryResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetOwnResourceSummaryResponse) GetJSON403 added in v0.1.1

func (r GetOwnResourceSummaryResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetOwnResourceSummaryResponse) GetJSON404 added in v0.1.1

func (r GetOwnResourceSummaryResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetOwnResourceSummaryResponse) GetJSON409 added in v0.1.1

func (r GetOwnResourceSummaryResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (GetOwnResourceSummaryResponse) GetJSON413 added in v0.1.1

func (r GetOwnResourceSummaryResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (GetOwnResourceSummaryResponse) GetJSON503 added in v0.1.1

func (r GetOwnResourceSummaryResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (GetOwnResourceSummaryResponse) Status added in v0.1.1

Status returns HTTPResponse.Status

func (GetOwnResourceSummaryResponse) StatusCode added in v0.1.1

func (r GetOwnResourceSummaryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPackageResponse

type GetPackageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Package
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseGetPackageResponse

func ParseGetPackageResponse(rsp *http.Response) (*GetPackageResponse, error)

ParseGetPackageResponse parses an HTTP response from a GetPackageWithResponse call

func (GetPackageResponse) ContentType

func (r GetPackageResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetPackageResponse) GetBody

func (r GetPackageResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPackageResponse) GetJSON200

func (r GetPackageResponse) GetJSON200() *Package

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetPackageResponse) GetJSON400

func (r GetPackageResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetPackageResponse) GetJSON401

func (r GetPackageResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetPackageResponse) GetJSON403

func (r GetPackageResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetPackageResponse) GetJSON404

func (r GetPackageResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetPackageResponse) GetJSON409

func (r GetPackageResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (GetPackageResponse) GetJSON413

func (r GetPackageResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (GetPackageResponse) GetJSON503

func (r GetPackageResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (GetPackageResponse) Status

func (r GetPackageResponse) Status() string

Status returns HTTPResponse.Status

func (GetPackageResponse) StatusCode

func (r GetPackageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetResourceCountsParams added in v0.1.1

type GetResourceCountsParams struct {
	SchoolId   string  `form:"school_id" json:"school_id"`
	CourseIds  *string `form:"course_ids,omitempty" json:"course_ids,omitempty"`
	Query      *string `form:"query,omitempty" json:"query,omitempty"`
	CategoryId *string `form:"category_id,omitempty" json:"category_id,omitempty"`
	FileType   *string `form:"file_type,omitempty" json:"file_type,omitempty"`
}

GetResourceCountsParams defines parameters for GetResourceCounts.

type GetResourceCountsResponse added in v0.1.1

type GetResourceCountsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ResourceCounts
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseGetResourceCountsResponse added in v0.1.1

func ParseGetResourceCountsResponse(rsp *http.Response) (*GetResourceCountsResponse, error)

ParseGetResourceCountsResponse parses an HTTP response from a GetResourceCountsWithResponse call

func (GetResourceCountsResponse) ContentType added in v0.1.1

func (r GetResourceCountsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetResourceCountsResponse) GetBody added in v0.1.1

func (r GetResourceCountsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetResourceCountsResponse) GetJSON200 added in v0.1.1

func (r GetResourceCountsResponse) GetJSON200() *ResourceCounts

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetResourceCountsResponse) GetJSON400 added in v0.1.1

func (r GetResourceCountsResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetResourceCountsResponse) GetJSON401 added in v0.1.1

func (r GetResourceCountsResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetResourceCountsResponse) GetJSON403 added in v0.1.1

func (r GetResourceCountsResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetResourceCountsResponse) GetJSON404 added in v0.1.1

func (r GetResourceCountsResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetResourceCountsResponse) GetJSON409 added in v0.1.1

func (r GetResourceCountsResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (GetResourceCountsResponse) GetJSON413 added in v0.1.1

func (r GetResourceCountsResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (GetResourceCountsResponse) GetJSON503 added in v0.1.1

func (r GetResourceCountsResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (GetResourceCountsResponse) Status added in v0.1.1

func (r GetResourceCountsResponse) Status() string

Status returns HTTPResponse.Status

func (GetResourceCountsResponse) StatusCode added in v0.1.1

func (r GetResourceCountsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetResourceRequestResponse

type GetResourceRequestResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RequestReceipt
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseGetResourceRequestResponse

func ParseGetResourceRequestResponse(rsp *http.Response) (*GetResourceRequestResponse, error)

ParseGetResourceRequestResponse parses an HTTP response from a GetResourceRequestWithResponse call

func (GetResourceRequestResponse) ContentType

func (r GetResourceRequestResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetResourceRequestResponse) GetBody

func (r GetResourceRequestResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetResourceRequestResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetResourceRequestResponse) GetJSON400

func (r GetResourceRequestResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetResourceRequestResponse) GetJSON401

func (r GetResourceRequestResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetResourceRequestResponse) GetJSON403

func (r GetResourceRequestResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetResourceRequestResponse) GetJSON404

func (r GetResourceRequestResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetResourceRequestResponse) GetJSON409

func (r GetResourceRequestResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (GetResourceRequestResponse) GetJSON413

func (r GetResourceRequestResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (GetResourceRequestResponse) GetJSON503

func (r GetResourceRequestResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (GetResourceRequestResponse) Status

Status returns HTTPResponse.Status

func (GetResourceRequestResponse) StatusCode

func (r GetResourceRequestResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetResourceResponse

type GetResourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Resource
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseGetResourceResponse

func ParseGetResourceResponse(rsp *http.Response) (*GetResourceResponse, error)

ParseGetResourceResponse parses an HTTP response from a GetResourceWithResponse call

func (GetResourceResponse) ContentType

func (r GetResourceResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetResourceResponse) GetBody

func (r GetResourceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetResourceResponse) GetJSON200

func (r GetResourceResponse) GetJSON200() *Resource

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetResourceResponse) GetJSON400

func (r GetResourceResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetResourceResponse) GetJSON401

func (r GetResourceResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetResourceResponse) GetJSON403

func (r GetResourceResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetResourceResponse) GetJSON404

func (r GetResourceResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetResourceResponse) GetJSON409

func (r GetResourceResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (GetResourceResponse) GetJSON413

func (r GetResourceResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (GetResourceResponse) GetJSON503

func (r GetResourceResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (GetResourceResponse) Status

func (r GetResourceResponse) Status() string

Status returns HTTPResponse.Status

func (GetResourceResponse) StatusCode

func (r GetResourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Grant

type Grant struct {
	ExpiresAt *time.Time `json:"expires_at,omitempty"`
	Id        string     `json:"id"`
	Revision  int64      `json:"revision"`
	Revoked   bool       `json:"revoked"`

	// SubjectKey Stable issuer/subject key, visible only to grant administrators.
	SubjectKey string `json:"subject_key"`
}

Grant defines model for Grant.

type GrantPage

type GrantPage struct {
	Items      []Grant `json:"items"`
	NextCursor string  `json:"next_cursor"`
}

GrantPage defines model for GrantPage.

type GrantWrite

type GrantWrite struct {
	ExpiresAt  *time.Time `json:"expires_at,omitempty"`
	Revision   int64      `json:"revision"`
	Revoked    bool       `json:"revoked"`
	SubjectKey string     `json:"subject_key"`
}

GrantWrite defines model for GrantWrite.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type ListCategoriesParams

type ListCategoriesParams struct {
	After           *string `form:"after,omitempty" json:"after,omitempty"`
	Limit           *string `form:"limit,omitempty" json:"limit,omitempty"`
	IncludeDisabled *string `form:"include_disabled,omitempty" json:"include_disabled,omitempty"`
}

ListCategoriesParams defines parameters for ListCategories.

type ListCategoriesResponse

type ListCategoriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *CategoryPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseListCategoriesResponse

func ParseListCategoriesResponse(rsp *http.Response) (*ListCategoriesResponse, error)

ParseListCategoriesResponse parses an HTTP response from a ListCategoriesWithResponse call

func (ListCategoriesResponse) ContentType

func (r ListCategoriesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListCategoriesResponse) GetBody

func (r ListCategoriesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListCategoriesResponse) GetJSON200

func (r ListCategoriesResponse) GetJSON200() *CategoryPage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListCategoriesResponse) GetJSON400

func (r ListCategoriesResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListCategoriesResponse) GetJSON401

func (r ListCategoriesResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListCategoriesResponse) GetJSON403

func (r ListCategoriesResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ListCategoriesResponse) GetJSON404

func (r ListCategoriesResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ListCategoriesResponse) GetJSON409

func (r ListCategoriesResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (ListCategoriesResponse) GetJSON413

func (r ListCategoriesResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (ListCategoriesResponse) GetJSON503

func (r ListCategoriesResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (ListCategoriesResponse) Status

func (r ListCategoriesResponse) Status() string

Status returns HTTPResponse.Status

func (ListCategoriesResponse) StatusCode

func (r ListCategoriesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListDirectoriesParams

type ListDirectoriesParams struct {
	SchoolId *string `form:"school_id,omitempty" json:"school_id,omitempty"`
	CourseId *string `form:"course_id,omitempty" json:"course_id,omitempty"`
	ParentId *string `form:"parent_id,omitempty" json:"parent_id,omitempty"`
	After    *string `form:"after,omitempty" json:"after,omitempty"`
	Limit    *string `form:"limit,omitempty" json:"limit,omitempty"`
}

ListDirectoriesParams defines parameters for ListDirectories.

type ListDirectoriesResponse

type ListDirectoriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *DirectoryPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseListDirectoriesResponse

func ParseListDirectoriesResponse(rsp *http.Response) (*ListDirectoriesResponse, error)

ParseListDirectoriesResponse parses an HTTP response from a ListDirectoriesWithResponse call

func (ListDirectoriesResponse) ContentType

func (r ListDirectoriesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListDirectoriesResponse) GetBody

func (r ListDirectoriesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListDirectoriesResponse) GetJSON200

func (r ListDirectoriesResponse) GetJSON200() *DirectoryPage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListDirectoriesResponse) GetJSON400

func (r ListDirectoriesResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListDirectoriesResponse) GetJSON401

func (r ListDirectoriesResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListDirectoriesResponse) GetJSON403

func (r ListDirectoriesResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ListDirectoriesResponse) GetJSON404

func (r ListDirectoriesResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ListDirectoriesResponse) GetJSON409

func (r ListDirectoriesResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (ListDirectoriesResponse) GetJSON413

func (r ListDirectoriesResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (ListDirectoriesResponse) GetJSON503

func (r ListDirectoriesResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (ListDirectoriesResponse) Status

func (r ListDirectoriesResponse) Status() string

Status returns HTTPResponse.Status

func (ListDirectoriesResponse) StatusCode

func (r ListDirectoriesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListGrantsParams

type ListGrantsParams struct {
	After *string `form:"after,omitempty" json:"after,omitempty"`
	Limit *string `form:"limit,omitempty" json:"limit,omitempty"`
}

ListGrantsParams defines parameters for ListGrants.

type ListGrantsResponse

type ListGrantsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GrantPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseListGrantsResponse

func ParseListGrantsResponse(rsp *http.Response) (*ListGrantsResponse, error)

ParseListGrantsResponse parses an HTTP response from a ListGrantsWithResponse call

func (ListGrantsResponse) ContentType

func (r ListGrantsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListGrantsResponse) GetBody

func (r ListGrantsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListGrantsResponse) GetJSON200

func (r ListGrantsResponse) GetJSON200() *GrantPage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListGrantsResponse) GetJSON400

func (r ListGrantsResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListGrantsResponse) GetJSON401

func (r ListGrantsResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListGrantsResponse) GetJSON403

func (r ListGrantsResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ListGrantsResponse) GetJSON404

func (r ListGrantsResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ListGrantsResponse) GetJSON409

func (r ListGrantsResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (ListGrantsResponse) GetJSON413

func (r ListGrantsResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (ListGrantsResponse) GetJSON503

func (r ListGrantsResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (ListGrantsResponse) Status

func (r ListGrantsResponse) Status() string

Status returns HTTPResponse.Status

func (ListGrantsResponse) StatusCode

func (r ListGrantsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListManagedResourcesParams

type ListManagedResourcesParams struct {
	SchoolId    *string                         `form:"school_id,omitempty" json:"school_id,omitempty"`
	CourseId    *string                         `form:"course_id,omitempty" json:"course_id,omitempty"`
	CategoryId  *string                         `form:"category_id,omitempty" json:"category_id,omitempty"`
	DirectoryId *string                         `form:"directory_id,omitempty" json:"directory_id,omitempty"`
	Query       *string                         `form:"query,omitempty" json:"query,omitempty"`
	Attributes  *string                         `form:"attributes,omitempty" json:"attributes,omitempty"`
	After       *string                         `form:"after,omitempty" json:"after,omitempty"`
	Limit       *string                         `form:"limit,omitempty" json:"limit,omitempty"`
	Sort        *ListManagedResourcesParamsSort `form:"sort,omitempty" json:"sort,omitempty"`
	FileType    *string                         `form:"file_type,omitempty" json:"file_type,omitempty"`
}

ListManagedResourcesParams defines parameters for ListManagedResources.

type ListManagedResourcesParamsSort added in v0.1.1

type ListManagedResourcesParamsSort string

ListManagedResourcesParamsSort defines parameters for ListManagedResources.

const (
	ListManagedResourcesParamsSortId     ListManagedResourcesParamsSort = "id"
	ListManagedResourcesParamsSortNewest ListManagedResourcesParamsSort = "newest"
)

Defines values for ListManagedResourcesParamsSort.

func (ListManagedResourcesParamsSort) Valid added in v0.1.1

Valid indicates whether the value is a known member of the ListManagedResourcesParamsSort enum.

type ListManagedResourcesResponse

type ListManagedResourcesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ResourcePage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseListManagedResourcesResponse

func ParseListManagedResourcesResponse(rsp *http.Response) (*ListManagedResourcesResponse, error)

ParseListManagedResourcesResponse parses an HTTP response from a ListManagedResourcesWithResponse call

func (ListManagedResourcesResponse) ContentType

func (r ListManagedResourcesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListManagedResourcesResponse) GetBody

func (r ListManagedResourcesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListManagedResourcesResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListManagedResourcesResponse) GetJSON400

func (r ListManagedResourcesResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListManagedResourcesResponse) GetJSON401

func (r ListManagedResourcesResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListManagedResourcesResponse) GetJSON403

func (r ListManagedResourcesResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ListManagedResourcesResponse) GetJSON404

func (r ListManagedResourcesResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ListManagedResourcesResponse) GetJSON409

func (r ListManagedResourcesResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (ListManagedResourcesResponse) GetJSON413

func (r ListManagedResourcesResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (ListManagedResourcesResponse) GetJSON503

func (r ListManagedResourcesResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (ListManagedResourcesResponse) Status

Status returns HTTPResponse.Status

func (ListManagedResourcesResponse) StatusCode

func (r ListManagedResourcesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListOwnResourcesParams

type ListOwnResourcesParams struct {
	After    *string                     `form:"after,omitempty" json:"after,omitempty"`
	Limit    *string                     `form:"limit,omitempty" json:"limit,omitempty"`
	Sort     *ListOwnResourcesParamsSort `form:"sort,omitempty" json:"sort,omitempty"`
	FileType *string                     `form:"file_type,omitempty" json:"file_type,omitempty"`
}

ListOwnResourcesParams defines parameters for ListOwnResources.

type ListOwnResourcesParamsSort added in v0.1.1

type ListOwnResourcesParamsSort string

ListOwnResourcesParamsSort defines parameters for ListOwnResources.

const (
	ListOwnResourcesParamsSortId     ListOwnResourcesParamsSort = "id"
	ListOwnResourcesParamsSortNewest ListOwnResourcesParamsSort = "newest"
)

Defines values for ListOwnResourcesParamsSort.

func (ListOwnResourcesParamsSort) Valid added in v0.1.1

func (e ListOwnResourcesParamsSort) Valid() bool

Valid indicates whether the value is a known member of the ListOwnResourcesParamsSort enum.

type ListOwnResourcesResponse

type ListOwnResourcesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ResourcePage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseListOwnResourcesResponse

func ParseListOwnResourcesResponse(rsp *http.Response) (*ListOwnResourcesResponse, error)

ParseListOwnResourcesResponse parses an HTTP response from a ListOwnResourcesWithResponse call

func (ListOwnResourcesResponse) ContentType

func (r ListOwnResourcesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListOwnResourcesResponse) GetBody

func (r ListOwnResourcesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListOwnResourcesResponse) GetJSON200

func (r ListOwnResourcesResponse) GetJSON200() *ResourcePage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListOwnResourcesResponse) GetJSON400

func (r ListOwnResourcesResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListOwnResourcesResponse) GetJSON401

func (r ListOwnResourcesResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListOwnResourcesResponse) GetJSON403

func (r ListOwnResourcesResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ListOwnResourcesResponse) GetJSON404

func (r ListOwnResourcesResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ListOwnResourcesResponse) GetJSON409

func (r ListOwnResourcesResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (ListOwnResourcesResponse) GetJSON413

func (r ListOwnResourcesResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (ListOwnResourcesResponse) GetJSON503

func (r ListOwnResourcesResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (ListOwnResourcesResponse) Status

func (r ListOwnResourcesResponse) Status() string

Status returns HTTPResponse.Status

func (ListOwnResourcesResponse) StatusCode

func (r ListOwnResourcesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListRequestsParams

type ListRequestsParams struct {
	After *string `form:"after,omitempty" json:"after,omitempty"`
	Limit *string `form:"limit,omitempty" json:"limit,omitempty"`
}

ListRequestsParams defines parameters for ListRequests.

type ListRequestsResponse

type ListRequestsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RequestPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseListRequestsResponse

func ParseListRequestsResponse(rsp *http.Response) (*ListRequestsResponse, error)

ParseListRequestsResponse parses an HTTP response from a ListRequestsWithResponse call

func (ListRequestsResponse) ContentType

func (r ListRequestsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListRequestsResponse) GetBody

func (r ListRequestsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListRequestsResponse) GetJSON200

func (r ListRequestsResponse) GetJSON200() *RequestPage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListRequestsResponse) GetJSON400

func (r ListRequestsResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListRequestsResponse) GetJSON401

func (r ListRequestsResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListRequestsResponse) GetJSON403

func (r ListRequestsResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ListRequestsResponse) GetJSON404

func (r ListRequestsResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ListRequestsResponse) GetJSON409

func (r ListRequestsResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (ListRequestsResponse) GetJSON413

func (r ListRequestsResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (ListRequestsResponse) GetJSON503

func (r ListRequestsResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (ListRequestsResponse) Status

func (r ListRequestsResponse) Status() string

Status returns HTTPResponse.Status

func (ListRequestsResponse) StatusCode

func (r ListRequestsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListResourcesParams

type ListResourcesParams struct {
	SchoolId    *string                  `form:"school_id,omitempty" json:"school_id,omitempty"`
	CourseId    *string                  `form:"course_id,omitempty" json:"course_id,omitempty"`
	CategoryId  *string                  `form:"category_id,omitempty" json:"category_id,omitempty"`
	DirectoryId *string                  `form:"directory_id,omitempty" json:"directory_id,omitempty"`
	Query       *string                  `form:"query,omitempty" json:"query,omitempty"`
	Attributes  *string                  `form:"attributes,omitempty" json:"attributes,omitempty"`
	After       *string                  `form:"after,omitempty" json:"after,omitempty"`
	Limit       *string                  `form:"limit,omitempty" json:"limit,omitempty"`
	Sort        *ListResourcesParamsSort `form:"sort,omitempty" json:"sort,omitempty"`
	FileType    *string                  `form:"file_type,omitempty" json:"file_type,omitempty"`
}

ListResourcesParams defines parameters for ListResources.

type ListResourcesParamsSort added in v0.1.1

type ListResourcesParamsSort string

ListResourcesParamsSort defines parameters for ListResources.

const (
	ListResourcesParamsSortId     ListResourcesParamsSort = "id"
	ListResourcesParamsSortNewest ListResourcesParamsSort = "newest"
)

Defines values for ListResourcesParamsSort.

func (ListResourcesParamsSort) Valid added in v0.1.1

func (e ListResourcesParamsSort) Valid() bool

Valid indicates whether the value is a known member of the ListResourcesParamsSort enum.

type ListResourcesResponse

type ListResourcesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ResourcePage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseListResourcesResponse

func ParseListResourcesResponse(rsp *http.Response) (*ListResourcesResponse, error)

ParseListResourcesResponse parses an HTTP response from a ListResourcesWithResponse call

func (ListResourcesResponse) ContentType

func (r ListResourcesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListResourcesResponse) GetBody

func (r ListResourcesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListResourcesResponse) GetJSON200

func (r ListResourcesResponse) GetJSON200() *ResourcePage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListResourcesResponse) GetJSON400

func (r ListResourcesResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListResourcesResponse) GetJSON401

func (r ListResourcesResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListResourcesResponse) GetJSON403

func (r ListResourcesResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ListResourcesResponse) GetJSON404

func (r ListResourcesResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ListResourcesResponse) GetJSON409

func (r ListResourcesResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (ListResourcesResponse) GetJSON413

func (r ListResourcesResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (ListResourcesResponse) GetJSON503

func (r ListResourcesResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (ListResourcesResponse) Status

func (r ListResourcesResponse) Status() string

Status returns HTTPResponse.Status

func (ListResourcesResponse) StatusCode

func (r ListResourcesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Metadata

type Metadata struct {
	Access           MetadataAccess   `json:"access"`
	Associations     Associations     `json:"associations"`
	Attributes       map[string]Value `json:"attributes"`
	CategoryId       string           `json:"category_id"`
	CategoryRevision int64            `json:"category_revision"`
	Description      string           `json:"description"`
	DirectoryId      *string          `json:"directory_id,omitempty"`
	Origin           Origin           `json:"origin"`
	Tags             []string         `json:"tags"`
	Title            string           `json:"title"`
}

Metadata defines model for Metadata.

type MetadataAccess

type MetadataAccess string

MetadataAccess defines model for Metadata.Access.

const (
	MetadataAccessPublic     MetadataAccess = "public"
	MetadataAccessRestricted MetadataAccess = "restricted"
)

Defines values for MetadataAccess.

func (MetadataAccess) Valid

func (e MetadataAccess) Valid() bool

Valid indicates whether the value is a known member of the MetadataAccess enum.

type MyResourcesReferencesParams

type MyResourcesReferencesParams struct {
	// Ids Comma-separated IDs referenced by own records, at most 100. Any unowned ID rejects the whole batch.
	Ids string `form:"ids" json:"ids"`
}

MyResourcesReferencesParams defines parameters for MyResourcesReferences.

type MyResourcesReferencesResponse

type MyResourcesReferencesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *References
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseMyResourcesReferencesResponse

func ParseMyResourcesReferencesResponse(rsp *http.Response) (*MyResourcesReferencesResponse, error)

ParseMyResourcesReferencesResponse parses an HTTP response from a MyResourcesReferencesWithResponse call

func (MyResourcesReferencesResponse) ContentType

func (r MyResourcesReferencesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MyResourcesReferencesResponse) GetBody

func (r MyResourcesReferencesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (MyResourcesReferencesResponse) GetJSON200

func (r MyResourcesReferencesResponse) GetJSON200() *References

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (MyResourcesReferencesResponse) GetJSON400

func (r MyResourcesReferencesResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (MyResourcesReferencesResponse) GetJSON401

func (r MyResourcesReferencesResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (MyResourcesReferencesResponse) GetJSON403

func (r MyResourcesReferencesResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (MyResourcesReferencesResponse) GetJSON404

func (r MyResourcesReferencesResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (MyResourcesReferencesResponse) GetJSON409

func (r MyResourcesReferencesResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (MyResourcesReferencesResponse) GetJSON503

func (r MyResourcesReferencesResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (MyResourcesReferencesResponse) Status

Status returns HTTPResponse.Status

func (MyResourcesReferencesResponse) StatusCode

func (r MyResourcesReferencesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Option

type Option struct {
	Id    string            `json:"id"`
	Names map[string]string `json:"names"`
}

Option defines model for Option.

type Origin

type Origin struct {
	Author  *string    `json:"author,omitempty"`
	Consent *Consent   `json:"consent,omitempty"`
	Kind    OriginKind `json:"kind"`
	License *string    `json:"license,omitempty"`
	Source  *string    `json:"source,omitempty"`
}

Origin defines model for Origin.

type OriginKind

type OriginKind string

OriginKind defines model for Origin.Kind.

const (
	Known    OriginKind = "known"
	Original OriginKind = "original"
	Unknown  OriginKind = "unknown"
)

Defines values for OriginKind.

func (OriginKind) Valid

func (e OriginKind) Valid() bool

Valid indicates whether the value is a known member of the OriginKind enum.

type OwnResourceSummary added in v0.1.1

type OwnResourceSummary struct {
	PublishedCount int `json:"published_count"`
	ResourceCount  int `json:"resource_count"`
}

OwnResourceSummary defines model for OwnResourceSummary.

type Package

type Package struct {
	ExpiresAt time.Time     `json:"expires_at"`
	Id        string        `json:"id"`
	Parts     []PackagePart `json:"parts"`
}

Package defines model for Package.

type PackagePart

type PackagePart struct {
	Bytes  int64  `json:"bytes"`
	Files  []File `json:"files"`
	Number int64  `json:"number"`
}

PackagePart defines model for PackagePart.

type PackageRequest

type PackageRequest struct {
	DirectoryId *string   `json:"directory_id,omitempty"`
	ResourceIds *[]string `json:"resource_ids,omitempty"`
}

PackageRequest defines model for PackageRequest.

type PreviewResourceResponse

type PreviewResourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParsePreviewResourceResponse

func ParsePreviewResourceResponse(rsp *http.Response) (*PreviewResourceResponse, error)

ParsePreviewResourceResponse parses an HTTP response from a PreviewResourceWithResponse call

func (PreviewResourceResponse) ContentType

func (r PreviewResourceResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PreviewResourceResponse) GetBody

func (r PreviewResourceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PreviewResourceResponse) GetJSON400

func (r PreviewResourceResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PreviewResourceResponse) GetJSON401

func (r PreviewResourceResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PreviewResourceResponse) GetJSON403

func (r PreviewResourceResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PreviewResourceResponse) GetJSON404

func (r PreviewResourceResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PreviewResourceResponse) GetJSON409

func (r PreviewResourceResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PreviewResourceResponse) GetJSON413

func (r PreviewResourceResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (PreviewResourceResponse) GetJSON503

func (r PreviewResourceResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (PreviewResourceResponse) Status

func (r PreviewResourceResponse) Status() string

Status returns HTTPResponse.Status

func (PreviewResourceResponse) StatusCode

func (r PreviewResourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Problem

type Problem struct {
	AccessReason          *ProblemAccessReason            `json:"access_reason,omitempty"`
	Code                  string                          `json:"code"`
	MissingConditions     *[]ProblemMissingConditions     `json:"missing_conditions,omitempty"`
	RequestId             *string                         `json:"request_id,omitempty"`
	RuleVersion           *string                         `json:"rule_version,omitempty"`
	UnavailableConditions *[]ProblemUnavailableConditions `json:"unavailable_conditions,omitempty"`
}

Problem defines model for Problem.

type ProblemAccessReason

type ProblemAccessReason string

ProblemAccessReason defines model for Problem.AccessReason.

const (
	PermissionDenied    ProblemAccessReason = "permission_denied"
	PurchaseUnavailable ProblemAccessReason = "purchase_unavailable"
	RequirementsMissing ProblemAccessReason = "requirements_missing"
	ResourceUnavailable ProblemAccessReason = "resource_unavailable"
	ServiceUnavailable  ProblemAccessReason = "service_unavailable"
)

Defines values for ProblemAccessReason.

func (ProblemAccessReason) Valid

func (e ProblemAccessReason) Valid() bool

Valid indicates whether the value is a known member of the ProblemAccessReason enum.

type ProblemMissingConditions

type ProblemMissingConditions string

ProblemMissingConditions defines model for Problem.MissingConditions.

const (
	ProblemMissingConditionsCampusEligibility   ProblemMissingConditions = "campus_eligibility"
	ProblemMissingConditionsContentAccess       ProblemMissingConditions = "content_access"
	ProblemMissingConditionsCourseEnrollment    ProblemMissingConditions = "course_enrollment"
	ProblemMissingConditionsIdentityVerified    ProblemMissingConditions = "identity_verified"
	ProblemMissingConditionsPhoneBound          ProblemMissingConditions = "phone_bound"
	ProblemMissingConditionsResourceEntitlement ProblemMissingConditions = "resource_entitlement"
)

Defines values for ProblemMissingConditions.

func (ProblemMissingConditions) Valid

func (e ProblemMissingConditions) Valid() bool

Valid indicates whether the value is a known member of the ProblemMissingConditions enum.

type ProblemUnavailableConditions

type ProblemUnavailableConditions string

ProblemUnavailableConditions defines model for Problem.UnavailableConditions.

const (
	ProblemUnavailableConditionsCampusEligibility   ProblemUnavailableConditions = "campus_eligibility"
	ProblemUnavailableConditionsContentAccess       ProblemUnavailableConditions = "content_access"
	ProblemUnavailableConditionsCourseEnrollment    ProblemUnavailableConditions = "course_enrollment"
	ProblemUnavailableConditionsIdentityVerified    ProblemUnavailableConditions = "identity_verified"
	ProblemUnavailableConditionsPhoneBound          ProblemUnavailableConditions = "phone_bound"
	ProblemUnavailableConditionsResourceEntitlement ProblemUnavailableConditions = "resource_entitlement"
)

Defines values for ProblemUnavailableConditions.

func (ProblemUnavailableConditions) Valid

Valid indicates whether the value is a known member of the ProblemUnavailableConditions enum.

type PutCategoryJSONRequestBody

type PutCategoryJSONRequestBody = CategoryWrite

PutCategoryJSONRequestBody defines body for PutCategory for application/json ContentType.

type PutCategoryParams

type PutCategoryParams struct {
	IdempotencyKey string `json:"Idempotency-Key"`
}

PutCategoryParams defines parameters for PutCategory.

type PutCategoryResponse

type PutCategoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Category
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParsePutCategoryResponse

func ParsePutCategoryResponse(rsp *http.Response) (*PutCategoryResponse, error)

ParsePutCategoryResponse parses an HTTP response from a PutCategoryWithResponse call

func (PutCategoryResponse) ContentType

func (r PutCategoryResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PutCategoryResponse) GetBody

func (r PutCategoryResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PutCategoryResponse) GetJSON200

func (r PutCategoryResponse) GetJSON200() *Category

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PutCategoryResponse) GetJSON400

func (r PutCategoryResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PutCategoryResponse) GetJSON401

func (r PutCategoryResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PutCategoryResponse) GetJSON403

func (r PutCategoryResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PutCategoryResponse) GetJSON404

func (r PutCategoryResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PutCategoryResponse) GetJSON409

func (r PutCategoryResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PutCategoryResponse) GetJSON413

func (r PutCategoryResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (PutCategoryResponse) GetJSON503

func (r PutCategoryResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (PutCategoryResponse) Status

func (r PutCategoryResponse) Status() string

Status returns HTTPResponse.Status

func (PutCategoryResponse) StatusCode

func (r PutCategoryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutCoverageJSONRequestBody

type PutCoverageJSONRequestBody = Coverage

PutCoverageJSONRequestBody defines body for PutCoverage for application/json ContentType.

type PutCoverageParams

type PutCoverageParams struct {
	IdempotencyKey string `json:"Idempotency-Key"`
}

PutCoverageParams defines parameters for PutCoverage.

type PutCoverageResponse

type PutCoverageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Coverage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParsePutCoverageResponse

func ParsePutCoverageResponse(rsp *http.Response) (*PutCoverageResponse, error)

ParsePutCoverageResponse parses an HTTP response from a PutCoverageWithResponse call

func (PutCoverageResponse) ContentType

func (r PutCoverageResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PutCoverageResponse) GetBody

func (r PutCoverageResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PutCoverageResponse) GetJSON200

func (r PutCoverageResponse) GetJSON200() *Coverage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PutCoverageResponse) GetJSON400

func (r PutCoverageResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PutCoverageResponse) GetJSON401

func (r PutCoverageResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PutCoverageResponse) GetJSON403

func (r PutCoverageResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PutCoverageResponse) GetJSON404

func (r PutCoverageResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PutCoverageResponse) GetJSON409

func (r PutCoverageResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PutCoverageResponse) GetJSON413

func (r PutCoverageResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (PutCoverageResponse) GetJSON503

func (r PutCoverageResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (PutCoverageResponse) Status

func (r PutCoverageResponse) Status() string

Status returns HTTPResponse.Status

func (PutCoverageResponse) StatusCode

func (r PutCoverageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutDirectoryJSONRequestBody

type PutDirectoryJSONRequestBody = DirectoryWrite

PutDirectoryJSONRequestBody defines body for PutDirectory for application/json ContentType.

type PutDirectoryParams

type PutDirectoryParams struct {
	IdempotencyKey string `json:"Idempotency-Key"`
}

PutDirectoryParams defines parameters for PutDirectory.

type PutDirectoryResponse

type PutDirectoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Directory
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParsePutDirectoryResponse

func ParsePutDirectoryResponse(rsp *http.Response) (*PutDirectoryResponse, error)

ParsePutDirectoryResponse parses an HTTP response from a PutDirectoryWithResponse call

func (PutDirectoryResponse) ContentType

func (r PutDirectoryResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PutDirectoryResponse) GetBody

func (r PutDirectoryResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PutDirectoryResponse) GetJSON200

func (r PutDirectoryResponse) GetJSON200() *Directory

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PutDirectoryResponse) GetJSON400

func (r PutDirectoryResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PutDirectoryResponse) GetJSON401

func (r PutDirectoryResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PutDirectoryResponse) GetJSON403

func (r PutDirectoryResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PutDirectoryResponse) GetJSON404

func (r PutDirectoryResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PutDirectoryResponse) GetJSON409

func (r PutDirectoryResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PutDirectoryResponse) GetJSON413

func (r PutDirectoryResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (PutDirectoryResponse) GetJSON503

func (r PutDirectoryResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (PutDirectoryResponse) Status

func (r PutDirectoryResponse) Status() string

Status returns HTTPResponse.Status

func (PutDirectoryResponse) StatusCode

func (r PutDirectoryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutGrantJSONRequestBody

type PutGrantJSONRequestBody = GrantWrite

PutGrantJSONRequestBody defines body for PutGrant for application/json ContentType.

type PutGrantParams

type PutGrantParams struct {
	IdempotencyKey string `json:"Idempotency-Key"`
}

PutGrantParams defines parameters for PutGrant.

type PutGrantResponse

type PutGrantResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Grant
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParsePutGrantResponse

func ParsePutGrantResponse(rsp *http.Response) (*PutGrantResponse, error)

ParsePutGrantResponse parses an HTTP response from a PutGrantWithResponse call

func (PutGrantResponse) ContentType

func (r PutGrantResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PutGrantResponse) GetBody

func (r PutGrantResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PutGrantResponse) GetJSON200

func (r PutGrantResponse) GetJSON200() *Grant

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PutGrantResponse) GetJSON400

func (r PutGrantResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PutGrantResponse) GetJSON401

func (r PutGrantResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PutGrantResponse) GetJSON403

func (r PutGrantResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PutGrantResponse) GetJSON404

func (r PutGrantResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PutGrantResponse) GetJSON409

func (r PutGrantResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PutGrantResponse) GetJSON413

func (r PutGrantResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (PutGrantResponse) GetJSON503

func (r PutGrantResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (PutGrantResponse) Status

func (r PutGrantResponse) Status() string

Status returns HTTPResponse.Status

func (PutGrantResponse) StatusCode

func (r PutGrantResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Reference

type Reference struct {
	CanonicalId *string `json:"canonical_id,omitempty"`
	Id          string  `json:"id"`
	Kind        string  `json:"kind"`
	Name        string  `json:"name"`
}

Reference defines model for Reference.

type References

type References struct {
	Items      []Reference `json:"items"`
	MissingIds []string    `json:"missing_ids"`
}

References defines model for References.

type Request

type Request struct {
	Contact        *string     `json:"contact,omitempty"`
	Evidence       *[]string   `json:"evidence,omitempty"`
	Kind           RequestKind `json:"kind"`
	PreviousTaskId *string     `json:"previous_task_id,omitempty"`
	Reason         string      `json:"reason"`
}

Request defines model for Request.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RequestKind

type RequestKind string

RequestKind defines model for Request.Kind.

const (
	Appeal     RequestKind = "appeal"
	Complaint  RequestKind = "complaint"
	Withdrawal RequestKind = "withdrawal"
)

Defines values for RequestKind.

func (RequestKind) Valid

func (e RequestKind) Valid() bool

Valid indicates whether the value is a known member of the RequestKind enum.

type RequestPage

type RequestPage struct {
	Items      []RequestReceipt `json:"items"`
	NextCursor string           `json:"next_cursor"`
}

RequestPage defines model for RequestPage.

type RequestReceipt

type RequestReceipt struct {
	CanAppeal      bool      `json:"can_appeal"`
	CreatedAt      time.Time `json:"created_at"`
	DecisionReason *string   `json:"decision_reason,omitempty"`
	Id             string    `json:"id"`
	Kind           *string   `json:"kind,omitempty"`
	ResourceId     *string   `json:"resource_id,omitempty"`

	// ResourceTitle Title snapshot at request submission. Present for an owner request, or when a complaint passed current content admission at submission. Omitted for other complaints and historical requests without an admission snapshot.
	ResourceTitle *string             `json:"resource_title,omitempty"`
	State         RequestReceiptState `json:"state"`
	TaskId        *string             `json:"task_id,omitempty"`
}

RequestReceipt defines model for RequestReceipt.

type RequestReceiptState

type RequestReceiptState string

RequestReceiptState defines model for RequestReceipt.State.

const (
	RequestReceiptStateApplied   RequestReceiptState = "applied"
	RequestReceiptStateDecided   RequestReceiptState = "decided"
	RequestReceiptStateFailed    RequestReceiptState = "failed"
	RequestReceiptStatePending   RequestReceiptState = "pending"
	RequestReceiptStateSubmitted RequestReceiptState = "submitted"
	RequestReceiptStateWaiting   RequestReceiptState = "waiting"
)

Defines values for RequestReceiptState.

func (RequestReceiptState) Valid

func (e RequestReceiptState) Valid() bool

Valid indicates whether the value is a known member of the RequestReceiptState enum.

type Resource

type Resource struct {
	// AccessReason allowed, requirements_missing, purchase_unavailable, resource_unavailable, permission_denied or service_unavailable. Owned metadata remains readable if file eligibility is unavailable. Use missing_conditions and unavailable_conditions rather than assuming that every failure requires a purchase.
	AccessReason          string                           `json:"access_reason"`
	AvailableMethods      *[]ResourceAvailableMethods      `json:"available_methods,omitempty"`
	Current               *Version                         `json:"current,omitempty"`
	DownloadAllowed       bool                             `json:"download_allowed"`
	Id                    string                           `json:"id"`
	MissingConditions     *[]ResourceMissingConditions     `json:"missing_conditions,omitempty"`
	Owned                 bool                             `json:"owned"`
	Proposal              *Version                         `json:"proposal,omitempty"`
	Revision              int64                            `json:"revision"`
	RuleVersion           *string                          `json:"rule_version,omitempty"`
	State                 ResourceState                    `json:"state"`
	UnavailableConditions *[]ResourceUnavailableConditions `json:"unavailable_conditions,omitempty"`
	UnlockReason          *string                          `json:"unlock_reason,omitempty"`
}

Resource defines model for Resource.

type ResourceAvailableMethods

type ResourceAvailableMethods string

ResourceAvailableMethods defines model for Resource.AvailableMethods.

const (
	Download ResourceAvailableMethods = "download"
	Purchase ResourceAvailableMethods = "purchase"
)

Defines values for ResourceAvailableMethods.

func (ResourceAvailableMethods) Valid

func (e ResourceAvailableMethods) Valid() bool

Valid indicates whether the value is a known member of the ResourceAvailableMethods enum.

type ResourceCounts added in v0.1.1

type ResourceCounts struct {
	Courses []CourseResourceCount `json:"courses"`
	Total   int                   `json:"total"`
}

ResourceCounts defines model for ResourceCounts.

type ResourceMissingConditions

type ResourceMissingConditions string

ResourceMissingConditions defines model for Resource.MissingConditions.

const (
	ResourceMissingConditionsCampusEligibility   ResourceMissingConditions = "campus_eligibility"
	ResourceMissingConditionsContentAccess       ResourceMissingConditions = "content_access"
	ResourceMissingConditionsCourseEnrollment    ResourceMissingConditions = "course_enrollment"
	ResourceMissingConditionsIdentityVerified    ResourceMissingConditions = "identity_verified"
	ResourceMissingConditionsPhoneBound          ResourceMissingConditions = "phone_bound"
	ResourceMissingConditionsResourceEntitlement ResourceMissingConditions = "resource_entitlement"
)

Defines values for ResourceMissingConditions.

func (ResourceMissingConditions) Valid

func (e ResourceMissingConditions) Valid() bool

Valid indicates whether the value is a known member of the ResourceMissingConditions enum.

type ResourcePage

type ResourcePage struct {
	Items      []Resource `json:"items"`
	NextCursor string     `json:"next_cursor"`

	// Total Total matching current-visible records before cursor pagination.
	Total int `json:"total"`
}

ResourcePage defines model for ResourcePage.

type ResourceState

type ResourceState string

ResourceState defines model for Resource.State.

const (
	ResourceStateBlocked   ResourceState = "blocked"
	ResourceStateDraft     ResourceState = "draft"
	ResourceStatePublished ResourceState = "published"
	ResourceStateUnlisted  ResourceState = "unlisted"
)

Defines values for ResourceState.

func (ResourceState) Valid

func (e ResourceState) Valid() bool

Valid indicates whether the value is a known member of the ResourceState enum.

type ResourceUnavailableConditions

type ResourceUnavailableConditions string

ResourceUnavailableConditions defines model for Resource.UnavailableConditions.

const (
	ResourceUnavailableConditionsCampusEligibility   ResourceUnavailableConditions = "campus_eligibility"
	ResourceUnavailableConditionsContentAccess       ResourceUnavailableConditions = "content_access"
	ResourceUnavailableConditionsCourseEnrollment    ResourceUnavailableConditions = "course_enrollment"
	ResourceUnavailableConditionsIdentityVerified    ResourceUnavailableConditions = "identity_verified"
	ResourceUnavailableConditionsPhoneBound          ResourceUnavailableConditions = "phone_bound"
	ResourceUnavailableConditionsResourceEntitlement ResourceUnavailableConditions = "resource_entitlement"
)

Defines values for ResourceUnavailableConditions.

func (ResourceUnavailableConditions) Valid

Valid indicates whether the value is a known member of the ResourceUnavailableConditions enum.

type RetryPendingJSONRequestBody

type RetryPendingJSONRequestBody = Command

RetryPendingJSONRequestBody defines body for RetryPending for application/json ContentType.

type RetryPendingParams

type RetryPendingParams struct {
	IdempotencyKey string `json:"Idempotency-Key"`
}

RetryPendingParams defines parameters for RetryPending.

type RetryPendingResponse

type RetryPendingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *Resource
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseRetryPendingResponse

func ParseRetryPendingResponse(rsp *http.Response) (*RetryPendingResponse, error)

ParseRetryPendingResponse parses an HTTP response from a RetryPendingWithResponse call

func (RetryPendingResponse) ContentType

func (r RetryPendingResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RetryPendingResponse) GetBody

func (r RetryPendingResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RetryPendingResponse) GetJSON202

func (r RetryPendingResponse) GetJSON202() *Resource

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (RetryPendingResponse) GetJSON400

func (r RetryPendingResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (RetryPendingResponse) GetJSON401

func (r RetryPendingResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (RetryPendingResponse) GetJSON403

func (r RetryPendingResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (RetryPendingResponse) GetJSON404

func (r RetryPendingResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (RetryPendingResponse) GetJSON409

func (r RetryPendingResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (RetryPendingResponse) GetJSON413

func (r RetryPendingResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (RetryPendingResponse) GetJSON503

func (r RetryPendingResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (RetryPendingResponse) Status

func (r RetryPendingResponse) Status() string

Status returns HTTPResponse.Status

func (RetryPendingResponse) StatusCode

func (r RetryPendingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetryResourceRequestJSONBody

type RetryResourceRequestJSONBody = map[string]interface{}

RetryResourceRequestJSONBody defines parameters for RetryResourceRequest.

type RetryResourceRequestJSONRequestBody

type RetryResourceRequestJSONRequestBody = RetryResourceRequestJSONBody

RetryResourceRequestJSONRequestBody defines body for RetryResourceRequest for application/json ContentType.

type RetryResourceRequestParams

type RetryResourceRequestParams struct {
	IdempotencyKey string `json:"Idempotency-Key"`
}

RetryResourceRequestParams defines parameters for RetryResourceRequest.

type RetryResourceRequestResponse

type RetryResourceRequestResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *RequestReceipt
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseRetryResourceRequestResponse

func ParseRetryResourceRequestResponse(rsp *http.Response) (*RetryResourceRequestResponse, error)

ParseRetryResourceRequestResponse parses an HTTP response from a RetryResourceRequestWithResponse call

func (RetryResourceRequestResponse) ContentType

func (r RetryResourceRequestResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RetryResourceRequestResponse) GetBody

func (r RetryResourceRequestResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RetryResourceRequestResponse) GetJSON202

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (RetryResourceRequestResponse) GetJSON400

func (r RetryResourceRequestResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (RetryResourceRequestResponse) GetJSON401

func (r RetryResourceRequestResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (RetryResourceRequestResponse) GetJSON403

func (r RetryResourceRequestResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (RetryResourceRequestResponse) GetJSON404

func (r RetryResourceRequestResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (RetryResourceRequestResponse) GetJSON409

func (r RetryResourceRequestResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (RetryResourceRequestResponse) GetJSON413

func (r RetryResourceRequestResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (RetryResourceRequestResponse) GetJSON503

func (r RetryResourceRequestResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (RetryResourceRequestResponse) Status

Status returns HTTPResponse.Status

func (RetryResourceRequestResponse) StatusCode

func (r RetryResourceRequestResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReviewResourceResponse

type ReviewResourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Resource
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseReviewResourceResponse

func ParseReviewResourceResponse(rsp *http.Response) (*ReviewResourceResponse, error)

ParseReviewResourceResponse parses an HTTP response from a ReviewResourceWithResponse call

func (ReviewResourceResponse) ContentType

func (r ReviewResourceResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ReviewResourceResponse) GetBody

func (r ReviewResourceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ReviewResourceResponse) GetJSON200

func (r ReviewResourceResponse) GetJSON200() *Resource

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ReviewResourceResponse) GetJSON400

func (r ReviewResourceResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ReviewResourceResponse) GetJSON401

func (r ReviewResourceResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ReviewResourceResponse) GetJSON403

func (r ReviewResourceResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ReviewResourceResponse) GetJSON404

func (r ReviewResourceResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ReviewResourceResponse) GetJSON409

func (r ReviewResourceResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (ReviewResourceResponse) GetJSON413

func (r ReviewResourceResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (ReviewResourceResponse) GetJSON503

func (r ReviewResourceResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (ReviewResourceResponse) Status

func (r ReviewResourceResponse) Status() string

Status returns HTTPResponse.Status

func (ReviewResourceResponse) StatusCode

func (r ReviewResourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type StateChange

type StateChange struct {
	Reason   string           `json:"reason"`
	Revision int64            `json:"revision"`
	State    StateChangeState `json:"state"`
}

StateChange defines model for StateChange.

type StateChangeState

type StateChangeState string

StateChangeState defines model for StateChange.State.

const (
	StateChangeStateBlocked   StateChangeState = "blocked"
	StateChangeStatePublished StateChangeState = "published"
	StateChangeStateUnlisted  StateChangeState = "unlisted"
)

Defines values for StateChangeState.

func (StateChangeState) Valid

func (e StateChangeState) Valid() bool

Valid indicates whether the value is a known member of the StateChangeState enum.

type SubmitResourceJSONRequestBody

type SubmitResourceJSONRequestBody = Command

SubmitResourceJSONRequestBody defines body for SubmitResource for application/json ContentType.

type SubmitResourceParams

type SubmitResourceParams struct {
	IdempotencyKey string `json:"Idempotency-Key"`
}

SubmitResourceParams defines parameters for SubmitResource.

type SubmitResourceResponse

type SubmitResourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *Resource
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseSubmitResourceResponse

func ParseSubmitResourceResponse(rsp *http.Response) (*SubmitResourceResponse, error)

ParseSubmitResourceResponse parses an HTTP response from a SubmitResourceWithResponse call

func (SubmitResourceResponse) ContentType

func (r SubmitResourceResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SubmitResourceResponse) GetBody

func (r SubmitResourceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SubmitResourceResponse) GetJSON202

func (r SubmitResourceResponse) GetJSON202() *Resource

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (SubmitResourceResponse) GetJSON400

func (r SubmitResourceResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (SubmitResourceResponse) GetJSON401

func (r SubmitResourceResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (SubmitResourceResponse) GetJSON403

func (r SubmitResourceResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (SubmitResourceResponse) GetJSON404

func (r SubmitResourceResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (SubmitResourceResponse) GetJSON409

func (r SubmitResourceResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (SubmitResourceResponse) GetJSON413

func (r SubmitResourceResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (SubmitResourceResponse) GetJSON503

func (r SubmitResourceResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (SubmitResourceResponse) Status

func (r SubmitResourceResponse) Status() string

Status returns HTTPResponse.Status

func (SubmitResourceResponse) StatusCode

func (r SubmitResourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Terms

type Terms struct {
	Digest  string `json:"digest"`
	Url     string `json:"url"`
	Version string `json:"version"`
}

Terms defines model for Terms.

type UpdateDraftJSONRequestBody

type UpdateDraftJSONRequestBody = DraftWrite

UpdateDraftJSONRequestBody defines body for UpdateDraft for application/json ContentType.

type UpdateDraftParams

type UpdateDraftParams struct {
	IdempotencyKey string `json:"Idempotency-Key"`
}

UpdateDraftParams defines parameters for UpdateDraft.

type UpdateDraftResponse

type UpdateDraftResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Resource
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Problem
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Problem
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Problem
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Problem
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Problem
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *Problem
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *Problem
}

func ParseUpdateDraftResponse

func ParseUpdateDraftResponse(rsp *http.Response) (*UpdateDraftResponse, error)

ParseUpdateDraftResponse parses an HTTP response from a UpdateDraftWithResponse call

func (UpdateDraftResponse) ContentType

func (r UpdateDraftResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateDraftResponse) GetBody

func (r UpdateDraftResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpdateDraftResponse) GetJSON200

func (r UpdateDraftResponse) GetJSON200() *Resource

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (UpdateDraftResponse) GetJSON400

func (r UpdateDraftResponse) GetJSON400() *Problem

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (UpdateDraftResponse) GetJSON401

func (r UpdateDraftResponse) GetJSON401() *Problem

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (UpdateDraftResponse) GetJSON403

func (r UpdateDraftResponse) GetJSON403() *Problem

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (UpdateDraftResponse) GetJSON404

func (r UpdateDraftResponse) GetJSON404() *Problem

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (UpdateDraftResponse) GetJSON409

func (r UpdateDraftResponse) GetJSON409() *Problem

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (UpdateDraftResponse) GetJSON413

func (r UpdateDraftResponse) GetJSON413() *Problem

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (UpdateDraftResponse) GetJSON503

func (r UpdateDraftResponse) GetJSON503() *Problem

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (UpdateDraftResponse) Status

func (r UpdateDraftResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateDraftResponse) StatusCode

func (r UpdateDraftResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UploadProfile

type UploadProfile struct {
	Access   UploadProfileAccess `json:"access"`
	Purpose  string              `json:"purpose"`
	SchoolId string              `json:"school_id"`
}

UploadProfile defines model for UploadProfile.

type UploadProfileAccess

type UploadProfileAccess string

UploadProfileAccess defines model for UploadProfile.Access.

const (
	UploadProfileAccessPublic     UploadProfileAccess = "public"
	UploadProfileAccessRestricted UploadProfileAccess = "restricted"
)

Defines values for UploadProfileAccess.

func (UploadProfileAccess) Valid

func (e UploadProfileAccess) Valid() bool

Valid indicates whether the value is a known member of the UploadProfileAccess enum.

type Value

type Value struct {
	Number *int64  `json:"number,omitempty"`
	Option *string `json:"option,omitempty"`
	Text   *string `json:"text,omitempty"`
}

Value defines model for Value.

type Version

type Version struct {
	Category  Category     `json:"category"`
	CreatedAt time.Time    `json:"created_at"`
	File      *File        `json:"file,omitempty"`
	Id        string       `json:"id"`
	Metadata  Metadata     `json:"metadata"`
	Number    int64        `json:"number"`
	State     VersionState `json:"state"`
}

Version defines model for Version.

type VersionState

type VersionState string

VersionState defines model for Version.State.

const (
	VersionStateApproved   VersionState = "approved"
	VersionStateBlocked    VersionState = "blocked"
	VersionStateDraft      VersionState = "draft"
	VersionStatePending    VersionState = "pending"
	VersionStatePreparing  VersionState = "preparing"
	VersionStatePublished  VersionState = "published"
	VersionStateRejected   VersionState = "rejected"
	VersionStateSuperseded VersionState = "superseded"
)

Defines values for VersionState.

func (VersionState) Valid

func (e VersionState) Valid() bool

Valid indicates whether the value is a known member of the VersionState enum.

Jump to

Keyboard shortcuts

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