Skip to content

Latest commit

 

History

History
179 lines (134 loc) · 13.6 KB

README.md

File metadata and controls

179 lines (134 loc) · 13.6 KB

DirectLink

(Templates.DirectLink)

Overview

Available Operations

Create

Create a direct link for a 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.DirectLink.Create(ctx, operations.TemplateCreateTemplateDirectLinkRequestBody{
        TemplateID: 4865.89,
    })
    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.TemplateCreateTemplateDirectLinkRequestBody ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.TemplateCreateTemplateDirectLinkResponse, error

Errors

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

Delete

Delete a direct link for a 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.DirectLink.Delete(ctx, operations.TemplateDeleteTemplateDirectLinkRequestBody{
        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.TemplateDeleteTemplateDirectLinkRequestBody ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.TemplateDeleteTemplateDirectLinkResponse, error

Errors

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

Toggle

Enable or disable a direct link for a 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.DirectLink.Toggle(ctx, operations.TemplateToggleTemplateDirectLinkRequestBody{
        TemplateID: 722.9,
        Enabled: true,
    })
    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.TemplateToggleTemplateDirectLinkRequestBody ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.TemplateToggleTemplateDirectLinkResponse, error

Errors

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