server

package
v0.8.0 Latest Latest
Warning

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

Go to latest
Published: Dec 23, 2022 License: MPL-2.0 Imports: 42 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateOrganisationInviteService added in v0.7.0

func CreateOrganisationInviteService(a *ApplicationHandler) *services.OrganisationInviteService

func FindMessageDeliveryAttempt added in v0.7.0

func FindMessageDeliveryAttempt(attempts *[]datastore.DeliveryAttempt, id string) (*datastore.DeliveryAttempt, error)

Types

type App added in v0.7.0

type App struct {
	Store    datastore.Store
	Queue    queue.Queuer
	Logger   log.StdLogger
	Tracer   tracer.Tracer
	Cache    cache.Cache
	Limiter  limiter.RateLimiter
	Searcher searcher.Searcher
}

type ApplicationHandler added in v0.6.2

type ApplicationHandler struct {
	M      *middleware.Middleware
	Router http.Handler
	A      App
}

func NewApplicationHandler added in v0.6.2

func NewApplicationHandler(a App) *ApplicationHandler

func (*ApplicationHandler) BatchReplayEvents added in v0.8.0

func (a *ApplicationHandler) BatchReplayEvents(w http.ResponseWriter, r *http.Request)

BatchReplayEvents @Summary Replays multiple endpoint events @Description This endpoint replays multiple events @Tags Events @Accept json @Produce json @Param projectID path string true "Project id" @Param startDate query string false "start date" @Param endDate query string false "end date" @Param source query string false "Source id" @Success 200 {object} util.ServerResponse{data=datastore.Event{data=Stub}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/events/batchreplay [post]

func (*ApplicationHandler) BatchRetryEventDelivery added in v0.6.2

func (a *ApplicationHandler) BatchRetryEventDelivery(w http.ResponseWriter, r *http.Request)

BatchRetryEventDelivery @Summary Batch Resend app events @Description This endpoint resends multiple app events @Tags EventDeliveries @Accept json @Produce json @Param projectID path string true "Project id" @Param deliveryIds body Stub{ids=[]string} true "event delivery ids" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/eventdeliveries/batchretry [post]

func (*ApplicationHandler) BuildRoutes added in v0.6.2

func (a *ApplicationHandler) BuildRoutes() http.Handler

func (*ApplicationHandler) CancelOrganizationInvite added in v0.6.2

func (a *ApplicationHandler) CancelOrganizationInvite(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) CountAffectedEventDeliveries added in v0.6.2

func (a *ApplicationHandler) CountAffectedEventDeliveries(w http.ResponseWriter, r *http.Request)

CountAffectedEventDeliveries @Summary Count affected eventDeliveries @Description This endpoint counts app events that will be affected by a batch retry operation @Tags EventDeliveries @Accept json @Produce json @Param appId query string false "application id" @Param projectID path string true "Project id" @Param startDate query string false "start date" @Param endDate query string false "end date" @Param perPage query string false "results per page" @Param page query string false "page number" @Param sort query string false "sort order" @Success 200 {object} util.ServerResponse{data=Stub{num=integer}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/eventdeliveries/countbatchretryevents [get]

func (*ApplicationHandler) CountAffectedEvents added in v0.8.0

func (a *ApplicationHandler) CountAffectedEvents(w http.ResponseWriter, r *http.Request)

CountAffectedEvents @Summary Counts affected events @Description This endpoint counts events that will be affected by a batch replay operation @Tags Events @Accept json @Produce json @Param projectID path string true "Project id" @Param startDate query string false "start date" @Param endDate query string false "end date" @Param source query string false "Source id" @Success 200 {object} util.ServerResponse{data=Stub{num=integer}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/events/countbatchreplayevents [get]

func (*ApplicationHandler) CreateAPIKey added in v0.6.2

func (a *ApplicationHandler) CreateAPIKey(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) CreateApp added in v0.6.2

func (a *ApplicationHandler) CreateApp(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) CreateAppEndpoint added in v0.6.2

func (a *ApplicationHandler) CreateAppEndpoint(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) CreateConfiguration added in v0.6.2

func (a *ApplicationHandler) CreateConfiguration(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) CreateEndpoint added in v0.8.0

func (a *ApplicationHandler) CreateEndpoint(w http.ResponseWriter, r *http.Request)

CreateEndpoint @Summary Create an endpoint @Description This endpoint creates an endpoint @Tags Endpoints @Accept json @Produce json @Param projectID path string true "Project id" @Param endpoint body models.Endpoint true "Endpoint Details" @Success 200 {object} util.ServerResponse{data=datastore.Endpoint} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/endpoints [post]

func (*ApplicationHandler) CreateEndpointAPIKey added in v0.8.0

func (a *ApplicationHandler) CreateEndpointAPIKey(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) CreateEndpointEvent added in v0.8.0

func (a *ApplicationHandler) CreateEndpointEvent(w http.ResponseWriter, r *http.Request)

CreateEndpointEvent @Summary Create endpoint event @Description This endpoint creates an endpoint event @Tags Events @Accept json @Produce json @Param projectID path string true "Project id" @Param event body models.Event true "Event Details" @Success 200 {object} util.ServerResponse{data=datastore.Event{data=Stub}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/events [post]

func (*ApplicationHandler) CreateEndpointFanoutEvent added in v0.8.0

func (a *ApplicationHandler) CreateEndpointFanoutEvent(w http.ResponseWriter, r *http.Request)

CreateEndpointFanoutEvent @Summary Fan out an event to multiple endpoints. @Description This endpoint uses the owner_id to fan out an event to multiple endpoints. @Tags Events @Accept json @Produce json @Param projectID path string true "Project id" @Param event body models.FanoutEvent true "Event Details" @Success 200 {object} util.ServerResponse{data=datastore.Event{data=Stub}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/events/fanout [post]

func (*ApplicationHandler) CreateOrganisation added in v0.6.2

func (a *ApplicationHandler) CreateOrganisation(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) CreatePersonalAPIKey added in v0.7.0

func (a *ApplicationHandler) CreatePersonalAPIKey(w http.ResponseWriter, r *http.Request)
func (a *ApplicationHandler) CreatePortalLink(w http.ResponseWriter, r *http.Request)

CreatePortalLink @Summary Create a portal link @Description This endpoint creates a portal link @Tags PortalLinks @Accept json @Produce json @Param projectID path string true "Project id" @Param portallink body models.PortalLink true "Portal Link Details" @Success 200 {object} util.ServerResponse{data=models.PortalLinkResponse} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/portal-links [post]

func (*ApplicationHandler) CreatePortalLinkEndpoint added in v0.8.0

func (a *ApplicationHandler) CreatePortalLinkEndpoint(w http.ResponseWriter, r *http.Request)

CreatePortalLinkEndpoint @Summary Create an endpoint @Description This endpoint creates an endpoint @Tags PortalLinks @Accept json @Produce json @Param endpoint body models.Endpoint true "Endpoint Details" @Success 200 {object} util.ServerResponse{data=datastore.Endpoint} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Router /portal/endpoints [post]

func (*ApplicationHandler) CreateProject added in v0.8.0

func (a *ApplicationHandler) CreateProject(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) CreateSource added in v0.6.2

func (a *ApplicationHandler) CreateSource(w http.ResponseWriter, r *http.Request)

CreateSource @Summary Create a source @Description This endpoint creates a source @Tags Sources @Accept json @Produce json @Param projectID path string true "Project id" @Param source body models.Source true "Source Details" @Success 200 {object} util.ServerResponse{data=models.SourceResponse} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/sources [post]

func (*ApplicationHandler) CreateSubscription added in v0.6.2

func (a *ApplicationHandler) CreateSubscription(w http.ResponseWriter, r *http.Request)

CreateSubscription @Summary Creates a subscription @Description This endpoint creates a subscriptions @Tags Subscriptions @Accept json @Produce json @Param projectID path string true "Project id" @Param subscription body models.Subscription true "Subscription details" @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]datastore.Subscription}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/subscriptions [post]

func (*ApplicationHandler) DeleteApp added in v0.6.2

func (a *ApplicationHandler) DeleteApp(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) DeleteAppEndpoint added in v0.6.2

func (a *ApplicationHandler) DeleteAppEndpoint(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) DeleteEndpoint added in v0.8.0

func (a *ApplicationHandler) DeleteEndpoint(w http.ResponseWriter, r *http.Request)

DeleteEndpoint @Summary Delete endpoint @Description This endpoint deletes an endpoint @Tags Endpoints @Accept json @Produce json @Param projectID path string true "Project id" @Param endpointID path string true "endpoint id" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/endpoints/{endpointID} [delete]

func (*ApplicationHandler) DeleteOrganisation added in v0.6.2

func (a *ApplicationHandler) DeleteOrganisation(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) DeleteOrganisationMember added in v0.6.2

func (a *ApplicationHandler) DeleteOrganisationMember(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) DeleteProject added in v0.8.0

func (a *ApplicationHandler) DeleteProject(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) DeleteSource added in v0.6.2

func (a *ApplicationHandler) DeleteSource(w http.ResponseWriter, r *http.Request)

DeleteSource @Summary Delete source @Description This endpoint deletes a source @Tags Sources @Accept json @Produce json @Param projectID path string true "Project id" @Param sourceID path string true "source id" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/sources/{sourceID} [delete]

func (*ApplicationHandler) DeleteSubscription added in v0.6.2

func (a *ApplicationHandler) DeleteSubscription(w http.ResponseWriter, r *http.Request)

DeleteSubscription @Summary Delete subscription @Description This endpoint deletes a subscription @Tags Subscriptions @Accept json @Produce json @Param projectID path string true "Project id" @Param subscriptionID path string true "subscription id" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/subscriptions/{subscriptionID} [delete]

func (*ApplicationHandler) ExpireSecret added in v0.7.2

func (a *ApplicationHandler) ExpireSecret(w http.ResponseWriter, r *http.Request)

ExpireSecret @Summary Expire and generate new application endpoint secret @Description This endpoint expires the current endpoint secret and generates a new one. @Tags Endpoints @Accept json @Produce json @Param projectID path string true "Project id" @Param endpointID path string true "endpoint id" @Success 200 {object} util.ServerResponse{data=datastore.Endpoint} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/endpoints/{endpointID}/expire_secret [put]

func (*ApplicationHandler) FindDevicesByAppID added in v0.7.0

func (a *ApplicationHandler) FindDevicesByAppID(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) FindUserByInviteToken added in v0.6.2

func (a *ApplicationHandler) FindUserByInviteToken(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) ForceResendEventDeliveries added in v0.6.2

func (a *ApplicationHandler) ForceResendEventDeliveries(w http.ResponseWriter, r *http.Request)

ForceResendEventDeliveries @Summary Force Resend app events @Description This endpoint force resends multiple app events @Tags EventDeliveries @Accept json @Produce json @Param projectID path string true "Project id" @Param deliveryIds body Stub{ids=[]string} true "event delivery ids" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/eventdeliveries/forceresend [post]

func (*ApplicationHandler) ForgotPassword added in v0.6.2

func (a *ApplicationHandler) ForgotPassword(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) GetAPIKeyByID added in v0.6.2

func (a *ApplicationHandler) GetAPIKeyByID(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) GetAPIKeys added in v0.6.2

func (a *ApplicationHandler) GetAPIKeys(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) GetAllConfigDetails added in v0.6.2

func (a *ApplicationHandler) GetAllConfigDetails(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) GetApp added in v0.6.2

func (*ApplicationHandler) GetAppEndpoint added in v0.6.2

func (a *ApplicationHandler) GetAppEndpoint(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) GetAppEndpoints added in v0.6.2

func (a *ApplicationHandler) GetAppEndpoints(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) GetApps added in v0.6.2

func (*ApplicationHandler) GetAuthLogin added in v0.6.2

func (a *ApplicationHandler) GetAuthLogin(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) GetDashboardSummary added in v0.6.2

func (a *ApplicationHandler) GetDashboardSummary(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) GetDeliveryAttempt added in v0.6.2

func (a *ApplicationHandler) GetDeliveryAttempt(w http.ResponseWriter, r *http.Request)

GetDeliveryAttempt @Summary Get delivery attempt @Description This endpoint fetches an app event delivery attempt @Tags DeliveryAttempts @Accept json @Produce json @Param projectID path string true "Project id" @Param eventDeliveryID path string true "event delivery id" @Param deliveryAttemptID path string true "delivery attempt id" @Success 200 {object} util.ServerResponse{data=datastore.DeliveryAttempt} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts/{deliveryAttemptID} [get]

func (*ApplicationHandler) GetDeliveryAttempts added in v0.6.2

func (a *ApplicationHandler) GetDeliveryAttempts(w http.ResponseWriter, r *http.Request)

GetDeliveryAttempts @Summary Get delivery attempts @Description This endpoint fetches an app message's delivery attempts @Tags DeliveryAttempts @Accept json @Produce json @Param projectID path string true "Project id" @Param eventDeliveryID path string true "event delivery id" @Success 200 {object} util.ServerResponse{data=[]datastore.DeliveryAttempt} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts [get]

func (*ApplicationHandler) GetEndpoint added in v0.8.0

func (a *ApplicationHandler) GetEndpoint(w http.ResponseWriter, r *http.Request)

GetEndpoint @Summary Get endpoint @Description This endpoint fetches an endpoint @Tags Endpoints @Accept json @Produce json @Param projectID path string true "Project id" @Param endpointID path string true "endpoint id" @Success 200 {object} util.ServerResponse{data=datastore.Endpoint} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/endpoints/{endpointID} [get]

func (*ApplicationHandler) GetEndpointEvent added in v0.8.0

func (a *ApplicationHandler) GetEndpointEvent(w http.ResponseWriter, r *http.Request)

GetEndpointEvent @Summary Get endpoint event @Description This endpoint fetches an endpoint event @Tags Events @Accept json @Produce json @Param projectID path string true "Project id" @Param eventID path string true "event id" @Success 200 {object} util.ServerResponse{data=datastore.Event{data=Stub}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/events/{eventID} [get]

func (*ApplicationHandler) GetEndpoints added in v0.8.0

func (a *ApplicationHandler) GetEndpoints(w http.ResponseWriter, r *http.Request)

GetEndpoints @Summary Get endpoints @Description This endpoint fetches an endpoints @Tags Endpoints @Accept json @Produce json @Param projectID path string true "Project id" @Success 200 {object} util.ServerResponse{data=[]datastore.Endpoint} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/endpoints [get]

func (*ApplicationHandler) GetEventDeliveriesPaged added in v0.6.2

func (a *ApplicationHandler) GetEventDeliveriesPaged(w http.ResponseWriter, r *http.Request)

GetEventDeliveriesPaged @Summary Get event deliveries @Description This endpoint fetch event deliveries. @Tags EventDeliveries @Accept json @Produce json @Param appId query string false "application id" @Param projectID path string true "Project id" @Param eventId query string false "event id" @Param startDate query string false "start date" @Param endDate query string false "end date" @Param perPage query string false "results per page" @Param page query string false "page number" @Param sort query string false "sort order" @Param status query []string false "status" @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]datastore.EventDelivery{data=Stub}}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/eventdeliveries [get]

func (*ApplicationHandler) GetEventDelivery added in v0.6.2

func (a *ApplicationHandler) GetEventDelivery(w http.ResponseWriter, r *http.Request)

GetEventDelivery @Summary Get event delivery @Description This endpoint fetches an event delivery. @Tags EventDeliveries @Accept json @Produce json @Param projectID path string true "Project id" @Param eventDeliveryID path string true "event delivery id" @Success 200 {object} util.ServerResponse{data=datastore.Event{data=Stub}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/eventdeliveries/{eventDeliveryID} [get]

func (*ApplicationHandler) GetEventsPaged added in v0.6.2

func (a *ApplicationHandler) GetEventsPaged(w http.ResponseWriter, r *http.Request)

GetEventsPaged @Summary Get app events with pagination @Description This endpoint fetches app events with pagination @Tags Events @Accept json @Produce json @Param appId query string false "application id" @Param projectID path string true "Project id" @Param sourceId query string false "source id" @Param startDate query string false "start date" @Param endDate query string false "end date" @Param perPage query string false "results per page" @Param page query string false "page number" @Param sort query string false "sort order" @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]datastore.Event{data=Stub}}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/events [get]

func (*ApplicationHandler) GetOrganisation added in v0.6.2

func (a *ApplicationHandler) GetOrganisation(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) GetOrganisationMember added in v0.6.2

func (a *ApplicationHandler) GetOrganisationMember(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) GetOrganisationMembers added in v0.6.2

func (a *ApplicationHandler) GetOrganisationMembers(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) GetOrganisationsPaged added in v0.6.2

func (a *ApplicationHandler) GetOrganisationsPaged(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) GetPendingOrganisationInvites added in v0.6.2

func (a *ApplicationHandler) GetPendingOrganisationInvites(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) GetPortalLinkByID added in v0.8.0

func (a *ApplicationHandler) GetPortalLinkByID(w http.ResponseWriter, r *http.Request)

GetPortalLinkByID @Summary Get a portal link @Description This endpoint fetches a portal link by its id @Tags PortalLinks @Accept json @Produce json @Param projectID path string true "Project id" @Param portalLinkID path string true "portal link id" @Success 200 {object} util.ServerResponse{data=models.PortalLinkResponse} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/portal-links/{portalLinkID} [get]

func (*ApplicationHandler) GetPortalLinkDevices added in v0.8.0

func (a *ApplicationHandler) GetPortalLinkDevices(w http.ResponseWriter, r *http.Request)

GetPortalLinkDevices @Summary Get portal link devices @Description This endpoint fetches all portal link devices @Tags PortalLinks @Accept json @Produce json @Success 200 {object} util.ServerResponse{data=[]datastore.Device} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Router /portal/devices [get]

func (*ApplicationHandler) GetPortalLinkEndpoints added in v0.8.0

func (a *ApplicationHandler) GetPortalLinkEndpoints(w http.ResponseWriter, r *http.Request)

GetPortalLinkEndpoints @Summary Get endpoints @Description This endpoint fetches all portal link endpoints @Tags PortalLinks @Accept json @Produce json @Success 200 {object} util.ServerResponse{data=[]datastore.Endpoint} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Router /portal/endpoints [get]

func (*ApplicationHandler) GetPortalLinkKeys added in v0.8.0

func (a *ApplicationHandler) GetPortalLinkKeys(w http.ResponseWriter, r *http.Request)

GetPortalLinkKeys @Summary Get portal link keys @Description This endpoint fetches all portal link endpoints keys @Tags PortalLinks @Accept json @Produce json @Success 200 {object} util.ServerResponse{data=models.PortalAPIKeyResponse} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Router /portal/keys [get]

func (*ApplicationHandler) GetProject added in v0.8.0

func (a *ApplicationHandler) GetProject(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) GetProjects added in v0.8.0

func (a *ApplicationHandler) GetProjects(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) GetSourceByID added in v0.6.2

func (a *ApplicationHandler) GetSourceByID(w http.ResponseWriter, r *http.Request)

GetSourceByID @Summary Get a source @Description This endpoint fetches a source by its id @Tags Sources @Accept json @Produce json @Param projectID path string true "Project id" @Param sourceID path string true "source id" @Success 200 {object} util.ServerResponse{data=models.SourceResponse} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/sources/{sourceID} [get]

func (*ApplicationHandler) GetSubscription added in v0.6.2

func (a *ApplicationHandler) GetSubscription(w http.ResponseWriter, r *http.Request)

GetSubscription @Summary Gets a subscription @Description This endpoint fetches an Subscription by it's id @Tags Subscriptions @Accept json @Produce json @Param projectID path string true "Project id" @Param subscriptionID path string true "subscription id" @Success 200 {object} util.ServerResponse{data=datastore.Subscription} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/subscriptions/{subscriptionID} [get]

func (*ApplicationHandler) GetSubscriptions added in v0.6.2

func (a *ApplicationHandler) GetSubscriptions(w http.ResponseWriter, r *http.Request)

GetSubscriptions @Summary Get all subscriptions @Description This endpoint fetches all the subscriptions @Tags Subscriptions @Accept json @Produce json @Param perPage query string false "results per page" @Param page query string false "page number" @Param sort query string false "sort order" @Param q query string false "subscription title" @Param projectID path string true "Project id" @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]datastore.Subscription}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/subscriptions [get]

