client

package
v3.4.0 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2023 License: GPL-3.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateFeedPath 

func CreateFeedPath() string

CreateFeedPath computes a request path to the create action of feed.

func CreateFilterOutputPath 

func CreateFilterOutputPath(id string) string

CreateFilterOutputPath computes a request path to the createFilter action of output.

func CreateOutputPath 

func CreateOutputPath() string

CreateOutputPath computes a request path to the create action of output.

func DeleteFeedPath 

func DeleteFeedPath(id string) string

DeleteFeedPath computes a request path to the delete action of feed.

func DeleteFilterOutputPath 

func DeleteFilterOutputPath(id string, idFilter string) string

DeleteFilterOutputPath computes a request path to the deleteFilter action of output.

func DeleteOutputPath 

func DeleteOutputPath(id string) string

DeleteOutputPath computes a request path to the delete action of output.

func GetExplorePath 

func GetExplorePath() string

GetExplorePath computes a request path to the get action of explore.

func GetFeedPath 

func GetFeedPath(id string) string

GetFeedPath computes a request path to the get action of feed.

func GetHealthPath 

func GetHealthPath() string

GetHealthPath computes a request path to the get action of health.

func GetIndexPath 

func GetIndexPath() string

GetIndexPath computes a request path to the get action of index.

func GetOpmlPath 

func GetOpmlPath() string

GetOpmlPath computes a request path to the get action of opml.

func GetOutputPath 

func GetOutputPath(id string) string

GetOutputPath computes a request path to the get action of output.

func GetSwaggerPath 

func GetSwaggerPath() string

GetSwaggerPath computes a request path to the get action of swagger.

func GetVarsPath 

func GetVarsPath() string

GetVarsPath computes a request path to the get action of vars.

func ListFeedPath 

func ListFeedPath() string

ListFeedPath computes a request path to the list action of feed.

func ListOutputPath 

func ListOutputPath() string

ListOutputPath computes a request path to the list action of output.

func PubPshbPath 

func PubPshbPath() string

PubPshbPath computes a request path to the pub action of pshb.

func SpecsFilterPath 

func SpecsFilterPath() string

SpecsFilterPath computes a request path to the specs action of filter.

func SpecsOutputPath 

func SpecsOutputPath() string

SpecsOutputPath computes a request path to the specs action of output.

func StartFeedPath 

func StartFeedPath(id string) string

StartFeedPath computes a request path to the start action of feed.

func StatusOpmlPath 

func StatusOpmlPath(id int) string

StatusOpmlPath computes a request path to the status action of opml.

func StopFeedPath 

func StopFeedPath(id string) string

StopFeedPath computes a request path to the stop action of feed.

func SubPshbPath 

func SubPshbPath() string

SubPshbPath computes a request path to the sub action of pshb.

func UpdateFeedPath 

func UpdateFeedPath(id string) string

UpdateFeedPath computes a request path to the update action of feed.

func UpdateFilterOutputPath 

func UpdateFilterOutputPath(id string, idFilter string) string

UpdateFilterOutputPath computes a request path to the updateFilter action of output.

func UpdateOutputPath 

func UpdateOutputPath(id string) string

UpdateOutputPath computes a request path to the update action of output.

func UploadOpmlPath 

func UploadOpmlPath() string

UploadOpmlPath computes a request path to the upload action of opml.

Types

type Client 

type Client struct {
	*goaclient.Client
	Encoder *goa.HTTPEncoder
	Decoder *goa.HTTPDecoder
}

Client is the feedpushr service client.

func New 

func New(c goaclient.Doer) *Client

New instantiates the client.

func (*Client) CreateFeed 

func (c *Client) CreateFeed(ctx context.Context, path string, url_ string, enable *bool, tags *string, title *string) (*http.Response, error)

Create a new feed

func (*Client) CreateFilterOutput 

func (c *Client) CreateFilterOutput(ctx context.Context, path string, payload *CreateFilterOutputPayload, contentType string) (*http.Response, error)

Create a new filter

func (*Client) CreateOutput 

func (c *Client) CreateOutput(ctx context.Context, path string, payload *CreateOutputPayload, contentType string) (*http.Response, error)

Create a new output

func (*Client) DecodeErrorResponse 

func (c *Client) DecodeErrorResponse(resp *http.Response) (*goa.ErrorResponse, error)

DecodeErrorResponse decodes the ErrorResponse instance encoded in resp body.

func (*Client) DecodeExploreResponse 

func (c *Client) DecodeExploreResponse(resp *http.Response) (*ExploreResponse, error)

DecodeExploreResponse decodes the ExploreResponse instance encoded in resp body.

func (*Client) DecodeExploreResponseCollection 

func (c *Client) DecodeExploreResponseCollection(resp *http.Response) (ExploreResponseCollection, error)

DecodeExploreResponseCollection decodes the ExploreResponseCollection instance encoded in resp body.

func (*Client) DecodeFeedResponse 

