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

filescom.getClickwrap

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 = filescom.getClickwrap({
    id: 1,
});

    import pulumi
import pulumi_filescom as filescom

example_clickwrap = filescom.get_clickwrap(id=1)

    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.GetClickwrap(ctx, &filescom.LookupClickwrapArgs{
			Id: 1,
		}, nil)
		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 = Filescom.GetClickwrap.Invoke(new()
    {
        Id = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.FilescomFunctions;
import com.pulumi.filescom.inputs.GetClickwrapArgs;
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) {
        final var exampleClickwrap = FilescomFunctions.getClickwrap(GetClickwrapArgs.builder()
            .id(1)
            .build());

    }
}

    variables:
  exampleClickwrap:
    fn::invoke:
      function: filescom:getClickwrap
      arguments:
        id: 1

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

data "filescom_getclickwrap" "exampleClickwrap" {
  id = 1
}

    Using getClickwrap

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getClickwrap(args: GetClickwrapArgs, opts?: InvokeOptions): Promise<GetClickwrapResult>
function getClickwrapOutput(args: GetClickwrapOutputArgs, opts?: InvokeOutputOptions): Output<GetClickwrapResult>
    def get_clickwrap(id: Optional[int] = None,
                  opts: Optional[InvokeOptions] = None) -> GetClickwrapResult
def get_clickwrap_output(id: pulumi.Input[Optional[int]] = None,
                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetClickwrapResult]
    func LookupClickwrap(ctx *Context, args *LookupClickwrapArgs, opts ...InvokeOption) (*LookupClickwrapResult, error)
func LookupClickwrapOutput(ctx *Context, args *LookupClickwrapOutputArgs, opts ...InvokeOption) LookupClickwrapResultOutput

    > Note: This function is named LookupClickwrap in the Go SDK.

    public static class GetClickwrap 
{
    public static Task<GetClickwrapResult> InvokeAsync(GetClickwrapArgs args, InvokeOptions? opts = null)
    public static Output<GetClickwrapResult> Invoke(GetClickwrapInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetClickwrapResult> Invoke(GetClickwrapInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetClickwrapResult> getClickwrap(GetClickwrapArgs args, InvokeOptions options)
public static Output<GetClickwrapResult> getClickwrap(GetClickwrapArgs args, InvokeOptions options)
public static Output<GetClickwrapResult> getClickwrap(GetClickwrapArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: filescom:index/getClickwrap:getClickwrap
  arguments:
    # arguments dictionary
    data "filescom_get_clickwrap" "name" {
    # arguments
}

    The following arguments are supported:

    Id int
    Clickwrap ID
    Id int
    Clickwrap ID
    id number
    Clickwrap ID
    id Integer
    Clickwrap ID
    id number
    Clickwrap ID
    id int
    Clickwrap ID
    id Number
    Clickwrap ID

    getClickwrap Result

    The following output properties are available:

    Body string
    Body text of Clickwrap (supports Markdown formatting).
    Id int
    Clickwrap ID
    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).
    Id int
    Clickwrap ID
    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).
    id number
    Clickwrap ID
    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).
    id Integer
    Clickwrap ID
    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).
    id number
    Clickwrap ID
    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).
    id int
    Clickwrap ID
    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).
    id Number
    Clickwrap ID
    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).

    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