client

Documentation

Index

• func ContextualiseFilter(filter bson.M, claimsToAdd claims.Claims) bson.M
• func IsValidIdentifier(id identifier.Identifier) bool
• type Client
  • func (c Client) Details() party.Details
  • func (c *Client) SetId(id string)
• type Type

Functions

func ContextualiseFilter

func ContextualiseFilter(filter bson.M, claimsToAdd claims.Claims) bson.M

func IsValidIdentifier

func IsValidIdentifier(id identifier.Identifier) bool

Types

type Client

type Client struct {
	Id string `json:"id" bson:"id"`

	// Client Type, Individual or Company
	Type Type `json:"type" bson:"type"`

	Name string `json:"name" bson:"name"`

	// The email address which will be used to invite the admin
	// user of the client
	// I.e. the first user of the system from the client
	AdminEmailAddress string `json:"adminEmailAddress" bson:"adminEmailAddress"`

	ParentPartyType party.Type    `json:"parentPartyType" bson:"parentPartyType"`
	ParentId        id.Identifier `json:"parentId" bson:"parentId"`
}

Client is the model for the client entities in the system

func (Client) Details

func (c Client) Details() party.Details

Details returns the party details of the client party

func (*Client) SetId

func (c *Client) SetId(id string)

type Type

type Type string

const Company Type = "Company"

const Individual Type = "Individual"