Skip to content

Latest commit

 

History

History
416 lines (315 loc) · 27.4 KB

README.md

File metadata and controls

416 lines (315 loc) · 27.4 KB

Templates

(Templates)

Overview

Available Operations

Find

Find templates based on a search criteria

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.Templates.Find(ctx, nil, nil, nil, nil)
    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.
query *string ➖ The search query.
page *float64 ➖ The pagination page number, starts at 1.
perPage *float64 ➖ The number of items per page.
type_ *operations.QueryParamType ➖ Filter templates by type.
opts []operations.Option ➖ The options for this request.

Response

*operations.TemplateFindTemplatesResponse, error

Errors

Error Type Status Code Content Type
apierrors.TemplateFindTemplatesResponseBody 400 application/json
apierrors.TemplateFindTemplatesTemplatesResponseBody 404 application/json
apierrors.TemplateFindTemplatesTemplatesResponseResponseBody 500 application/json
apierrors.APIError 4XX, 5XX */*

Get

Get template

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

Response

*operations.TemplateGetTemplateByIDResponse, error

Errors

Error Type Status Code Content Type
apierrors.TemplateGetTemplateByIDResponseBody 400 application/json
apierrors.TemplateGetTemplateByIDTemplatesResponseBody 404 application/json
apierrors.TemplateGetTemplateByIDTemplatesResponseResponseBody 500 application/json
apierrors.APIError 4XX, 5XX */*

Update

Update template

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.Templates.Update(ctx, operations.TemplateUpdateTemplateRequestBody{
        TemplateID: 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.TemplateUpdateTemplateRequestBody ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.TemplateUpdateTemplateResponse, error

Errors

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

Duplicate

Duplicate template

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.Templates.Duplicate(ctx, operations.TemplateDuplicateTemplateRequestBody{
        TemplateID: 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.TemplateDuplicateTemplateRequestBody ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.TemplateDuplicateTemplateResponse, error

Errors

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

Delete

Delete template

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

Response

*operations.TemplateDeleteTemplateResponse, error

Errors

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

Use

Use the template to create 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.Templates.Use(ctx, operations.TemplateCreateDocumentFromTemplateRequestBody{
        TemplateID: 6626.9,
        Recipients: []operations.TemplateCreateDocumentFromTemplateRecipients{
            operations.TemplateCreateDocumentFromTemplateRecipients{
                ID: 6473.53,
                Email: "[email protected]",
            },
            operations.TemplateCreateDocumentFromTemplateRecipients{
                ID: 3772.31,
                Email: "[email protected]",
            },
        },
    })
    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.TemplateCreateDocumentFromTemplateRequestBody ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.TemplateCreateDocumentFromTemplateResponse, error

Errors

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

MoveToTeam

Move a template 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.Templates.MoveToTeam(ctx, operations.TemplateMoveTemplateToTeamRequestBody{
        TemplateID: 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.TemplateMoveTemplateToTeamRequestBody ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.TemplateMoveTemplateToTeamResponse, error

Errors

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