public

Documentation

Index

• func RequirePersonalAPIKeys(a *PublicHandler) func(next http.Handler) http.Handler
• func RequireProjectAccess(a *PublicHandler) func(next http.Handler) http.Handler
• type PublicHandler
  • func NewPublicHandler(a *types.APIOptions) *PublicHandler
  • func (a *PublicHandler) BatchReplayEvents(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) BatchRetryEventDelivery(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) BuildRoutes() http.Handler
  • func (a *PublicHandler) CreateDynamicEvent(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) CreateEndpoint(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) CreateEndpointEvent(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) CreateEndpointFanoutEvent(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) CreatePortalLink(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) CreateProject(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) CreateSource(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) CreateSubscription(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) DeleteEndpoint(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) DeleteProject(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) DeleteSource(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) DeleteSubscription(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) ExpireSecret(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) ForceResendEventDeliveries(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetDeliveryAttempt(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetDeliveryAttempts(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetEndpoint(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetEndpointEvent(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetEndpoints(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetEventDeliveriesPaged(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetEventDelivery(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetEventsPaged(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetMetaEvent(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetMetaEventsPaged(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetOrganisationsPaged(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetPortalLinkByID(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetProject(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetProjects(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetSourceByID(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetSubscription(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) GetSubscriptions(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) LoadPortalLinksPaged(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) LoadSourcesPaged(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) PauseEndpoint(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) RedirectToProjects(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) ReplayEndpointEvent(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) ResendEventDelivery(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) ResendMetaEvent(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) RevokePortalLink(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) TestSubscriptionFilter(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) TestSubscriptionFunction(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) ToggleEndpointStatus(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) ToggleSubscriptionStatus(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) UpdateEndpoint(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) UpdatePortalLink(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) UpdateProject(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) UpdateSource(w http.ResponseWriter, r *http.Request)
  • func (a *PublicHandler) UpdateSubscription(w http.ResponseWriter, r *http.Request)
• type Stub

Functions

func RequirePersonalAPIKeys

func RequirePersonalAPIKeys(a *PublicHandler) func(next http.Handler) http.Handler

func RequireProjectAccess

func RequireProjectAccess(a *PublicHandler) func(next http.Handler) http.Handler

Types

type PublicHandler

type PublicHandler struct {
	Router http.Handler
	A      *types.APIOptions
}

func NewPublicHandler

func NewPublicHandler(a *types.APIOptions) *PublicHandler

func (*PublicHandler) BatchReplayEvents

func (a *PublicHandler) 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 request query models.QueryBatchReplayEventResponse false "Query Params" @Success 200 {object} util.ServerResponse{data=datastore.Event{data=Stub}} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/events/batchreplay [post]

func (*PublicHandler) BatchRetryEventDelivery

func (a *PublicHandler) 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 request query models.QueryBatchRetryEventDelivery false "Query Params" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/eventdeliveries/batchretry [post]

func (*PublicHandler) BuildRoutes

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

func (*PublicHandler) CreateDynamicEvent

func (a *PublicHandler) CreateDynamicEvent(w http.ResponseWriter, r *http.Request)

CreateDynamicEvent @Summary Dynamic Events @Description This endpoint does not require creating endpoint and subscriptions ahead of time. Instead, you supply the endpoint and the payload, and Convoy delivers the events @Tags Events @Accept json @Produce json @Param projectID path string true "Project ID" @Param event body models.DynamicEvent true "Event Details" @Success 200 {object} Stub @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/events/dynamic [post]

func (*PublicHandler) CreateEndpoint

func (a *PublicHandler) 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.CreateEndpoint true "Endpoint Details" @Success 200 {object} util.ServerResponse{data=models.EndpointResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/endpoints [post]

func (*PublicHandler) CreateEndpointEvent

func (a *PublicHandler) 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.CreateEvent true "Event Details" @Success 200 {object} util.ServerResponse{data=models.EventResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/events [post]

func (*PublicHandler) CreateEndpointFanoutEvent

func (a *PublicHandler) 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=models.EventResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/events/fanout [post]

func (*PublicHandler) CreatePortalLink

func (a *PublicHandler) 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 /v1/projects/{projectID}/portal-links [post]

func (*PublicHandler) CreateProject

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

CreateProject - this is a duplicate annotation for the api/v1 route of this handler @Summary Create a project @Description This endpoint creates a project @Tags Projects @Accept json @Produce json @Param orgID query string true "Organisation id" @Param project body models.CreateProject true "Project Details" @Success 200 {object} util.ServerResponse{data=models.CreateProjectResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects [post]

func (*PublicHandler) CreateSource

func (a *PublicHandler) 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.CreateSource true "Source Details" @Success 200 {object} util.ServerResponse{data=models.SourceResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/sources [post]

func (*PublicHandler) CreateSubscription

func (a *PublicHandler) 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.CreateSubscription true "Subscription details" @Success 200 {object} util.ServerResponse{data=models.SubscriptionResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/subscriptions [post]

func (*PublicHandler) DeleteEndpoint

func (a *PublicHandler) 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 /v1/projects/{projectID}/endpoints/{endpointID} [delete]

func (*PublicHandler) DeleteProject

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

DeleteProject - this is a duplicate annotation for the api/v1 route of this handler @Summary Delete a project @Description This endpoint deletes a project using its id @Tags Projects @Accept json @Produce json @Param projectID path string true "Project ID" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID} [delete]

func (*PublicHandler) DeleteSource

func (a *PublicHandler) 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 /v1/projects/{projectID}/sources/{sourceID} [delete]

func (*PublicHandler) DeleteSubscription

func (a *PublicHandler) 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 /v1/projects/{projectID}/subscriptions/{subscriptionID} [delete]

func (*PublicHandler) ExpireSecret

func (a *PublicHandler) 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=models.EndpointResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/endpoints/{endpointID}/expire_secret [put]

func (*PublicHandler) ForceResendEventDeliveries

func (a *PublicHandler) 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=models.IDs} true "event delivery ids" @Success 200 {object} util.ServerResponse{data=Stub} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/eventdeliveries/forceresend [post]

func (*PublicHandler) GetDeliveryAttempt

func (a *PublicHandler) 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 /v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts/{deliveryAttemptID} [get]

func (*PublicHandler) GetDeliveryAttempts

func (a *PublicHandler) 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 /v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts [get]

func (*PublicHandler) GetEndpoint

func (a *PublicHandler) 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=models.EndpointResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/endpoints/{endpointID} [get]

func (*PublicHandler) GetEndpointEvent

func (a *PublicHandler) 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=models.EventResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/events/{eventID} [get]

func (*PublicHandler) GetEndpoints

func (a *PublicHandler) 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" @Param request query models.QueryListEndpoint false "Query Params" @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]models.EndpointResponse}} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/endpoints [get]

func (*PublicHandler) GetEventDeliveriesPaged

func (a *PublicHandler) 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 projectID path string true "Project ID" @Param request query models.QueryListEventDelivery false "Query Params" @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]models.EventDeliveryResponse}} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/eventdeliveries [get]

func (*PublicHandler) GetEventDelivery

func (a *PublicHandler) 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=models.EventDeliveryResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/eventdeliveries/{eventDeliveryID} [get]

func (*PublicHandler) GetEventsPaged

func (a *PublicHandler) 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 projectID path string true "Project ID" @Param request query models.QueryListEvent false "Query Params" @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]models.EventResponse}} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/events [get]

func (*PublicHandler) GetMetaEvent

func (a *PublicHandler) GetMetaEvent(w http.ResponseWriter, r *http.Request)

GetMetaEvent @Summary Retrieve a meta event @Description This endpoint retrieves a meta event @Tags Meta Events @Accept json @Produce json @Param projectID path string true "Project ID" @Param metaEventID path string true "meta event id" @Success 200 {object} util.ServerResponse{data=models.MetaEventResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/meta-events/{metaEventID} [get]

func (*PublicHandler) GetMetaEventsPaged

func (a *PublicHandler) GetMetaEventsPaged(w http.ResponseWriter, r *http.Request)

GetMetaEventsPaged @Summary List all meta events @Description This endpoint fetches meta events with pagination @Tags Meta Events @Accept json @Produce json @Param projectID path string true "Project ID" @Param request query models.QueryListMetaEvent false "Query Params" @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]models.MetaEventResponse}} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/meta-events [get]

func (*PublicHandler) GetOrganisationsPaged

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

func (*PublicHandler) GetPortalLinkByID

func (a *PublicHandler) 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 /v1/projects/{projectID}/portal-links/{portalLinkID} [get]

func (*PublicHandler) GetProject

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

GetProject - this is a duplicate annotation for the api/v1 route of this handler @Summary Retrieve a project @Description This endpoint fetches a project by its id @Tags Projects @Accept json @Produce json @Param projectID path string true "Project ID" @Success 200 {object} util.ServerResponse{data=models.ProjectResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID} [get]

func (*PublicHandler) GetProjects

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

GetProjects - this is a duplicate annotation for the api/v1 route of this handler @Summary List all projects @Description This endpoint fetches projects @Tags Projects @Accept json @Produce json @Param name query string false "Project name" @Param orgID query string true "organisation id" @Success 200 {object} util.ServerResponse{data=[]models.ProjectResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects [get]

func (*PublicHandler) GetSourceByID

func (a *PublicHandler) 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 /v1/projects/{projectID}/sources/{sourceID} [get]

func (*PublicHandler) GetSubscription

func (a *PublicHandler) 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=models.SubscriptionResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/subscriptions/{subscriptionID} [get]

func (*PublicHandler) GetSubscriptions

func (a *PublicHandler) 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 projectID path string true "Project ID" @Param request query models.QueryListSubscription false "Query Params" @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]models.SubscriptionResponse}} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/subscriptions [get]

func (*PublicHandler) LoadPortalLinksPaged

func (a *PublicHandler) 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 /v1/projects/{projectID}/portal-links [get]

func (*PublicHandler) LoadSourcesPaged

func (a *PublicHandler) 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 request query models.QueryListSource false "Query Params" @Success 200 {object} util.ServerResponse{data=pagedResponse{content=[]models.SourceResponse}} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/sources [get]

func (*PublicHandler) PauseEndpoint

func (a *PublicHandler) PauseEndpoint(w http.ResponseWriter, r *http.Request)

PauseEndpoint @Summary Pause endpoint @Description This endpoint toggles an endpoint status between the active and paused states @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=models.EndpointResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/endpoints/{endpointID}/pause [put]

func (*PublicHandler) RedirectToProjects

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

func (*PublicHandler) ReplayEndpointEvent

func (a *PublicHandler) 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=models.EventResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/events/{eventID}/replay [put]

func (*PublicHandler) ResendEventDelivery

func (a *PublicHandler) 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=models.EventDeliveryResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/resend [put]

func (*PublicHandler) ResendMetaEvent

func (a *PublicHandler) ResendMetaEvent(w http.ResponseWriter, r *http.Request)

ResendMetaEvent @Summary Retry meta event @Description This endpoint retries a meta event @Tags Meta Events @Accept json @Produce json @Param projectID path string true "Project ID" @Param metaEventID path string true "meta event id" @Success 200 {object} util.ServerResponse{data=models.MetaEventResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/meta-events/{metaEventID}/resend [put]

func (*PublicHandler) RevokePortalLink

func (a *PublicHandler) 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 /v1/projects/{projectID}/portal-links/{portalLinkID}/revoke [put]

func (*PublicHandler) TestSubscriptionFilter

func (a *PublicHandler) 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 /v1/projects/{projectID}/subscriptions/test_filter [post]

func (*PublicHandler) TestSubscriptionFunction

func (a *PublicHandler) TestSubscriptionFunction(w http.ResponseWriter, r *http.Request)

TestSubscriptionFunction @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.TestWebhookFunction true "Function Details" @Success 200 {object} util.ServerResponse{data=models.SubscriptionFunctionResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/subscriptions/test_function [post]

func (*PublicHandler) ToggleEndpointStatus

func (a *PublicHandler) 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=models.EndpointResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/endpoints/{endpointID}/toggle_status [put]

func (*PublicHandler) ToggleSubscriptionStatus

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

func (*PublicHandler) UpdateEndpoint

func (a *PublicHandler) 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.UpdateEndpoint true "Endpoint Details" @Success 200 {object} util.ServerResponse{data=models.EndpointResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/endpoints/{endpointID} [put]

func (*PublicHandler) UpdatePortalLink

func (a *PublicHandler) 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 /v1/projects/{projectID}/portal-links/{portalLinkID} [put]

func (*PublicHandler) UpdateProject

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

UpdateProject - this is a duplicate annotation for the api/v1 route of this handler @Summary Update a project @Description This endpoint updates a project @Tags Projects @Accept json @Produce json @Param projectID path string true "Project ID" @Param project body models.UpdateProject true "Project Details" @Success 200 {object} util.ServerResponse{data=models.ProjectResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID} [put]

func (*PublicHandler) UpdateSource

func (a *PublicHandler) 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.UpdateSource true "Source Details" @Success 200 {object} util.ServerResponse{data=models.SourceResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/sources/{sourceID} [put]

func (*PublicHandler) UpdateSubscription

func (a *PublicHandler) 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.UpdateSubscription true "Subscription Details" @Success 200 {object} util.ServerResponse{data=models.SubscriptionResponse} @Failure 400,401,404 {object} util.ServerResponse{data=Stub} @Security ApiKeyAuth @Router /v1/projects/{projectID}/subscriptions/{subscriptionID} [put]

type Stub

type Stub struct{}

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