client

Documentation

Index

• Constants
• type AuthResponse
• type AuthStruct
• type Client
  • func NewClient(endpoint, identity, password *string) (*Client, error)
  • func (c *Client) AuthRefresh() (*AuthResponse, error)
  • func (c *Client) AuthWithPassword() (*AuthResponse, error)
  • func (c *Client) ConfirmPasswordReset(token, password, passwordConfirm string) error
  • func (c *Client) CreateAdmin(admin *models.AdminCreateRequest) (*models.Admin, error)
  • func (c *Client) CreateCollection(collection *models.CollectionCreateRequest) (*models.Collection, error)
  • func (c *Client) DeleteAdmin(id string) error
  • func (c *Client) DeleteCollection(id string) error
  • func (c *Client) HealthCheck() (*models.HealthResponse, error)
  • func (c *Client) ImportCollections(collections *models.CollectionImportRequest) error
  • func (c *Client) ListAdmins() (*models.AdminList, error)
  • func (c *Client) ListCollections() (*models.CollectionList, error)
  • func (c *Client) ListSettings(fields *string) (*models.SettingsList, error)
  • func (c *Client) RequestPasswordReset(email string) error
  • func (c *Client) SendTestEmail(settings *models.SettingsSendTestEmailRequest) (*models.SettingsResponse, error)
  • func (c *Client) TestS3StorageConnection(settings *models.SettingsS3StorageTestRequest) (*models.SettingsResponse, error)
  • func (c *Client) UpdateAdmin(id string, admin *models.AdminUpdateRequest) (*models.Admin, error)
  • func (c *Client) UpdateCollection(id string, collection *models.CollectionUpdateRequest) (*models.Collection, error)
  • func (c *Client) UpdateSettings(settings *models.SettingsUpdateRequest) (*models.SettingsList, error)
  • func (c *Client) ViewAdmin(id string) (*models.Admin, error)
  • func (c *Client) ViewCollection(id string) (*models.Collection, error)

Constants

const Endpoint = "http://localhost:8090"

Endpoint represents a single endpoint

Types

type AuthResponse

type AuthResponse struct {
	Token string `json:"token"`
	Admin struct {
		Id      string `json:"id"`
		Created string `json:"created"`
		Updated string `json:"updated"`
		Email   string `json:"email"`
		Avatar  int    `json:"avatar"`
	} `json:"admin"`
}

AuthResponse -

type AuthStruct

type AuthStruct struct {
	Identity string `json:"identity"`
	Password string `json:"password"`
}

AuthStruct -

type Client

type Client struct {
	Endpoint   string
	HTTPClient *http.Client
	Token      string
	Auth       AuthStruct
}

Client -

func NewClient

func NewClient(endpoint, identity, password *string) (*Client, error)

NewClient -

func (*Client) AuthRefresh

func (c *Client) AuthRefresh() (*AuthResponse, error)

AuthRefresh - Returns a new auth response (token and admin data) for already authenticated admin.

func (*Client) AuthWithPassword

func (c *Client) AuthWithPassword() (*AuthResponse, error)

AuthWithPassword - Authenticate an admin with their email and password.

func (*Client) ConfirmPasswordReset

func (c *Client) ConfirmPasswordReset(token, password, passwordConfirm string) error

ConfirmPasswordReset - Confirms a password reset request and sets a new admin password.

func (*Client) CreateAdmin

func (c *Client) CreateAdmin(admin *models.AdminCreateRequest) (*models.Admin, error)

CreateAdmin - Creates a new admin. Only admins can access this action.

func (*Client) CreateCollection

func (c *Client) CreateCollection(collection *models.CollectionCreateRequest) (*models.Collection, error)

CreateCollection - Creates a new Collection. Only admins can access this action.

func (*Client) DeleteAdmin

func (c *Client) DeleteAdmin(id string) error

DeleteAdmin - Deletes a single admin by its id. Only admins can access this action.

func (*Client) DeleteCollection

func (c *Client) DeleteCollection(id string) error

DeleteCollection - Deletes a single Collection by its ID or name. Only admins can access this action.

func (*Client) HealthCheck

func (c *Client) HealthCheck() (*models.HealthResponse, error)

func (*Client) ImportCollections

func (c *Client) ImportCollections(collections *models.CollectionImportRequest) error

ImportCollections - Bulk imports the provided Collections configuration. Only admins can access this action.

func (*Client) ListAdmins

func (c *Client) ListAdmins() (*models.AdminList, error)

ListAdmins - Returns a paginated admins list. Only admins can access this action.

func (*Client) ListCollections

func (c *Client) ListCollections() (*models.CollectionList, error)

ListCollections - Returns a paginated Collections list. Only admins can access this action.

func (*Client) ListSettings

func (c *Client) ListSettings(fields *string) (*models.SettingsList, error)

ListSettings - Returns a list with all available application settings. Secret/password fields are automatically redacted with ****** characters. Only admins can access this action.

func (*Client) RequestPasswordReset

func (c *Client) RequestPasswordReset(email string) error

RequestPasswordReset - Sends a password reset email to an admin.

func (*Client) SendTestEmail

func (c *Client) SendTestEmail(settings *models.SettingsSendTestEmailRequest) (*models.SettingsResponse, error)

SendTestEmail - Sends a test user email. Only admins can access this action.

func (*Client) TestS3StorageConnection

func (c *Client) TestS3StorageConnection(settings *models.SettingsS3StorageTestRequest) (*models.SettingsResponse, error)

TestS3StorageConnection - Performs a S3 storage connection test. Only admins can access this action.

func (*Client) UpdateAdmin

func (c *Client) UpdateAdmin(id string, admin *models.AdminUpdateRequest) (*models.Admin, error)

UpdateAdmin - Update a single admin model by its ID. Only admins can access this action.

func (*Client) UpdateCollection

func (c *Client) UpdateCollection(id string, collection *models.CollectionUpdateRequest) (*models.Collection, error)

UpdateCollection - Updates a single Collection by its ID or name. Only admins can access this action.

func (*Client) UpdateSettings

func (c *Client) UpdateSettings(settings *models.SettingsUpdateRequest) (*models.SettingsList, error)

UpdateSettings - Bulk updates application settings and returns the updated settings list. Only admins can access this action.

func (*Client) ViewAdmin

func (c *Client) ViewAdmin(id string) (*models.Admin, error)

ViewAdmin - Return a single admin by its ID. Only admins can access this action.

func (*Client) ViewCollection

func (c *Client) ViewCollection(id string) (*models.Collection, error)

ViewCollection - Returns a single Collection by its ID or name. Only admins can access this action.