func (c *Client) DecodeFeedResponse(resp *http.Response) (*FeedResponse, error)

DecodeFeedResponse decodes the FeedResponse instance encoded in resp body.

func (*Client) DecodeFeedResponseCollection 

func (c *Client) DecodeFeedResponseCollection(resp *http.Response) (FeedResponseCollection, error)

DecodeFeedResponseCollection decodes the FeedResponseCollection instance encoded in resp body. 

func (c *Client) DecodeFeedResponseLink(resp *http.Response) (*FeedResponseLink, error)

DecodeFeedResponseLink decodes the FeedResponseLink instance encoded in resp body.

func (*Client) DecodeFeedResponseLinkCollection 

func (c *Client) DecodeFeedResponseLinkCollection(resp *http.Response) (FeedResponseLinkCollection, error)

DecodeFeedResponseLinkCollection decodes the FeedResponseLinkCollection instance encoded in resp body.

func (*Client) DecodeFeedResponseTiny 

func (c *Client) DecodeFeedResponseTiny(resp *http.Response) (*FeedResponseTiny, error)

DecodeFeedResponseTiny decodes the FeedResponseTiny instance encoded in resp body.

func (*Client) DecodeFeedResponseTinyCollection 

func (c *Client) DecodeFeedResponseTinyCollection(resp *http.Response) (FeedResponseTinyCollection, error)

DecodeFeedResponseTinyCollection decodes the FeedResponseTinyCollection instance encoded in resp body.

func (*Client) DecodeFeedsPageResponse 

func (c *Client) DecodeFeedsPageResponse(resp *http.Response) (*FeedsPageResponse, error)

DecodeFeedsPageResponse decodes the FeedsPageResponse instance encoded in resp body.

func (*Client) DecodeFilterResponse 

func (c *Client) DecodeFilterResponse(resp *http.Response) (*FilterResponse, error)

DecodeFilterResponse decodes the FilterResponse instance encoded in resp body.

func (*Client) DecodeFilterResponseCollection 

func (c *Client) DecodeFilterResponseCollection(resp *http.Response) (FilterResponseCollection, error)

DecodeFilterResponseCollection decodes the FilterResponseCollection instance encoded in resp body.

func (*Client) DecodeFilterSpecResponse 

func (c *Client) DecodeFilterSpecResponse(resp *http.Response) (*FilterSpecResponse, error)

DecodeFilterSpecResponse decodes the FilterSpecResponse instance encoded in resp body.

func (*Client) DecodeFilterSpecResponseCollection 

func (c *Client) DecodeFilterSpecResponseCollection(resp *http.Response) (FilterSpecResponseCollection, error)

DecodeFilterSpecResponseCollection decodes the FilterSpecResponseCollection instance encoded in resp body. 

func (c *Client) DecodeHALLink(resp *http.Response) (*HALLink, error)

DecodeHALLink decodes the HALLink instance encoded in resp body.

func (*Client) DecodeInfo 

func (c *Client) DecodeInfo(resp *http.Response) (*Info, error)

DecodeInfo decodes the Info instance encoded in resp body.

func (*Client) DecodeOPMLImportJobResponse 

func (c *Client) DecodeOPMLImportJobResponse(resp *http.Response) (*OPMLImportJobResponse, error)

DecodeOPMLImportJobResponse decodes the OPMLImportJobResponse instance encoded in resp body.

func (*Client) DecodeOutputResponse 

func (c *Client) DecodeOutputResponse(resp *http.Response) (*OutputResponse, error)

DecodeOutputResponse decodes the OutputResponse instance encoded in resp body.

func (*Client) DecodeOutputResponseCollection 

func (c *Client) DecodeOutputResponseCollection(resp *http.Response) (OutputResponseCollection, error)

DecodeOutputResponseCollection decodes the OutputResponseCollection instance encoded in resp body.

func (*Client) DecodeOutputSpecResponse 

func (c *Client) DecodeOutputSpecResponse(resp *http.Response) (*OutputSpecResponse, error)

DecodeOutputSpecResponse decodes the OutputSpecResponse instance encoded in resp body.

func (*Client) DecodeOutputSpecResponseCollection 

func (c *Client) DecodeOutputSpecResponseCollection(resp *http.Response) (OutputSpecResponseCollection, error)

DecodeOutputSpecResponseCollection decodes the OutputSpecResponseCollection instance encoded in resp body.

func (*Client) DecodePropSpec 

func (c *Client) DecodePropSpec(resp *http.Response) (*PropSpec, error)

DecodePropSpec decodes the PropSpec instance encoded in resp body.

func (*Client) DecodePropSpecCollection 

func (c *Client) DecodePropSpecCollection(resp *http.Response) (PropSpecCollection, error)

DecodePropSpecCollection decodes the PropSpecCollection instance encoded in resp body.

func (*Client) DeleteFeed 

func (c *Client) DeleteFeed(ctx context.Context, path string) (*http.Response, error)

Delete a feed

func (*Client) DeleteFilterOutput 

