Documents

(Documents)

Overview

Available Operations

Find - Find documents
Get - Get document
CreateV0 - Create document
Update - Update document
Delete - Delete document
MoveToTeam - Move document
Distribute - Distribute document
Redistribute - Redistribute document
Duplicate - Duplicate document

Find

Find documents based on a search criteria

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/documenso/sdk-go"
	"github.com/documenso/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("DOCUMENSO_API_KEY")),
    )

    res, err := s.Documents.Find(ctx, operations.DocumentFindDocumentsRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.DocumentFindDocumentsRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.DocumentFindDocumentsResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.DocumentFindDocumentsResponseBody	400	application/json
apierrors.DocumentFindDocumentsDocumentsResponseBody	404	application/json
apierrors.DocumentFindDocumentsDocumentsResponseResponseBody	500	application/json
apierrors.APIError	4XX, 5XX	/

Get

Returns a document given an ID

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/documenso/sdk-go"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("DOCUMENSO_API_KEY")),
    )

    res, err := s.Documents.Get(ctx, 7003.47)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`documentID`	float64	✔️	N/A
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.DocumentGetDocumentWithDetailsByIDResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.DocumentGetDocumentWithDetailsByIDResponseBody	400	application/json
apierrors.DocumentGetDocumentWithDetailsByIDDocumentsResponseBody	404	application/json
apierrors.DocumentGetDocumentWithDetailsByIDDocumentsResponseResponseBody	500	application/json
apierrors.APIError	4XX, 5XX	/

CreateV0

You will need to upload the PDF to the provided URL returned. Note: Once V2 API is released, this will be removed since we will allow direct uploads, instead of using an upload URL.

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/documenso/sdk-go"
	"github.com/documenso/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("DOCUMENSO_API_KEY")),
    )

    res, err := s.Documents.CreateV0(ctx, operations.DocumentCreateDocumentTemporaryRequestBody{
        Title: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.DocumentCreateDocumentTemporaryRequestBody	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.DocumentCreateDocumentTemporaryResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.DocumentCreateDocumentTemporaryResponseBody	400	application/json
apierrors.DocumentCreateDocumentTemporaryDocumentsResponseBody	500	application/json
apierrors.APIError	4XX, 5XX	/

Update

Update document

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/documenso/sdk-go"
	"github.com/documenso/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("DOCUMENSO_API_KEY")),
    )

    res, err := s.Documents.Update(ctx, operations.DocumentSetSettingsForDocumentRequestBody{
        DocumentID: 8574.78,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.DocumentSetSettingsForDocumentRequestBody	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.DocumentSetSettingsForDocumentResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.DocumentSetSettingsForDocumentResponseBody	400	application/json
apierrors.DocumentSetSettingsForDocumentDocumentsResponseBody	500	application/json
apierrors.APIError	4XX, 5XX	/

Delete

Delete document

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/documenso/sdk-go"
	"github.com/documenso/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("DOCUMENSO_API_KEY")),
    )

    res, err := s.Documents.Delete(ctx, operations.DocumentDeleteDocumentRequestBody{
        DocumentID: 5459.07,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.DocumentDeleteDocumentRequestBody	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.DocumentDeleteDocumentResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.DocumentDeleteDocumentResponseBody	400	application/json
apierrors.DocumentDeleteDocumentDocumentsResponseBody	500	application/json
apierrors.APIError	4XX, 5XX	/

MoveToTeam

Move a document from your personal account to a team

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/documenso/sdk-go"
	"github.com/documenso/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("DOCUMENSO_API_KEY")),
    )

    res, err := s.Documents.MoveToTeam(ctx, operations.DocumentMoveDocumentToTeamRequestBody{
        DocumentID: 8301.72,
        TeamID: 6724.78,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.DocumentMoveDocumentToTeamRequestBody	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.DocumentMoveDocumentToTeamResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.DocumentMoveDocumentToTeamResponseBody	400	application/json
apierrors.DocumentMoveDocumentToTeamDocumentsResponseBody	500	application/json
apierrors.APIError	4XX, 5XX	/

Distribute

Send the document out to recipients based on your distribution method

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/documenso/sdk-go"
	"github.com/documenso/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("DOCUMENSO_API_KEY")),
    )

    res, err := s.Documents.Distribute(ctx, operations.DocumentSendDocumentRequestBody{
        DocumentID: 4115.92,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.DocumentSendDocumentRequestBody	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.DocumentSendDocumentResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.DocumentSendDocumentResponseBody	400	application/json
apierrors.DocumentSendDocumentDocumentsResponseBody	500	application/json
apierrors.APIError	4XX, 5XX	/

Redistribute

Redistribute the document to the provided recipients who have not actioned the document. Will use the distribution method set in the document

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/documenso/sdk-go"
	"github.com/documenso/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("DOCUMENSO_API_KEY")),
    )

    res, err := s.Documents.Redistribute(ctx, operations.DocumentResendDocumentRequestBody{
        DocumentID: 5758.65,
        Recipients: []float64{

        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.DocumentResendDocumentRequestBody	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.DocumentResendDocumentResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.DocumentResendDocumentResponseBody	400	application/json
apierrors.DocumentResendDocumentDocumentsResponseBody	500	application/json
apierrors.APIError	4XX, 5XX	/

Duplicate

Duplicate document

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/documenso/sdk-go"
	"github.com/documenso/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("DOCUMENSO_API_KEY")),
    )

    res, err := s.Documents.Duplicate(ctx, operations.DocumentDuplicateDocumentRequestBody{
        DocumentID: 3523.11,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.DocumentDuplicateDocumentRequestBody	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.DocumentDuplicateDocumentResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.DocumentDuplicateDocumentResponseBody	400	application/json
apierrors.DocumentDuplicateDocumentDocumentsResponseBody	500	application/json
apierrors.APIError	4XX, 5XX	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

Documents

Overview

Available Operations

Find

Example Usage

Parameters

Response

Errors

Get

Example Usage

Parameters

Response

Errors

CreateV0

Example Usage

Parameters

Response

Errors

Update

Example Usage

Parameters

Response

Errors

Delete

Example Usage

Parameters

Response

Errors

MoveToTeam

Example Usage

Parameters

Response

Errors

Distribute

Example Usage

Parameters

Response

Errors

Redistribute

Example Usage

Parameters

Response

Errors

Duplicate

Example Usage

Parameters

Response

Errors