Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. Clickwrap
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

filescom.Clickwrap

filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

    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 useWithUsers, useWithBundles, useWithInboxes are explained as follows:

    • none - This Clickwrap may not be used in this context.

    • availableToAllUsers - 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.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";

const exampleClickwrap = new filescom.Clickwrap("example_clickwrap", {
    name: "Example Site NDA for Files.com Use",
    body: "[Legal body text]",
    useWithBundles: "example",
    useWithInboxes: "example",
    useWithUsers: "example",
});

    import pulumi
import pulumi_filescom as filescom

example_clickwrap = filescom.Clickwrap("example_clickwrap",
    name="Example Site NDA for Files.com Use",
    body="[Legal body text]",
    use_with_bundles="example",
    use_with_inboxes="example",
    use_with_users="example")

    package main

import (
	"github.com/jschady/pulumi-filescom/sdk/go/filescom"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := filescom.NewClickwrap(ctx, "example_clickwrap", &filescom.ClickwrapArgs{
			Name:           pulumi.String("Example Site NDA for Files.com Use"),
			Body:           pulumi.String("[Legal body text]"),
			UseWithBundles: pulumi.String("example"),
			UseWithInboxes: pulumi.String("example"),
			UseWithUsers:   pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Filescom = Jschady.Filescom;

return await Deployment.RunAsync(() => 
{
    var exampleClickwrap = new Filescom.Clickwrap("example_clickwrap", new()
    {
        Name = "Example Site NDA for Files.com Use",
        Body = "[Legal body text]",
        UseWithBundles = "example",
        UseWithInboxes = "example",
        UseWithUsers = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.Clickwrap;
import com.pulumi.filescom.ClickwrapArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleClickwrap = new Clickwrap("exampleClickwrap", ClickwrapArgs.builder()
            .name("Example Site NDA for Files.com Use")
            .body("[Legal body text]")
            .useWithBundles("example")
            .useWithInboxes("example")
            .useWithUsers("example")
            .build());

    }
}

    resources:
  exampleClickwrap:
    type: filescom:Clickwrap
    name: example_clickwrap
    properties:
      name: Example Site NDA for Files.com Use
      body: '[Legal body text]'
      useWithBundles: example
      useWithInboxes: example
      useWithUsers: example

    pulumi {
  required_providers {
    filescom = {
      source = "pulumi/filescom"
    }
  }
}

resource "filescom_clickwrap" "example_clickwrap" {
  name             = "Example Site NDA for Files.com Use"
  body             = "[Legal body text]"
  use_with_bundles = "example"
  use_with_inboxes = "example"
  use_with_users   = "example"
}

    Create Clickwrap Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Clickwrap(name: string, args?: ClickwrapArgs, opts?: CustomResourceOptions);
    @overload
def Clickwrap(resource_name: str,
              args: Optional[ClickwrapArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def Clickwrap(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              body: Optional[str] = None,
              name: Optional[str] = None,
              use_with_bundles: Optional[str] = None,
              use_with_inboxes: Optional[str] = None,
              use_with_users: Optional[str] = None)
    func NewClickwrap(ctx *Context, name string, args *ClickwrapArgs, opts ...ResourceOption) (*Clickwrap, error)
    public Clickwrap(string name, ClickwrapArgs? args = null, CustomResourceOptions? opts = null)
    public Clickwrap(String name, ClickwrapArgs args)
public Clickwrap(String name, ClickwrapArgs args, CustomResourceOptions options)

    type: filescom:Clickwrap
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "filescom_clickwrap" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ClickwrapArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClickwrapArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClickwrapArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClickwrapArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClickwrapArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var clickwrapResource = new Filescom.Clickwrap("clickwrapResource", new()
{
    Body = "string",
    Name = "string",
    UseWithBundles = "string",
    UseWithInboxes = "string",
    UseWithUsers = "string",
});

    example, err := filescom.NewClickwrap(ctx, "clickwrapResource", &filescom.ClickwrapArgs{
	Body:           pulumi.String("string"),
	Name:           pulumi.String("string"),
	UseWithBundles: pulumi.String("string"),
	UseWithInboxes: pulumi.String("string"),
	UseWithUsers:   pulumi.String("string"),
})

    resource "filescom_clickwrap" "clickwrapResource" {
  lifecycle {
    create_before_destroy = true
  }
  body             = "string"
  name             = "string"
  use_with_bundles = "string"
  use_with_inboxes = "string"
  use_with_users   = "string"
}

    var clickwrapResource = new Clickwrap("clickwrapResource", ClickwrapArgs.builder()
    .body("string")
    .name("string")
    .useWithBundles("string")
    .useWithInboxes("string")
    .useWithUsers("string")
    .build());

    clickwrap_resource = filescom.Clickwrap("clickwrapResource",
    body="string",
    name="string",
    use_with_bundles="string",
    use_with_inboxes="string",
    use_with_users="string")

    const clickwrapResource = new filescom.Clickwrap("clickwrapResource", {
    body: "string",
    name: "string",
    useWithBundles: "string",
    useWithInboxes: "string",
    useWithUsers: "string",
});

    type: filescom:Clickwrap
properties:
    body: string
    name: string
    useWithBundles: string
    useWithInboxes: string
    useWithUsers: string

    Clickwrap Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Clickwrap resource accepts the following input properties:

    Body string
    Body text of Clickwrap (supports Markdown formatting).
    Name string
    Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
    UseWithBundles string
    Use this Clickwrap for Bundles?
    UseWithInboxes string
    Use this Clickwrap for Inboxes?
    UseWithUsers string
    Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), requireAllUsersOnce (show to all users at their next web login; once accepted, not shown again), requireAllUsersAlways (show to all users on every web login).
    Body string
    Body text of Clickwrap (supports Markdown formatting).
    Name string
    Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
    UseWithBundles string
    Use this Clickwrap for Bundles?
    UseWithInboxes string
    Use this Clickwrap for Inboxes?
    UseWithUsers string
    Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), requireAllUsersOnce (show to all users at their next web login; once accepted, not shown again), requireAllUsersAlways (show to all users on every web login).
    body string
    Body text of Clickwrap (supports Markdown formatting).
    name string
    Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
    use_with_bundles string
    Use this Clickwrap for Bundles?
    use_with_inboxes string
    Use this Clickwrap for Inboxes?
    use_with_users string
    Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), requireAllUsersOnce (show to all users at their next web login; once accepted, not shown again), requireAllUsersAlways (show to all users on every web login).
    body String
    Body text of Clickwrap (supports Markdown formatting).
    name String
    Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
    useWithBundles String
    Use this Clickwrap for Bundles?
    useWithInboxes String
    Use this Clickwrap for Inboxes?
    useWithUsers String
    Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), requireAllUsersOnce (show to all users at their next web login; once accepted, not shown again), requireAllUsersAlways (show to all users on every web login).
    body string
    Body text of Clickwrap (supports Markdown formatting).
    name string
    Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
    useWithBundles string
    Use this Clickwrap for Bundles?
    useWithInboxes string
    Use this Clickwrap for Inboxes?
    useWithUsers string
    Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), requireAllUsersOnce (show to all users at their next web login; once accepted, not shown again), requireAllUsersAlways (show to all users on every web login).
    body str
    Body text of Clickwrap (supports Markdown formatting).
    name str
    Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
    use_with_bundles str
    Use this Clickwrap for Bundles?
    use_with_inboxes str
    Use this Clickwrap for Inboxes?
    use_with_users str
    Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), requireAllUsersOnce (show to all users at their next web login; once accepted, not shown again), requireAllUsersAlways (show to all users on every web login).
    body String
    Body text of Clickwrap (supports Markdown formatting).
    name String
    Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
    useWithBundles String
    Use this Clickwrap for Bundles?
    useWithInboxes String
    Use this Clickwrap for Inboxes?
    useWithUsers String
    Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), requireAllUsersOnce (show to all users at their next web login; once accepted, not shown again), requireAllUsersAlways (show to all users on every web login).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Clickwrap resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Clickwrap Resource

    Get an existing Clickwrap resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ClickwrapState, opts?: CustomResourceOptions): Clickwrap
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        body: Optional[str] = None,
        name: Optional[str] = None,
        use_with_bundles: Optional[str] = None,
        use_with_inboxes: Optional[str] = None,
        use_with_users: Optional[str] = None) -> Clickwrap
    func GetClickwrap(ctx *Context, name string, id IDInput, state *ClickwrapState, opts ...ResourceOption) (*Clickwrap, error)
    public static Clickwrap Get(string name, Input<string> id, ClickwrapState? state, CustomResourceOptions? opts = null)
    public static Clickwrap get(String name, Output<String> id, ClickwrapState state, CustomResourceOptions options)
    resources:  _:    type: filescom:Clickwrap    get:      id: ${id}
    import {
  to = filescom_clickwrap.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Body string
    Body text of Clickwrap (supports Markdown formatting).
    Name string
    Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
    UseWithBundles string
    Use this Clickwrap for Bundles?
    UseWithInboxes string
    Use this Clickwrap for Inboxes?
    UseWithUsers string
    Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), requireAllUsersOnce (show to all users at their next web login; once accepted, not shown again), requireAllUsersAlways (show to all users on every web login).
    Body string
    Body text of Clickwrap (supports Markdown formatting).
    Name string
    Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
    UseWithBundles string
    Use this Clickwrap for Bundles?
    UseWithInboxes string
    Use this Clickwrap for Inboxes?
    UseWithUsers string
    Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), requireAllUsersOnce (show to all users at their next web login; once accepted, not shown again), requireAllUsersAlways (show to all users on every web login).
    body string
    Body text of Clickwrap (supports Markdown formatting).
    name string
    Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
    use_with_bundles string
    Use this Clickwrap for Bundles?
    use_with_inboxes string
    Use this Clickwrap for Inboxes?
    use_with_users string
    Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), requireAllUsersOnce (show to all users at their next web login; once accepted, not shown again), requireAllUsersAlways (show to all users on every web login).
    body String
    Body text of Clickwrap (supports Markdown formatting).
    name String
    Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
    useWithBundles String
    Use this Clickwrap for Bundles?
    useWithInboxes String
    Use this Clickwrap for Inboxes?
    useWithUsers String
    Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), requireAllUsersOnce (show to all users at their next web login; once accepted, not shown again), requireAllUsersAlways (show to all users on every web login).
    body string
    Body text of Clickwrap (supports Markdown formatting).
    name string
    Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
    useWithBundles string
    Use this Clickwrap for Bundles?
    useWithInboxes string
    Use this Clickwrap for Inboxes?
    useWithUsers string
    Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), requireAllUsersOnce (show to all users at their next web login; once accepted, not shown again), requireAllUsersAlways (show to all users on every web login).
    body str
    Body text of Clickwrap (supports Markdown formatting).
    name str
    Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
    use_with_bundles str
    Use this Clickwrap for Bundles?
    use_with_inboxes str
    Use this Clickwrap for Inboxes?
    use_with_users str
    Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), requireAllUsersOnce (show to all users at their next web login; once accepted, not shown again), requireAllUsersAlways (show to all users on every web login).
    body String
    Body text of Clickwrap (supports Markdown formatting).
    name String
    Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
    useWithBundles String
    Use this Clickwrap for Bundles?
    useWithInboxes String
    Use this Clickwrap for Inboxes?
    useWithUsers String
    Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), requireAllUsersOnce (show to all users at their next web login; once accepted, not shown again), requireAllUsersAlways (show to all users on every web login).

    Import

    The pulumi import command can be used, for example:

    Clickwraps can be imported by specifying the id.

    $ pulumi import filescom:index/clickwrap:Clickwrap example_clickwrap 1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    filescom jschady/pulumi-filescom
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady
    Schema (JSON)
    jschady/pulumi-filescom

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial