Documentation
¶
Overview ¶
Package message_bus provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version v1.12.4 DO NOT EDIT.
Index ¶
- Constants
- func NewGetActionTypeRequest(server string, sourceId SourceID, name ActionName) (*http.Request, error)
- func NewGetActionTypesBySourceIDRequest(server string, sourceId SourceID) (*http.Request, error)
- func NewGetActionTypesRequest(server string) (*http.Request, error)
- func NewGetEventTypeRequest(server string, sourceId SourceID, name EventName) (*http.Request, error)
- func NewGetEventTypesBySourceIDRequest(server string, sourceId SourceID) (*http.Request, error)
- func NewGetEventTypesRequest(server string) (*http.Request, error)
- func NewPollSIO2Request(server string) (*http.Request, error)
- func NewPollSIORequest(server string) (*http.Request, error)
- func NewPublishEventRequest(server string, sourceId SourceID, name EventName, ...) (*http.Request, error)
- func NewPublishEventRequestWithBody(server string, sourceId SourceID, name EventName, contentType string, ...) (*http.Request, error)
- func NewRegisterActionTypesRequest(server string, body RegisterActionTypesJSONRequestBody) (*http.Request, error)
- func NewRegisterActionTypesRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewRegisterEventTypesRequest(server string, body RegisterEventTypesJSONRequestBody) (*http.Request, error)
- func NewRegisterEventTypesRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewSubscribeActionWSRequest(server string, sourceId SourceID, params *SubscribeActionWSParams) (*http.Request, error)
- func NewSubscribeEventWSRequest(server string, sourceId SourceID, params *SubscribeEventWSParams) (*http.Request, error)
- func NewSubscribeSIO2Request(server string) (*http.Request, error)
- func NewSubscribeSIORequest(server string) (*http.Request, error)
- func NewTriggerActionRequest(server string, sourceId SourceID, name ActionName, ...) (*http.Request, error)
- func NewTriggerActionRequestWithBody(server string, sourceId SourceID, name ActionName, contentType string, ...) (*http.Request, error)
- type Action
- type ActionName
- type ActionNames
- type ActionType
- type BaseResponse
- type Client
- func (c *Client) GetActionType(ctx context.Context, sourceId SourceID, name ActionName, ...) (*http.Response, error)
- func (c *Client) GetActionTypes(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetActionTypesBySourceID(ctx context.Context, sourceId SourceID, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetEventType(ctx context.Context, sourceId SourceID, name EventName, ...) (*http.Response, error)
- func (c *Client) GetEventTypes(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetEventTypesBySourceID(ctx context.Context, sourceId SourceID, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) PollSIO(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) PollSIO2(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) PublishEvent(ctx context.Context, sourceId SourceID, name EventName, ...) (*http.Response, error)
- func (c *Client) PublishEventWithBody(ctx context.Context, sourceId SourceID, name EventName, contentType string, ...) (*http.Response, error)
- func (c *Client) RegisterActionTypes(ctx context.Context, body RegisterActionTypesJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) RegisterActionTypesWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) RegisterEventTypes(ctx context.Context, body RegisterEventTypesJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) RegisterEventTypesWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) SubscribeActionWS(ctx context.Context, sourceId SourceID, params *SubscribeActionWSParams, ...) (*http.Response, error)
- func (c *Client) SubscribeEventWS(ctx context.Context, sourceId SourceID, params *SubscribeEventWSParams, ...) (*http.Response, error)
- func (c *Client) SubscribeSIO(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) SubscribeSIO2(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) TriggerAction(ctx context.Context, sourceId SourceID, name ActionName, ...) (*http.Response, error)
- func (c *Client) TriggerActionWithBody(ctx context.Context, sourceId SourceID, name ActionName, contentType string, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) GetActionTypeWithResponse(ctx context.Context, sourceId SourceID, name ActionName, ...) (*GetActionTypeResponse, error)
- func (c *ClientWithResponses) GetActionTypesBySourceIDWithResponse(ctx context.Context, sourceId SourceID, reqEditors ...RequestEditorFn) (*GetActionTypesBySourceIDResponse, error)
- func (c *ClientWithResponses) GetActionTypesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetActionTypesResponse, error)
- func (c *ClientWithResponses) GetEventTypeWithResponse(ctx context.Context, sourceId SourceID, name EventName, ...) (*GetEventTypeResponse, error)
- func (c *ClientWithResponses) GetEventTypesBySourceIDWithResponse(ctx context.Context, sourceId SourceID, reqEditors ...RequestEditorFn) (*GetEventTypesBySourceIDResponse, error)
- func (c *ClientWithResponses) GetEventTypesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetEventTypesResponse, error)
- func (c *ClientWithResponses) PollSIO2WithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PollSIO2Response, error)
- func (c *ClientWithResponses) PollSIOWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PollSIOResponse, error)
- func (c *ClientWithResponses) PublishEventWithBodyWithResponse(ctx context.Context, sourceId SourceID, name EventName, contentType string, ...) (*PublishEventResponse, error)
- func (c *ClientWithResponses) PublishEventWithResponse(ctx context.Context, sourceId SourceID, name EventName, ...) (*PublishEventResponse, error)
- func (c *ClientWithResponses) RegisterActionTypesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*RegisterActionTypesResponse, error)
- func (c *ClientWithResponses) RegisterActionTypesWithResponse(ctx context.Context, body RegisterActionTypesJSONRequestBody, ...) (*RegisterActionTypesResponse, error)
- func (c *ClientWithResponses) RegisterEventTypesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*RegisterEventTypesResponse, error)
- func (c *ClientWithResponses) RegisterEventTypesWithResponse(ctx context.Context, body RegisterEventTypesJSONRequestBody, ...) (*RegisterEventTypesResponse, error)
- func (c *ClientWithResponses) SubscribeActionWSWithResponse(ctx context.Context, sourceId SourceID, params *SubscribeActionWSParams, ...) (*SubscribeActionWSResponse, error)
- func (c *ClientWithResponses) SubscribeEventWSWithResponse(ctx context.Context, sourceId SourceID, params *SubscribeEventWSParams, ...) (*SubscribeEventWSResponse, error)
- func (c *ClientWithResponses) SubscribeSIO2WithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SubscribeSIO2Response, error)
- func (c *ClientWithResponses) SubscribeSIOWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SubscribeSIOResponse, error)
- func (c *ClientWithResponses) TriggerActionWithBodyWithResponse(ctx context.Context, sourceId SourceID, name ActionName, contentType string, ...) (*TriggerActionResponse, error)
- func (c *ClientWithResponses) TriggerActionWithResponse(ctx context.Context, sourceId SourceID, name ActionName, ...) (*TriggerActionResponse, error)
- type ClientWithResponsesInterface
- type Event
- type EventName
- type EventNames
- type EventType
- type GetActionTypeOK
- type GetActionTypeResponse
- type GetActionTypesBySourceIDResponse
- type GetActionTypesOK
- type GetActionTypesResponse
- type GetEventTypeOK
- type GetEventTypeResponse
- type GetEventTypesBySourceIDResponse
- type GetEventTypesOK
- type GetEventTypesResponse
- type HttpRequestDoer
- type PollSIO2Response
- type PollSIOResponse
- type PropertyType
- type PublishEvent
- type PublishEventJSONBody
- type PublishEventJSONRequestBody
- type PublishEventOK
- type PublishEventResponse
- type RegisterActionTypes
- type RegisterActionTypesJSONBody
- type RegisterActionTypesJSONRequestBody
- type RegisterActionTypesResponse
- type RegisterEventTypes
- type RegisterEventTypesJSONBody
- type RegisterEventTypesJSONRequestBody
- type RegisterEventTypesResponse
- type RequestEditorFn
- type ResponseBadRequest
- type ResponseConflict
- type ResponseInternalServerError
- type ResponseNotFound
- type ResponseOK
- type SourceID
- type SubscribeActionWSParams
- type SubscribeActionWSResponse
- type SubscribeEventWSParams
- type SubscribeEventWSResponse
- type SubscribeSIO2Response
- type SubscribeSIOResponse
- type TriggerAction
- type TriggerActionJSONBody
- type TriggerActionJSONRequestBody
- type TriggerActionOK
- type TriggerActionResponse
Constants ¶
const (
Access_tokenScopes = "access_token.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func NewGetActionTypeRequest ¶
func NewGetActionTypeRequest(server string, sourceId SourceID, name ActionName) (*http.Request, error)
NewGetActionTypeRequest generates requests for GetActionType
func NewGetActionTypesBySourceIDRequest ¶
NewGetActionTypesBySourceIDRequest generates requests for GetActionTypesBySourceID
func NewGetActionTypesRequest ¶
NewGetActionTypesRequest generates requests for GetActionTypes
func NewGetEventTypeRequest ¶
func NewGetEventTypeRequest(server string, sourceId SourceID, name EventName) (*http.Request, error)
NewGetEventTypeRequest generates requests for GetEventType
func NewGetEventTypesBySourceIDRequest ¶
NewGetEventTypesBySourceIDRequest generates requests for GetEventTypesBySourceID
func NewGetEventTypesRequest ¶
NewGetEventTypesRequest generates requests for GetEventTypes
func NewPollSIO2Request ¶
NewPollSIO2Request generates requests for PollSIO2
func NewPollSIORequest ¶
NewPollSIORequest generates requests for PollSIO
func NewPublishEventRequest ¶
func NewPublishEventRequest(server string, sourceId SourceID, name EventName, body PublishEventJSONRequestBody) (*http.Request, error)
NewPublishEventRequest calls the generic PublishEvent builder with application/json body
func NewPublishEventRequestWithBody ¶
func NewPublishEventRequestWithBody(server string, sourceId SourceID, name EventName, contentType string, body io.Reader) (*http.Request, error)
NewPublishEventRequestWithBody generates requests for PublishEvent with any type of body
func NewRegisterActionTypesRequest ¶
func NewRegisterActionTypesRequest(server string, body RegisterActionTypesJSONRequestBody) (*http.Request, error)
NewRegisterActionTypesRequest calls the generic RegisterActionTypes builder with application/json body
func NewRegisterActionTypesRequestWithBody ¶
func NewRegisterActionTypesRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewRegisterActionTypesRequestWithBody generates requests for RegisterActionTypes with any type of body
func NewRegisterEventTypesRequest ¶
func NewRegisterEventTypesRequest(server string, body RegisterEventTypesJSONRequestBody) (*http.Request, error)
NewRegisterEventTypesRequest calls the generic RegisterEventTypes builder with application/json body
func NewRegisterEventTypesRequestWithBody ¶
func NewRegisterEventTypesRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewRegisterEventTypesRequestWithBody generates requests for RegisterEventTypes with any type of body
func NewSubscribeActionWSRequest ¶
func NewSubscribeActionWSRequest(server string, sourceId SourceID, params *SubscribeActionWSParams) (*http.Request, error)
NewSubscribeActionWSRequest generates requests for SubscribeActionWS
func NewSubscribeEventWSRequest ¶
func NewSubscribeEventWSRequest(server string, sourceId SourceID, params *SubscribeEventWSParams) (*http.Request, error)
NewSubscribeEventWSRequest generates requests for SubscribeEventWS
func NewSubscribeSIO2Request ¶
NewSubscribeSIO2Request generates requests for SubscribeSIO2
func NewSubscribeSIORequest ¶
NewSubscribeSIORequest generates requests for SubscribeSIO
func NewTriggerActionRequest ¶
func NewTriggerActionRequest(server string, sourceId SourceID, name ActionName, body TriggerActionJSONRequestBody) (*http.Request, error)
NewTriggerActionRequest calls the generic TriggerAction builder with application/json body
Types ¶
type Action ¶
type Action struct {
// Name action name
Name string `json:"name"`
// Properties event properties
Properties map[string]string `json:"properties"`
// SourceID associated source id
SourceID string `json:"sourceID"`
// Timestamp timestamp this action took place
Timestamp *time.Time `json:"timestamp,omitempty"`
}
Action defines model for Action.
type ActionType ¶
type ActionType struct {
// Name action name
//
// (there is no naming convention for action names, but it is recommended to name each as structural and descriptive as possible)
Name string `json:"name"`
PropertyTypeList []PropertyType `json:"propertyTypeList"`
// SourceID action source id to identify where the action will take
SourceID string `json:"sourceID"`
}
ActionType defines model for ActionType.
type BaseResponse ¶
type BaseResponse struct {
// Message message returned by server side if there is any
Message *string `json:"message,omitempty"`
}
BaseResponse defines model for BaseResponse.
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) GetActionType ¶
func (c *Client) GetActionType(ctx context.Context, sourceId SourceID, name ActionName, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetActionTypes ¶
func (*Client) GetActionTypesBySourceID ¶
func (*Client) GetEventType ¶
func (*Client) GetEventTypes ¶
func (*Client) GetEventTypesBySourceID ¶
func (*Client) PublishEvent ¶
func (c *Client) PublishEvent(ctx context.Context, sourceId SourceID, name EventName, body PublishEventJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PublishEventWithBody ¶
func (*Client) RegisterActionTypes ¶
func (c *Client) RegisterActionTypes(ctx context.Context, body RegisterActionTypesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) RegisterActionTypesWithBody ¶
func (*Client) RegisterEventTypes ¶
func (c *Client) RegisterEventTypes(ctx context.Context, body RegisterEventTypesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) RegisterEventTypesWithBody ¶
func (*Client) SubscribeActionWS ¶
func (c *Client) SubscribeActionWS(ctx context.Context, sourceId SourceID, params *SubscribeActionWSParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) SubscribeEventWS ¶
func (c *Client) SubscribeEventWS(ctx context.Context, sourceId SourceID, params *SubscribeEventWSParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) SubscribeSIO ¶
func (*Client) SubscribeSIO2 ¶
func (*Client) TriggerAction ¶
func (c *Client) TriggerAction(ctx context.Context, sourceId SourceID, name ActionName, body TriggerActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) TriggerActionWithBody ¶
type ClientInterface ¶
type ClientInterface interface {
// SubscribeActionWS request
SubscribeActionWS(ctx context.Context, sourceId SourceID, params *SubscribeActionWSParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// TriggerAction request with any body
TriggerActionWithBody(ctx context.Context, sourceId SourceID, name ActionName, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
TriggerAction(ctx context.Context, sourceId SourceID, name ActionName, body TriggerActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetActionTypes request
GetActionTypes(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// RegisterActionTypes request with any body
RegisterActionTypesWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
RegisterActionTypes(ctx context.Context, body RegisterActionTypesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetActionTypesBySourceID request
GetActionTypesBySourceID(ctx context.Context, sourceId SourceID, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetActionType request
GetActionType(ctx context.Context, sourceId SourceID, name ActionName, reqEditors ...RequestEditorFn) (*http.Response, error)
// SubscribeEventWS request
SubscribeEventWS(ctx context.Context, sourceId SourceID, params *SubscribeEventWSParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PublishEvent request with any body
PublishEventWithBody(ctx context.Context, sourceId SourceID, name EventName, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PublishEvent(ctx context.Context, sourceId SourceID, name EventName, body PublishEventJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetEventTypes request
GetEventTypes(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// RegisterEventTypes request with any body
RegisterEventTypesWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
RegisterEventTypes(ctx context.Context, body RegisterEventTypesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetEventTypesBySourceID request
GetEventTypesBySourceID(ctx context.Context, sourceId SourceID, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetEventType request
GetEventType(ctx context.Context, sourceId SourceID, name EventName, reqEditors ...RequestEditorFn) (*http.Response, error)
// SubscribeSIO request
SubscribeSIO(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// PollSIO request
PollSIO(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// SubscribeSIO2 request
SubscribeSIO2(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// PollSIO2 request
PollSIO2(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) GetActionTypeWithResponse ¶
func (c *ClientWithResponses) GetActionTypeWithResponse(ctx context.Context, sourceId SourceID, name ActionName, reqEditors ...RequestEditorFn) (*GetActionTypeResponse, error)
GetActionTypeWithResponse request returning *GetActionTypeResponse
func (*ClientWithResponses) GetActionTypesBySourceIDWithResponse ¶
func (c *ClientWithResponses) GetActionTypesBySourceIDWithResponse(ctx context.Context, sourceId SourceID, reqEditors ...RequestEditorFn) (*GetActionTypesBySourceIDResponse, error)
GetActionTypesBySourceIDWithResponse request returning *GetActionTypesBySourceIDResponse
func (*ClientWithResponses) GetActionTypesWithResponse ¶
func (c *ClientWithResponses) GetActionTypesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetActionTypesResponse, error)
GetActionTypesWithResponse request returning *GetActionTypesResponse
func (*ClientWithResponses) GetEventTypeWithResponse ¶
func (c *ClientWithResponses) GetEventTypeWithResponse(ctx context.Context, sourceId SourceID, name EventName, reqEditors ...RequestEditorFn) (*GetEventTypeResponse, error)
GetEventTypeWithResponse request returning *GetEventTypeResponse
func (*ClientWithResponses) GetEventTypesBySourceIDWithResponse ¶
func (c *ClientWithResponses) GetEventTypesBySourceIDWithResponse(ctx context.Context, sourceId SourceID, reqEditors ...RequestEditorFn) (*GetEventTypesBySourceIDResponse, error)
GetEventTypesBySourceIDWithResponse request returning *GetEventTypesBySourceIDResponse
func (*ClientWithResponses) GetEventTypesWithResponse ¶
func (c *ClientWithResponses) GetEventTypesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetEventTypesResponse, error)
GetEventTypesWithResponse request returning *GetEventTypesResponse
func (*ClientWithResponses) PollSIO2WithResponse ¶
func (c *ClientWithResponses) PollSIO2WithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PollSIO2Response, error)
PollSIO2WithResponse request returning *PollSIO2Response
func (*ClientWithResponses) PollSIOWithResponse ¶
func (c *ClientWithResponses) PollSIOWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PollSIOResponse, error)
PollSIOWithResponse request returning *PollSIOResponse
func (*ClientWithResponses) PublishEventWithBodyWithResponse ¶
func (c *ClientWithResponses) PublishEventWithBodyWithResponse(ctx context.Context, sourceId SourceID, name EventName, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PublishEventResponse, error)
PublishEventWithBodyWithResponse request with arbitrary body returning *PublishEventResponse
func (*ClientWithResponses) PublishEventWithResponse ¶
func (c *ClientWithResponses) PublishEventWithResponse(ctx context.Context, sourceId SourceID, name EventName, body PublishEventJSONRequestBody, reqEditors ...RequestEditorFn) (*PublishEventResponse, error)
func (*ClientWithResponses) RegisterActionTypesWithBodyWithResponse ¶
func (c *ClientWithResponses) RegisterActionTypesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterActionTypesResponse, error)
RegisterActionTypesWithBodyWithResponse request with arbitrary body returning *RegisterActionTypesResponse
func (*ClientWithResponses) RegisterActionTypesWithResponse ¶
func (c *ClientWithResponses) RegisterActionTypesWithResponse(ctx context.Context, body RegisterActionTypesJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterActionTypesResponse, error)
func (*ClientWithResponses) RegisterEventTypesWithBodyWithResponse ¶
func (c *ClientWithResponses) RegisterEventTypesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterEventTypesResponse, error)
RegisterEventTypesWithBodyWithResponse request with arbitrary body returning *RegisterEventTypesResponse
func (*ClientWithResponses) RegisterEventTypesWithResponse ¶
func (c *ClientWithResponses) RegisterEventTypesWithResponse(ctx context.Context, body RegisterEventTypesJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterEventTypesResponse, error)
func (*ClientWithResponses) SubscribeActionWSWithResponse ¶
func (c *ClientWithResponses) SubscribeActionWSWithResponse(ctx context.Context, sourceId SourceID, params *SubscribeActionWSParams, reqEditors ...RequestEditorFn) (*SubscribeActionWSResponse, error)
SubscribeActionWSWithResponse request returning *SubscribeActionWSResponse
func (*ClientWithResponses) SubscribeEventWSWithResponse ¶
func (c *ClientWithResponses) SubscribeEventWSWithResponse(ctx context.Context, sourceId SourceID, params *SubscribeEventWSParams, reqEditors ...RequestEditorFn) (*SubscribeEventWSResponse, error)
SubscribeEventWSWithResponse request returning *SubscribeEventWSResponse
func (*ClientWithResponses) SubscribeSIO2WithResponse ¶
func (c *ClientWithResponses) SubscribeSIO2WithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SubscribeSIO2Response, error)
SubscribeSIO2WithResponse request returning *SubscribeSIO2Response
func (*ClientWithResponses) SubscribeSIOWithResponse ¶
func (c *ClientWithResponses) SubscribeSIOWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SubscribeSIOResponse, error)
SubscribeSIOWithResponse request returning *SubscribeSIOResponse
func (*ClientWithResponses) TriggerActionWithBodyWithResponse ¶
func (c *ClientWithResponses) TriggerActionWithBodyWithResponse(ctx context.Context, sourceId SourceID, name ActionName, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*TriggerActionResponse, error)
TriggerActionWithBodyWithResponse request with arbitrary body returning *TriggerActionResponse
func (*ClientWithResponses) TriggerActionWithResponse ¶
func (c *ClientWithResponses) TriggerActionWithResponse(ctx context.Context, sourceId SourceID, name ActionName, body TriggerActionJSONRequestBody, reqEditors ...RequestEditorFn) (*TriggerActionResponse, error)
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// SubscribeActionWS request
SubscribeActionWSWithResponse(ctx context.Context, sourceId SourceID, params *SubscribeActionWSParams, reqEditors ...RequestEditorFn) (*SubscribeActionWSResponse, error)
// TriggerAction request with any body
TriggerActionWithBodyWithResponse(ctx context.Context, sourceId SourceID, name ActionName, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*TriggerActionResponse, error)
TriggerActionWithResponse(ctx context.Context, sourceId SourceID, name ActionName, body TriggerActionJSONRequestBody, reqEditors ...RequestEditorFn) (*TriggerActionResponse, error)
// GetActionTypes request
GetActionTypesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetActionTypesResponse, error)
// RegisterActionTypes request with any body
RegisterActionTypesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterActionTypesResponse, error)
RegisterActionTypesWithResponse(ctx context.Context, body RegisterActionTypesJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterActionTypesResponse, error)
// GetActionTypesBySourceID request
GetActionTypesBySourceIDWithResponse(ctx context.Context, sourceId SourceID, reqEditors ...RequestEditorFn) (*GetActionTypesBySourceIDResponse, error)
// GetActionType request
GetActionTypeWithResponse(ctx context.Context, sourceId SourceID, name ActionName, reqEditors ...RequestEditorFn) (*GetActionTypeResponse, error)
// SubscribeEventWS request
SubscribeEventWSWithResponse(ctx context.Context, sourceId SourceID, params *SubscribeEventWSParams, reqEditors ...RequestEditorFn) (*SubscribeEventWSResponse, error)
// PublishEvent request with any body
PublishEventWithBodyWithResponse(ctx context.Context, sourceId SourceID, name EventName, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PublishEventResponse, error)
PublishEventWithResponse(ctx context.Context, sourceId SourceID, name EventName, body PublishEventJSONRequestBody, reqEditors ...RequestEditorFn) (*PublishEventResponse, error)
// GetEventTypes request
GetEventTypesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetEventTypesResponse, error)
// RegisterEventTypes request with any body
RegisterEventTypesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterEventTypesResponse, error)
RegisterEventTypesWithResponse(ctx context.Context, body RegisterEventTypesJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterEventTypesResponse, error)
// GetEventTypesBySourceID request
GetEventTypesBySourceIDWithResponse(ctx context.Context, sourceId SourceID, reqEditors ...RequestEditorFn) (*GetEventTypesBySourceIDResponse, error)
// GetEventType request
GetEventTypeWithResponse(ctx context.Context, sourceId SourceID, name EventName, reqEditors ...RequestEditorFn) (*GetEventTypeResponse, error)
// SubscribeSIO request
SubscribeSIOWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SubscribeSIOResponse, error)
// PollSIO request
PollSIOWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PollSIOResponse, error)
// SubscribeSIO2 request
SubscribeSIO2WithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SubscribeSIO2Response, error)
// PollSIO2 request
PollSIO2WithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PollSIO2Response, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type Event ¶
type Event struct {
// Name event name
Name string `json:"name"`
// Properties event properties
Properties map[string]string `json:"properties"`
// SourceID associated source id
SourceID string `json:"sourceID"`
// Timestamp timestamp this event took place
Timestamp *time.Time `json:"timestamp,omitempty"`
// Uuid event uuid
Uuid *string `json:"uuid,omitempty"`
}
Event defines model for Event.
type EventType ¶
type EventType struct {
// Name event name
//
// (there is no naming convention for event names, but it is recommended to name each as structural and descriptive as possible)
Name string `json:"name"`
PropertyTypeList []PropertyType `json:"propertyTypeList"`
// SourceID event source id to identify where the event comes from
SourceID string `json:"sourceID"`
}
EventType defines model for EventType.
type GetActionTypeOK ¶
type GetActionTypeOK = ActionType
GetActionTypeOK defines model for GetActionTypeOK.
type GetActionTypeResponse ¶
type GetActionTypeResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ActionType
JSON404 *BaseResponse
}
func ParseGetActionTypeResponse ¶
func ParseGetActionTypeResponse(rsp *http.Response) (*GetActionTypeResponse, error)
ParseGetActionTypeResponse parses an HTTP response from a GetActionTypeWithResponse call
func (GetActionTypeResponse) Status ¶
func (r GetActionTypeResponse) Status() string
Status returns HTTPResponse.Status
func (GetActionTypeResponse) StatusCode ¶
func (r GetActionTypeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetActionTypesBySourceIDResponse ¶
type GetActionTypesBySourceIDResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]ActionType
JSON404 *BaseResponse
}
func ParseGetActionTypesBySourceIDResponse ¶
func ParseGetActionTypesBySourceIDResponse(rsp *http.Response) (*GetActionTypesBySourceIDResponse, error)
ParseGetActionTypesBySourceIDResponse parses an HTTP response from a GetActionTypesBySourceIDWithResponse call
func (GetActionTypesBySourceIDResponse) Status ¶
func (r GetActionTypesBySourceIDResponse) Status() string
Status returns HTTPResponse.Status
func (GetActionTypesBySourceIDResponse) StatusCode ¶
func (r GetActionTypesBySourceIDResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetActionTypesOK ¶
type GetActionTypesOK = []ActionType
GetActionTypesOK defines model for GetActionTypesOK.
type GetActionTypesResponse ¶
type GetActionTypesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]ActionType
}
func ParseGetActionTypesResponse ¶
func ParseGetActionTypesResponse(rsp *http.Response) (*GetActionTypesResponse, error)
ParseGetActionTypesResponse parses an HTTP response from a GetActionTypesWithResponse call
func (GetActionTypesResponse) Status ¶
func (r GetActionTypesResponse) Status() string
Status returns HTTPResponse.Status
func (GetActionTypesResponse) StatusCode ¶
func (r GetActionTypesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetEventTypeOK ¶
type GetEventTypeOK = EventType
GetEventTypeOK defines model for GetEventTypeOK.
type GetEventTypeResponse ¶
type GetEventTypeResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *EventType
JSON404 *BaseResponse
}
func ParseGetEventTypeResponse ¶
func ParseGetEventTypeResponse(rsp *http.Response) (*GetEventTypeResponse, error)
ParseGetEventTypeResponse parses an HTTP response from a GetEventTypeWithResponse call
func (GetEventTypeResponse) Status ¶
func (r GetEventTypeResponse) Status() string
Status returns HTTPResponse.Status
func (GetEventTypeResponse) StatusCode ¶
func (r GetEventTypeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetEventTypesBySourceIDResponse ¶
type GetEventTypesBySourceIDResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]EventType
JSON404 *BaseResponse
}
func ParseGetEventTypesBySourceIDResponse ¶
func ParseGetEventTypesBySourceIDResponse(rsp *http.Response) (*GetEventTypesBySourceIDResponse, error)
ParseGetEventTypesBySourceIDResponse parses an HTTP response from a GetEventTypesBySourceIDWithResponse call
func (GetEventTypesBySourceIDResponse) Status ¶
func (r GetEventTypesBySourceIDResponse) Status() string
Status returns HTTPResponse.Status
func (GetEventTypesBySourceIDResponse) StatusCode ¶
func (r GetEventTypesBySourceIDResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetEventTypesOK ¶
type GetEventTypesOK = []EventType
GetEventTypesOK defines model for GetEventTypesOK.
type GetEventTypesResponse ¶
type GetEventTypesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]EventType
JSON500 *BaseResponse
}
func ParseGetEventTypesResponse ¶
func ParseGetEventTypesResponse(rsp *http.Response) (*GetEventTypesResponse, error)
ParseGetEventTypesResponse parses an HTTP response from a GetEventTypesWithResponse call
func (GetEventTypesResponse) Status ¶
func (r GetEventTypesResponse) Status() string
Status returns HTTPResponse.Status
func (GetEventTypesResponse) StatusCode ¶
func (r GetEventTypesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type PollSIO2Response ¶
func ParsePollSIO2Response ¶
func ParsePollSIO2Response(rsp *http.Response) (*PollSIO2Response, error)
ParsePollSIO2Response parses an HTTP response from a PollSIO2WithResponse call
func (PollSIO2Response) Status ¶
func (r PollSIO2Response) Status() string
Status returns HTTPResponse.Status
func (PollSIO2Response) StatusCode ¶
func (r PollSIO2Response) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PollSIOResponse ¶
func ParsePollSIOResponse ¶
func ParsePollSIOResponse(rsp *http.Response) (*PollSIOResponse, error)
ParsePollSIOResponse parses an HTTP response from a PollSIOWithResponse call
func (PollSIOResponse) Status ¶
func (r PollSIOResponse) Status() string
Status returns HTTPResponse.Status
func (PollSIOResponse) StatusCode ¶
func (r PollSIOResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PropertyType ¶
type PropertyType struct {
Description *string `json:"description,omitempty"`
Example *string `json:"example,omitempty"`
// Name property name
//
// > It is recommended for a property name to be as descriptive as possible. One option is to prefix with a namespace.
// > - If the property is source specific, prefix with source ID. For example, `local-storage:vendor`
// > - Otherwise, prefix with `common:`. For example, `common:email`
// >
// > Some bad examples are `id`, `avail`, `blk`...which can be ambiguous and confusing.
Name string `json:"name"`
}
PropertyType defines model for PropertyType.
type PublishEventJSONBody ¶
PublishEventJSONBody defines parameters for PublishEvent.
type PublishEventJSONRequestBody ¶
type PublishEventJSONRequestBody PublishEventJSONBody
PublishEventJSONRequestBody defines body for PublishEvent for application/json ContentType.
type PublishEventResponse ¶
type PublishEventResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *Event
JSON400 *BaseResponse
JSON404 *BaseResponse
}
func ParsePublishEventResponse ¶
func ParsePublishEventResponse(rsp *http.Response) (*PublishEventResponse, error)
ParsePublishEventResponse parses an HTTP response from a PublishEventWithResponse call
func (PublishEventResponse) Status ¶
func (r PublishEventResponse) Status() string
Status returns HTTPResponse.Status
func (PublishEventResponse) StatusCode ¶
func (r PublishEventResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RegisterActionTypes ¶
type RegisterActionTypes = []ActionType
RegisterActionTypes defines model for RegisterActionTypes.
type RegisterActionTypesJSONBody ¶
type RegisterActionTypesJSONBody = []ActionType
RegisterActionTypesJSONBody defines parameters for RegisterActionTypes.
type RegisterActionTypesJSONRequestBody ¶
type RegisterActionTypesJSONRequestBody = RegisterActionTypesJSONBody
RegisterActionTypesJSONRequestBody defines body for RegisterActionTypes for application/json ContentType.
type RegisterActionTypesResponse ¶
type RegisterActionTypesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *BaseResponse
JSON400 *BaseResponse
JSON409 *BaseResponse
}
func ParseRegisterActionTypesResponse ¶
func ParseRegisterActionTypesResponse(rsp *http.Response) (*RegisterActionTypesResponse, error)
ParseRegisterActionTypesResponse parses an HTTP response from a RegisterActionTypesWithResponse call
func (RegisterActionTypesResponse) Status ¶
func (r RegisterActionTypesResponse) Status() string
Status returns HTTPResponse.Status
func (RegisterActionTypesResponse) StatusCode ¶
func (r RegisterActionTypesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RegisterEventTypes ¶
type RegisterEventTypes = []EventType
RegisterEventTypes defines model for RegisterEventTypes.
type RegisterEventTypesJSONBody ¶
type RegisterEventTypesJSONBody = []EventType
RegisterEventTypesJSONBody defines parameters for RegisterEventTypes.
type RegisterEventTypesJSONRequestBody ¶
type RegisterEventTypesJSONRequestBody = RegisterEventTypesJSONBody
RegisterEventTypesJSONRequestBody defines body for RegisterEventTypes for application/json ContentType.
type RegisterEventTypesResponse ¶
type RegisterEventTypesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *BaseResponse
JSON400 *BaseResponse
JSON409 *BaseResponse
}
func ParseRegisterEventTypesResponse ¶
func ParseRegisterEventTypesResponse(rsp *http.Response) (*RegisterEventTypesResponse, error)
ParseRegisterEventTypesResponse parses an HTTP response from a RegisterEventTypesWithResponse call
func (RegisterEventTypesResponse) Status ¶
func (r RegisterEventTypesResponse) Status() string
Status returns HTTPResponse.Status
func (RegisterEventTypesResponse) StatusCode ¶
func (r RegisterEventTypesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type ResponseBadRequest ¶
type ResponseBadRequest = BaseResponse
ResponseBadRequest defines model for ResponseBadRequest.
type ResponseConflict ¶
type ResponseConflict = BaseResponse
ResponseConflict defines model for ResponseConflict.
type ResponseInternalServerError ¶
type ResponseInternalServerError = BaseResponse
ResponseInternalServerError defines model for ResponseInternalServerError.
type ResponseNotFound ¶
type ResponseNotFound = BaseResponse
ResponseNotFound defines model for ResponseNotFound.
type SubscribeActionWSParams ¶
type SubscribeActionWSParams struct {
Names *ActionNames `form:"names,omitempty" json:"names,omitempty"`
}
SubscribeActionWSParams defines parameters for SubscribeActionWS.
type SubscribeActionWSResponse ¶
func ParseSubscribeActionWSResponse ¶
func ParseSubscribeActionWSResponse(rsp *http.Response) (*SubscribeActionWSResponse, error)
ParseSubscribeActionWSResponse parses an HTTP response from a SubscribeActionWSWithResponse call
func (SubscribeActionWSResponse) Status ¶
func (r SubscribeActionWSResponse) Status() string
Status returns HTTPResponse.Status
func (SubscribeActionWSResponse) StatusCode ¶
func (r SubscribeActionWSResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SubscribeEventWSParams ¶
type SubscribeEventWSParams struct {
Names *EventNames `form:"names,omitempty" json:"names,omitempty"`
}
SubscribeEventWSParams defines parameters for SubscribeEventWS.
type SubscribeEventWSResponse ¶
func ParseSubscribeEventWSResponse ¶
func ParseSubscribeEventWSResponse(rsp *http.Response) (*SubscribeEventWSResponse, error)
ParseSubscribeEventWSResponse parses an HTTP response from a SubscribeEventWSWithResponse call
func (SubscribeEventWSResponse) Status ¶
func (r SubscribeEventWSResponse) Status() string
Status returns HTTPResponse.Status
func (SubscribeEventWSResponse) StatusCode ¶
func (r SubscribeEventWSResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SubscribeSIO2Response ¶
func ParseSubscribeSIO2Response ¶
func ParseSubscribeSIO2Response(rsp *http.Response) (*SubscribeSIO2Response, error)
ParseSubscribeSIO2Response parses an HTTP response from a SubscribeSIO2WithResponse call
func (SubscribeSIO2Response) Status ¶
func (r SubscribeSIO2Response) Status() string
Status returns HTTPResponse.Status
func (SubscribeSIO2Response) StatusCode ¶
func (r SubscribeSIO2Response) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SubscribeSIOResponse ¶
func ParseSubscribeSIOResponse ¶
func ParseSubscribeSIOResponse(rsp *http.Response) (*SubscribeSIOResponse, error)
ParseSubscribeSIOResponse parses an HTTP response from a SubscribeSIOWithResponse call
func (SubscribeSIOResponse) Status ¶
func (r SubscribeSIOResponse) Status() string
Status returns HTTPResponse.Status
func (SubscribeSIOResponse) StatusCode ¶
func (r SubscribeSIOResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type TriggerActionJSONBody ¶
TriggerActionJSONBody defines parameters for TriggerAction.
type TriggerActionJSONRequestBody ¶
type TriggerActionJSONRequestBody TriggerActionJSONBody
TriggerActionJSONRequestBody defines body for TriggerAction for application/json ContentType.
type TriggerActionOK ¶
type TriggerActionOK = Action
TriggerActionOK defines model for TriggerActionOK.
type TriggerActionResponse ¶
type TriggerActionResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *Action
JSON400 *BaseResponse
JSON404 *BaseResponse
}
func ParseTriggerActionResponse ¶
func ParseTriggerActionResponse(rsp *http.Response) (*TriggerActionResponse, error)
ParseTriggerActionResponse parses an HTTP response from a TriggerActionWithResponse call
func (TriggerActionResponse) Status ¶
func (r TriggerActionResponse) Status() string
Status returns HTTPResponse.Status
func (TriggerActionResponse) StatusCode ¶
func (r TriggerActionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode