operations

package
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Jul 8, 2024 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Client for operations API

func (*Client) GetLanguages 

func (a *Client) GetLanguages(params *GetLanguagesParams, opts ...ClientOption) (*GetLanguagesOK, error)

GetLanguages gets a list of supported languages

func (*Client) GetWords 

func (a *Client) GetWords(params *GetWordsParams, opts ...ClientOption) (*GetWordsOK, error)

GetWords lists words in dictionaries

List words in the user's personal dictionaries.

func (*Client) PostCheck 

func (a *Client) PostCheck(params *PostCheckParams, opts ...ClientOption) (*PostCheckOK, error)

PostCheck checks a text

The main feature - check a text with LanguageTool for possible style and grammar issues.

func (*Client) PostWordsAdd 

func (a *Client) PostWordsAdd(params *PostWordsAddParams, opts ...ClientOption) (*PostWordsAddOK, error)

PostWordsAdd adds word to a dictionary

Add a word to one of the user's personal dictionaries. Please note that this feature is considered to be used for personal dictionaries which must not contain more than 500 words. If this is an issue for you, please contact us.

func (*Client) PostWordsDelete 

func (a *Client) PostWordsDelete(params *PostWordsDeleteParams, opts ...ClientOption) (*PostWordsDeleteOK, error)

PostWordsDelete removes word from a dictionary

