sails-forth.client — sparkfund/sails-forth 0.9.1

build-atomic-cache clj

(build-atomic-cache)

build-http-client clj

(build-http-client config)

build-memory-client clj

(build-memory-client schema)

(build-memory-client schema take-action-map)

Cache clj protocol

get! clj

(get! _ key)

put! clj

(put! _ key value)

Client clj protocol

take-action! clj

(take-action! _ action inputs)

Submits a request to perform the given action

limits! clj

(limits! _)

Returns the current limits

create! clj

(create! _ type attrs)

Creates an object of the given type and attrs using the given salesforce client. If salesforce responds successfully, this returns the object's id, otherwise this raises an exception.

list-actions! clj

(list-actions! _ path)

Gets a list of actions that can be performed

objects! clj

(objects! _)

Lists all objects

list! clj

(list! _ type)

Lists all objets of the given type

describe-action! clj

(describe-action! _ action)

Describes an action

cache clj

(cache _)

Returns a persistent cache

describe! clj

(describe! _ type)

Describes the given type

delete! clj

(delete! _ type id)

Deletes the object of the given type with the given id. This returns true if it succeeds and raises an exception otherwise.

import! clj

(import! _ type records)

Imports the given records into the given type

update! clj

(update! _ type id attrs)

Updates the object of the given type with the given id. This returns true if it succeeds and raises an exception otherwise.

query! clj

(query! _ query)

Executes the given query and returns all results, eagerly fetching if there is pagination

count! clj

(count! _ query)

Returns the number of results from the given query

client? clj

(client? x)

get-attrs-for-label clj

(get-attrs-for-label client type label)

Returns the set of attributes on the given type that have the given label

get-field-description clj

(get-field-description client type attr)

Obtains the description for the given field on a type by its attribute

get-fields clj

(get-fields client type)

Obtains a map of descriptions by field for the given type

get-type-description clj

(get-type-description client type)

Obtains the description for a given type and builds some custom indexes into it. This will only fetch the type once for a given client.

get-types clj

(get-types client)

Obtains a map of descriptions by type

resolve-attr-path clj

(resolve-attr-path client type attr-path)

Resolves a path of attrs against a given type, returning a path of fields. All but the last attr in a path must resolve to a reference type.

resolve-field-path clj

(resolve-field-path field-path)

Derives a seq of record keys for the given seq of fields, suitable for applying to the result of the underlying query! fn

schema clj

(schema client types)