Documentation
¶
Index ¶
- func CreateOrganisationInviteService(a *ApplicationHandler) *services.OrganisationInviteService
- func FindMessageDeliveryAttempt(attempts *[]datastore.DeliveryAttempt, id string) (*datastore.DeliveryAttempt, error)
- type App
- type ApplicationHandler
- func (a *ApplicationHandler) BatchReplayEvents(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) BatchRetryEventDelivery(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) BuildRoutes() http.Handler
- func (a *ApplicationHandler) CancelOrganizationInvite(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CountAffectedEventDeliveries(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CountAffectedEvents(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateAPIKey(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateApp(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateAppEndpoint(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateConfiguration(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateEndpoint(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateEndpointAPIKey(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateEndpointEvent(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateEndpointFanoutEvent(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateOrganisation(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreatePersonalAPIKey(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreatePortalLink(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreatePortalLinkEndpoint(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateProject(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateSource(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateSubscription(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) DeleteApp(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) DeleteAppEndpoint(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) DeleteEndpoint(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) DeleteOrganisation(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) DeleteOrganisationMember(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) DeleteProject(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) DeleteSource(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) DeleteSubscription(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) ExpireSecret(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) FindDevicesByAppID(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) FindUserByInviteToken(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) ForceResendEventDeliveries(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) ForgotPassword(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetAPIKeyByID(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetAPIKeys(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetAllConfigDetails(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetApp(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetAppEndpoint(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetAppEndpoints(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetApps(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetAuthLogin(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetDashboardSummary(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetDeliveryAttempt(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetDeliveryAttempts(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetEndpoint(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetEndpointEvent(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetEndpoints(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetEventDeliveriesPaged(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetEventDelivery(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetEventsPaged(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetOrganisation(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetOrganisationMember(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetOrganisationMembers(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetOrganisationsPaged(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetPendingOrganisationInvites(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetPortalLinkByID(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetPortalLinkDevices(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetPortalLinkEndpoints(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetPortalLinkKeys(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetProject(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetProjectStatistics(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetProjects(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetSourceByID(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetSubscription(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetSubscriptions(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetUser(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetUserOrganisations(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) HandleCrcCheck(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) IngestEvent(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) InviteUserToOrganisation(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) LoadConfiguration(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) LoadEndpointAPIKeysPaged(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) LoadPortalLinksPaged(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) LoadSourcesPaged(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) LoginUser(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) LogoutUser(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) ProcessOrganisationMemberInvite(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) RedirectToProjects(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) RefreshToken(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) RegenerateProjectAPIKey(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) RegisterUser(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) ReplayEndpointEvent(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) ResendEventDelivery(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) ResendOrganizationInvite(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) ResendVerificationEmail(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) ResetPassword(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) RevokeAPIKey(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) RevokeEndpointAPIKey(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) RevokePersonalAPIKey(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) RevokePortalLink(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) TestSubscriptionFilter(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) ToggleEndpointStatus(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) ToggleSubscriptionStatus(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) UpdateAPIKey(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) UpdateApp(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) UpdateAppEndpoint(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) UpdateConfiguration(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) UpdateEndpoint(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) UpdateOrganisation(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) UpdateOrganisationMember(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) UpdatePassword(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) UpdatePortalLink(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) UpdateProject(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) UpdateSource(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) UpdateSubscription(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) UpdateUser(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) VerifyEmail(w http.ResponseWriter, r *http.Request)
- type AuthorizedLogin
- type Stub
- type ViewableConfiguration
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateOrganisationInviteService ¶
func CreateOrganisationInviteService(a *ApplicationHandler) *services.OrganisationInviteService
func FindMessageDeliveryAttempt ¶
func FindMessageDeliveryAttempt(attempts *[]datastore.DeliveryAttempt, id string) (*datastore.DeliveryAttempt, error)
Types ¶
type ApplicationHandler ¶
type ApplicationHandler struct {
M *middleware.Middleware
Router http.Handler
A App
}
func NewApplicationHandler ¶
func NewApplicationHandler(a App) *ApplicationHandler
func (*ApplicationHandler) BatchReplayEvents ¶
func (a *ApplicationHandler) BatchReplayEvents(w http.ResponseWriter, r *http.Request)
BatchReplayEvents @Summary Batch replay events @Description This endpoint replays multiple events at once. @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/events/batchreplay [post]
func (*ApplicationHandler) BatchRetryEventDelivery ¶
func (a *ApplicationHandler) BatchRetryEventDelivery(w http.ResponseWriter, r *http.Request)
BatchRetryEventDelivery @Summary Batch retry event delivery @Description This endpoint batch retries multiple event deliveries at once. @Tags Event Deliveries @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/eventdeliveries/batchretry [post]
func (*ApplicationHandler) BuildRoutes ¶
func (a *ApplicationHandler) BuildRoutes() http.Handler
func (*ApplicationHandler) CancelOrganizationInvite ¶
func (a *ApplicationHandler) CancelOrganizationInvite(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) CountAffectedEventDeliveries ¶
func (a *ApplicationHandler) CountAffectedEventDeliveries(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) CountAffectedEvents ¶
func (a *ApplicationHandler) CountAffectedEvents(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) CreateAPIKey ¶
func (a *ApplicationHandler) CreateAPIKey(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) CreateApp ¶
func (a *ApplicationHandler) CreateApp(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) CreateAppEndpoint ¶
func (a *ApplicationHandler) CreateAppEndpoint(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) CreateConfiguration ¶
func (a *ApplicationHandler) CreateConfiguration(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) CreateEndpoint ¶
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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/endpoints [post]
func (*ApplicationHandler) CreateEndpointAPIKey ¶
func (a *ApplicationHandler) CreateEndpointAPIKey(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) CreateEndpointEvent ¶
func (a *ApplicationHandler) CreateEndpointEvent(w http.ResponseWriter, r *http.Request)
CreateEndpointEvent @Summary Create an 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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/events [post]
func (*ApplicationHandler) CreateEndpointFanoutEvent ¶
func (a *ApplicationHandler) CreateEndpointFanoutEvent(w http.ResponseWriter, r *http.Request)
CreateEndpointFanoutEvent @Summary Fan out an event @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/events/fanout [post]
func (*ApplicationHandler) CreateOrganisation ¶
func (a *ApplicationHandler) CreateOrganisation(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) CreatePersonalAPIKey ¶
func (a *ApplicationHandler) CreatePersonalAPIKey(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) CreatePortalLink ¶
func (a *ApplicationHandler) CreatePortalLink(w http.ResponseWriter, r *http.Request)
CreatePortalLink @Summary Create a portal link @Description This endpoint creates a portal link @Tags Portal Links @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/portal-links [post]
func (*ApplicationHandler) CreatePortalLinkEndpoint ¶
func (a *ApplicationHandler) CreatePortalLinkEndpoint(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) CreateProject ¶
func (a *ApplicationHandler) CreateProject(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) CreateSource ¶
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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/sources [post]
func (*ApplicationHandler) CreateSubscription ¶
func (a *ApplicationHandler) CreateSubscription(w http.ResponseWriter, r *http.Request)
CreateSubscription @Summary Create 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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/subscriptions [post]
func (*ApplicationHandler) DeleteApp ¶
func (a *ApplicationHandler) DeleteApp(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) DeleteAppEndpoint ¶
func (a *ApplicationHandler) DeleteAppEndpoint(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) DeleteEndpoint ¶
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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/endpoints/{endpointID} [delete]
func (*ApplicationHandler) DeleteOrganisation ¶
func (a *ApplicationHandler) DeleteOrganisation(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) DeleteOrganisationMember ¶
func (a *ApplicationHandler) DeleteOrganisationMember(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) DeleteProject ¶
func (a *ApplicationHandler) DeleteProject(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) DeleteSource ¶
func (a *ApplicationHandler) DeleteSource(w http.ResponseWriter, r *http.Request)
DeleteSource @Summary Delete a 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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/sources/{sourceID} [delete]
func (*ApplicationHandler) DeleteSubscription ¶
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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/subscriptions/{subscriptionID} [delete]
func (*ApplicationHandler) ExpireSecret ¶
func (a *ApplicationHandler) ExpireSecret(w http.ResponseWriter, r *http.Request)
ExpireSecret @Summary Roll endpoint secret @Description This endpoint expires and re-generates the endpoint secret. @Tags Endpoints @Accept json @Produce json @Param projectID path string true "Project ID" @Param endpointID path string true "Endpoint ID" @Param endpoint body models.ExpireSecret true "Expire Secret Body Parameters" @Success 200 {object} util.ServerResponse{data=datastore.Endpoint} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/endpoints/{endpointID}/expire_secret [put]
func (*ApplicationHandler) FindDevicesByAppID ¶
func (a *ApplicationHandler) FindDevicesByAppID(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) FindUserByInviteToken ¶
func (a *ApplicationHandler) FindUserByInviteToken(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) ForceResendEventDeliveries ¶
func (a *ApplicationHandler) ForceResendEventDeliveries(w http.ResponseWriter, r *http.Request)
ForceResendEventDeliveries @Summary Force retry event delivery @Description This endpoint enables you retry a previously successful event delivery @Tags Event Deliveries @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/eventdeliveries/forceresend [post]
func (*ApplicationHandler) ForgotPassword ¶
func (a *ApplicationHandler) ForgotPassword(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetAPIKeyByID ¶
func (a *ApplicationHandler) GetAPIKeyByID(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetAPIKeys ¶
func (a *ApplicationHandler) GetAPIKeys(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetAllConfigDetails ¶
func (a *ApplicationHandler) GetAllConfigDetails(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetApp ¶
func (a *ApplicationHandler) GetApp(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetAppEndpoint ¶
func (a *ApplicationHandler) GetAppEndpoint(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetAppEndpoints ¶
func (a *ApplicationHandler) GetAppEndpoints(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetApps ¶
func (a *ApplicationHandler) GetApps(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetAuthLogin ¶
func (a *ApplicationHandler) GetAuthLogin(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetDashboardSummary ¶
func (a *ApplicationHandler) GetDashboardSummary(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetDeliveryAttempt ¶
func (a *ApplicationHandler) GetDeliveryAttempt(w http.ResponseWriter, r *http.Request)
GetDeliveryAttempt @Summary Retrieve a delivery attempt @Description This endpoint fetches an app event delivery attempt @Tags Delivery Attempts @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts/{deliveryAttemptID} [get]
func (*ApplicationHandler) GetDeliveryAttempts ¶
func (a *ApplicationHandler) GetDeliveryAttempts(w http.ResponseWriter, r *http.Request)
GetDeliveryAttempts @Summary List delivery attempts @Description This endpoint fetches an app message's delivery attempts @Tags Delivery Attempts @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts [get]
func (*ApplicationHandler) GetEndpoint ¶
func (a *ApplicationHandler) GetEndpoint(w http.ResponseWriter, r *http.Request)
GetEndpoint @Summary Retrieve 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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/endpoints/{endpointID} [get]
func (*ApplicationHandler) GetEndpointEvent ¶
func (a *ApplicationHandler) GetEndpointEvent(w http.ResponseWriter, r *http.Request)
GetEndpointEvent @Summary Retrieve an event @Description This endpoint retrieves an 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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/events/{eventID} [get]
func (*ApplicationHandler) GetEndpoints ¶
func (a *ApplicationHandler) GetEndpoints(w http.ResponseWriter, r *http.Request)
GetEndpoints @Summary List all 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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/endpoints [get]
func (*ApplicationHandler) GetEventDeliveriesPaged ¶
func (a *ApplicationHandler) GetEventDeliveriesPaged(w http.ResponseWriter, r *http.Request)
GetEventDeliveriesPaged @Summary List all event deliveries @Description This endpoint retrieves all event deliveries paginated. @Tags Event Deliveries @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/eventdeliveries [get]
func (*ApplicationHandler) GetEventDelivery ¶
func (a *ApplicationHandler) GetEventDelivery(w http.ResponseWriter, r *http.Request)
GetEventDelivery @Summary Retrieve an event delivery @Description This endpoint fetches an event delivery. @Tags Event Deliveries @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/eventdeliveries/{eventDeliveryID} [get]
func (*ApplicationHandler) GetEventsPaged ¶
func (a *ApplicationHandler) GetEventsPaged(w http.ResponseWriter, r *http.Request)
GetEventsPaged @Summary List all events @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/events [get]
func (*ApplicationHandler) GetOrganisation ¶
func (a *ApplicationHandler) GetOrganisation(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetOrganisationMember ¶
func (a *ApplicationHandler) GetOrganisationMember(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetOrganisationMembers ¶
func (a *ApplicationHandler) GetOrganisationMembers(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetOrganisationsPaged ¶
func (a *ApplicationHandler) GetOrganisationsPaged(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetPendingOrganisationInvites ¶
func (a *ApplicationHandler) GetPendingOrganisationInvites(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetPortalLinkByID ¶
func (a *ApplicationHandler) GetPortalLinkByID(w http.ResponseWriter, r *http.Request)
GetPortalLinkByID @Summary Retrieve a portal link @Description This endpoint retrieves a portal link by its id. @Tags Portal Links @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/portal-links/{portalLinkID} [get]
func (*ApplicationHandler) GetPortalLinkDevices ¶
func (a *ApplicationHandler) GetPortalLinkDevices(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetPortalLinkEndpoints ¶
func (a *ApplicationHandler) GetPortalLinkEndpoints(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetPortalLinkKeys ¶
func (a *ApplicationHandler) GetPortalLinkKeys(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetProject ¶
func (a *ApplicationHandler) GetProject(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetProjectStatistics ¶
func (a *ApplicationHandler) GetProjectStatistics(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetProjects ¶
func (a *ApplicationHandler) GetProjects(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetSourceByID ¶
func (a *ApplicationHandler) GetSourceByID(w http.ResponseWriter, r *http.Request)
GetSourceByID @Summary Retrieve a source @Description This endpoint retrieves 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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/sources/{sourceID} [get]
func (*ApplicationHandler) GetSubscription ¶
func (a *ApplicationHandler) GetSubscription(w http.ResponseWriter, r *http.Request)
GetSubscription @Summary Retrieve a subscription @Description This endpoint retrieves a single 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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/subscriptions/{subscriptionID} [get]
func (*ApplicationHandler) GetSubscriptions ¶
func (a *ApplicationHandler) GetSubscriptions(w http.ResponseWriter, r *http.Request)
GetSubscriptions @Summary List 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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/subscriptions [get]
func (*ApplicationHandler) GetUser ¶
func (a *ApplicationHandler) GetUser(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetUserOrganisations ¶
func (a *ApplicationHandler) GetUserOrganisations(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) HandleCrcCheck ¶
func (a *ApplicationHandler) HandleCrcCheck(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) IngestEvent ¶
func (a *ApplicationHandler) IngestEvent(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) InviteUserToOrganisation ¶
func (a *ApplicationHandler) InviteUserToOrganisation(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) LoadConfiguration ¶
func (a *ApplicationHandler) LoadConfiguration(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) LoadEndpointAPIKeysPaged ¶
func (a *ApplicationHandler) LoadEndpointAPIKeysPaged(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) LoadPortalLinksPaged ¶
func (a *ApplicationHandler) LoadPortalLinksPaged(w http.ResponseWriter, r *http.Request)
LoadPortalLinksPaged @Summary List all portal links @Description This endpoint fetches multiple portal links @Tags Portal Links @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/portal-links [get]
func (*ApplicationHandler) LoadSourcesPaged ¶
func (a *ApplicationHandler) LoadSourcesPaged(w http.ResponseWriter, r *http.Request)
LoadSourcesPaged @Summary List all 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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/sources [get]
func (*ApplicationHandler) LoginUser ¶
func (a *ApplicationHandler) LoginUser(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) LogoutUser ¶
func (a *ApplicationHandler) LogoutUser(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) ProcessOrganisationMemberInvite ¶
func (a *ApplicationHandler) ProcessOrganisationMemberInvite(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) RedirectToProjects ¶
func (a *ApplicationHandler) RedirectToProjects(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) RefreshToken ¶
func (a *ApplicationHandler) RefreshToken(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) RegenerateProjectAPIKey ¶
func (a *ApplicationHandler) RegenerateProjectAPIKey(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) RegisterUser ¶
func (a *ApplicationHandler) RegisterUser(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) ReplayEndpointEvent ¶
func (a *ApplicationHandler) ReplayEndpointEvent(w http.ResponseWriter, r *http.Request)
ReplayEndpointEvent @Summary Replay event @Description This endpoint replays an event afresh assuming it is a new 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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/events/{eventID}/replay [put]
func (*ApplicationHandler) ResendEventDelivery ¶
func (a *ApplicationHandler) ResendEventDelivery(w http.ResponseWriter, r *http.Request)
ResendEventDelivery @Summary Retry event delivery @Description This endpoint retries an event delivery. @Tags Event Deliveries @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/resend [put]
func (*ApplicationHandler) ResendOrganizationInvite ¶
func (a *ApplicationHandler) ResendOrganizationInvite(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) ResendVerificationEmail ¶
func (a *ApplicationHandler) ResendVerificationEmail(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) ResetPassword ¶
func (a *ApplicationHandler) ResetPassword(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) RevokeAPIKey ¶
func (a *ApplicationHandler) RevokeAPIKey(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) RevokeEndpointAPIKey ¶
func (a *ApplicationHandler) RevokeEndpointAPIKey(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) RevokePersonalAPIKey ¶
func (a *ApplicationHandler) RevokePersonalAPIKey(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) RevokePortalLink ¶
func (a *ApplicationHandler) RevokePortalLink(w http.ResponseWriter, r *http.Request)
RevokePortalLink @Summary Revoke a portal link @Description This endpoint revokes a portal link @Tags Portal Links @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/portal-links/{portalLinkID}/revoke [put]
func (*ApplicationHandler) TestSubscriptionFilter ¶
func (a *ApplicationHandler) TestSubscriptionFilter(w http.ResponseWriter, r *http.Request)
TestSubscriptionFilter @Summary Validate subscription filter @Description This endpoint validates that a filter will match a certain payload structure. @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/subscriptions/test_filter [post]
func (*ApplicationHandler) ToggleEndpointStatus ¶
func (a *ApplicationHandler) ToggleEndpointStatus(w http.ResponseWriter, r *http.Request)
ToggleEndpointStatus @Summary Toggle endpoint status @Description This endpoint toggles an endpoint status between the active and inactive statetes @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/endpoints/{endpointID}/toggle_status [put]
func (*ApplicationHandler) ToggleSubscriptionStatus ¶
func (a *ApplicationHandler) ToggleSubscriptionStatus(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) UpdateAPIKey ¶
func (a *ApplicationHandler) UpdateAPIKey(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) UpdateApp ¶
func (a *ApplicationHandler) UpdateApp(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) UpdateAppEndpoint ¶
func (a *ApplicationHandler) UpdateAppEndpoint(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) UpdateConfiguration ¶
func (a *ApplicationHandler) UpdateConfiguration(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) UpdateEndpoint ¶
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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/endpoints/{endpointID} [put]
func (*ApplicationHandler) UpdateOrganisation ¶
func (a *ApplicationHandler) UpdateOrganisation(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) UpdateOrganisationMember ¶
func (a *ApplicationHandler) UpdateOrganisationMember(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) UpdatePassword ¶
func (a *ApplicationHandler) UpdatePassword(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) UpdatePortalLink ¶
func (a *ApplicationHandler) UpdatePortalLink(w http.ResponseWriter, r *http.Request)
UpdatePortalLink @Summary Update a portal link @Description This endpoint updates a portal link @Tags Portal Links @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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/portal-links/{portalLinkID} [put]
func (*ApplicationHandler) UpdateProject ¶
func (a *ApplicationHandler) UpdateProject(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) UpdateSource ¶
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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/sources/{sourceID} [put]
func (*ApplicationHandler) UpdateSubscription ¶
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,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/subscriptions/{subscriptionID} [put]
func (*ApplicationHandler) UpdateUser ¶
func (a *ApplicationHandler) UpdateUser(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) VerifyEmail ¶
func (a *ApplicationHandler) VerifyEmail(w http.ResponseWriter, r *http.Request)
type AuthorizedLogin ¶
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"`
}
Source Files
Directories