Skip to content

Latest commit

 

History

History
402 lines (315 loc) · 25.7 KB

README.md

File metadata and controls

402 lines (315 loc) · 25.7 KB

Fields

(Documents.Fields)

Overview

Available Operations

Get

Returns a single field. If you want to retrieve all the fields for a document, use the "Get Document" endpoint.

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.Fields.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.
fieldID float64 ✔️ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.FieldGetDocumentFieldResponse, error

Errors

Error Type Status Code Content Type
apierrors.FieldGetDocumentFieldResponseBody 400 application/json
apierrors.FieldGetDocumentFieldDocumentsFieldsResponseBody 404 application/json
apierrors.FieldGetDocumentFieldDocumentsFieldsResponseResponseBody 500 application/json
apierrors.APIError 4XX, 5XX */*

Create

Create a single field for a 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.Fields.Create(ctx, operations.FieldCreateDocumentFieldRequestBody{
        DocumentID: 4865.89,
        Field: operations.CreateFieldField8(
            operations.Field8{
                Type: operations.FieldCreateDocumentFieldFieldDocumentsFieldsRequestRequestBody8TypeNumber,
                RecipientID: 4174.58,
                PageNumber: 1343.65,
                PageX: 690.25,
                PageY: 7964.74,
                Width: 9510.62,
                Height: 0.86,
            },
        ),
    })
    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.FieldCreateDocumentFieldRequestBody ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.FieldCreateDocumentFieldResponse, error

Errors

Error Type Status Code Content Type
apierrors.FieldCreateDocumentFieldResponseBody 400 application/json
apierrors.FieldCreateDocumentFieldDocumentsFieldsResponseBody 500 application/json
apierrors.APIError 4XX, 5XX */*

CreateMany

Create multiple fields for a 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.Fields.CreateMany(ctx, operations.FieldCreateDocumentFieldsRequestBody{
        DocumentID: 5158.41,
        Fields: []operations.FieldCreateDocumentFieldsFields{
            operations.CreateFieldCreateDocumentFieldsFieldsFields10(
                operations.Fields10{
                    Type: operations.FieldCreateDocumentFieldsFieldsDocumentsFieldsRequestRequestBody10TypeCheckbox,
                    RecipientID: 2516.72,
                    PageNumber: 2304.17,
                    PageX: 7760.32,
                    PageY: 3376.66,
                    Width: 3566.94,
                    Height: 2768.94,
                },
            ),
            operations.CreateFieldCreateDocumentFieldsFieldsFields8(
                operations.Fields8{
                    Type: operations.FieldCreateDocumentFieldsFieldsDocumentsFieldsRequestRequestBody8TypeNumber,
                    RecipientID: 5689.64,
                    PageNumber: 6483.69,
                    PageX: 7271.79,
                    PageY: 1891.56,
                    Width: 7263.21,
                    Height: 5043.41,
                },
            ),
        },
    })
    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.FieldCreateDocumentFieldsRequestBody ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.FieldCreateDocumentFieldsResponse, error

Errors

Error Type Status Code Content Type
apierrors.FieldCreateDocumentFieldsResponseBody 400 application/json
apierrors.FieldCreateDocumentFieldsDocumentsFieldsResponseBody 500 application/json
apierrors.APIError 4XX, 5XX */*

Update

Update a single field for a 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.Fields.Update(ctx, operations.FieldUpdateDocumentFieldRequestBody{
        DocumentID: 8574.78,
        Field: operations.CreateFieldUpdateDocumentFieldFieldFieldUpdateDocumentFieldField7(
            operations.FieldUpdateDocumentFieldField7{
                Type: operations.FieldUpdateDocumentFieldFieldDocumentsFieldsRequestRequestBody7TypeText,
                ID: 3446.2,
            },
        ),
    })
    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.FieldUpdateDocumentFieldRequestBody ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.FieldUpdateDocumentFieldResponse, error

Errors

Error Type Status Code Content Type
apierrors.FieldUpdateDocumentFieldResponseBody 400 application/json
apierrors.FieldUpdateDocumentFieldDocumentsFieldsResponseBody 500 application/json
apierrors.APIError 4XX, 5XX */*

UpdateMany

Update multiple fields for a 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.Fields.UpdateMany(ctx, operations.FieldUpdateDocumentFieldsRequestBody{
        DocumentID: 4057.69,
        Fields: []operations.FieldUpdateDocumentFieldsFields{
            operations.CreateFieldUpdateDocumentFieldsFieldsFieldUpdateDocumentFieldsFields6(
                operations.FieldUpdateDocumentFieldsFields6{
                    Type: operations.FieldUpdateDocumentFieldsFieldsDocumentsFieldsRequestRequestBody6TypeDate,
                    ID: 8982.15,
                },
            ),
            operations.CreateFieldUpdateDocumentFieldsFieldsFieldUpdateDocumentFieldsFields4(
                operations.FieldUpdateDocumentFieldsFields4{
                    Type: operations.FieldUpdateDocumentFieldsFieldsDocumentsFieldsRequestRequestBody4TypeName,
                    ID: 310.19,
                },
            ),
        },
    })
    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.FieldUpdateDocumentFieldsRequestBody ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.FieldUpdateDocumentFieldsResponse, error

Errors

Error Type Status Code Content Type
apierrors.FieldUpdateDocumentFieldsResponseBody 400 application/json
apierrors.FieldUpdateDocumentFieldsDocumentsFieldsResponseBody 500 application/json
apierrors.APIError 4XX, 5XX */*

Delete

Delete document field

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.Fields.Delete(ctx, operations.FieldDeleteDocumentFieldRequestBody{
        FieldID: 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.FieldDeleteDocumentFieldRequestBody ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.FieldDeleteDocumentFieldResponse, error

Errors

Error Type Status Code Content Type
apierrors.FieldDeleteDocumentFieldResponseBody 400 application/json
apierrors.FieldDeleteDocumentFieldDocumentsFieldsResponseBody 500 application/json
apierrors.APIError 4XX, 5XX */*