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) 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) CreateAPIKey(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateApp(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateAppAPIKey(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateAppEndpoint(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateAppEvent(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateConfiguration(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) CreateGroup(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) 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) DeleteGroup(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) DeleteSource(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) DeleteSubscription(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) GetAppEvent(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) 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) GetGroup(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetGroups(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) GetPaginatedApps(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) GetPendingOrganisationInvites(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) LoadAppAPIKeysPaged(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) LoadConfiguration(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) RegisterUser(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) ReplayAppEvent(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) ResetPassword(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) RevokeAPIKey(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) RevokeAppAPIKey(w http.ResponseWriter, r *http.Request)
- func (a *ApplicationHandler) RevokePersonalAPIKey(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) UpdateGroup(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) 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)
- type AuthorizedLogin
- type Stub
- type ViewableConfiguration
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 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) 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 EventDelivery @Accept json @Produce json @Param projectID path string true "Project id" @Param delivery ids 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)
CancelOrganizationInvite @Summary cancel organization invite @Description This endpoint cancels an organization invite @Tags Organisation @Accept json @Produce json @Param orgID path string true "organisation id" @Param inviteID path string true "invite id" @Success 200 {object} util.ServerResponse{data=datastore.OrganisationInvite} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/invites/{inviteID}/cancel [post]
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 EventDelivery @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) CreateAPIKey ¶ added in v0.6.2
func (a *ApplicationHandler) CreateAPIKey(w http.ResponseWriter, r *http.Request)
CreateAPIKey @Summary Create an api key @Description This endpoint creates an api key that will be used by the native auth realm @Tags APIKey @Accept json @Produce json @Param orgID path string true "Organisation id" @Param apiKey body models.APIKey true "API Key" @Success 200 {object} util.ServerResponse{data=models.APIKeyResponse} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/security/keys [post]
func (*ApplicationHandler) CreateApp ¶ added in v0.6.2
func (a *ApplicationHandler) CreateApp(w http.ResponseWriter, r *http.Request)
CreateApp @Summary Create an application @Description This endpoint creates an application @Tags Application @Accept json @Produce json @Param projectID path string true "Project id" @Param application body models.Application true "Application Details" @Success 200 {object} util.ServerResponse{data=datastore.Application} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/applications [post]
func (*ApplicationHandler) CreateAppAPIKey ¶ added in v0.7.0
func (a *ApplicationHandler) CreateAppAPIKey(w http.ResponseWriter, r *http.Request)
CreateAppAPIKey @Summary Create an api key for app portal or the cli (API) @Description This endpoint creates an api key that will be used by app portal or the cli @Tags APIKey @Accept json @Produce json @Param projectID path string true "Project id" @Param appID path string true "application ID" @Param appAPIKey body models.APIKey true "APIKey details" @Success 201 {object} util.ServerResponse{data=models.PortalAPIKeyResponse} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/security/applications/{appID}/keys [post]
func (*ApplicationHandler) CreateAppEndpoint ¶ added in v0.6.2
func (a *ApplicationHandler) CreateAppEndpoint(w http.ResponseWriter, r *http.Request)
CreateAppEndpoint @Summary Create an application endpoint @Description This endpoint creates an application endpoint @Tags Application Endpoints @Accept json @Produce json @Param projectID path string true "Project id" @Param appID path string true "application 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}/applications/{appID}/endpoints [post]
func (*ApplicationHandler) CreateAppEvent ¶ added in v0.6.2
func (a *ApplicationHandler) CreateAppEvent(w http.ResponseWriter, r *http.Request)
CreateAppEvent @Summary Create app event @Description This endpoint creates an app 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) CreateConfiguration ¶ added in v0.6.2
func (a *ApplicationHandler) CreateConfiguration(w http.ResponseWriter, r *http.Request)
CreateConfiguration @Summary Create a configuration @Description This endpoint creates a configuration @Tags Configuration @Accept json @Produce json @Param application body models.Configuration true "Configuration Details" @Success 200 {object} util.ServerResponse{data=models.ConfigurationResponse} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/configuration [post]
func (*ApplicationHandler) CreateGroup ¶ added in v0.6.2
func (a *ApplicationHandler) CreateGroup(w http.ResponseWriter, r *http.Request)
CreateGroup @Summary Create a group - UI @Description This endpoint creates a group @Tags Group @Accept json @Produce json @Param orgID path string true "Organisation id" @Param group body models.Group true "Group Details" @Success 200 {object} util.ServerResponse{data=datastore.Group} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/groups [post]
func (*ApplicationHandler) CreateOrganisation ¶ added in v0.6.2
func (a *ApplicationHandler) CreateOrganisation(w http.ResponseWriter, r *http.Request)
CreateOrganisation @Summary Create an organisation @Description This endpoint creates an organisation @Tags Organisation @Accept json @Produce json @Param organisation body models.Organisation true "Organisation Details" @Success 200 {object} util.ServerResponse{data=datastore.Organisation} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations [post]
func (*ApplicationHandler) CreatePersonalAPIKey ¶ added in v0.7.0
func (a *ApplicationHandler) CreatePersonalAPIKey(w http.ResponseWriter, r *http.Request)
CreatePersonalAPIKey @Summary Create a personal api key @Description This endpoint creates a personal api key that can be used to authenticate to this user's context @Tags APIKey @Accept json @Produce json @Param userID path string true "User id" @Param apiKey body models.PersonalAPIKey true "API Key" @Success 200 {object} util.ServerResponse{data=models.APIKeyResponse} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/users/{userID}/security/personal_api_keys [post]
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 Source @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)
DeleteApp @Summary Delete app @Description This endpoint deletes an app @Tags Application @Accept json @Produce json @Param projectID path string true "Project id" @Param appID path string true "application id" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/applications/{appID} [delete]
func (*ApplicationHandler) DeleteAppEndpoint ¶ added in v0.6.2
func (a *ApplicationHandler) DeleteAppEndpoint(w http.ResponseWriter, r *http.Request)
DeleteAppEndpoint @Summary Delete application endpoint @Description This endpoint deletes an application endpoint @Tags Application Endpoints @Accept json @Produce json @Param projectID path string true "Project id" @Param appID path string true "application 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}/applications/{appID}/endpoints/{endpointID} [delete]
func (*ApplicationHandler) DeleteGroup ¶ added in v0.6.2
func (a *ApplicationHandler) DeleteGroup(w http.ResponseWriter, r *http.Request)
DeleteGroup @Summary Delete a group - UI @Description This endpoint deletes a group using its id @Tags Group @Accept json @Produce json @Param groupID path string true "group id" @Param orgID path string true "organisation id" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/groups/{groupID} [delete]
func (*ApplicationHandler) DeleteOrganisation ¶ added in v0.6.2
func (a *ApplicationHandler) DeleteOrganisation(w http.ResponseWriter, r *http.Request)
DeleteOrganisation @Summary Delete organisation @Description This endpoint deletes an organisation @Tags Organisation @Accept json @Produce json @Param orgID path string true "organisation id" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID} [delete]
func (*ApplicationHandler) DeleteOrganisationMember ¶ added in v0.6.2
func (a *ApplicationHandler) DeleteOrganisationMember(w http.ResponseWriter, r *http.Request)
DeleteOrganisationMember @Summary Delete an organisation's member @Description This endpoint deletes an organisation's member @Tags Organisation @Accept json @Produce json @Param orgID path string true "organisation id" @Param memberID path string true "organisation member id" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/members/{memberID} [delete]
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 Source @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) FindDevicesByAppID ¶ added in v0.7.0
func (a *ApplicationHandler) FindDevicesByAppID(w http.ResponseWriter, r *http.Request)
FindDevicesByAppID @Summary Fetch devices for an app @Description This endpoint fetches devices for an app @Tags Source @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 appID path string true "app id" @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]datastore.Device}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /devices/{appID} [get]
func (*ApplicationHandler) FindUserByInviteToken ¶ added in v0.6.2
func (a *ApplicationHandler) FindUserByInviteToken(w http.ResponseWriter, r *http.Request)
FindUserByInviteToken @Summary Find user by invite token @Description This endpoint finds a user by an invite token @Tags Organisation @Accept json @Produce json @Param token query string true "invite token" @Success 200 {object} util.ServerResponse{data=datastore.User} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/users/token [get]
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 EventDelivery @Accept json @Produce json @Param projectID path string true "Project id" @Param delivery ids 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)
ForgotPassword @Summary Send password reset token @Description This endpoint generates a password reset token @Tags User @Accept json @Produce json @Param email body models.ForgotPassword true "Forgot Password Details" @Success 200 {object} util.ServerResponse{data=datastore.User} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Router /ui/users/forgot-password [post]
func (*ApplicationHandler) GetAPIKeyByID ¶ added in v0.6.2
func (a *ApplicationHandler) GetAPIKeyByID(w http.ResponseWriter, r *http.Request)
GetAPIKeyByID @Summary Get api key by id @Description This endpoint fetches an api key by its id @Tags APIKey @Accept json @Produce json @Param orgID path string true "Organisation id" @Param keyID path string true "API Key id" @Success 200 {object} util.ServerResponse{data=datastore.APIKey} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/security/keys/{keyID} [get]
func (*ApplicationHandler) GetAPIKeys ¶ added in v0.6.2
func (a *ApplicationHandler) GetAPIKeys(w http.ResponseWriter, r *http.Request)
GetAPIKeys @Summary Fetch multiple api keys @Description This endpoint fetches multiple api keys @Tags APIKey @Accept json @Produce json @Param orgID path string true "Organisation id" @Param keyType query string false "api key type" @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.APIKey}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/security/keys [get]
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 (a *ApplicationHandler) GetApp(w http.ResponseWriter, r *http.Request)
GetApp @Summary Get an application @Description This endpoint fetches an application by it's id @Tags Application @Accept json @Produce json @Param projectID path string true "Project id" @Param appID path string true "application id" @Success 200 {object} util.ServerResponse{data=datastore.Application} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/applications/{appID} [get]
func (*ApplicationHandler) GetAppEndpoint ¶ added in v0.6.2
func (a *ApplicationHandler) GetAppEndpoint(w http.ResponseWriter, r *http.Request)
GetAppEndpoint @Summary Get application endpoint @Description This endpoint fetches an application endpoint @Tags Application Endpoints @Accept json @Produce json @Param projectID path string true "Project id" @Param appID path string true "application 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}/applications/{appID}/endpoints/{endpointID} [get]
func (*ApplicationHandler) GetAppEndpoints ¶ added in v0.6.2
func (a *ApplicationHandler) GetAppEndpoints(w http.ResponseWriter, r *http.Request)
GetAppEndpoints @Summary Get application endpoints @Description This endpoint fetches an application's endpoints @Tags Application Endpoints @Accept json @Produce json @Param projectID path string true "Project id" @Param appID path string true "application 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}/applications/{appID}/endpoints [get]
func (*ApplicationHandler) GetAppEvent ¶ added in v0.6.2
func (a *ApplicationHandler) GetAppEvent(w http.ResponseWriter, r *http.Request)
GetAppEvent @Summary Get app event @Description This endpoint fetches an app 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) GetApps ¶ added in v0.6.2
func (a *ApplicationHandler) GetApps(w http.ResponseWriter, r *http.Request)
GetApps @Summary Get all applications @Description This fetches all applications @Tags Application @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 "app title" @Param projectID path string true "Project id" @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]datastore.Application}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/applications [get]
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) 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 EventDelivery @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 EventDelivery @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) GetGroup ¶ added in v0.6.2
func (a *ApplicationHandler) GetGroup(w http.ResponseWriter, r *http.Request)
GetGroup @Summary Get a group - UI @Description This endpoint fetches a group by its id @Tags Group @Accept json @Produce json @Param groupID path string true "group id" @Param orgID path string true "organisation id" @Success 200 {object} util.ServerResponse{data=datastore.Group} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/groups/{groupID} [get]
func (*ApplicationHandler) GetGroups ¶ added in v0.6.2
func (a *ApplicationHandler) GetGroups(w http.ResponseWriter, r *http.Request)
GetGroups @Summary Get groups - UI @Description This endpoint fetches groups @Tags Group @Accept json @Produce json @Param name query string false "group name" @Param orgID path string true "organisation id" @Success 200 {object} util.ServerResponse{data=[]datastore.Group} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/groups [get]
func (*ApplicationHandler) GetOrganisation ¶ added in v0.6.2
func (a *ApplicationHandler) GetOrganisation(w http.ResponseWriter, r *http.Request)
GetOrganisation @Summary Get an organisation @Description This endpoint fetches an organisation by its id @Tags Organisation @Accept json @Produce json @Param orgID path string true "organisation id" @Success 200 {object} util.ServerResponse{data=datastore.Organisation} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID} [get]
func (*ApplicationHandler) GetOrganisationMember ¶ added in v0.6.2
func (a *ApplicationHandler) GetOrganisationMember(w http.ResponseWriter, r *http.Request)
GetOrganisationMember @Summary Get organisation member @Description This endpoint fetches an organisation's member @Tags Organisation @Accept json @Produce json @Param orgID path string true "organisation id" @Param memberID path string true "organisation member id" @Success 200 {object} util.ServerResponse{data=datastore.OrganisationMember} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/members/{memberID} [get]
func (*ApplicationHandler) GetOrganisationMembers ¶ added in v0.6.2
func (a *ApplicationHandler) GetOrganisationMembers(w http.ResponseWriter, r *http.Request)
GetOrganisationMembers @Summary Get organisation members @Description This endpoint fetches an organisation's members @Tags Organisation @Accept json @Produce json @Param orgID path string true "organisation 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=[]datastore.OrganisationMember}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/members [get]
func (*ApplicationHandler) GetOrganisationsPaged ¶ added in v0.6.2
func (a *ApplicationHandler) GetOrganisationsPaged(w http.ResponseWriter, r *http.Request)
GetOrganisationsPaged @Summary Get organisations @Description This endpoint fetches the organisations a user is part of @Tags Organisation @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" @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]datastore.Organisation}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations [get]
func (*ApplicationHandler) GetPaginatedApps ¶ added in v0.6.2
func (a *ApplicationHandler) GetPaginatedApps(w http.ResponseWriter, r *http.Request)
func (*ApplicationHandler) GetPendingOrganisationInvites ¶ added in v0.6.2
func (a *ApplicationHandler) GetPendingOrganisationInvites(w http.ResponseWriter, r *http.Request)
GetPendingOrganisationInvites @Summary Fetch pending organisation invites @Description This endpoint fetches pending organisation invites @Tags Organisation @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 orgID path string true "organisation id" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/invites/pending [get]
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 Source @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 "application 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 (a *ApplicationHandler) GetUser(w http.ResponseWriter, r *http.Request)
GetUser @Summary Gets a user @Description This endpoint fetches a user @Tags User @Accept json @Produce json @Param userID path string true "user id" @Success 200 {object} util.ServerResponse{data=datastore.User} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/users/{userID}/profile [get]
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)
InviteUserToOrganisation @Summary Invite a user to join an organisation @Description This endpoint invites a user to join an organisation @Tags Organisation @Accept json @Produce json @Param orgID path string true "organisation id" @Param invite body models.OrganisationInvite true "Organisation Invite Details" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/invites [post]
func (*ApplicationHandler) LoadAppAPIKeysPaged ¶ added in v0.7.0
func (a *ApplicationHandler) LoadAppAPIKeysPaged(w http.ResponseWriter, r *http.Request)
LoadAppAPIKeysPaged @Summary Fetch multiple api keys belonging to an app @Description This endpoint fetches multiple api keys belonging to an app @Tags APIKey @Accept json @Produce json @Param orgID path string true "Organisation id" @Param appID path string true "application ID" @Success 201 {object} util.ServerResponse{data=models.PortalAPIKeyResponse} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/security/applications/{appID}/keys [get]
func (*ApplicationHandler) LoadConfiguration ¶ added in v0.6.2
func (a *ApplicationHandler) LoadConfiguration(w http.ResponseWriter, r *http.Request)
LoadConfiguration @Summary Fetch configuration @Description This endpoint fetches configuration @Tags Configuration @Accept json @Produce json @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]models.ConfigurationResponse}} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/configuration [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 Source @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)
LoginUser @Summary Login a user @Description This endpoint logs in a user @Tags User @Accept json @Produce json @Param user body models.LoginUser true "User Details" @Success 200 {object} util.ServerResponse{data=models.LoginUserResponse} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Router /ui/auth/login [post]
func (*ApplicationHandler) LogoutUser ¶ added in v0.6.2
func (a *ApplicationHandler) LogoutUser(w http.ResponseWriter, r *http.Request)
LogoutUser @Summary Logs out a user @Description This endpoint logs out a user @Tags User @Accept json @Produce json @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/auth/logout [post]
func (*ApplicationHandler) ProcessOrganisationMemberInvite ¶ added in v0.6.2
func (a *ApplicationHandler) ProcessOrganisationMemberInvite(w http.ResponseWriter, r *http.Request)
ProcessOrganisationMemberInvite @Summary Accept or decline an organisation invite @Description This endpoint process a user's response to an organisation invite @Tags Organisation @Accept json @Produce json @Param token query string true "invite token" @Param accepted query string true "email" @Param user body models.User false "User Details" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/process_invite [post]
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)
RefreshToken @Summary Refresh an access token @Description This endpoint refreshes an access token @Tags User @Accept json @Produce json @Param token body models.Token true "Token Details" @Success 200 {object} util.ServerResponse{data=models.Token} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Router /ui/auth/token/refresh [post]
func (*ApplicationHandler) RegisterUser ¶ added in v0.6.5
func (a *ApplicationHandler) RegisterUser(w http.ResponseWriter, r *http.Request)
RegisterUser @Summary Registers a user @Description This endpoint registers a new user @Tags User @Accept json @Produce json @Param user body models.RegisterUser true "User Details" @Success 201 {object} util.ServerResponse{data=models.LoginUserResponse} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Router /ui/auth/register [post]
func (*ApplicationHandler) ReplayAppEvent ¶ added in v0.6.2
func (a *ApplicationHandler) ReplayAppEvent(w http.ResponseWriter, r *http.Request)
ReplayAppEvent @Summary Replay app event @Description This endpoint replays an app 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 EventDelivery @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)
ResendOrganizationInvite @Summary resend organization invite @Description This endpoint resends the organization invite to a user @Tags Organisation @Accept json @Produce json @Param orgID path string true "organisation id" @Param inviteID path string true "invite id" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/invites/{inviteID}/resend [post]
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)
RevokeAPIKey @Summary Revoke API Key @Description This endpoint revokes an api key @Tags APIKey @Accept json @Produce json @Param orgID path string true "Organisation id" @Param keyID path string true "API Key id" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/security/keys/{keyID}/revoke [put]
func (*ApplicationHandler) RevokeAppAPIKey ¶ added in v0.7.0
func (a *ApplicationHandler) RevokeAppAPIKey(w http.ResponseWriter, r *http.Request)
RevokeAppAPIKey @Summary Revoke an App's API Key @Description This endpoint revokes app's an api key @Tags APIKey @Accept json @Produce json @Param orgID path string true "Organisation id" @Param groupID path string true "Group id" @Param appID path string true "application id" @Param keyID path string true "API Key id" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/groups/{groupID}/apps/{appID}/keys/{keyID}/revoke [put]
func (*ApplicationHandler) RevokePersonalAPIKey ¶ added in v0.7.0
func (a *ApplicationHandler) RevokePersonalAPIKey(w http.ResponseWriter, r *http.Request)
RevokePersonalAPIKey @Summary Revoke a Personal API Key @Description This endpoint revokes a personal api key @Tags APIKey @Accept json @Produce json @Param userID path string true "User id" @Param keyID path string true "API Key id" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/users/{userID}/security/personal_api_keys/{keyID}/revoke [put]
func (*ApplicationHandler) ToggleSubscriptionStatus ¶ added in v0.6.2
func (a *ApplicationHandler) ToggleSubscriptionStatus(w http.ResponseWriter, r *http.Request)
ToggleSubscriptionStatus @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)
UpdateAPIKey @Summary update api key @Description This endpoint updates an api key @Tags APIKey @Accept json @Produce json @Param orgID path string true "Organisation id" @Param keyID path string true "API Key id" @Success 200 {object} util.ServerResponse{data=datastore.APIKey} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/security/keys/{keyID} [put]
func (*ApplicationHandler) UpdateApp ¶ added in v0.6.2
func (a *ApplicationHandler) UpdateApp(w http.ResponseWriter, r *http.Request)
UpdateApp @Summary Update an application @Description This endpoint updates an application @Tags Application @Accept json @Produce json @Param projectID path string true "Project id" @Param appID path string true "application id" @Param application body models.Application true "Application Details" @Success 200 {object} util.ServerResponse{data=datastore.Application} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /api/v1/projects/{projectID}/applications/{appID} [put]
func (*ApplicationHandler) UpdateAppEndpoint ¶ added in v0.6.2
func (a *ApplicationHandler) UpdateAppEndpoint(w http.ResponseWriter, r *http.Request)
UpdateAppEndpoint @Summary Update an application endpoint @Description This endpoint updates an application endpoint @Tags Application Endpoints @Accept json @Produce json @Param projectID path string true "Project id" @Param appID path string true "application 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}/applications/{appID}/endpoints/{endpointID} [put]
func (*ApplicationHandler) UpdateConfiguration ¶ added in v0.6.2
func (a *ApplicationHandler) UpdateConfiguration(w http.ResponseWriter, r *http.Request)
UpdateConfiguration @Summary Update configuration @Description This endpoint updates configuration @Tags Configuration @Accept json @Produce json @Param application body models.Configuration true "Configuration Details" @Success 202 {object} util.ServerResponse{data=models.ConfigurationResponse} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/configuration [put]
func (*ApplicationHandler) UpdateGroup ¶ added in v0.6.2
func (a *ApplicationHandler) UpdateGroup(w http.ResponseWriter, r *http.Request)
UpdateGroup @Summary Update a group - UI @Description This endpoint updates a group @Tags Group @Accept json @Produce json @Param groupID path string true "group id" @Param orgID path string true "organisation id" @Param group body models.Group true "Group Details" @Success 200 {object} util.ServerResponse{data=datastore.Group} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/groups/{groupID} [put]
func (*ApplicationHandler) UpdateOrganisation ¶ added in v0.6.2
func (a *ApplicationHandler) UpdateOrganisation(w http.ResponseWriter, r *http.Request)
UpdateOrganisation @Summary Update an organisation @Description This endpoint updates an organisation @Tags Organisation @Accept json @Produce json @Param orgID path string true "organisation id" @Param organisation body models.Organisation true "Organisation Details" @Success 200 {object} util.ServerResponse{data=datastore.Organisation} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID} [put]
func (*ApplicationHandler) UpdateOrganisationMember ¶ added in v0.6.2
func (a *ApplicationHandler) UpdateOrganisationMember(w http.ResponseWriter, r *http.Request)
UpdateOrganisationMember @Summary Update an organisation's member @Description This endpoint updates an organisation's member @Tags Organisation @Accept json @Produce json @Param orgID path string true "organisation id" @Param memberID path string true "organisation member id" @Param organisation_member body models.UpdateOrganisationMember true "Organisation member Details" @Success 200 {object} util.ServerResponse{data=datastore.Organisation} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/organisations/{orgID}/members/{memberID} [put]
func (*ApplicationHandler) UpdatePassword ¶ added in v0.6.2
func (a *ApplicationHandler) UpdatePassword(w http.ResponseWriter, r *http.Request)
UpdatePassword @Summary Updates a user's password @Description This endpoint updates a user's password @Tags User @Accept json @Produce json @Param userID path string true "user id" @Param group body models.UpdatePassword true "Password Details" @Success 200 {object} util.ServerResponse{data=datastore.User} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/users/{userID}/password [put]
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 Source @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)
UpdateUser @Summary Updates a user @Description This endpoint updates a user @Tags User @Accept json @Produce json @Param userID path string true "user id" @Param group body models.UpdateUser true "User Details" @Success 200 {object} util.ServerResponse{data=datastore.User} @Failure 400,401,500 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /ui/users/{userID}/profile [put]
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"`
}