announcements

package
v0.20.0-rc1 Latest Latest
Warning

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

 Go to latest Published: Sep 16, 2025 License: AGPL-3.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AnnouncementsGetBadRequest 

type AnnouncementsGetBadRequest struct {
}

AnnouncementsGetBadRequest describes a response with status code 400, with default header values.

bad request

func NewAnnouncementsGetBadRequest 

func NewAnnouncementsGetBadRequest() *AnnouncementsGetBadRequest

NewAnnouncementsGetBadRequest creates a AnnouncementsGetBadRequest with default headers values

func (*AnnouncementsGetBadRequest) Code 

func (o *AnnouncementsGetBadRequest) Code() int

Code gets the status code for the announcements get bad request response

func (*AnnouncementsGetBadRequest) Error 

func (o *AnnouncementsGetBadRequest) Error() string

func (*AnnouncementsGetBadRequest) IsClientError 

func (o *AnnouncementsGetBadRequest) IsClientError() bool

IsClientError returns true when this announcements get bad request response has a 4xx status code

func (*AnnouncementsGetBadRequest) IsCode 

func (o *AnnouncementsGetBadRequest) IsCode(code int) bool

IsCode returns true when this announcements get bad request response a status code equal to that given

func (*AnnouncementsGetBadRequest) IsRedirect 

func (o *AnnouncementsGetBadRequest) IsRedirect() bool

IsRedirect returns true when this announcements get bad request response has a 3xx status code

func (*AnnouncementsGetBadRequest) IsServerError 

func (o *AnnouncementsGetBadRequest) IsServerError() bool

IsServerError returns true when this announcements get bad request response has a 5xx status code

func (*AnnouncementsGetBadRequest) IsSuccess 

func (o *AnnouncementsGetBadRequest) IsSuccess() bool

IsSuccess returns true when this announcements get bad request response has a 2xx status code

func (*AnnouncementsGetBadRequest) String 

func (o *AnnouncementsGetBadRequest) String() string

type AnnouncementsGetInternalServerError 

type AnnouncementsGetInternalServerError struct {
}

AnnouncementsGetInternalServerError describes a response with status code 500, with default header values.

internal server error

func NewAnnouncementsGetInternalServerError 

func NewAnnouncementsGetInternalServerError() *AnnouncementsGetInternalServerError

NewAnnouncementsGetInternalServerError creates a AnnouncementsGetInternalServerError with default headers values

func (*AnnouncementsGetInternalServerError) Code 

func (o *AnnouncementsGetInternalServerError) Code() int

Code gets the status code for the announcements get internal server error response

func (*AnnouncementsGetInternalServerError) Error 

func (o *AnnouncementsGetInternalServerError) Error() string

func (*AnnouncementsGetInternalServerError) IsClientError 

func (o *AnnouncementsGetInternalServerError) IsClientError() bool

IsClientError returns true when this announcements get internal server error response has a 4xx status code

func (*AnnouncementsGetInternalServerError) IsCode 

func (o *AnnouncementsGetInternalServerError) IsCode(code int) bool

IsCode returns true when this announcements get internal server error response a status code equal to that given

func (*AnnouncementsGetInternalServerError) IsRedirect 

func (o *AnnouncementsGetInternalServerError) IsRedirect() bool

IsRedirect returns true when this announcements get internal server error response has a 3xx status code

func (*AnnouncementsGetInternalServerError) IsServerError 

func (o *AnnouncementsGetInternalServerError) IsServerError() bool

IsServerError returns true when this announcements get internal server error response has a 5xx status code

func (*AnnouncementsGetInternalServerError) IsSuccess 

func (o *AnnouncementsGetInternalServerError) IsSuccess() bool

IsSuccess returns true when this announcements get internal server error response has a 2xx status code

func (*AnnouncementsGetInternalServerError) String 

func (o *AnnouncementsGetInternalServerError) String() string

type AnnouncementsGetNotAcceptable 

type AnnouncementsGetNotAcceptable struct {
}

AnnouncementsGetNotAcceptable describes a response with status code 406, with default header values.

not acceptable

func NewAnnouncementsGetNotAcceptable 

func NewAnnouncementsGetNotAcceptable() *AnnouncementsGetNotAcceptable