Remove a word from one of the user's personal dictionaries.

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 {
	GetLanguages(params *GetLanguagesParams, opts ...ClientOption) (*GetLanguagesOK, error)

	GetWords(params *GetWordsParams, opts ...ClientOption) (*GetWordsOK, error)

	PostCheck(params *PostCheckParams, opts ...ClientOption) (*PostCheckOK, error)

	PostWordsAdd(params *PostWordsAddParams, opts ...ClientOption) (*PostWordsAddOK, error)

	PostWordsDelete(params *PostWordsDeleteParams, opts ...ClientOption) (*PostWordsDeleteOK, 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 operations API client.

func NewClientWithBasicAuth 

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

New creates a new operations 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 operations 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 GetLanguagesOK 

type GetLanguagesOK struct {
	Payload []*GetLanguagesOKBodyItems0
}

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

An array of language objects.

func NewGetLanguagesOK 

func NewGetLanguagesOK() *GetLanguagesOK

NewGetLanguagesOK creates a GetLanguagesOK with default headers values

func (*GetLanguagesOK) Code 

func (o *GetLanguagesOK) Code() int

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

func (*GetLanguagesOK) Error 

func (o *GetLanguagesOK) Error() string

func (*GetLanguagesOK) GetPayload 

func (o *GetLanguagesOK) GetPayload() []*GetLanguagesOKBodyItems0

func (*GetLanguagesOK) IsClientError 

func (o *GetLanguagesOK) IsClientError() bool

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

func (*GetLanguagesOK) IsCode 

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

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

func (*GetLanguagesOK) IsRedirect 

func (o *GetLanguagesOK) IsRedirect() bool

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

func (*GetLanguagesOK) IsServerError 

func (o *GetLanguagesOK) IsServerError() bool

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

func (*GetLanguagesOK) IsSuccess 

func (o *GetLanguagesOK) IsSuccess() bool

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

func (*GetLanguagesOK) String 

func (o *GetLanguagesOK) String() string

type GetLanguagesOKBodyItems0 

type GetLanguagesOKBodyItems0 struct {

	// a language code like 'en'
	// Required: true
	Code *string `json:"code"`

	// a language code like 'en-US' or 'ca-ES-valencia'
	// Required: true
	LongCode *string `json:"longCode"`

	// a language name like 'French' or 'English (Australia)'
	// Required: true
	Name *string `json:"name"`
}

GetLanguagesOKBodyItems0 get languages o k body items0 swagger:model GetLanguagesOKBodyItems0

func (*GetLanguagesOKBodyItems0) ContextValidate 

func (o *GetLanguagesOKBodyItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this get languages o k body items0 based on context it is used

func (*GetLanguagesOKBodyItems0) MarshalBinary 

func (o *GetLanguagesOKBodyItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetLanguagesOKBodyItems0) UnmarshalBinary 

func (o *GetLanguagesOKBodyItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetLanguagesOKBodyItems0) Validate 

func (o *GetLanguagesOKBodyItems0) Validate(formats strfmt.Registry) error

Validate validates this get languages o k body items0

type GetLanguagesParams 

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

GetLanguagesParams contains all the parameters to send to the API endpoint 

for the get languages operation.

Typically these are written to a http.Request.

func NewGetLanguagesParams 

func NewGetLanguagesParams() *GetLanguagesParams

NewGetLanguagesParams creates a new GetLanguagesParams 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 NewGetLanguagesParamsWithContext 

func NewGetLanguagesParamsWithContext(ctx context.Context) *GetLanguagesParams

NewGetLanguagesParamsWithContext creates a new GetLanguagesParams object with the ability to set a context for a request.

func NewGetLanguagesParamsWithHTTPClient 

func NewGetLanguagesParamsWithHTTPClient(client *http.Client) *GetLanguagesParams

NewGetLanguagesParamsWithHTTPClient creates a new GetLanguagesParams object with the ability to set a custom HTTPClient for a request.

func NewGetLanguagesParamsWithTimeout 

func NewGetLanguagesParamsWithTimeout(timeout time.Duration) *GetLanguagesParams

NewGetLanguagesParamsWithTimeout creates a new GetLanguagesParams object with the ability to set a timeout on a request.

func (*GetLanguagesParams) SetContext 

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

SetContext adds the context to the get languages params

func (*GetLanguagesParams) SetDefaults 

func (o *GetLanguagesParams) SetDefaults()

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

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

func (*GetLanguagesParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get languages params

func (*GetLanguagesParams) SetTimeout 

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

SetTimeout adds the timeout to the get languages params

func (*GetLanguagesParams) WithContext 

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

WithContext adds the context to the get languages params

func (*GetLanguagesParams) WithDefaults 

func (o *GetLanguagesParams) WithDefaults() *GetLanguagesParams

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

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

func (*GetLanguagesParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get languages params

func (*GetLanguagesParams) WithTimeout 

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

WithTimeout adds the timeout to the get languages params

func (*GetLanguagesParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetLanguagesReader 

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

GetLanguagesReader is a Reader for the GetLanguages structure.

func (*GetLanguagesReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetWordsOK 

type GetWordsOK struct {
	Payload *GetWordsOKBody
}

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

the user's words from the given user dictionaries

func NewGetWordsOK 

func NewGetWordsOK() *GetWordsOK

NewGetWordsOK creates a GetWordsOK with default headers values

func (*GetWordsOK) Code 

func (o *GetWordsOK) Code() int

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

func (*GetWordsOK) Error 

func (o *GetWordsOK) Error() string

func (*GetWordsOK) GetPayload 

func (o *GetWordsOK) GetPayload() *GetWordsOKBody

func (*GetWordsOK) IsClientError 

func (o *GetWordsOK) IsClientError() bool

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

func (*GetWordsOK) IsCode 

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

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

func (*GetWordsOK) IsRedirect 

func (o *GetWordsOK) IsRedirect() bool

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

func (*GetWordsOK) IsServerError 

func (o *GetWordsOK) IsServerError() bool

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

func (*GetWordsOK) IsSuccess 

func (o *GetWordsOK) IsSuccess() bool

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

func (*GetWordsOK) String 

func (o *GetWordsOK) String() string

type GetWordsOKBody 

type GetWordsOKBody struct {

	// array of words
	Words []string `json:"words"`
}

GetWordsOKBody get words o k body swagger:model GetWordsOKBody

func (*GetWordsOKBody) ContextValidate 

func (o *GetWordsOKBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this get words o k body based on context it is used

func (*GetWordsOKBody) MarshalBinary 

func (o *GetWordsOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetWordsOKBody) UnmarshalBinary 

func (o *GetWordsOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetWordsOKBody) Validate 

func (o *GetWordsOKBody) Validate(formats strfmt.Registry) error

Validate validates this get words o k body

type GetWordsParams 

type GetWordsParams struct {

	/* APIKey.

	   <a target='_blank' href='https://languagetool.org/editor/settings/access-tokens'>Your API key</a>

	   Format: password
	*/
	APIKey strfmt.Password

	/* Dicts.

	   Comma-separated list of dictionaries to include words from; uses special default dictionary if this is unset
	*/
	Dicts *string

	/* Limit.

	   Maximum number of words to return. Defaults to 10.
	*/
	Limit *int64

	/* Offset.

	   Offset of where to start in the list of words. Defaults to 0.
	*/
	Offset *int64

	/* Username.

	   Your username as used to log in at languagetool.org.
	*/
	Username string

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

GetWordsParams contains all the parameters to send to the API endpoint 

for the get words operation.

Typically these are written to a http.Request.

func NewGetWordsParams 

func NewGetWordsParams() *GetWordsParams

NewGetWordsParams creates a new GetWordsParams 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 NewGetWordsParamsWithContext 

func NewGetWordsParamsWithContext(ctx context.Context) *GetWordsParams

NewGetWordsParamsWithContext creates a new GetWordsParams object with the ability to set a context for a request.

func NewGetWordsParamsWithHTTPClient 

func NewGetWordsParamsWithHTTPClient(client *http.Client) *GetWordsParams

NewGetWordsParamsWithHTTPClient creates a new GetWordsParams object with the ability to set a custom HTTPClient for a request.

func NewGetWordsParamsWithTimeout 

func NewGetWordsParamsWithTimeout(timeout time.Duration) *GetWordsParams

NewGetWordsParamsWithTimeout creates a new GetWordsParams object with the ability to set a timeout on a request.

func (*GetWordsParams) SetAPIKey 

func (o *GetWordsParams) SetAPIKey(aPIKey strfmt.Password)

SetAPIKey adds the apiKey to the get words params

func (*GetWordsParams) SetContext 

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

SetContext adds the context to the get words params

func (*GetWordsParams) SetDefaults 

func (o *GetWordsParams) SetDefaults()

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

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

func (*GetWordsParams) SetDicts 

func (o *GetWordsParams) SetDicts(dicts *string)

SetDicts adds the dicts to the get words params

func (*GetWordsParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get words params

func (*GetWordsParams) SetLimit 

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

SetLimit adds the limit to the get words params

func (*GetWordsParams) SetOffset 

func (o *GetWordsParams) SetOffset(offset *int64)

SetOffset adds the offset to the get words params

func (*GetWordsParams) SetTimeout 

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

SetTimeout adds the timeout to the get words params

func (*GetWordsParams) SetUsername 

func (o *GetWordsParams) SetUsername(username string)

SetUsername adds the username to the get words params

func (*GetWordsParams) WithAPIKey 

func (o *GetWordsParams) WithAPIKey(aPIKey strfmt.Password) *GetWordsParams

WithAPIKey adds the aPIKey to the get words params

func (*GetWordsParams) WithContext 

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

WithContext adds the context to the get words params

func (*GetWordsParams) WithDefaults 

func (o *GetWordsParams) WithDefaults() *GetWordsParams

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

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

func (*GetWordsParams) WithDicts 

func (o *GetWordsParams) WithDicts(dicts *string) *GetWordsParams

WithDicts adds the dicts to the get words params

func (*GetWordsParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get words params

func (*GetWordsParams) WithLimit 

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

WithLimit adds the limit to the get words params

func (*GetWordsParams) WithOffset 

func (o *GetWordsParams) WithOffset(offset *int64) *GetWordsParams

WithOffset adds the offset to the get words params

func (*GetWordsParams) WithTimeout 

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

WithTimeout adds the timeout to the get words params

func (*GetWordsParams) WithUsername 

func (o *GetWordsParams) WithUsername(username string) *GetWordsParams

WithUsername adds the username to the get words params

func (*GetWordsParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetWordsReader 

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

GetWordsReader is a Reader for the GetWords structure.

func (*GetWordsReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type PostCheckOK 

type PostCheckOK struct {
	Payload *PostCheckOKBody
}

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

the result of checking the text

func NewPostCheckOK 

func NewPostCheckOK() *PostCheckOK

NewPostCheckOK creates a PostCheckOK with default headers values

func (*PostCheckOK) Code 

func (o *PostCheckOK) Code() int

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

func (*PostCheckOK) Error 

func (o *PostCheckOK) Error() string

func (*PostCheckOK) GetPayload 

func (o *PostCheckOK) GetPayload() *PostCheckOKBody

func (*PostCheckOK) IsClientError 

func (o *PostCheckOK) IsClientError() bool

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

func (*PostCheckOK) IsCode 

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

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

func (*PostCheckOK) IsRedirect 

func (o *PostCheckOK) IsRedirect() bool

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

func (*PostCheckOK) IsServerError 

func (o *PostCheckOK) IsServerError() bool

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

func (*PostCheckOK) IsSuccess 

func (o *PostCheckOK) IsSuccess() bool

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

func (*PostCheckOK) String 

func (o *PostCheckOK) String() string

type PostCheckOKBody 

type PostCheckOKBody struct {

	// language
	Language *PostCheckOKBodyLanguage `json:"language,omitempty"`

	// matches
	Matches []*PostCheckOKBodyMatchesItems0 `json:"matches"`

	// software
	Software *PostCheckOKBodySoftware `json:"software,omitempty"`
}

PostCheckOKBody post check o k body swagger:model PostCheckOKBody

func (*PostCheckOKBody) ContextValidate 

func (o *PostCheckOKBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this post check o k body based on the context it is used

func (*PostCheckOKBody) MarshalBinary 

func (o *PostCheckOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostCheckOKBody) UnmarshalBinary 

func (o *PostCheckOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostCheckOKBody) Validate 

func (o *PostCheckOKBody) Validate(formats strfmt.Registry) error

Validate validates this post check o k body

type PostCheckOKBodyLanguage 

type PostCheckOKBodyLanguage struct {

	// ISO 639-1 code like 'en', 'en-US', or 'ca-ES-valencia'
	// Required: true
	Code *string `json:"code"`

	// detected language
	// Required: true
	DetectedLanguage *PostCheckOKBodyLanguageDetectedLanguage `json:"detectedLanguage"`

	// Language name like 'French' or 'English (US)'.
	// Required: true
	Name *string `json:"name"`
}

PostCheckOKBodyLanguage The language used for checking the text. swagger:model PostCheckOKBodyLanguage

func (*PostCheckOKBodyLanguage) ContextValidate 

func (o *PostCheckOKBodyLanguage) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this post check o k body language based on the context it is used

func (*PostCheckOKBodyLanguage) MarshalBinary 

func (o *PostCheckOKBodyLanguage) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostCheckOKBodyLanguage) UnmarshalBinary 

func (o *PostCheckOKBodyLanguage) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostCheckOKBodyLanguage) Validate 

func (o *PostCheckOKBodyLanguage) Validate(formats strfmt.Registry) error

Validate validates this post check o k body language

type PostCheckOKBodyLanguageDetectedLanguage 

type PostCheckOKBodyLanguageDetectedLanguage struct {

	// ISO 639-1 code like 'en', 'en-US', or 'ca-ES-valencia'.
	// Required: true
	Code *string `json:"code"`

	// Language name like 'French' or 'English (US)'.
	// Required: true
	Name *string `json:"name"`
}

PostCheckOKBodyLanguageDetectedLanguage The automatically detected text language (might be different from the language actually used for checking). swagger:model PostCheckOKBodyLanguageDetectedLanguage

func (*PostCheckOKBodyLanguageDetectedLanguage) ContextValidate 

func (o *PostCheckOKBodyLanguageDetectedLanguage) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post check o k body language detected language based on context it is used

func (*PostCheckOKBodyLanguageDetectedLanguage) MarshalBinary 

func (o *PostCheckOKBodyLanguageDetectedLanguage) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostCheckOKBodyLanguageDetectedLanguage) UnmarshalBinary 

func (o *PostCheckOKBodyLanguageDetectedLanguage) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostCheckOKBodyLanguageDetectedLanguage) Validate 

func (o *PostCheckOKBodyLanguageDetectedLanguage) Validate(formats strfmt.Registry) error

Validate validates this post check o k body language detected language

type PostCheckOKBodyMatchesItems0 

type PostCheckOKBodyMatchesItems0 struct {

	// context
	// Required: true
	Context *PostCheckOKBodyMatchesItems0Context `json:"context"`

	// The length of the error in characters.
	// Required: true
	Length *int64 `json:"length"`

	// Message about the error displayed to the user.
	// Required: true
	Message *string `json:"message"`

	// The 0-based character offset of the error in the text.
	// Required: true
	Offset *int64 `json:"offset"`

	// Replacements that might correct the error. The array can be empty, in this case there is no suggested replacement.
	// Required: true
	Replacements []*PostCheckOKBodyMatchesItems0ReplacementsItems0 `json:"replacements"`

	// rule
	Rule *PostCheckOKBodyMatchesItems0Rule `json:"rule,omitempty"`

	// The sentence the error occurred in (since LanguageTool 4.0 or later)
	// Required: true
	Sentence *string `json:"sentence"`

	// An optional shorter version of 'message'.
	ShortMessage string `json:"shortMessage,omitempty"`
}

PostCheckOKBodyMatchesItems0 post check o k body matches items0 swagger:model PostCheckOKBodyMatchesItems0

func (*PostCheckOKBodyMatchesItems0) ContextValidate 

func (o *PostCheckOKBodyMatchesItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this post check o k body matches items0 based on the context it is used

func (*PostCheckOKBodyMatchesItems0) MarshalBinary 

func (o *PostCheckOKBodyMatchesItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostCheckOKBodyMatchesItems0) UnmarshalBinary 

func (o *PostCheckOKBodyMatchesItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostCheckOKBodyMatchesItems0) Validate 

func (o *PostCheckOKBodyMatchesItems0) Validate(formats strfmt.Registry) error

Validate validates this post check o k body matches items0

type PostCheckOKBodyMatchesItems0Context 

type PostCheckOKBodyMatchesItems0Context struct {

	// The length of the error in characters in the context.
	// Required: true
	Length *int64 `json:"length"`

	// The 0-based character offset of the error in the context text.
	// Required: true
	Offset *int64 `json:"offset"`

	// Context of the error, i.e. the error and some text to the left and to the left.
	// Required: true
	Text *string `json:"text"`
}

PostCheckOKBodyMatchesItems0Context post check o k body matches items0 context swagger:model PostCheckOKBodyMatchesItems0Context

func (*PostCheckOKBodyMatchesItems0Context) ContextValidate 

func (o *PostCheckOKBodyMatchesItems0Context) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post check o k body matches items0 context based on context it is used

func (*PostCheckOKBodyMatchesItems0Context) MarshalBinary 

func (o *PostCheckOKBodyMatchesItems0Context) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostCheckOKBodyMatchesItems0Context) UnmarshalBinary 

func (o *PostCheckOKBodyMatchesItems0Context) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostCheckOKBodyMatchesItems0Context) Validate 

func (o *PostCheckOKBodyMatchesItems0Context) Validate(formats strfmt.Registry) error

Validate validates this post check o k body matches items0 context

type PostCheckOKBodyMatchesItems0ReplacementsItems0 

type PostCheckOKBodyMatchesItems0ReplacementsItems0 struct {

	// the replacement string
	Value string `json:"value,omitempty"`
}

PostCheckOKBodyMatchesItems0ReplacementsItems0 post check o k body matches items0 replacements items0 swagger:model PostCheckOKBodyMatchesItems0ReplacementsItems0

func (*PostCheckOKBodyMatchesItems0ReplacementsItems0) ContextValidate 

func (o *PostCheckOKBodyMatchesItems0ReplacementsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post check o k body matches items0 replacements items0 based on context it is used

func (*PostCheckOKBodyMatchesItems0ReplacementsItems0) MarshalBinary 

func (o *PostCheckOKBodyMatchesItems0ReplacementsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostCheckOKBodyMatchesItems0ReplacementsItems0) UnmarshalBinary 

func (o *PostCheckOKBodyMatchesItems0ReplacementsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostCheckOKBodyMatchesItems0ReplacementsItems0) Validate 

func (o *PostCheckOKBodyMatchesItems0ReplacementsItems0) Validate(formats strfmt.Registry) error

Validate validates this post check o k body matches items0 replacements items0

type PostCheckOKBodyMatchesItems0Rule 

type PostCheckOKBodyMatchesItems0Rule struct {

	// category
	// Required: true
	Category *PostCheckOKBodyMatchesItems0RuleCategory `json:"category"`

	// description
	// Required: true
	Description *string `json:"description"`

	// An rule's identifier that's unique for this language.
	// Required: true
	ID *string `json:"id"`

	// The <a href="http://www.w3.org/International/multilingualweb/lt/drafts/its20/its20.html#lqissue-typevalues">Localization Quality Issue Type</a>. This is not defined for all languages, in which case it will always be 'Uncategorized'.
	IssueType string `json:"issueType,omitempty"`

	// An optional sub identifier of the rule, used when several rules are grouped.
	SubID string `json:"subId,omitempty"`

	// An optional array of URLs with a more detailed description of the error.
	Urls []*PostCheckOKBodyMatchesItems0RuleUrlsItems0 `json:"urls"`
}

PostCheckOKBodyMatchesItems0Rule post check o k body matches items0 rule swagger:model PostCheckOKBodyMatchesItems0Rule

func (*PostCheckOKBodyMatchesItems0Rule) ContextValidate 

func (o *PostCheckOKBodyMatchesItems0Rule) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this post check o k body matches items0 rule based on the context it is used

func (*PostCheckOKBodyMatchesItems0Rule) MarshalBinary 

func (o *PostCheckOKBodyMatchesItems0Rule) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostCheckOKBodyMatchesItems0Rule) UnmarshalBinary 

func (o *PostCheckOKBodyMatchesItems0Rule) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostCheckOKBodyMatchesItems0Rule) Validate 

func (o *PostCheckOKBodyMatchesItems0Rule) Validate(formats strfmt.Registry) error

Validate validates this post check o k body matches items0 rule

type PostCheckOKBodyMatchesItems0RuleCategory 

type PostCheckOKBodyMatchesItems0RuleCategory struct {

	// A category's identifier that's unique for this language.
	ID string `json:"id,omitempty"`

	// A short description of the category.
	Name string `json:"name,omitempty"`
}

PostCheckOKBodyMatchesItems0RuleCategory post check o k body matches items0 rule category swagger:model PostCheckOKBodyMatchesItems0RuleCategory

func (*PostCheckOKBodyMatchesItems0RuleCategory) ContextValidate 

func (o *PostCheckOKBodyMatchesItems0RuleCategory) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post check o k body matches items0 rule category based on context it is used

func (*PostCheckOKBodyMatchesItems0RuleCategory) MarshalBinary 

func (o *PostCheckOKBodyMatchesItems0RuleCategory) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostCheckOKBodyMatchesItems0RuleCategory) UnmarshalBinary 

func (o *PostCheckOKBodyMatchesItems0RuleCategory) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostCheckOKBodyMatchesItems0RuleCategory) Validate 

func (o *PostCheckOKBodyMatchesItems0RuleCategory) Validate(formats strfmt.Registry) error

Validate validates this post check o k body matches items0 rule category

type PostCheckOKBodyMatchesItems0RuleUrlsItems0 

type PostCheckOKBodyMatchesItems0RuleUrlsItems0 struct {

	// the URL
	Value string `json:"value,omitempty"`
}

PostCheckOKBodyMatchesItems0RuleUrlsItems0 post check o k body matches items0 rule urls items0 swagger:model PostCheckOKBodyMatchesItems0RuleUrlsItems0

func (*PostCheckOKBodyMatchesItems0RuleUrlsItems0) ContextValidate 

func (o *PostCheckOKBodyMatchesItems0RuleUrlsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post check o k body matches items0 rule urls items0 based on context it is used

func (*PostCheckOKBodyMatchesItems0RuleUrlsItems0) MarshalBinary 

func (o *PostCheckOKBodyMatchesItems0RuleUrlsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostCheckOKBodyMatchesItems0RuleUrlsItems0) UnmarshalBinary 

func (o *PostCheckOKBodyMatchesItems0RuleUrlsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostCheckOKBodyMatchesItems0RuleUrlsItems0) Validate 

func (o *PostCheckOKBodyMatchesItems0RuleUrlsItems0) Validate(formats strfmt.Registry) error

Validate validates this post check o k body matches items0 rule urls items0

type PostCheckOKBodySoftware 

type PostCheckOKBodySoftware struct {

	// Version of this API response. We don't expect to make incompatible changes, so this can also be increased for newly added fields.
	// Required: true
	APIVersion *int64 `json:"apiVersion"`

	// Date when the software was built, e.g. '2016-05-25'.
	// Required: true
	BuildDate *string `json:"buildDate"`

	// Usually 'LanguageTool'.
	// Required: true
	Name *string `json:"name"`

	// true if you're using a Premium account with all the premium text checks (since LanguageTool 4.2)
	Premium bool `json:"premium,omitempty"`

	// An optional warning, e.g. when the API format is not stable.
	Status string `json:"status,omitempty"`

	// A version string like '3.3' or '3.4-SNAPSHOT'.
	// Required: true
	Version *string `json:"version"`
}

PostCheckOKBodySoftware post check o k body software swagger:model PostCheckOKBodySoftware

func (*PostCheckOKBodySoftware) ContextValidate 

func (o *PostCheckOKBodySoftware) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post check o k body software based on context it is used

func (*PostCheckOKBodySoftware) MarshalBinary 

func (o *PostCheckOKBodySoftware) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostCheckOKBodySoftware) UnmarshalBinary 

func (o *PostCheckOKBodySoftware) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostCheckOKBodySoftware) Validate 

func (o *PostCheckOKBodySoftware) Validate(formats strfmt.Registry) error

Validate validates this post check o k body software

type PostCheckParams 

type PostCheckParams struct {

	/* APIKey.

	   Set to get Premium API access: <a target='_blank' href='https://languagetool.org/editor/settings/access-tokens'>your API key</a>

	   Format: password
	*/
	APIKey *strfmt.Password

	/* Data.

	     The text to be checked, given as a JSON document that specifies what's text and what's markup. This or 'text' is required. Markup will be ignored when looking for errors. Example text: <pre>A &lt;b>test&lt;/b></pre>JSON for the example text: <pre>{"annotation":[
	 {"text": "A "},
	 {"markup": "&lt;b>"},
	 {"text": "test"},
	 {"markup": "&lt;/b>"}
	]}</pre> <p>If you have markup that should be interpreted as whitespace, like <tt>&lt;p&gt;</tt> in HTML, you can have it interpreted like this: <pre>{"markup": "&lt;p&gt;", "interpretAs": "\n\n"}</pre><p>The 'data' feature is not limited to HTML or XML, it can be used for any kind of markup. Entities will need to be expanded in this input.
	*/
	Data *string

	/* Dicts.

	   Comma-separated list of dictionaries to include words from; uses special default dictionary if this is unset
	*/
	Dicts *string

	/* DisabledCategories.

	   IDs of categories to be disabled, comma-separated
	*/
	DisabledCategories *string

	/* DisabledRules.

	   IDs of rules to be disabled, comma-separated
	*/
	DisabledRules *string

	/* EnabledCategories.

	   IDs of categories to be enabled, comma-separated
	*/
	EnabledCategories *string

	/* EnabledOnly.

	   If true, only the rules and categories whose IDs are specified with `enabledRules` or `enabledCategories` are enabled.
	*/
	EnabledOnly *bool

	/* EnabledRules.

	   IDs of rules to be enabled, comma-separated. Note that 'level' still applies, so the rule won't run unless 'level' is set to a level that activates the rule.
	*/
	EnabledRules *string

	/* Language.

	   A language code like `en-US`, `de-DE`, `fr`, or `auto` to guess the language automatically (see `preferredVariants` below). For languages with variants (English, German, Portuguese) spell checking will only be activated when you specify the variant, e.g. `en-GB` instead of just `en`.
	*/
	Language string

	/* Level.

	   If set to `picky`, additional rules will be activated, i.e. rules that you might only find useful when checking formal text.
	*/
	Level *string

	/* MotherTongue.

	   A language code of the user's native language, enabling false friends checks for some language pairs.
	*/
	MotherTongue *string

	/* PreferredVariants.

	   Comma-separated list of preferred language variants. The language detector used with `language=auto` can detect e.g. English, but it cannot decide whether British English or American English is used. Thus this parameter can be used to specify the preferred variants like `en-GB` and `de-AT`. Only available with `language=auto`. You should set variants for at least German and English, as otherwise the spell checking will not work for those, as no spelling dictionary can be selected for just `en` or `de`.
	*/
	PreferredVariants *string

	/* Text.

	   The text to be checked. This or 'data' is required.
	*/
	Text *string

	/* Username.

	   Set to get Premium API access: Your username/email as used to log in at languagetool.org.
	*/
	Username *string

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

PostCheckParams contains all the parameters to send to the API endpoint 

for the post check operation.

Typically these are written to a http.Request.

func NewPostCheckParams 

func NewPostCheckParams() *PostCheckParams

NewPostCheckParams creates a new PostCheckParams 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 NewPostCheckParamsWithContext 

func NewPostCheckParamsWithContext(ctx context.Context) *PostCheckParams

NewPostCheckParamsWithContext creates a new PostCheckParams object with the ability to set a context for a request.

func NewPostCheckParamsWithHTTPClient 

func NewPostCheckParamsWithHTTPClient(client *http.Client) *PostCheckParams

NewPostCheckParamsWithHTTPClient creates a new PostCheckParams object with the ability to set a custom HTTPClient for a request.

func NewPostCheckParamsWithTimeout 

func NewPostCheckParamsWithTimeout(timeout time.Duration) *PostCheckParams

NewPostCheckParamsWithTimeout creates a new PostCheckParams object with the ability to set a timeout on a request.

func (*PostCheckParams) SetAPIKey 

func (o *PostCheckParams) SetAPIKey(aPIKey *strfmt.Password)

SetAPIKey adds the apiKey to the post check params

func (*PostCheckParams) SetContext 

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

SetContext adds the context to the post check params

func (*PostCheckParams) SetData 

func (o *PostCheckParams) SetData(data *string)

SetData adds the data to the post check params

func (*PostCheckParams) SetDefaults 

func (o *PostCheckParams) SetDefaults()

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

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

func (*PostCheckParams) SetDicts 

func (o *PostCheckParams) SetDicts(dicts *string)

SetDicts adds the dicts to the post check params

func (*PostCheckParams) SetDisabledCategories 

func (o *PostCheckParams) SetDisabledCategories(disabledCategories *string)

SetDisabledCategories adds the disabledCategories to the post check params

func (*PostCheckParams) SetDisabledRules 

func (o *PostCheckParams) SetDisabledRules(disabledRules *string)

SetDisabledRules adds the disabledRules to the post check params

func (*PostCheckParams) SetEnabledCategories 

func (o *PostCheckParams) SetEnabledCategories(enabledCategories *string)

SetEnabledCategories adds the enabledCategories to the post check params

func (*PostCheckParams) SetEnabledOnly 

func (o *PostCheckParams) SetEnabledOnly(enabledOnly *bool)

SetEnabledOnly adds the enabledOnly to the post check params

func (*PostCheckParams) SetEnabledRules 

func (o *PostCheckParams) SetEnabledRules(enabledRules *string)

SetEnabledRules adds the enabledRules to the post check params

func (*PostCheckParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the post check params

func (*PostCheckParams) SetLanguage 

func (o *PostCheckParams) SetLanguage(language string)

SetLanguage adds the language to the post check params

func (*PostCheckParams) SetLevel 

func (o *PostCheckParams) SetLevel(level *string)

SetLevel adds the level to the post check params

func (*PostCheckParams) SetMotherTongue 

func (o *PostCheckParams) SetMotherTongue(motherTongue *string)

SetMotherTongue adds the motherTongue to the post check params

func (*PostCheckParams) SetPreferredVariants 

func (o *PostCheckParams) SetPreferredVariants(preferredVariants *string)

SetPreferredVariants adds the preferredVariants to the post check params

func (*PostCheckParams) SetText 

func (o *PostCheckParams) SetText(text *string)

SetText adds the text to the post check params

func (*PostCheckParams) SetTimeout 

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

SetTimeout adds the timeout to the post check params

func (*PostCheckParams) SetUsername 

func (o *PostCheckParams) SetUsername(username *string)

SetUsername adds the username to the post check params

func (*PostCheckParams) WithAPIKey 

func (o *PostCheckParams) WithAPIKey(aPIKey *strfmt.Password) *PostCheckParams

WithAPIKey adds the aPIKey to the post check params

func (*PostCheckParams) WithContext 

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

WithContext adds the context to the post check params

func (*PostCheckParams) WithData 

func (o *PostCheckParams) WithData(data *string) *PostCheckParams

WithData adds the data to the post check params

func (*PostCheckParams) WithDefaults 

func (o *PostCheckParams) WithDefaults() *PostCheckParams

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

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

func (*PostCheckParams) WithDicts 

func (o *PostCheckParams) WithDicts(dicts *string) *PostCheckParams

WithDicts adds the dicts to the post check params

func (*PostCheckParams) WithDisabledCategories 

func (o *PostCheckParams) WithDisabledCategories(disabledCategories *string) *PostCheckParams

WithDisabledCategories adds the disabledCategories to the post check params

func (*PostCheckParams) WithDisabledRules 

func (o *PostCheckParams) WithDisabledRules(disabledRules *string) *PostCheckParams

WithDisabledRules adds the disabledRules to the post check params

func (*PostCheckParams) WithEnabledCategories 

func (o *PostCheckParams) WithEnabledCategories(enabledCategories *string) *PostCheckParams

WithEnabledCategories adds the enabledCategories to the post check params

func (*PostCheckParams) WithEnabledOnly 

func (o *PostCheckParams) WithEnabledOnly(enabledOnly *bool) *PostCheckParams

WithEnabledOnly adds the enabledOnly to the post check params

func (*PostCheckParams) WithEnabledRules 

func (o *PostCheckParams) WithEnabledRules(enabledRules *string) *PostCheckParams

WithEnabledRules adds the enabledRules to the post check params

func (*PostCheckParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the post check params

func (*PostCheckParams) WithLanguage 

func (o *PostCheckParams) WithLanguage(language string) *PostCheckParams

WithLanguage adds the language to the post check params

func (*PostCheckParams) WithLevel 

func (o *PostCheckParams) WithLevel(level *string) *PostCheckParams

WithLevel adds the level to the post check params

func (*PostCheckParams) WithMotherTongue 

func (o *PostCheckParams) WithMotherTongue(motherTongue *string) *PostCheckParams

WithMotherTongue adds the motherTongue to the post check params

func (*PostCheckParams) WithPreferredVariants 

func (o *PostCheckParams) WithPreferredVariants(preferredVariants *string) *PostCheckParams

WithPreferredVariants adds the preferredVariants to the post check params

func (*PostCheckParams) WithText 

func (o *PostCheckParams) WithText(text *string) *PostCheckParams

WithText adds the text to the post check params

func (*PostCheckParams) WithTimeout 

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

WithTimeout adds the timeout to the post check params

func (*PostCheckParams) WithUsername 

func (o *PostCheckParams) WithUsername(username *string) *PostCheckParams

WithUsername adds the username to the post check params

func (*PostCheckParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type PostCheckReader 

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

PostCheckReader is a Reader for the PostCheck structure.

func (*PostCheckReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type PostWordsAddOK 

type PostWordsAddOK struct {
	Payload *PostWordsAddOKBody
}

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

the result of adding the word

func NewPostWordsAddOK 

func NewPostWordsAddOK() *PostWordsAddOK

NewPostWordsAddOK creates a PostWordsAddOK with default headers values

func (*PostWordsAddOK) Code 

func (o *PostWordsAddOK) Code() int

Code gets the status code for the post words add o k response

func (*PostWordsAddOK) Error 

func (o *PostWordsAddOK) Error() string

func (*PostWordsAddOK) GetPayload 

func (o *PostWordsAddOK) GetPayload() *PostWordsAddOKBody

func (*PostWordsAddOK) IsClientError 

func (o *PostWordsAddOK) IsClientError() bool

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

func (*PostWordsAddOK) IsCode 

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

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

func (*PostWordsAddOK) IsRedirect 

func (o *PostWordsAddOK) IsRedirect() bool

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

func (*PostWordsAddOK) IsServerError 

func (o *PostWordsAddOK) IsServerError() bool

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

func (*PostWordsAddOK) IsSuccess 

func (o *PostWordsAddOK) IsSuccess() bool

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

func (*PostWordsAddOK) String 

func (o *PostWordsAddOK) String() string

type PostWordsAddOKBody 

type PostWordsAddOKBody struct {

	// true if the word has been added. false means the word hasn't been added because it had been added before.
	Added bool `json:"added,omitempty"`
}

PostWordsAddOKBody post words add o k body swagger:model PostWordsAddOKBody

func (*PostWordsAddOKBody) ContextValidate 

func (o *PostWordsAddOKBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post words add o k body based on context it is used

func (*PostWordsAddOKBody) MarshalBinary 

func (o *PostWordsAddOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostWordsAddOKBody) UnmarshalBinary 

func (o *PostWordsAddOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostWordsAddOKBody) Validate 

func (o *PostWordsAddOKBody) Validate(formats strfmt.Registry) error

Validate validates this post words add o k body

type PostWordsAddParams 

type PostWordsAddParams struct {

	/* APIKey.

	   <a target='_blank' href='https://languagetool.org/editor/settings/access-tokens'>Your API key</a>

	   Format: password
	*/
	APIKey strfmt.Password

	/* Dict.

	   Name of the dictionary to add the word to; non-existent dictionaries are created after calling this; if unset, adds to special default dictionary
	*/
	Dict *string

	/* Username.

	   Your username as used to log in at languagetool.org.
	*/
	Username string

	/* Word.

	   The word to be added. Must not be a phrase, i.e. cannot contain white space. The word is added to a global dictionary that applies to all languages.
	*/
	Word string

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

PostWordsAddParams contains all the parameters to send to the API endpoint 

for the post words add operation.

Typically these are written to a http.Request.

func NewPostWordsAddParams 

func NewPostWordsAddParams() *PostWordsAddParams

NewPostWordsAddParams creates a new PostWordsAddParams 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 NewPostWordsAddParamsWithContext 

func NewPostWordsAddParamsWithContext(ctx context.Context) *PostWordsAddParams

NewPostWordsAddParamsWithContext creates a new PostWordsAddParams object with the ability to set a context for a request.

func NewPostWordsAddParamsWithHTTPClient 

func NewPostWordsAddParamsWithHTTPClient(client *http.Client) *PostWordsAddParams

NewPostWordsAddParamsWithHTTPClient creates a new PostWordsAddParams object with the ability to set a custom HTTPClient for a request.

func NewPostWordsAddParamsWithTimeout 

func NewPostWordsAddParamsWithTimeout(timeout time.Duration) *PostWordsAddParams

NewPostWordsAddParamsWithTimeout creates a new PostWordsAddParams object with the ability to set a timeout on a request.

func (*PostWordsAddParams) SetAPIKey 

func (o *PostWordsAddParams) SetAPIKey(aPIKey strfmt.Password)

SetAPIKey adds the apiKey to the post words add params

func (*PostWordsAddParams) SetContext 

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

SetContext adds the context to the post words add params

func (*PostWordsAddParams) SetDefaults 

func (o *PostWordsAddParams) SetDefaults()

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

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

func (*PostWordsAddParams) SetDict 

func (o *PostWordsAddParams) SetDict(dict *string)

SetDict adds the dict to the post words add params

func (*PostWordsAddParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the post words add params

func (*PostWordsAddParams) SetTimeout 

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

SetTimeout adds the timeout to the post words add params

func (*PostWordsAddParams) SetUsername 

func (o *PostWordsAddParams) SetUsername(username string)

SetUsername adds the username to the post words add params

func (*PostWordsAddParams) SetWord 

func (o *PostWordsAddParams) SetWord(word string)

SetWord adds the word to the post words add params

func (*PostWordsAddParams) WithAPIKey 

func (o *PostWordsAddParams) WithAPIKey(aPIKey strfmt.Password) *PostWordsAddParams

WithAPIKey adds the aPIKey to the post words add params

func (*PostWordsAddParams) WithContext 

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

WithContext adds the context to the post words add params

func (*PostWordsAddParams) WithDefaults 

func (o *PostWordsAddParams) WithDefaults() *PostWordsAddParams

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

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

func (*PostWordsAddParams) WithDict 

func (o *PostWordsAddParams) WithDict(dict *string) *PostWordsAddParams

WithDict adds the dict to the post words add params

func (*PostWordsAddParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the post words add params

func (*PostWordsAddParams) WithTimeout 

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

WithTimeout adds the timeout to the post words add params

func (*PostWordsAddParams) WithUsername 

func (o *PostWordsAddParams) WithUsername(username string) *PostWordsAddParams

WithUsername adds the username to the post words add params

func (*PostWordsAddParams) WithWord 

func (o *PostWordsAddParams) WithWord(word string) *PostWordsAddParams

WithWord adds the word to the post words add params

func (*PostWordsAddParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type PostWordsAddReader 

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

PostWordsAddReader is a Reader for the PostWordsAdd structure.

func (*PostWordsAddReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type PostWordsDeleteOK 

type PostWordsDeleteOK struct {
	Payload *PostWordsDeleteOKBody
}

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

the result of removing the word

func NewPostWordsDeleteOK 

func NewPostWordsDeleteOK() *PostWordsDeleteOK

NewPostWordsDeleteOK creates a PostWordsDeleteOK with default headers values

func (*PostWordsDeleteOK) Code 

func (o *PostWordsDeleteOK) Code() int

Code gets the status code for the post words delete o k response

func (*PostWordsDeleteOK) Error 

func (o *PostWordsDeleteOK) Error() string

func (*PostWordsDeleteOK) GetPayload 

func (o *PostWordsDeleteOK) GetPayload() *PostWordsDeleteOKBody

func (*PostWordsDeleteOK) IsClientError 

func (o *PostWordsDeleteOK) IsClientError() bool

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

func (*PostWordsDeleteOK) IsCode 

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

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

func (*PostWordsDeleteOK) IsRedirect 

func (o *PostWordsDeleteOK) IsRedirect() bool

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

func (*PostWordsDeleteOK) IsServerError 

func (o *PostWordsDeleteOK) IsServerError() bool

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

func (*PostWordsDeleteOK) IsSuccess 

func (o *PostWordsDeleteOK) IsSuccess() bool

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

func (*PostWordsDeleteOK) String 

func (o *PostWordsDeleteOK) String() string

type PostWordsDeleteOKBody 

type PostWordsDeleteOKBody struct {

	// true if the word has been removed. false means the word hasn't been removed because it was not in the dictionary.
	Deleted bool `json:"deleted,omitempty"`
}

PostWordsDeleteOKBody post words delete o k body swagger:model PostWordsDeleteOKBody

func (*PostWordsDeleteOKBody) ContextValidate 

func (o *PostWordsDeleteOKBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post words delete o k body based on context it is used

func (*PostWordsDeleteOKBody) MarshalBinary 

func (o *PostWordsDeleteOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostWordsDeleteOKBody) UnmarshalBinary 

func (o *PostWordsDeleteOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostWordsDeleteOKBody) Validate 

func (o *PostWordsDeleteOKBody) Validate(formats strfmt.Registry) error

Validate validates this post words delete o k body

type PostWordsDeleteParams 

type PostWordsDeleteParams struct {

	/* APIKey.

	   <a target='_blank' href='https://languagetool.org/editor/settings/access-tokens'>Your API key</a>

	   Format: password
	*/
	APIKey strfmt.Password

	/* Dict.

	   Name of the dictionary to remove the word from; if the dictionary is empty upon calling this, it is deleted; if unset, removes from special default dictionary
	*/
	Dict *string

	/* Username.

	   Your username as used to log in at languagetool.org.
	*/
	Username string

	/* Word.

	   The word to be removed.
	*/
	Word string

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

PostWordsDeleteParams contains all the parameters to send to the API endpoint 

for the post words delete operation.

Typically these are written to a http.Request.

func NewPostWordsDeleteParams 

func NewPostWordsDeleteParams() *PostWordsDeleteParams

NewPostWordsDeleteParams creates a new PostWordsDeleteParams 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 NewPostWordsDeleteParamsWithContext 

func NewPostWordsDeleteParamsWithContext(ctx context.Context) *PostWordsDeleteParams

NewPostWordsDeleteParamsWithContext creates a new PostWordsDeleteParams object with the ability to set a context for a request.

func NewPostWordsDeleteParamsWithHTTPClient 

func NewPostWordsDeleteParamsWithHTTPClient(client *http.Client) *PostWordsDeleteParams

NewPostWordsDeleteParamsWithHTTPClient creates a new PostWordsDeleteParams object with the ability to set a custom HTTPClient for a request.

func NewPostWordsDeleteParamsWithTimeout 

func NewPostWordsDeleteParamsWithTimeout(timeout time.Duration) *PostWordsDeleteParams

NewPostWordsDeleteParamsWithTimeout creates a new PostWordsDeleteParams object with the ability to set a timeout on a request.

func (*PostWordsDeleteParams) SetAPIKey 

func (o *PostWordsDeleteParams) SetAPIKey(aPIKey strfmt.Password)

SetAPIKey adds the apiKey to the post words delete params

func (*PostWordsDeleteParams) SetContext 

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

SetContext adds the context to the post words delete params

func (*PostWordsDeleteParams) SetDefaults 

func (o *PostWordsDeleteParams) SetDefaults()

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

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

func (*PostWordsDeleteParams) SetDict 

func (o *PostWordsDeleteParams) SetDict(dict *string)

SetDict adds the dict to the post words delete params

func (*PostWordsDeleteParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the post words delete params

func (*PostWordsDeleteParams) SetTimeout 

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

SetTimeout adds the timeout to the post words delete params

func (*PostWordsDeleteParams) SetUsername 

func (o *PostWordsDeleteParams) SetUsername(username string)

SetUsername adds the username to the post words delete params

func (*PostWordsDeleteParams) SetWord 

func (o *PostWordsDeleteParams) SetWord(word string)

SetWord adds the word to the post words delete params

func (*PostWordsDeleteParams) WithAPIKey 

func (o *PostWordsDeleteParams) WithAPIKey(aPIKey strfmt.Password) *PostWordsDeleteParams

WithAPIKey adds the aPIKey to the post words delete params

func (*PostWordsDeleteParams) WithContext 

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

WithContext adds the context to the post words delete params

func (*PostWordsDeleteParams) WithDefaults 

func (o *PostWordsDeleteParams) WithDefaults() *PostWordsDeleteParams

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

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

func (*PostWordsDeleteParams) WithDict 

func (o *PostWordsDeleteParams) WithDict(dict *string) *PostWordsDeleteParams

WithDict adds the dict to the post words delete params

func (*PostWordsDeleteParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the post words delete params

func (*PostWordsDeleteParams) WithTimeout 

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

WithTimeout adds the timeout to the post words delete params

func (*PostWordsDeleteParams) WithUsername 

func (o *PostWordsDeleteParams) WithUsername(username string) *PostWordsDeleteParams

WithUsername adds the username to the post words delete params

func (*PostWordsDeleteParams) WithWord 

func (o *PostWordsDeleteParams) WithWord(word string) *PostWordsDeleteParams

WithWord adds the word to the post words delete params

func (*PostWordsDeleteParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type PostWordsDeleteReader 

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

PostWordsDeleteReader is a Reader for the PostWordsDelete structure.

func (*PostWordsDeleteReader) ReadResponse 

func (o *PostWordsDeleteReader) 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.