func (c *Client) DeleteFilterOutput(ctx context.Context, path string) (*http.Response, error)

Delete a filter

func (*Client) DeleteOutput 

func (c *Client) DeleteOutput(ctx context.Context, path string) (*http.Response, error)

Delete an output

func (*Client) GetExplore 

func (c *Client) GetExplore(ctx context.Context, path string, q *string) (*http.Response, error)

Search RSS feed using external search engine

func (*Client) GetFeed 

func (c *Client) GetFeed(ctx context.Context, path string) (*http.Response, error)

Retrieve feed with given ID

func (*Client) GetHealth 

func (c *Client) GetHealth(ctx context.Context, path string) (*http.Response, error)

Perform health check.

func (*Client) GetIndex 

func (c *Client) GetIndex(ctx context.Context, path string) (*http.Response, error)

Get basic API information.

func (*Client) GetOpml 

func (c *Client) GetOpml(ctx context.Context, path string) (*http.Response, error)

Get all feeds as an OPML format

func (*Client) GetOutput 

func (c *Client) GetOutput(ctx context.Context, path string) (*http.Response, error)

Retrieve output with given ID

func (*Client) GetSwagger 

func (c *Client) GetSwagger(ctx context.Context, path string) (*http.Response, error)

Get OpenAPI specifications

func (*Client) GetVars 

func (c *Client) GetVars(ctx context.Context, path string) (*http.Response, error)

Get all internals exp vars

func (*Client) ListFeed 

func (c *Client) ListFeed(ctx context.Context, path string, page *int, q *string, size *int) (*http.Response, error)

Retrieve all feeds

func (*Client) ListOutput 

func (c *Client) ListOutput(ctx context.Context, path string) (*http.Response, error)

Retrieve all outputs definitions

func (*Client) NewCreateFeedRequest 

func (c *Client) NewCreateFeedRequest(ctx context.Context, path string, url_ string, enable *bool, tags *string, title *string) (*http.Request, error)

NewCreateFeedRequest create the request corresponding to the create action endpoint of the feed resource.

func (*Client) NewCreateFilterOutputRequest 

func (c *Client) NewCreateFilterOutputRequest(ctx context.Context, path string, payload *CreateFilterOutputPayload, contentType string) (*http.Request, error)

NewCreateFilterOutputRequest create the request corresponding to the createFilter action endpoint of the output resource.

func (*Client) NewCreateOutputRequest 

func (c *Client) NewCreateOutputRequest(ctx context.Context, path string, payload *CreateOutputPayload, contentType string) (*http.Request, error)

NewCreateOutputRequest create the request corresponding to the create action endpoint of the output resource.

func (*Client) NewDeleteFeedRequest 

func (c *Client) NewDeleteFeedRequest(ctx context.Context, path string) (*http.Request, error)

NewDeleteFeedRequest create the request corresponding to the delete action endpoint of the feed resource.

func (*Client) NewDeleteFilterOutputRequest 

func (c *Client) NewDeleteFilterOutputRequest(ctx context.Context, path string) (*http.Request, error)

NewDeleteFilterOutputRequest create the request corresponding to the deleteFilter action endpoint of the output resource.

func (*Client) NewDeleteOutputRequest 

func (c *Client) NewDeleteOutputRequest(ctx context.Context, path string) (*http.Request, error)

NewDeleteOutputRequest create the request corresponding to the delete action endpoint of the output resource.

func (*Client) NewGetExploreRequest 

func (c *Client) NewGetExploreRequest(ctx context.Context, path string, q *string) (*http.Request, error)

NewGetExploreRequest create the request corresponding to the get action endpoint of the explore resource.

func (*Client) NewGetFeedRequest 

func (c *Client) NewGetFeedRequest(ctx context.Context, path string) (*http.Request, error)

NewGetFeedRequest create the request corresponding to the get action endpoint of the feed resource.

func (*Client) NewGetHealthRequest 

func (c *Client) NewGetHealthRequest(ctx context.Context, path string) (*http.Request, error)

NewGetHealthRequest create the request corresponding to the get action endpoint of the health resource.

func (*Client) NewGetIndexRequest 

func (c *Client) NewGetIndexRequest(ctx context.Context, path string) (*http.Request, error)

NewGetIndexRequest create the request corresponding to the get action endpoint of the index resource.

func (*Client) NewGetOpmlRequest 

func (c *Client) NewGetOpmlRequest(ctx context.Context, path string) (*http.Request, error)

NewGetOpmlRequest create the request corresponding to the get action endpoint of the opml resource.

func (*Client) NewGetOutputRequest 

func (c *Client) NewGetOutputRequest(ctx context.Context, path string) (*http.Request, error)

NewGetOutputRequest create the request corresponding to the get action endpoint of the output resource.

func (*Client) NewGetSwaggerRequest 

func (c *Client) NewGetSwaggerRequest(ctx context.Context, path string) (*http.Request, error)

