clarify

Nov 22, 2023

Changes in this version

type Credentials

+ func CredentialsFromString(s string) (*Credentials, error)

Oct 26, 2023

Changes in this version

+ type AdminNamespace struct

+ func (ns AdminNamespace) PublishSignals(integration string, itemsBySignal map[string]views.ItemSave) PublishSignalsRequest

+ func (ns AdminNamespace) SelectSignals(integration string, q fields.ResourceQuery) SelectSignalsRequest

+ type ClarifyNamespace struct

+ func (ns ClarifyNamespace) DataFrame(items fields.ResourceQuery, data fields.DataQuery) DataFrameRequest

+ func (ns ClarifyNamespace) Evaluate(items []fields.ItemAggregation, calculations []fields.Calculation, ...) EvaluateRequest

+ func (ns ClarifyNamespace) SelectItems(q fields.ResourceQuery) SelectItemsRequest

type Client

+ func (c Client) Admin() AdminNamespace

+ func (c Client) Clarify() ClarifyNamespace

+ func (c Client) Integration() IntegrationNamespace

+ type EvaluateRequest = request.Relational[EvaluateResult]

+ type EvaluateResult = views.Selection[views.DataFrame, views.DataFrameInclude]

+ type InsertRequest = request.Request[InsertResult]

+ type IntegrationNamespace struct

+ func (ns IntegrationNamespace) Insert(data views.DataFrame) InsertRequest

+ func (ns IntegrationNamespace) SaveSignals(inputs map[string]views.SignalSave) SaveSignalRequest

+ type PublishSignalsRequest = request.Request[PublishSignalsResult]

+ type SaveSignalRequest = request.Request[SaveSignalsResult]

+ type SelectItemsRequest = request.Relational[SelectItemsResult]

+ type SelectSignalsRequest = request.Relational[SelectSignalsResult]

Oct 12, 2022

Changes in this version

type DataFrameRequest

+ func (req DataFrameRequest) Query(q query.Query) DataFrameRequest

+ func (req DataFrameRequest) Total() DataFrameRequest

Sep 6, 2022

Changes in this version

type DataFrameRequest

+ func (req DataFrameRequest) Sort(fields ...string) DataFrameRequest

Jun 8, 2022

Changes in this version

+ const CodeConflict

+ const CodeForbidden

+ const CodeFoundInvalidResource

+ const CodeInternal

+ const CodeInvalidJSON

+ const CodeInvalidParams

+ const CodeInvalidRequest

+ const CodeMethodNotFound

+ const CodePartialFailure

+ const CodeProduceInvalidResource

+ const CodeServerError

+ const CodeTryAgain

+ const ErrBadCredentials

+ const ErrBadRequest

+ const ErrBadResponse

+ const TypeBasicAuth

+ const TypeClientCredentials

+ type Client struct

+ func NewClient(integration string, h jsonrpc.Handler) *Client

+ func (c *Client) DataFrame() DataFrameRequest

+ func (c *Client) Insert(data views.DataFrame) resource.Request[InsertResult]

+ func (c *Client) PublishSignals(integration string, itemsBySignal map[string]views.ItemSave) resource.SaveRequest[map[string]views.ItemSave, PublishSignalsResult]

+ func (c *Client) SaveSignals(inputs map[string]views.SignalSave) resource.SaveRequest[map[string]views.SignalSave, SaveSignalsResult]

+ func (c *Client) SelectItems() resource.SelectRequest[SelectItemsResult]

+ func (c *Client) SelectSignals(integration string) resource.SelectRequest[SelectSignalsResult]

+ type Credentials struct

+ APIURL string

+ CreatedAt time.Time

+ Credentials CredentialsAuth

+ Integration string

+ Name string

+ func BasicAuthCredentials(integrationID, password string) *Credentials

+ func CredentialsFromFile(name string) (creds *Credentials, err error)

+ func CredentialsFromReader(r io.Reader) (*Credentials, error)

+ func (creds *Credentials) Validate() error

+ func (creds Credentials) Client(ctx context.Context) *Client

+ func (creds Credentials) HTTPHandler(ctx context.Context) (*jsonrpc.HTTPHandler, error)

+ type CredentialsAuth struct

+ ClientID string

+ ClientSecret string

+ Type string

+ type DataFrameInclude struct

+ Items []views.Item

+ type DataFrameRequest struct

+ func (req DataFrameRequest) Do(ctx context.Context) (*DataFrameResult, error)

+ func (req DataFrameRequest) Filter(filter query.FilterType) DataFrameRequest

+ func (req DataFrameRequest) FilterField(path string, cmp query.Comparison) DataFrameRequest

+ func (req DataFrameRequest) Include(relationships ...string) DataFrameRequest

+ func (req DataFrameRequest) Last(n int) DataFrameRequest

+ func (req DataFrameRequest) Limit(n int) DataFrameRequest

+ func (req DataFrameRequest) RollupBucket(d time.Duration) DataFrameRequest

+ func (req DataFrameRequest) RollupWindow() DataFrameRequest

+ func (req DataFrameRequest) Skip(n int) DataFrameRequest

+ func (req DataFrameRequest) TimeRange(gte, lt time.Time) DataFrameRequest

+ type DataFrameResult = struct

+ Data views.DataFrame

+ Included DataFrameInclude

+ Meta resource.SelectionMeta

+ type HTTPError = jsonrpc.HTTPError

+ type InsertResult struct

+ SignalsByInput map[string]resource.CreateSummary

+ type PathErrors map[string][]string

+ func (err PathErrors) Error() string

+ type PublishSignalsResult struct

+ ItemsBySignals map[string]resource.SaveSummary

+ type SaveSignalsResult struct

+ SignalsByInput map[string]resource.SaveSummary

+ type SelectItemsResult = resource.Selection[views.Item, views.ItemInclude]

+ type SelectSignalsResult = resource.Selection[views.Signal, views.SignalInclude]

+ type ServerError = jsonrpc.ServerError