func (*ApplicationHandler) GetUser added in v0.6.2

func (*ApplicationHandler) GetUserOrganisations added in v0.7.0

func (a *ApplicationHandler) GetUserOrganisations(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) HandleCrcCheck added in v0.6.2

func (a *ApplicationHandler) HandleCrcCheck(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) IngestEvent added in v0.6.2

func (a *ApplicationHandler) IngestEvent(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) InviteUserToOrganisation added in v0.6.2

func (a *ApplicationHandler) InviteUserToOrganisation(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) LoadConfiguration added in v0.6.2

func (a *ApplicationHandler) LoadConfiguration(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) LoadEndpointAPIKeysPaged added in v0.8.0

func (a *ApplicationHandler) LoadEndpointAPIKeysPaged(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) LoadPortalLinksPaged added in v0.8.0

func (a *ApplicationHandler) LoadPortalLinksPaged(w http.ResponseWriter, r *http.Request)

LoadPortalLinksPaged @Summary Fetch multiple portal links @Description This endpoint fetches multiple portal links @Tags PortalLinks @Accept json @Produce json @Param projectID path string true "Project id" @Param perPage query string false "results per page" @Param page query string false "page number" @Param sort query string false "sort order" @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]models.PortalLinkResponse}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/portal-links [get]

func (*ApplicationHandler) LoadSourcesPaged added in v0.6.2