NewGetSwaggerRequest create the request corresponding to the get action endpoint of the swagger resource.

func (*Client) NewGetVarsRequest 

func (c *Client) NewGetVarsRequest(ctx context.Context, path string) (*http.Request, error)

NewGetVarsRequest create the request corresponding to the get action endpoint of the vars resource.

func (*Client) NewListFeedRequest 

func (c *Client) NewListFeedRequest(ctx context.Context, path string, page *int, q *string, size *int) (*http.Request, error)

NewListFeedRequest create the request corresponding to the list action endpoint of the feed resource.

func (*Client) NewListOutputRequest 

func (c *Client) NewListOutputRequest(ctx context.Context, path string) (*http.Request, error)

NewListOutputRequest create the request corresponding to the list action endpoint of the output resource.

func (*Client) NewPubPshbRequest 

func (c *Client) NewPubPshbRequest(ctx context.Context, path string) (*http.Request, error)

NewPubPshbRequest create the request corresponding to the pub action endpoint of the pshb resource.

func (*Client) NewSpecsFilterRequest 

func (c *Client) NewSpecsFilterRequest(ctx context.Context, path string) (*http.Request, error)

NewSpecsFilterRequest create the request corresponding to the specs action endpoint of the filter resource.

func (*Client) NewSpecsOutputRequest 

func (c *Client) NewSpecsOutputRequest(ctx context.Context, path string) (*http.Request, error)

NewSpecsOutputRequest create the request corresponding to the specs action endpoint of the output resource.

func (*Client) NewStartFeedRequest 

func (c *Client) NewStartFeedRequest(ctx context.Context, path string) (*http.Request, error)

NewStartFeedRequest create the request corresponding to the start action endpoint of the feed resource.

func (*Client) NewStatusOpmlRequest 

func (c *Client) NewStatusOpmlRequest(ctx context.Context, path string) (*http.Request, error)

NewStatusOpmlRequest create the request corresponding to the status action endpoint of the opml resource.

func (*Client) NewStopFeedRequest 

func (c *Client) NewStopFeedRequest(ctx context.Context, path string) (*http.Request, error)

NewStopFeedRequest create the request corresponding to the stop action endpoint of the feed resource.

func (*Client) NewSubPshbRequest 

func (c *Client) NewSubPshbRequest(ctx context.Context, path string, hubChallenge string, hubMode string, hubTopic string, hubLeaseSeconds *int) (*http.Request, error)

NewSubPshbRequest create the request corresponding to the sub action endpoint of the pshb resource.

func (*Client) NewUpdateFeedRequest 

func (c *Client) NewUpdateFeedRequest(ctx context.Context, path string, tags *string, title *string) (*http.Request, error)

NewUpdateFeedRequest create the request corresponding to the update action endpoint of the feed resource.

func (*Client) NewUpdateFilterOutputRequest 

func (c *Client) NewUpdateFilterOutputRequest(ctx context.Context, path string, payload *UpdateFilterOutputPayload, contentType string) (*http.Request, error)

NewUpdateFilterOutputRequest create the request corresponding to the updateFilter action endpoint of the output resource.

func (*Client) NewUpdateOutputRequest 

func (c *Client) NewUpdateOutputRequest(ctx context.Context, path string, payload *UpdateOutputPayload, contentType string) (*http.Request, error)

NewUpdateOutputRequest create the request corresponding to the update action endpoint of the output resource.

func (*Client) NewUploadOpmlRequest 

func (c *Client) NewUploadOpmlRequest(ctx context.Context, path string) (*http.Request, error)

NewUploadOpmlRequest create the request corresponding to the upload action endpoint of the opml resource.

func (*Client) PubPshb 

func (c *Client) PubPshb(ctx context.Context, path string) (*http.Response, error)

Publication endpoint for PSHB hubs

func (*Client) SpecsFilter 

func (c *Client) SpecsFilter(ctx context.Context, path string) (*http.Response, error)

Retrieve all filter types available

func (*Client) SpecsOutput 

func (c *Client) SpecsOutput(ctx context.Context, path string) (*http.Response, error)

Retrieve all output types available

func (*Client) StartFeed 

func (c *Client) StartFeed(ctx context.Context, path string) (*http.Response, error)

Start feed aggregation

func (*Client) StatusOpml 

func (c *Client) StatusOpml(ctx context.Context, path string) (*http.Response, error)

Get OPML import status

func (*Client) StopFeed 

func (c *Client) StopFeed(ctx context.Context, path string) (*http.Response, error)

Stop feed aggregation

func (*Client) SubPshb 

func (c *Client) SubPshb(ctx context.Context, path string, hubChallenge string, hubMode string, hubTopic string, hubLeaseSeconds *int) (*http.Response, error)

Callback to validate the (un)subscription to the topic of a Hub

func (*Client) UpdateFeed 

func (c *Client) UpdateFeed(ctx context.Context, path string, tags *string, title *string) (*http.Response, error)

Update a feed

func (*Client) UpdateFilterOutput 