NewAnnouncementsGetNotAcceptable creates a AnnouncementsGetNotAcceptable with default headers values

func (*AnnouncementsGetNotAcceptable) Code 

func (o *AnnouncementsGetNotAcceptable) Code() int

Code gets the status code for the announcements get not acceptable response

func (*AnnouncementsGetNotAcceptable) Error 

func (o *AnnouncementsGetNotAcceptable) Error() string

func (*AnnouncementsGetNotAcceptable) IsClientError 

func (o *AnnouncementsGetNotAcceptable) IsClientError() bool

IsClientError returns true when this announcements get not acceptable response has a 4xx status code

func (*AnnouncementsGetNotAcceptable) IsCode 

func (o *AnnouncementsGetNotAcceptable) IsCode(code int) bool

IsCode returns true when this announcements get not acceptable response a status code equal to that given

func (*AnnouncementsGetNotAcceptable) IsRedirect 

func (o *AnnouncementsGetNotAcceptable) IsRedirect() bool

IsRedirect returns true when this announcements get not acceptable response has a 3xx status code

func (*AnnouncementsGetNotAcceptable) IsServerError 

func (o *AnnouncementsGetNotAcceptable) IsServerError() bool

IsServerError returns true when this announcements get not acceptable response has a 5xx status code

func (*AnnouncementsGetNotAcceptable) IsSuccess 

func (o *AnnouncementsGetNotAcceptable) IsSuccess() bool

IsSuccess returns true when this announcements get not acceptable response has a 2xx status code

func (*AnnouncementsGetNotAcceptable) String 

func (o *AnnouncementsGetNotAcceptable) String() string

type AnnouncementsGetOK 

type AnnouncementsGetOK struct {
	Payload []interface{}
}

AnnouncementsGetOK describes a response with status code 200, with default header values.

AnnouncementsGetOK announcements get o k

func NewAnnouncementsGetOK 

func NewAnnouncementsGetOK() *AnnouncementsGetOK

NewAnnouncementsGetOK creates a AnnouncementsGetOK with default headers values

func (*AnnouncementsGetOK) Code 

func (o *AnnouncementsGetOK) Code() int

Code gets the status code for the announcements get o k response

func (*AnnouncementsGetOK) Error 

func (o *AnnouncementsGetOK) Error() string

func (*AnnouncementsGetOK) GetPayload 

func (o *AnnouncementsGetOK) GetPayload() []interface{}

func (*AnnouncementsGetOK) IsClientError 

func (o *AnnouncementsGetOK) IsClientError() bool

IsClientError returns true when this announcements get o k response has a 4xx status code

func (*AnnouncementsGetOK) IsCode 

func (o *AnnouncementsGetOK) IsCode(code int) bool

IsCode returns true when this announcements get o k response a status code equal to that given

func (*AnnouncementsGetOK) IsRedirect 

func (o *AnnouncementsGetOK) IsRedirect() bool

IsRedirect returns true when this announcements get o k response has a 3xx status code

func (*AnnouncementsGetOK) IsServerError 

func (o *AnnouncementsGetOK) IsServerError() bool

IsServerError returns true when this announcements get o k response has a 5xx status code

func (*AnnouncementsGetOK) IsSuccess 

func (o *AnnouncementsGetOK) IsSuccess() bool

IsSuccess returns true when this announcements get o k response has a 2xx status code

func (*AnnouncementsGetOK) String 

func (o *AnnouncementsGetOK) String() string

type AnnouncementsGetParams 

type AnnouncementsGetParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

AnnouncementsGetParams contains all the parameters to send to the API endpoint 

for the announcements get operation.

Typically these are written to a http.Request.

func NewAnnouncementsGetParams 

func NewAnnouncementsGetParams() *AnnouncementsGetParams

NewAnnouncementsGetParams creates a new AnnouncementsGetParams object, with the default timeout for this client.

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

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

func NewAnnouncementsGetParamsWithContext 

func NewAnnouncementsGetParamsWithContext(ctx context.Context) *AnnouncementsGetParams

NewAnnouncementsGetParamsWithContext creates a new AnnouncementsGetParams object with the ability to set a context for a request.

func NewAnnouncementsGetParamsWithHTTPClient 

func NewAnnouncementsGetParamsWithHTTPClient(client *http.Client) *AnnouncementsGetParams

NewAnnouncementsGetParamsWithHTTPClient creates a new AnnouncementsGetParams object with the ability to set a custom HTTPClient for a request.

func NewAnnouncementsGetParamsWithTimeout 

func NewAnnouncementsGetParamsWithTimeout(timeout time.Duration) *AnnouncementsGetParams

NewAnnouncementsGetParamsWithTimeout creates a new AnnouncementsGetParams object with the ability to set a timeout on a request.

func (*AnnouncementsGetParams) SetContext 

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

SetContext adds the context to the announcements get params

func (*AnnouncementsGetParams) SetDefaults 

func (o *AnnouncementsGetParams) SetDefaults()

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

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

func (*AnnouncementsGetParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the announcements get params

func (*AnnouncementsGetParams) SetTimeout 

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

SetTimeout adds the timeout to the announcements get params

func (*AnnouncementsGetParams) WithContext 

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

WithContext adds the context to the announcements get params

func (*AnnouncementsGetParams) WithDefaults 

func (o *AnnouncementsGetParams) WithDefaults() *AnnouncementsGetParams

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

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

func (*AnnouncementsGetParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the announcements get params

func (*AnnouncementsGetParams) WithTimeout 

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

WithTimeout adds the timeout to the announcements get params

func (*AnnouncementsGetParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type AnnouncementsGetReader 

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

AnnouncementsGetReader is a Reader for the AnnouncementsGet structure.

func (*AnnouncementsGetReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type AnnouncementsGetUnauthorized 

type AnnouncementsGetUnauthorized struct {
}

AnnouncementsGetUnauthorized describes a response with status code 401, with default header values.

unauthorized

func NewAnnouncementsGetUnauthorized 

func NewAnnouncementsGetUnauthorized() *AnnouncementsGetUnauthorized

NewAnnouncementsGetUnauthorized creates a AnnouncementsGetUnauthorized with default headers values

func (*AnnouncementsGetUnauthorized) Code 

func (o *AnnouncementsGetUnauthorized) Code() int

Code gets the status code for the announcements get unauthorized response

func (*AnnouncementsGetUnauthorized) Error 

func (o *AnnouncementsGetUnauthorized) Error() string

func (*AnnouncementsGetUnauthorized) IsClientError 

func (o *AnnouncementsGetUnauthorized) IsClientError() bool

IsClientError returns true when this announcements get unauthorized response has a 4xx status code

func (*AnnouncementsGetUnauthorized) IsCode 

func (o *AnnouncementsGetUnauthorized) IsCode(code int) bool

IsCode returns true when this announcements get unauthorized response a status code equal to that given

func (*AnnouncementsGetUnauthorized) IsRedirect 

func (o *AnnouncementsGetUnauthorized) IsRedirect() bool

IsRedirect returns true when this announcements get unauthorized response has a 3xx status code

func (*AnnouncementsGetUnauthorized) IsServerError 

func (o *AnnouncementsGetUnauthorized) IsServerError() bool

IsServerError returns true when this announcements get unauthorized response has a 5xx status code

func (*AnnouncementsGetUnauthorized) IsSuccess 

func (o *AnnouncementsGetUnauthorized) IsSuccess() bool

IsSuccess returns true when this announcements get unauthorized response has a 2xx status code

func (*AnnouncementsGetUnauthorized) String 

func (o *AnnouncementsGetUnauthorized) String() string

type Client 

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

Client for announcements API

func (*Client) AnnouncementsGet 

func (a *Client) AnnouncementsGet(params *AnnouncementsGetParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*AnnouncementsGetOK, error)

AnnouncementsGet gets an array of currently active announcements

THIS ENDPOINT IS CURRENTLY NOT FULLY IMPLEMENTED: it will always return an empty array.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption may be used to customize the behavior of Client methods.

type ClientService 

type ClientService interface {
	AnnouncementsGet(params *AnnouncementsGetParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*AnnouncementsGetOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New 

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

New creates a new announcements API client.

func NewClientWithBasicAuth 

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new announcements API client with basic auth credentials. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken 

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new announcements API client with a bearer token for authentication. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.