DKRouter

The domain and path for all endpoints on the Dropmark API. Defaults to “https://api.dropmark.com/v1”, and may be modified for different API versions.

The number of objects to list per page request. Defaults to 24

Get a list of the most recently updated items across a user’s teams and personal accounts. Returns a DKItem list.

Pass in an email and password, and get a user object containing the token necessary to authenticate requests on behalf of the user. Returns a DKUser object.

Get a list of collections. Returns a DKCollection list.

Create a collection. Returns a DKCollection object.

Get a single collection. Returns a DKCollection object.

Update a single collection. Returns a DKCollection object.

Delete a single collection. Returns only a 200 response.

Get the total number of collections available to the user. Returns an integer.

Get the total number of items in a collection. Returns an integer.

Get a list of users with permission to access the collection. Returns a DKUser list.

Give a user access to a collection (only works if the current user has permission)

Remove a user’s access to a collection (only works if the current user has permission). Returns only a 200 response.

Get a list of comments associated with an item. Returns a DKComment list.

Add a comment to an item. Returns a DKComment object.

Update a comment. Returns a DKComment object.

Delete a comment. Returns only a 200 response.

Get a list of emails associated with the current user. Returns a String list.

Add an email for the current user

Delete an email for the current user

Get a list of all items matching the query parameters. Returns a DKItem list.

Get a list of all child items in a collection (adding a parent_id will filter in a stack). Returns a DKItem list.

Create a new item in a parent collection. Returns a DKItem object.

Update multiple items within a collection. Returns a DKItem list.

Update multiple items. Returns a DKItem list.

Get a single item. Returns a DKItem object.

Update a single item. Returns a DKItem object.

Delete a single item. Returns only a 200 response.

Delete multiple items within a parent collection. Returns only a 200 response.

Duplicate an item(s) within a parent collection. Returns a DKItem list.

Get a list of reactions associated with an item. Returns a DKReaction list.

Create a reaction for an item. Returns a DKReaction object.

Delete a reaction. Returns only a 200 response.

Run a search for collections, items, comments, reactions, and invites using the q parameter. Note: Be sure to use the DKResponseListAny serializer to accept varying object types. Returns a list containing ‘DKCollection’, ‘DKItem’, ‘DKComment’, ‘DKReaction’, and ‘DKInvite’ objects.

Get a list of tags associated with the current user. Returns a DKTag list.

Get a list of tags applied to the specified item. Returns a DKTag list.

Create a new tag and apply it to the specified item. Returns a DKTag object.

Delete a tag. Returns only a 200 response.

Get a list of teams the current user belongs to. Returns a DKTeam list.

Get a specified team, if visible to the current user. Returns a DKTeam object.

Update a team. Returns a DKTeam object.

List all users belonging to the specified team. Returns a DKUser list.

Add a user to a team. Returns a DKUser object.

Update a user within a team. Returns a DKUser object.

Remove a user from a team. Returns only a 200 response.

Create a user (aka register a new account). Returns a DKUser object.

Get the user object for the current user. NOTE: The user object returned by this endpoint will not contain a ‘token’ for authentication. Returns a DKUser object.

Update information for the current user. Returns a DKUser object.

Get a list of users associated with the current user

Check if an email is available for registration. Returns a Bool value.

Check if a username is available for registration. Returns a Bool value.

Use this endpoint to get an upload signature for direct uploads to Amazon S3

Returns a URL request or throws if an Error was encountered.

- Throws: An `Error` if the underlying `URLRequest` is `nil`.
- Returns: A URL request.

To access API resources, an API token is required in the header of all requests. To authenticate with this function, first set the DKRouter.apiToken variable. Then pass a reference to a request through.

To authorize requests on behalf of a user, the user’s private token must be encoded and supplied in the Authorization header. To authorize a user’s request for the duration of the app session, set an authenticated user to DKRouter.user.