func (c *Client) UpdateFilterOutput(ctx context.Context, path string, payload *UpdateFilterOutputPayload, contentType string) (*http.Response, error)

Update a filter

func (*Client) UpdateOutput 

func (c *Client) UpdateOutput(ctx context.Context, path string, payload *UpdateOutputPayload, contentType string) (*http.Response, error)

Update an output

func (*Client) UploadOpml 

func (c *Client) UploadOpml(ctx context.Context, path string) (*http.Response, error)

Upload an OPML file to create feeds

type CreateFilterOutputPayload 

type CreateFilterOutputPayload struct {
	// Alias of the filter
	Alias string `form:"alias" json:"alias" yaml:"alias" xml:"alias"`
	// Conditional expression of the output
	Condition string `form:"condition" json:"condition" yaml:"condition" xml:"condition"`
	// Name of the filter
	Name string `form:"name" json:"name" yaml:"name" xml:"name"`
	// Filter properties
	Props map[string]interface{} `form:"props,omitempty" json:"props,omitempty" yaml:"props,omitempty" xml:"props,omitempty"`
}

CreateFilterOutputPayload is the output createFilter action payload.

type CreateOutputPayload 

type CreateOutputPayload struct {
	// Alias of the output
	Alias string `form:"alias" json:"alias" yaml:"alias" xml:"alias"`
	// Conditional expression of the output
	Condition string `form:"condition" json:"condition" yaml:"condition" xml:"condition"`
	// Name of the output
	Name string `form:"name" json:"name" yaml:"name" xml:"name"`
	// Output properties
	Props map[string]interface{} `form:"props,omitempty" json:"props,omitempty" yaml:"props,omitempty" xml:"props,omitempty"`
}

CreateOutputPayload is the output create action payload.

type ExploreResponse 

type ExploreResponse struct {
	// Feed description
	Desc string `form:"desc" json:"desc" yaml:"desc" xml:"desc"`
	// URL of the feed website
	HTMLURL string `form:"htmlUrl" json:"htmlUrl" yaml:"htmlUrl" xml:"htmlUrl"`
	// Feed title
	Title string `form:"title" json:"title" yaml:"title" xml:"title"`
	// URL of the XML feed
	XMLURL string `form:"xmlUrl" json:"xmlUrl" yaml:"xmlUrl" xml:"xmlUrl"`
}

The search result (default view)

Identifier: application/vnd.feedpushr.explore.v2+json; view=default

func (*ExploreResponse) Validate 

func (mt *ExploreResponse) Validate() (err error)

Validate validates the ExploreResponse media type instance.

type ExploreResponseCollection 

type ExploreResponseCollection []*ExploreResponse

ExploreResponseCollection is the media type for an array of ExploreResponse (default view)

Identifier: application/vnd.feedpushr.explore.v2+json; type=collection; view=default

func (ExploreResponseCollection) Validate 

func (mt ExploreResponseCollection) Validate() (err error)

Validate validates the ExploreResponseCollection media type instance.

type FeedResponse 

type FeedResponse struct {
	// Date of creation
	Cdate time.Time `form:"cdate" json:"cdate" yaml:"cdate" xml:"cdate"`
	// Number of consecutive aggregation errors
	ErrorCount *int `form:"errorCount,omitempty" json:"errorCount,omitempty" yaml:"errorCount,omitempty" xml:"errorCount,omitempty"`
	// Last aggregation error
	ErrorMsg *string `form:"errorMsg,omitempty" json:"errorMsg,omitempty" yaml:"errorMsg,omitempty" xml:"errorMsg,omitempty"`
	// URL of the feed website
	HTMLURL *string `form:"htmlUrl,omitempty" json:"htmlUrl,omitempty" yaml:"htmlUrl,omitempty" xml:"htmlUrl,omitempty"`
	// URL of the PubSubHubbud hub
	HubURL *string `form:"hubUrl,omitempty" json:"hubUrl,omitempty" yaml:"hubUrl,omitempty" xml:"hubUrl,omitempty"`
	// ID of feed (MD5 of the xmlUrl)
	ID string `form:"id" json:"id" yaml:"id" xml:"id"`
	// Last aggregation pass
	LastCheck *time.Time `form:"lastCheck,omitempty" json:"lastCheck,omitempty" yaml:"lastCheck,omitempty" xml:"lastCheck,omitempty"`
	// Date of modification
	Mdate time.Time `form:"mdate" json:"mdate" yaml:"mdate" xml:"mdate"`
	// Total number of processed items
	NbProcessedItems *int `` /* 134-byte string literal not displayed */
	// Next aggregation pass
	NextCheck *time.Time `form:"nextCheck,omitempty" json:"nextCheck,omitempty" yaml:"nextCheck,omitempty" xml:"nextCheck,omitempty"`
	// Aggregation status
	Status *string `form:"status,omitempty" json:"status,omitempty" yaml:"status,omitempty" xml:"status,omitempty"`
	// List of tags
	Tags []string `form:"tags,omitempty" json:"tags,omitempty" yaml:"tags,omitempty" xml:"tags,omitempty"`
	// Title of the Feed
	Title string `form:"title" json:"title" yaml:"title" xml:"title"`
	// URL of the XML feed
	XMLURL string `form:"xmlUrl" json:"xmlUrl" yaml:"xmlUrl" xml:"xmlUrl"`
}

A RSS feed (default view)

Identifier: application/vnd.feedpushr.feed.v2+json; view=default

func (*FeedResponse) Validate 

func (mt *FeedResponse) Validate() (err error)

Validate validates the FeedResponse media type instance.

type FeedResponseCollection 

type FeedResponseCollection []*FeedResponse

FeedResponseCollection is the media type for an array of FeedResponse (default view)

Identifier: application/vnd.feedpushr.feed.v2+json; type=collection; view=default

func (FeedResponseCollection) Validate 

func (mt FeedResponseCollection) Validate() (err error)

Validate validates the FeedResponseCollection media type instance. 

type FeedResponseLink struct {
	// ID of feed (MD5 of the xmlUrl)
	ID string `form:"id" json:"id" yaml:"id" xml:"id"`
	// URL of the XML feed
	XMLURL string `form:"xmlUrl" json:"xmlUrl" yaml:"xmlUrl" xml:"xmlUrl"`
}

A RSS feed (link view)

Identifier: application/vnd.feedpushr.feed.v2+json; view=link

func (*FeedResponseLink) Validate 

func (mt *FeedResponseLink) Validate() (err error)

Validate validates the FeedResponseLink media type instance.

type FeedResponseLinkCollection 

type FeedResponseLinkCollection []*FeedResponseLink

FeedResponseCollection is the media type for an array of FeedResponse (link view)

Identifier: application/vnd.feedpushr.feed.v2+json; type=collection; view=link

func (FeedResponseLinkCollection) Validate 

func (mt FeedResponseLinkCollection) Validate() (err error)

Validate validates the FeedResponseLinkCollection media type instance.

type FeedResponseTiny 

type FeedResponseTiny struct {
	// Date of creation
	Cdate time.Time `form:"cdate" json:"cdate" yaml:"cdate" xml:"cdate"`
	// ID of feed (MD5 of the xmlUrl)
	ID string `form:"id" json:"id" yaml:"id" xml:"id"`
	// List of tags
	Tags []string `form:"tags,omitempty" json:"tags,omitempty" yaml:"tags,omitempty" xml:"tags,omitempty"`
	// Title of the Feed
	Title string `form:"title" json:"title" yaml:"title" xml:"title"`
	// URL of the XML feed
	XMLURL string `form:"xmlUrl" json:"xmlUrl" yaml:"xmlUrl" xml:"xmlUrl"`
}

A RSS feed (tiny view)

Identifier: application/vnd.feedpushr.feed.v2+json; view=tiny

func (*FeedResponseTiny) Validate 

func (mt *FeedResponseTiny) Validate() (err error)

Validate validates the FeedResponseTiny media type instance.

type FeedResponseTinyCollection 

type FeedResponseTinyCollection []*FeedResponseTiny

FeedResponseCollection is the media type for an array of FeedResponse (tiny view)

Identifier: application/vnd.feedpushr.feed.v2+json; type=collection; view=tiny

func (FeedResponseTinyCollection) Validate 

func (mt FeedResponseTinyCollection) Validate() (err error)

Validate validates the FeedResponseTinyCollection media type instance.

type FeedsPageResponse 

type FeedsPageResponse struct {
	// Current page number
	Current int `form:"current" json:"current" yaml:"current" xml:"current"`
	// List of feeds
	Data FeedResponseCollection `form:"data" json:"data" yaml:"data" xml:"data"`
	// Max number of feeds by page
	Size int `form:"size" json:"size" yaml:"size" xml:"size"`
	// Total number of feeds
	Total int `form:"total" json:"total" yaml:"total" xml:"total"`
}

A pagignated list of feeds (default view)

Identifier: application/vnd.feedpushr.feeds-page.v2+json; view=default

func (*FeedsPageResponse) Validate 

func (mt *FeedsPageResponse) Validate() (err error)

Validate validates the FeedsPageResponse media type instance.

type FilterResponse 

type FilterResponse struct {
	// Alias of the filter
	Alias string `form:"alias" json:"alias" yaml:"alias" xml:"alias"`
	// Conditional expression of the filter
	Condition string `form:"condition" json:"condition" yaml:"condition" xml:"condition"`
	// Description of the filter
	Desc string `form:"desc" json:"desc" yaml:"desc" xml:"desc"`
	// Status
	Enabled bool `form:"enabled" json:"enabled" yaml:"enabled" xml:"enabled"`
	// ID of the filter
	ID string `form:"id" json:"id" yaml:"id" xml:"id"`
	// Name of the filter
	Name string `form:"name" json:"name" yaml:"name" xml:"name"`
	// Number of error
	NbError int `form:"nbError" json:"nbError" yaml:"nbError" xml:"nbError"`
	// Number of success
	NbSuccess int `form:"nbSuccess" json:"nbSuccess" yaml:"nbSuccess" xml:"nbSuccess"`
	// Filter properties
	Props map[string]interface{} `form:"props" json:"props" yaml:"props" xml:"props"`
}