func (a *ApplicationHandler) LoadSourcesPaged(w http.ResponseWriter, r *http.Request)

LoadSourcesPaged @Summary Fetch multiple sources @Description This endpoint fetches multiple sources @Tags Sources @Accept json @Produce json @Param projectID path string true "Project id" @Param perPage query string false "results per page" @Param page query string false "page number" @Param sort query string false "sort order" @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]models.SourceResponse}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/sources [get]

func (*ApplicationHandler) LoginUser added in v0.6.2

func (a *ApplicationHandler) LoginUser(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) LogoutUser added in v0.6.2

func (a *ApplicationHandler) LogoutUser(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) ProcessOrganisationMemberInvite added in v0.6.2

func (a *ApplicationHandler) ProcessOrganisationMemberInvite(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) RedirectToProjects added in v0.7.0

func (a *ApplicationHandler) RedirectToProjects(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) RefreshToken added in v0.6.2

func (a *ApplicationHandler) RefreshToken(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) RegisterUser added in v0.6.5

func (a *ApplicationHandler) RegisterUser(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) ReplayEndpointEvent added in v0.8.0

func (a *ApplicationHandler) ReplayEndpointEvent(w http.ResponseWriter, r *http.Request)

ReplayEndpointEvent @Summary Replay endpoint event @Description This endpoint replays an endpoint event @Tags Events @Accept json @Produce json @Param projectID path string true "Project id" @Param eventID path string true "event id" @Success 200 {object} util.ServerResponse{data=datastore.Event{data=Stub}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/events/{eventID}/replay [put]

func (*ApplicationHandler) ResendEventDelivery added in v0.6.2

func (a *ApplicationHandler) ResendEventDelivery(w http.ResponseWriter, r *http.Request)

ResendEventDelivery @Summary Resend an app event @Description This endpoint resends an app event @Tags EventDeliveries @Accept json @Produce json @Param projectID path string true "Project id" @Param eventDeliveryID path string true "event delivery id" @Success 200 {object} util.ServerResponse{data=datastore.Event{data=Stub}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/resend [put]

func (*ApplicationHandler) ResendOrganizationInvite added in v0.6.2

func (a *ApplicationHandler) ResendOrganizationInvite(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) ResendVerificationEmail added in v0.8.0

func (a *ApplicationHandler) ResendVerificationEmail(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) ResetPassword added in v0.6.2

func (a *ApplicationHandler) ResetPassword(w http.ResponseWriter, r *http.Request)

ResetPassword @Summary Reset user password @Description This endpoint resets a users password @Tags User @Accept json @Produce json @Param token query string true "reset token" @Param password body models.ResetPassword true "Reset Password Details" @Success 200 {object} util.ServerResponse{data=datastore.User} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Router /ui/users/reset-password [post]

func (*ApplicationHandler) RevokeAPIKey added in v0.6.2

func (a *ApplicationHandler) RevokeAPIKey(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) RevokeEndpointAPIKey added in v0.8.0

func (a *ApplicationHandler) RevokeEndpointAPIKey(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) RevokePersonalAPIKey added in v0.7.0

func (a *ApplicationHandler) RevokePersonalAPIKey(w http.ResponseWriter, r *http.Request)
func (a *ApplicationHandler) RevokePortalLink(w http.ResponseWriter, r *http.Request)

RevokePortalLink @Summary Revoke Portal Link @Description This endpoint revokes a portal link @Tags PortalLinks @Accept json @Produce json @Param projectID path string true "Project id" @Param portalLinkID path string true "portal link id" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/portal-links/{portalLinkID}/revoke [put]

func (*ApplicationHandler) TestSubscriptionFilter added in v0.8.0

func (a *ApplicationHandler) TestSubscriptionFilter(w http.ResponseWriter, r *http.Request)

TestSubscriptionFilter @Summary Test subscription filter @Description This endpoint tests a subscription's filter @Tags Subscriptions @Accept json @Produce json @Param projectID path string true "Project id" @Param filter body models.TestFilter true "Filter Details" @Success 200 {object} util.ServerResponse{data=boolean} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/subscriptions/test_filter [post]

func (*ApplicationHandler) ToggleEndpointStatus added in v0.8.0

func (a *ApplicationHandler) ToggleEndpointStatus(w http.ResponseWriter, r *http.Request)

ToggleEndpointStatus @Summary Toggles an endpoint's status from active <-> inactive @Description This endpoint updates a subscription @Tags Subscriptions @Accept json @Produce json @Param projectID path string true "Project id" @Param endpointID path string true "endpoint id" @Success 200 {object} util.ServerResponse{data=datastore.Endpoint} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/endpoints/{endpointID}/toggle_status [put]

func (*ApplicationHandler) ToggleSubscriptionStatus added in v0.6.2

func (a *ApplicationHandler) ToggleSubscriptionStatus(w http.ResponseWriter, r *http.Request)

ToggleSubscriptionStatus Deprecated @Summary Toggles a subscription's status from active <-> inactive @Description This endpoint updates a subscription @Tags Subscriptions @Accept json @Produce json @Param projectID path string true "Project id" @Param subscriptionID path string true "subscription id" @Success 200 {object} util.ServerResponse{data=datastore.Subscription} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/subscriptions/{subscriptionID}/toggle_status [put]

func (*ApplicationHandler) UpdateAPIKey added in v0.6.2

func (a *ApplicationHandler) UpdateAPIKey(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) UpdateApp added in v0.6.2

func (a *ApplicationHandler) UpdateApp(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) UpdateAppEndpoint added in v0.6.2

func (a *ApplicationHandler) UpdateAppEndpoint(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) UpdateConfiguration added in v0.6.2

func (a *ApplicationHandler) UpdateConfiguration(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) UpdateEndpoint added in v0.8.0

func (a *ApplicationHandler) UpdateEndpoint(w http.ResponseWriter, r *http.Request)

UpdateEndpoint @Summary Update an endpoint @Description This endpoint updates an endpoint @Tags Endpoints @Accept json @Produce json @Param projectID path string true "Project id" @Param endpointID path string true "endpoint id" @Param endpoint body models.Endpoint true "Endpoint Details" @Success 200 {object} util.ServerResponse{data=datastore.Endpoint} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/endpoints/{endpointID} [put]

func (*ApplicationHandler) UpdateOrganisation added in v0.6.2

func (a *ApplicationHandler) UpdateOrganisation(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) UpdateOrganisationMember added in v0.6.2

func (a *ApplicationHandler) UpdateOrganisationMember(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) UpdatePassword added in v0.6.2

func (a *ApplicationHandler) UpdatePassword(w http.ResponseWriter, r *http.Request)
func (a *ApplicationHandler) UpdatePortalLink(w http.ResponseWriter, r *http.Request)

UpdatePortalLink @Summary Update a portal link @Description This endpoint updates a portal link @Tags PortalLinks @Accept json @Produce json @Param projectID path string true "Project id" @Param portalLinkID path string true "portal link id" @Param portallink body models.PortalLink true "Portal Link Details" @Success 200 {object} util.ServerResponse{data=models.PortalLinkResponse} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/portal-links/{portalLinkID} [put]

func (*ApplicationHandler) UpdateProject added in v0.8.0

func (a *ApplicationHandler) UpdateProject(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) UpdateSource added in v0.6.2

func (a *ApplicationHandler) UpdateSource(w http.ResponseWriter, r *http.Request)

UpdateSource @Summary Update a source @Description This endpoint updates a source @Tags Sources @Accept json @Produce json @Param projectID path string true "Project id" @Param sourceID path string true "source id" @Param source body models.Source true "Source Details" @Success 200 {object} util.ServerResponse{data=models.SourceResponse} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/sources/{sourceID} [put]

func (*ApplicationHandler) UpdateSubscription added in v0.6.2

func (a *ApplicationHandler) UpdateSubscription(w http.ResponseWriter, r *http.Request)

UpdateSubscription @Summary Update a subscription @Description This endpoint updates a subscription @Tags Subscriptions @Accept json @Produce json @Param projectID path string true "Project id" @Param subscriptionID path string true "subscription id" @Param subscription body models.Subscription true "Subscription Details" @Success 200 {object} util.ServerResponse{data=datastore.Subscription} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/subscriptions/{subscriptionID} [put]

func (*ApplicationHandler) UpdateUser added in v0.6.2

func (a *ApplicationHandler) UpdateUser(w http.ResponseWriter, r *http.Request)

func (*ApplicationHandler) VerifyEmail added in v0.8.0

func (a *ApplicationHandler) VerifyEmail(w http.ResponseWriter, r *http.Request)

VerifyEmail @Summary Verify Email @Description This endpoint verifies a user's email @Tags User @Accept json @Produce json @Param token query string true "Email verification token" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Router /ui/users/forgot-password [post]

type AuthorizedLogin

type AuthorizedLogin struct {
	Username   string    `json:"username,omitempty"`
	Token      string    `json:"token"`
	ExpiryTime time.Time `json:"expiry_time"`
}

type Stub

type Stub struct{}

Stub represents empty json or arbitrary json bodies for our doc annotations

type ViewableConfiguration

type ViewableConfiguration struct {
	Strategy  datastore.StrategyConfiguration  `json:"strategy"`
	Signature datastore.SignatureConfiguration `json:"signature"`
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL