customtabs

Documentation

Overview

Package customtabs implements the DocuSign SDK category CustomTabs.

Custom Tabs enable accounts to have one or more pre-configured (custom) tabs. Custom tabs save time when users are tagging documents since the users don't have to manually set the tabs' parameters.

This category enables custom tabs to be managed programmatically, including creation, deletion, etc.

Service Api documentation may be found at: https://developers.docusign.com/docs/esign-rest-api/reference/CustomTabs Usage example:

import (
    "github.com/jfcote87/esign"
    "github.com/jfcote87/esign/v2.1/model"
)
...
customtabsService := customtabs.New(esignCredential)

Index

• type CreateOp
  • func (op *CreateOp) Do(ctx context.Context) (*model.TabMetadata, error)
• type DeleteOp
  • func (op *DeleteOp) Do(ctx context.Context) error
• type GetOp
  • func (op *GetOp) Do(ctx context.Context) (*model.TabMetadata, error)
• type ListOp
  • func (op *ListOp) CustomTabOnly() *ListOp
  • func (op *ListOp) Do(ctx context.Context) (*model.TabMetadataList, error)
• type Service
  • func New(cred esign.Credential) *Service
  • func (s *Service) Create(tabMetadata *model.TabMetadata) *CreateOp
  • func (s *Service) Delete(customTabID string) *DeleteOp
  • func (s *Service) Get(customTabID string) *GetOp
  • func (s *Service) List() *ListOp
  • func (s *Service) Update(customTabID string, tabMetadata *model.TabMetadata) *UpdateOp
• type UpdateOp
  • func (op *UpdateOp) Do(ctx context.Context) (*model.TabMetadata, error)

Types

type CreateOp

type CreateOp esign.Op

CreateOp implements DocuSign API SDK CustomTabs::create

func (*CreateOp) Do

func (op *CreateOp) Do(ctx context.Context) (*model.TabMetadata, error)

Do executes the op. A nil context will return error.

type DeleteOp

type DeleteOp esign.Op

DeleteOp implements DocuSign API SDK CustomTabs::delete

func (*DeleteOp) Do

func (op *DeleteOp) Do(ctx context.Context) error

Do executes the op. A nil context will return error.

type GetOp

type GetOp esign.Op

GetOp implements DocuSign API SDK CustomTabs::get

func (*GetOp) Do

func (op *GetOp) Do(ctx context.Context) (*model.TabMetadata, error)

Do executes the op. A nil context will return error.

type ListOp

type ListOp esign.Op

ListOp implements DocuSign API SDK CustomTabs::list

func (*ListOp) CustomTabOnly

func (op *ListOp) CustomTabOnly() *ListOp

CustomTabOnly when **true,** only custom tabs are returned in the response.

func (*ListOp) Do

func (op *ListOp) Do(ctx context.Context) (*model.TabMetadataList, error)

Do executes the op. A nil context will return error.

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service implements DocuSign CustomTabs API operations

func New

func New(cred esign.Credential) *Service

New initializes a customtabs service using cred to authorize ops.

func (*Service) Create

func (s *Service) Create(tabMetadata *model.TabMetadata) *CreateOp

Create creates a custom tab.

https://developers.docusign.com/docs/esign-rest-api/reference/customtabs/customtabs/create

SDK Method CustomTabs::create

func (*Service) Delete

func (s *Service) Delete(customTabID string) *DeleteOp

Delete deletes custom tab information.

https://developers.docusign.com/docs/esign-rest-api/reference/customtabs/customtabs/delete

SDK Method CustomTabs::delete

func (*Service) Get

func (s *Service) Get(customTabID string) *GetOp

Get gets custom tab information.

https://developers.docusign.com/docs/esign-rest-api/reference/customtabs/customtabs/get

SDK Method CustomTabs::get

func (*Service) List

func (s *Service) List() *ListOp

List gets a list of all account tabs.

https://developers.docusign.com/docs/esign-rest-api/reference/customtabs/customtabs/list

SDK Method CustomTabs::list

func (*Service) Update

func (s *Service) Update(customTabID string, tabMetadata *model.TabMetadata) *UpdateOp

Update updates custom tab information.

https://developers.docusign.com/docs/esign-rest-api/reference/customtabs/customtabs/update

SDK Method CustomTabs::update

type UpdateOp

type UpdateOp esign.Op

UpdateOp implements DocuSign API SDK CustomTabs::update

func (*UpdateOp) Do

func (op *UpdateOp) Do(ctx context.Context) (*model.TabMetadata, error)

Do executes the op. A nil context will return error.