A filter (default view)

Identifier: application/vnd.feedpushr.filter.v2+json; view=default

func (*FilterResponse) Validate 

func (mt *FilterResponse) Validate() (err error)

Validate validates the FilterResponse media type instance.

type FilterResponseCollection 

type FilterResponseCollection []*FilterResponse

FilterResponseCollection is the media type for an array of FilterResponse (default view)

Identifier: application/vnd.feedpushr.filter.v2+json; type=collection; view=default

func (FilterResponseCollection) Validate 

func (mt FilterResponseCollection) Validate() (err error)

Validate validates the FilterResponseCollection media type instance.

type FilterSpecResponse 

type FilterSpecResponse struct {
	// Description of the filter
	Desc string `form:"desc" json:"desc" yaml:"desc" xml:"desc"`
	// Name of the filter
	Name  string             `form:"name" json:"name" yaml:"name" xml:"name"`
	Props PropSpecCollection `form:"props" json:"props" yaml:"props" xml:"props"`
}

The filter specification (default view)

Identifier: application/vnd.feedpushr.filter-spec.v2+json; view=default

func (*FilterSpecResponse) Validate 

func (mt *FilterSpecResponse) Validate() (err error)

Validate validates the FilterSpecResponse media type instance.

type FilterSpecResponseCollection 

type FilterSpecResponseCollection []*FilterSpecResponse

FilterSpecResponseCollection is the media type for an array of FilterSpecResponse (default view)

Identifier: application/vnd.feedpushr.filter-spec.v2+json; type=collection; view=default

func (FilterSpecResponseCollection) Validate 

func (mt FilterSpecResponseCollection) Validate() (err error)

Validate validates the FilterSpecResponseCollection media type instance. 

type HALLink struct {
	// Link's destination
	Href string `form:"href" json:"href" yaml:"href" xml:"href"`
}

HAL link (default view)

Identifier: application/vnd.feedpushr.hal-links.v2+json; view=default

func (*HALLink) Validate 

func (mt *HALLink) Validate() (err error)

Validate validates the HALLink media type instance.

type Info 

type Info struct {
	// HAL links
	Links map[string]*HALLink `form:"_links" json:"_links" yaml:"_links" xml:"_links"`
	// Default UI ClientID
	ClientID string `form:"client_id" json:"client_id" yaml:"client_id" xml:"client_id"`
	// Service description
	Desc string `form:"desc" json:"desc" yaml:"desc" xml:"desc"`
	// Service name
	Name string `form:"name" json:"name" yaml:"name" xml:"name"`
	// Service version
	Version string `form:"version" json:"version" yaml:"version" xml:"version"`
}

API info (default view)

Identifier: application/vnd.feedpushr.info.v2+json; view=default

func (*Info) Validate 

func (mt *Info) Validate() (err error)

Validate validates the Info media type instance.

type OPMLImportJobResponse 

type OPMLImportJobResponse struct {
	// ID of the import job
	ID string `form:"id" json:"id" yaml:"id" xml:"id"`
}

OPMLImportJobResponse media type (default view)

Identifier: application/vnd.feedpushr.ompl-import-job.v2+json; view=default

func (*OPMLImportJobResponse) Validate 

func (mt *OPMLImportJobResponse) Validate() (err error)

Validate validates the OPMLImportJobResponse media type instance.

type OutputResponse 

type OutputResponse struct {
	// Alias of the output channel
	Alias string `form:"alias" json:"alias" yaml:"alias" xml:"alias"`
	// Conditional expression of the filter
	Condition string `form:"condition" json:"condition" yaml:"condition" xml:"condition"`
	// Description of the output channel
	Desc string `form:"desc" json:"desc" yaml:"desc" xml:"desc"`
	// Status
	Enabled bool `form:"enabled" json:"enabled" yaml:"enabled" xml:"enabled"`
	// Filters
	Filters FilterResponseCollection `form:"filters,omitempty" json:"filters,omitempty" yaml:"filters,omitempty" xml:"filters,omitempty"`
	// ID of the output
	ID string `form:"id" json:"id" yaml:"id" xml:"id"`
	// Name of the output channel
	Name string `form:"name" json:"name" yaml:"name" xml:"name"`
	// Number of error
	NbError int `form:"nbError" json:"nbError" yaml:"nbError" xml:"nbError"`
	// Number of success
	NbSuccess int `form:"nbSuccess" json:"nbSuccess" yaml:"nbSuccess" xml:"nbSuccess"`
	// Output channel properties
	Props map[string]interface{} `form:"props" json:"props" yaml:"props" xml:"props"`
}

The output channel (default view)

Identifier: application/vnd.feedpushr.output.v2+json; view=default

func (*OutputResponse) Validate 

func (mt *OutputResponse) Validate() (err error)

Validate validates the OutputResponse media type instance.

type OutputResponseCollection 

type OutputResponseCollection []*OutputResponse

OutputResponseCollection is the media type for an array of OutputResponse (default view)

Identifier: application/vnd.feedpushr.output.v2+json; type=collection; view=default

func (OutputResponseCollection) Validate 

func (mt OutputResponseCollection) Validate() (err error)

Validate validates the OutputResponseCollection media type instance.

type OutputSpecResponse 

type OutputSpecResponse struct {
	// Description of the output channel
	Desc string `form:"desc" json:"desc" yaml:"desc" xml:"desc"`
	// Name of the output channel
	Name  string             `form:"name" json:"name" yaml:"name" xml:"name"`
	Props PropSpecCollection `form:"props" json:"props" yaml:"props" xml:"props"`
}

The output channel specification (default view)

Identifier: application/vnd.feedpushr.output-spec.v2+json; view=default

func (*OutputSpecResponse) Validate 

func (mt *OutputSpecResponse) Validate() (err error)

Validate validates the OutputSpecResponse media type instance.

type OutputSpecResponseCollection 

type OutputSpecResponseCollection []*OutputSpecResponse

OutputSpecResponseCollection is the media type for an array of OutputSpecResponse (default view)

Identifier: application/vnd.feedpushr.output-spec.v2+json; type=collection; view=default

func (OutputSpecResponseCollection) Validate 

func (mt OutputSpecResponseCollection) Validate() (err error)

Validate validates the OutputSpecResponseCollection media type instance.

type PropSpec 

type PropSpec struct {
	// Description of the output channel
	Desc string `form:"desc" json:"desc" yaml:"desc" xml:"desc"`
	// Name of the property
	Name string `form:"name" json:"name" yaml:"name" xml:"name"`
	// Property options
	Options map[string]string `form:"options,omitempty" json:"options,omitempty" yaml:"options,omitempty" xml:"options,omitempty"`
	// Property type ('text', 'url', ...)
	Type string `form:"type" json:"type" yaml:"type" xml:"type"`
}

The specification of a property (default view)

Identifier: application/vnd.feedpushr.prop-spec.v2+json; view=default

func (*PropSpec) Validate 

func (mt *PropSpec) Validate() (err error)

Validate validates the PropSpec media type instance.

type PropSpecCollection 

type PropSpecCollection []*PropSpec

PropSpecCollection is the media type for an array of PropSpec (default view)

Identifier: application/vnd.feedpushr.prop-spec.v2+json; type=collection; view=default

func (PropSpecCollection) Validate 

func (mt PropSpecCollection) Validate() (err error)

Validate validates the PropSpecCollection media type instance.

type SubscriptionPayload 

type SubscriptionPayload struct {
	Alias *string `form:"alias,omitempty" json:"alias,omitempty" yaml:"alias,omitempty" xml:"alias,omitempty"`
	URI   *string `form:"uri,omitempty" json:"uri,omitempty" yaml:"uri,omitempty" xml:"uri,omitempty"`
}

SubscriptionPayload user type.

func (*SubscriptionPayload) Validate 

func (ut *SubscriptionPayload) Validate() (err error)

Validate validates the SubscriptionPayload type instance.

type UpdateFilterOutputPayload 

type UpdateFilterOutputPayload struct {
	// Alias of the filter
	Alias *string `form:"alias,omitempty" json:"alias,omitempty" yaml:"alias,omitempty" xml:"alias,omitempty"`
	// Conditional expression of the output
	Condition *string `form:"condition,omitempty" json:"condition,omitempty" yaml:"condition,omitempty" xml:"condition,omitempty"`
	// Filter status
	Enabled bool `form:"enabled" json:"enabled" yaml:"enabled" xml:"enabled"`
	// Filter properties
	Props map[string]interface{} `form:"props,omitempty" json:"props,omitempty" yaml:"props,omitempty" xml:"props,omitempty"`
}

UpdateFilterOutputPayload is the output updateFilter action payload.

type UpdateOutputPayload 

type UpdateOutputPayload struct {
	// Alias of the output
	Alias *string `form:"alias,omitempty" json:"alias,omitempty" yaml:"alias,omitempty" xml:"alias,omitempty"`
	// Conditional expression of the output
	Condition *string `form:"condition,omitempty" json:"condition,omitempty" yaml:"condition,omitempty" xml:"condition,omitempty"`
	// Output status
	Enabled bool `form:"enabled" json:"enabled" yaml:"enabled" xml:"enabled"`
	// Output properties
	Props map[string]interface{} `form:"props,omitempty" json:"props,omitempty" yaml:"props,omitempty" xml:"props,omitempty"`
}

UpdateOutputPayload is the output update action payload.

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.