Clickwraps

A Clickwrap is a legal agreement (such as an NDA or Terms of Use) that your Users and/or Bundle/Inbox participants will need to agree to via a "Clickwrap" UI before accessing the site, bundle, or inbox.

The values for use_with_users, use_with_bundles, use_with_inboxes are explained as follows:

  • none - This Clickwrap may not be used in this context.
  • available_to_all_users - This Clickwrap may be assigned in this context by any user.
  • available - This Clickwrap may be assigned in this context, but only by Site Admins. We recognize that the name of this setting is somewhat ambiguous, but we maintain it for legacy reasons.
  • required - This Clickwrap will always be used in this context, and may not be overridden.

List Clickwraps

Command

files-cli clickwraps list

Output

Outputs a list of Clickwrap objects according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

files-cli clickwraps list

Show Clickwrap

Command

files-cli clickwraps find

Output

Outputs a Clickwrap object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required		Clickwrap ID.

Example Request

files-cli clickwraps find \
  --id=1

Create Clickwrap

Command

files-cli clickwraps create

Output

Outputs a Clickwrap object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDefaultDescription
--name=
string		Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
--body=
string		Body text of Clickwrap (supports Markdown formatting).
--use-with-bundles=
string		"none"Use this Clickwrap for Bundles?
Possible values: none, available, require, available_to_all_users
--use-with-inboxes=
string		"none"Use this Clickwrap for Inboxes?
Possible values: none, available, require, available_to_all_users
--use-with-users=
string		"none"Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), require_all_users_once (show to all users at their next web login; once accepted, not shown again), require_all_users_always (show to all users on every web login).
Possible values: none, require, require_all_users_once, require_all_users_always

Example Request

files-cli clickwraps create \
  --name="Example Site NDA for Files.com Use"

Update Clickwrap

Command

files-cli clickwraps update

Output

Outputs a Clickwrap object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required		Clickwrap ID.
--name=
string		Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
--body=
string		Body text of Clickwrap (supports Markdown formatting).
--use-with-bundles=
string		Use this Clickwrap for Bundles?
Possible values: none, available, require, available_to_all_users
--use-with-inboxes=
string		Use this Clickwrap for Inboxes?
Possible values: none, available, require, available_to_all_users
--use-with-users=
string		Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), require_all_users_once (show to all users at their next web login; once accepted, not shown again), require_all_users_always (show to all users on every web login).
Possible values: none, require, require_all_users_once, require_all_users_always

Example Request

files-cli clickwraps update \
  --id=1 \
  --name="Example Site NDA for Files.com Use"

Delete Clickwrap

Command

files-cli clickwraps delete

Output

No output is returned.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required		Clickwrap ID.

Example Request

files-cli clickwraps delete \
  --id=1

The Clickwrap Object

Some of the commands above return a Clickwrap object. The attributes of this object are listed below.

AttributeDescription
id
int64		Clickwrap ID
name
string		Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
body
string		Body text of Clickwrap (supports Markdown formatting).
use_with_users
string		Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), require_all_users_once (show to all users at their next web login; once accepted, not shown again), require_all_users_always (show to all users on every web login).
Possible values: none, require, require_all_users_once, require_all_users_always
use_with_bundles
string		Use this Clickwrap for Bundles?
Possible values: none, available, require, available_to_all_users
use_with_inboxes
string		Use this Clickwrap for Inboxes?
Possible values: none, available, require, available_to_all_users