satori

Documentation

Index

• type SatoriClient
  • func NewSatoriClient(logger *zap.Logger, satoriUrl, apiKeyName, apiKey, signingKey string) *SatoriClient
  • func (s *SatoriClient) Authenticate(ctx context.Context, id string, ipAddress ...string) error
  • func (s *SatoriClient) EventsPublish(ctx context.Context, id string, events []*runtime.Event) error
  • func (s *SatoriClient) ExperimentsList(ctx context.Context, id string, names ...string) (*runtime.ExperimentList, error)
  • func (s *SatoriClient) FlagsList(ctx context.Context, id string, names ...string) (*runtime.FlagList, error)
  • func (s *SatoriClient) LiveEventsList(ctx context.Context, id string, names ...string) (*runtime.LiveEventList, error)
  • func (s *SatoriClient) PropertiesGet(ctx context.Context, id string) (*runtime.Properties, error)
  • func (s *SatoriClient) PropertiesUpdate(ctx context.Context, id string, properties *runtime.PropertiesUpdate) error

Types

type SatoriClient

type SatoriClient struct {
	// contains filtered or unexported fields
}

func NewSatoriClient

func NewSatoriClient(logger *zap.Logger, satoriUrl, apiKeyName, apiKey, signingKey string) *SatoriClient

func (*SatoriClient) Authenticate

func (s *SatoriClient) Authenticate(ctx context.Context, id string, ipAddress ...string) error

@group satori @summary Create a new identity. @param ctx(type=context.Context) The context object represents information about the server and requester. @param id(type=string) The identifier of the identity. @param ipAddress(type=string, optional=true) An optional client IP address to pass on to Satori for geo-IP lookup. @return error(error) An optional error value if an error occurred.

func (*SatoriClient) EventsPublish

func (s *SatoriClient) EventsPublish(ctx context.Context, id string, events []*runtime.Event) error

@group satori @summary Publish an event. @param ctx(type=context.Context) The context object represents information about the server and requester. @param id(type=string) The identifier of the identity. @param events(type=[]*runtime.Event) An array of events to publish. @return error(error) An optional error value if an error occurred.

func (*SatoriClient) ExperimentsList

func (s *SatoriClient) ExperimentsList(ctx context.Context, id string, names ...string) (*runtime.ExperimentList, error)

@group satori @summary List experiments. @param ctx(type=context.Context) The context object represents information about the server and requester. @param id(type=string) The identifier of the identity. @param names(type=[]string, optional=true, default=[]) Optional list of experiment names to filter. @return experiments(*runtime.ExperimentList) The experiment list. @return error(error) An optional error value if an error occurred.

func (*SatoriClient) FlagsList

func (s *SatoriClient) FlagsList(ctx context.Context, id string, names ...string) (*runtime.FlagList, error)

@group satori @summary List flags. @param ctx(type=context.Context) The context object represents information about the server and requester. @param id(type=string) The identifier of the identity. @param names(type=[]string, optional=true, default=[]) Optional list of flag names to filter. @return flags(*runtime.FlagList) The flag list. @return error(error) An optional error value if an error occurred.

func (*SatoriClient) LiveEventsList

func (s *SatoriClient) LiveEventsList(ctx context.Context, id string, names ...string) (*runtime.LiveEventList, error)

@group satori @summary List live events. @param ctx(type=context.Context) The context object represents information about the server and requester. @param id(type=string) The identifier of the identity. @param names(type=[]string, optional=true, default=[]) Optional list of live event names to filter. @return liveEvents(*runtime.LiveEventsList) The live event list. @return error(error) An optional error value if an error occurred.

func (*SatoriClient) PropertiesGet

func (s *SatoriClient) PropertiesGet(ctx context.Context, id string) (*runtime.Properties, error)

@group satori @summary Get identity properties. @param ctx(type=context.Context) The context object represents information about the server and requester. @param id(type=string) The identifier of the identity. @return properties(*runtime.Properties) The identity properties. @return error(error) An optional error value if an error occurred.

func (*SatoriClient) PropertiesUpdate

func (s *SatoriClient) PropertiesUpdate(ctx context.Context, id string, properties *runtime.PropertiesUpdate) error

@group satori @summary Update identity properties. @param ctx(type=context.Context) The context object represents information about the server and requester. @param id(type=string) The identifier of the identity. @param properties(type=*runtime.PropertiesUpdate) The identity properties to update. @return error(error) An optional error value if an error occurred.