document

package
v0.0.0-...-2439cfa Latest Latest
Warning

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

 Go to latest Published: Nov 17, 2025 License: GPL-3.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithAcceptApplicationJSON 

func WithAcceptApplicationJSON(r *runtime.ClientOperation)

WithAcceptApplicationJSON sets the Accept header to "application/json".

func WithAcceptApplicationXML 

func WithAcceptApplicationXML(r *runtime.ClientOperation)

WithAcceptApplicationXML sets the Accept header to "application/xml".

func WithAcceptTextJSON 

func WithAcceptTextJSON(r *runtime.ClientOperation)

WithAcceptTextJSON sets the Accept header to "text/json".

func WithAcceptTextXML 

func WithAcceptTextXML(r *runtime.ClientOperation)

WithAcceptTextXML sets the Accept header to "text/xml".

func WithContentTypeApplicationJSON 

func WithContentTypeApplicationJSON(r *runtime.ClientOperation)

WithContentTypeApplicationJSON sets the Content-Type header to "application/json".

func WithContentTypeApplicationXML 

func WithContentTypeApplicationXML(r *runtime.ClientOperation)

WithContentTypeApplicationXML sets the Content-Type header to "application/xml".

func WithContentTypeApplicationxWwwFormUrlencoded 

func WithContentTypeApplicationxWwwFormUrlencoded(r *runtime.ClientOperation)

WithContentTypeApplicationxWwwFormUrlencoded sets the Content-Type header to "application/x-www-form-urlencoded".

func WithContentTypeTextJSON 

func WithContentTypeTextJSON(r *runtime.ClientOperation)

WithContentTypeTextJSON sets the Content-Type header to "text/json".

func WithContentTypeTextXML 

func WithContentTypeTextXML(r *runtime.ClientOperation)

WithContentTypeTextXML sets the Content-Type header to "text/xml".

Types

type Client 

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

Client for document API

func (*Client) DocumentGetDocument 

func (a *Client) DocumentGetDocument(params *DocumentGetDocumentParams, opts ...ClientOption) (*DocumentGetDocumentOK, error)

DocumentGetDocument document get document API

func (*Client) DocumentGetDocuments 

func (a *Client) DocumentGetDocuments(params *DocumentGetDocumentsParams, opts ...ClientOption) (*DocumentGetDocumentsOK, error)

DocumentGetDocuments document get documents API

func (*Client) DocumentPostDocument 

func (a *Client) DocumentPostDocument(params *DocumentPostDocumentParams, opts ...ClientOption) (*DocumentPostDocumentOK, error)

DocumentPostDocument document post document API

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.

func WithAccept 

func WithAccept(mime string) ClientOption

WithAccept allows the client to force the Accept header to negotiate a specific Producer from the server.

You may use this option to set arbitrary extensions to your MIME media type.

func WithContentType 

func WithContentType(mime string) ClientOption

WithContentType allows the client to force the Content-Type header to negotiate a specific Consumer from the server.

You may use this option to set arbitrary extensions to your MIME media type.

type ClientService 

