api

Documentation

Overview

Package api defines CRUD actions for the Panther organization database.

Index

• type API
  • func (API) CompleteAction(input *models.CompleteActionInput) (*models.CompleteActionOutput, error)
  • func (API) CreateOrganization(input *models.CreateOrganizationInput) (*models.CreateOrganizationOutput, error)
  • func (API) GetOrganization(_ *models.GetOrganizationInput) (*models.GetOrganizationOutput, error)
  • func (API) UpdateOrganization(input *models.UpdateOrganizationInput) (*models.UpdateOrganizationOutput, error)

Types

type API

type API struct{}

API has all of the handlers as receiver methods.

func (API) CompleteAction

func (API) CompleteAction(input *models.CompleteActionInput) (*models.CompleteActionOutput, error)

CompleteAction generates a new organization ID.

func (API) CreateOrganization

func (API) CreateOrganization(
	input *models.CreateOrganizationInput) (*models.CreateOrganizationOutput, error)

CreateOrganization generates a new organization ID.

TODO - populate the rules table for new customers

func (API) GetOrganization

func (API) GetOrganization(_ *models.GetOrganizationInput) (*models.GetOrganizationOutput, error)

GetOrganization retrieves customer account details.

func (API) UpdateOrganization

func (API) UpdateOrganization(
	input *models.UpdateOrganizationInput) (*models.UpdateOrganizationOutput, error)

UpdateOrganization updates account details.