type ClientService interface {
	DocumentGetDocument(params *DocumentGetDocumentParams, opts ...ClientOption) (*DocumentGetDocumentOK, error)

	DocumentGetDocuments(params *DocumentGetDocumentsParams, opts ...ClientOption) (*DocumentGetDocumentsOK, error)

	DocumentPostDocument(params *DocumentPostDocumentParams, opts ...ClientOption) (*DocumentPostDocumentOK, 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 document API client.

func NewClientWithBasicAuth 

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

New creates a new document 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 document 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.

type DocumentGetDocumentOK 

type DocumentGetDocumentOK struct {
	Payload *model.DocumentAPIView
}

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

Get a document

func NewDocumentGetDocumentOK 

func NewDocumentGetDocumentOK() *DocumentGetDocumentOK

NewDocumentGetDocumentOK creates a DocumentGetDocumentOK with default headers values

func (*DocumentGetDocumentOK) Code 

func (o *DocumentGetDocumentOK) Code() int

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

func (*DocumentGetDocumentOK) Error 

func (o *DocumentGetDocumentOK) Error() string

func (*DocumentGetDocumentOK) GetPayload 

func (o *DocumentGetDocumentOK) GetPayload() *model.DocumentAPIView

func (*DocumentGetDocumentOK) IsClientError 

func (o *DocumentGetDocumentOK) IsClientError() bool

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

func (*DocumentGetDocumentOK) IsCode 

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

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

func (*DocumentGetDocumentOK) IsRedirect 

func (o *DocumentGetDocumentOK) IsRedirect() bool

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

func (*DocumentGetDocumentOK) IsServerError 

func (o *DocumentGetDocumentOK) IsServerError() bool

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

func (*DocumentGetDocumentOK) IsSuccess 

func (o *DocumentGetDocumentOK) IsSuccess() bool

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

func (*DocumentGetDocumentOK) String 

func (o *DocumentGetDocumentOK) String() string

type DocumentGetDocumentParams 

type DocumentGetDocumentParams struct {

	// DocumentID.
	//
	// Format: int32
	DocumentID int32

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

DocumentGetDocumentParams contains all the parameters to send to the API endpoint 

for the document get document operation.

Typically these are written to a http.Request.

func NewDocumentGetDocumentParams 

func NewDocumentGetDocumentParams() *DocumentGetDocumentParams

NewDocumentGetDocumentParams creates a new DocumentGetDocumentParams 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 NewDocumentGetDocumentParamsWithContext 

func NewDocumentGetDocumentParamsWithContext(ctx context.Context) *DocumentGetDocumentParams

NewDocumentGetDocumentParamsWithContext creates a new DocumentGetDocumentParams object with the ability to set a context for a request.

func NewDocumentGetDocumentParamsWithHTTPClient 

func NewDocumentGetDocumentParamsWithHTTPClient(client *http.Client) *DocumentGetDocumentParams

NewDocumentGetDocumentParamsWithHTTPClient creates a new DocumentGetDocumentParams object with the ability to set a custom HTTPClient for a request.

func NewDocumentGetDocumentParamsWithTimeout 

func NewDocumentGetDocumentParamsWithTimeout(timeout time.Duration) *DocumentGetDocumentParams

NewDocumentGetDocumentParamsWithTimeout creates a new DocumentGetDocumentParams object with the ability to set a timeout on a request.

func (*DocumentGetDocumentParams) SetContext 

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

SetContext adds the context to the document get document params

func (*DocumentGetDocumentParams) SetDefaults 

func (o *DocumentGetDocumentParams) SetDefaults()

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

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

func (*DocumentGetDocumentParams) SetDocumentID 

func (o *DocumentGetDocumentParams) SetDocumentID(documentID int32)

SetDocumentID adds the documentId to the document get document params

func (*DocumentGetDocumentParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the document get document params

func (*DocumentGetDocumentParams) SetTimeout 

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

SetTimeout adds the timeout to the document get document params

func (*DocumentGetDocumentParams) WithContext 

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

WithContext adds the context to the document get document params

func (*DocumentGetDocumentParams) WithDefaults 

func (o *DocumentGetDocumentParams) WithDefaults() *DocumentGetDocumentParams

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

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

func (*DocumentGetDocumentParams) WithDocumentID 

func (o *DocumentGetDocumentParams) WithDocumentID(documentID int32) *DocumentGetDocumentParams

WithDocumentID adds the documentID to the document get document params

func (*DocumentGetDocumentParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the document get document params

func (*DocumentGetDocumentParams) WithTimeout 

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

WithTimeout adds the timeout to the document get document params

func (*DocumentGetDocumentParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type DocumentGetDocumentReader 

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

DocumentGetDocumentReader is a Reader for the DocumentGetDocument structure.

func (*DocumentGetDocumentReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type DocumentGetDocumentsOK 

type DocumentGetDocumentsOK struct {
	Payload []*model.DocumentAPIView
}

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

Get a list of documents

func NewDocumentGetDocumentsOK 

func NewDocumentGetDocumentsOK() *DocumentGetDocumentsOK

NewDocumentGetDocumentsOK creates a DocumentGetDocumentsOK with default headers values

func (*DocumentGetDocumentsOK) Code 

func (o *DocumentGetDocumentsOK) Code() int

Code gets the status code for the document get documents o k response

func (*DocumentGetDocumentsOK) Error 

func (o *DocumentGetDocumentsOK) Error() string

func (*DocumentGetDocumentsOK) GetPayload 

func (o *DocumentGetDocumentsOK) GetPayload() []*model.DocumentAPIView

func (*DocumentGetDocumentsOK) IsClientError 

func (o *DocumentGetDocumentsOK) IsClientError() bool

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

func (*DocumentGetDocumentsOK) IsCode 

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

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

func (*DocumentGetDocumentsOK) IsRedirect 

func (o *DocumentGetDocumentsOK) IsRedirect() bool

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

func (*DocumentGetDocumentsOK) IsServerError 

func (o *DocumentGetDocumentsOK) IsServerError() bool

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

func (*DocumentGetDocumentsOK) IsSuccess 

func (o *DocumentGetDocumentsOK) IsSuccess() bool

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

func (*DocumentGetDocumentsOK) String 

func (o *DocumentGetDocumentsOK) String() string

type DocumentGetDocumentsParams 

type DocumentGetDocumentsParams struct {

	// FullTextSearch.
	FullTextSearch *string

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

DocumentGetDocumentsParams contains all the parameters to send to the API endpoint 

for the document get documents operation.

Typically these are written to a http.Request.

func NewDocumentGetDocumentsParams 

func NewDocumentGetDocumentsParams() *DocumentGetDocumentsParams

NewDocumentGetDocumentsParams creates a new DocumentGetDocumentsParams 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 NewDocumentGetDocumentsParamsWithContext 

func NewDocumentGetDocumentsParamsWithContext(ctx context.Context) *DocumentGetDocumentsParams

NewDocumentGetDocumentsParamsWithContext creates a new DocumentGetDocumentsParams object with the ability to set a context for a request.

func NewDocumentGetDocumentsParamsWithHTTPClient 

func NewDocumentGetDocumentsParamsWithHTTPClient(client *http.Client) *DocumentGetDocumentsParams

NewDocumentGetDocumentsParamsWithHTTPClient creates a new DocumentGetDocumentsParams object with the ability to set a custom HTTPClient for a request.

func NewDocumentGetDocumentsParamsWithTimeout 

func NewDocumentGetDocumentsParamsWithTimeout(timeout time.Duration) *DocumentGetDocumentsParams

NewDocumentGetDocumentsParamsWithTimeout creates a new DocumentGetDocumentsParams object with the ability to set a timeout on a request.

func (*DocumentGetDocumentsParams) SetContext 

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

SetContext adds the context to the document get documents params

func (*DocumentGetDocumentsParams) SetDefaults 

func (o *DocumentGetDocumentsParams) SetDefaults()

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

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

func (*DocumentGetDocumentsParams) SetFullTextSearch 

func (o *DocumentGetDocumentsParams) SetFullTextSearch(fullTextSearch *string)

SetFullTextSearch adds the fullTextSearch to the document get documents params

func (*DocumentGetDocumentsParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the document get documents params

func (*DocumentGetDocumentsParams) SetTimeout 

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

SetTimeout adds the timeout to the document get documents params

func (*DocumentGetDocumentsParams) WithContext 

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

WithContext adds the context to the document get documents params

func (*DocumentGetDocumentsParams) WithDefaults 

func (o *DocumentGetDocumentsParams) WithDefaults() *DocumentGetDocumentsParams

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

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

func (*DocumentGetDocumentsParams) WithFullTextSearch 

func (o *DocumentGetDocumentsParams) WithFullTextSearch(fullTextSearch *string) *DocumentGetDocumentsParams

WithFullTextSearch adds the fullTextSearch to the document get documents params

func (*DocumentGetDocumentsParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the document get documents params

func (*DocumentGetDocumentsParams) WithTimeout 

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

WithTimeout adds the timeout to the document get documents params

func (*DocumentGetDocumentsParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type DocumentGetDocumentsReader 

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

DocumentGetDocumentsReader is a Reader for the DocumentGetDocuments structure.

func (*DocumentGetDocumentsReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type DocumentPostDocumentOK 

type DocumentPostDocumentOK struct {
	Payload int32
}

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

Save a document

func NewDocumentPostDocumentOK 

func NewDocumentPostDocumentOK() *DocumentPostDocumentOK

NewDocumentPostDocumentOK creates a DocumentPostDocumentOK with default headers values

func (*DocumentPostDocumentOK) Code 

func (o *DocumentPostDocumentOK) Code() int

Code gets the status code for the document post document o k response

func (*DocumentPostDocumentOK) Error 

func (o *DocumentPostDocumentOK) Error() string

func (*DocumentPostDocumentOK) GetPayload 

func (o *DocumentPostDocumentOK) GetPayload() int32

func (*DocumentPostDocumentOK) IsClientError 

func (o *DocumentPostDocumentOK) IsClientError() bool

IsClientError returns true when this document post document o k response has a 4xx status code

func (*DocumentPostDocumentOK) IsCode 

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

IsCode returns true when this document post document o k response a status code equal to that given

func (*DocumentPostDocumentOK) IsRedirect 

func (o *DocumentPostDocumentOK) IsRedirect() bool

IsRedirect returns true when this document post document o k response has a 3xx status code

func (*DocumentPostDocumentOK) IsServerError 

func (o *DocumentPostDocumentOK) IsServerError() bool

IsServerError returns true when this document post document o k response has a 5xx status code

func (*DocumentPostDocumentOK) IsSuccess 

func (o *DocumentPostDocumentOK) IsSuccess() bool

IsSuccess returns true when this document post document o k response has a 2xx status code

func (*DocumentPostDocumentOK) String 

func (o *DocumentPostDocumentOK) String() string

type DocumentPostDocumentParams 

type DocumentPostDocumentParams struct {

	// Document.
	Document *model.Document

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

DocumentPostDocumentParams contains all the parameters to send to the API endpoint 

for the document post document operation.

Typically these are written to a http.Request.

func NewDocumentPostDocumentParams 

func NewDocumentPostDocumentParams() *DocumentPostDocumentParams

NewDocumentPostDocumentParams creates a new DocumentPostDocumentParams 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 NewDocumentPostDocumentParamsWithContext 

func NewDocumentPostDocumentParamsWithContext(ctx context.Context) *DocumentPostDocumentParams

NewDocumentPostDocumentParamsWithContext creates a new DocumentPostDocumentParams object with the ability to set a context for a request.

func NewDocumentPostDocumentParamsWithHTTPClient 

func NewDocumentPostDocumentParamsWithHTTPClient(client *http.Client) *DocumentPostDocumentParams

NewDocumentPostDocumentParamsWithHTTPClient creates a new DocumentPostDocumentParams object with the ability to set a custom HTTPClient for a request.

func NewDocumentPostDocumentParamsWithTimeout 

func NewDocumentPostDocumentParamsWithTimeout(timeout time.Duration) *DocumentPostDocumentParams

NewDocumentPostDocumentParamsWithTimeout creates a new DocumentPostDocumentParams object with the ability to set a timeout on a request.

func (*DocumentPostDocumentParams) SetContext 

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

SetContext adds the context to the document post document params

func (*DocumentPostDocumentParams) SetDefaults 

func (o *DocumentPostDocumentParams) SetDefaults()

SetDefaults hydrates default values in the document post document params (not the query body).

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

func (*DocumentPostDocumentParams) SetDocument 

func (o *DocumentPostDocumentParams) SetDocument(document *model.Document)

SetDocument adds the document to the document post document params

func (*DocumentPostDocumentParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the document post document params

func (*DocumentPostDocumentParams) SetTimeout 

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

SetTimeout adds the timeout to the document post document params

func (*DocumentPostDocumentParams) WithContext 

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

WithContext adds the context to the document post document params

func (*DocumentPostDocumentParams) WithDefaults 

func (o *DocumentPostDocumentParams) WithDefaults() *DocumentPostDocumentParams

WithDefaults hydrates default values in the document post document params (not the query body).

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

func (*DocumentPostDocumentParams) WithDocument 

func (o *DocumentPostDocumentParams) WithDocument(document *model.Document) *DocumentPostDocumentParams

WithDocument adds the document to the document post document params

func (*DocumentPostDocumentParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the document post document params

func (*DocumentPostDocumentParams) WithTimeout 

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

WithTimeout adds the timeout to the document post document params

func (*DocumentPostDocumentParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type DocumentPostDocumentReader 

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

DocumentPostDocumentReader is a Reader for the DocumentPostDocument structure.

func (*DocumentPostDocumentReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

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.