tasklists

Documentation

Overview

Package tasklists implements the DocuSign SDK category TaskLists.

Your administrator may also have created custom task list templates that can be added to rooms. If your administrator created room templates, those room templates may include task lists for you to use.

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

import (
    "github.com/jfcote87/esign"
    "github.com/jfcote87/esign/rooms"
)
...
tasklistsService := tasklists.New(esignCredential)

Index

• type CreateTaskListOp
  • func (op *CreateTaskListOp) Do(ctx context.Context) (*rooms.TaskList, error)
• type DeleteTaskListOp
  • func (op *DeleteTaskListOp) Do(ctx context.Context) error
• type GetTaskListTemplatesOp
  • func (op *GetTaskListTemplatesOp) Count(val int) *GetTaskListTemplatesOp
  • func (op *GetTaskListTemplatesOp) Do(ctx context.Context) (*rooms.TaskListTemplateList, error)
  • func (op *GetTaskListTemplatesOp) StartPosition(val int) *GetTaskListTemplatesOp
• type GetTaskListsOp
  • func (op *GetTaskListsOp) Do(ctx context.Context) (*rooms.TaskListSummaryList, error)
• type Service
  • func New(cred esign.Credential) *Service
  • func (s *Service) CreateTaskList(roomID string, body *rooms.TaskListForCreate) *CreateTaskListOp
  • func (s *Service) DeleteTaskList(taskListID string) *DeleteTaskListOp
  • func (s *Service) GetTaskListTemplates() *GetTaskListTemplatesOp
  • func (s *Service) GetTaskLists(roomID string) *GetTaskListsOp

Types

type CreateTaskListOp

type CreateTaskListOp esign.Op

CreateTaskListOp implements DocuSign API SDK TaskLists::CreateTaskList

func (*CreateTaskListOp) Do

func (op *CreateTaskListOp) Do(ctx context.Context) (*rooms.TaskList, error)

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

type DeleteTaskListOp

type DeleteTaskListOp esign.Op

DeleteTaskListOp implements DocuSign API SDK TaskLists::DeleteTaskList

func (*DeleteTaskListOp) Do

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

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

type GetTaskListTemplatesOp

type GetTaskListTemplatesOp esign.Op

GetTaskListTemplatesOp implements DocuSign API SDK TaskLists::GetTaskListTemplates

func (*GetTaskListTemplatesOp) Count

func (op *GetTaskListTemplatesOp) Count(val int) *GetTaskListTemplatesOp

Count (Optional) The number of results to return. This value must be a number between `1` and `100` (default).

func (*GetTaskListTemplatesOp) Do

func (op *GetTaskListTemplatesOp) Do(ctx context.Context) (*rooms.TaskListTemplateList, error)

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

func (*GetTaskListTemplatesOp) StartPosition

func (op *GetTaskListTemplatesOp) StartPosition(val int) *GetTaskListTemplatesOp

StartPosition (Optional) The starting zero-based index position from which to start returning values. The default is `0`.

type GetTaskListsOp

type GetTaskListsOp esign.Op

GetTaskListsOp implements DocuSign API SDK TaskLists::GetTaskLists

func (*GetTaskListsOp) Do

func (op *GetTaskListsOp) Do(ctx context.Context) (*rooms.TaskListSummaryList, error)

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

type Service

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

Service implements DocuSign TaskLists API operations

func New

func New(cred esign.Credential) *Service

New initializes a tasklists service using cred to authorize ops.

func (*Service) CreateTaskList

func (s *Service) CreateTaskList(roomID string, body *rooms.TaskListForCreate) *CreateTaskListOp

CreateTaskList applies a task list to a room.

https://developers.docusign.com/docs/rooms-api/reference/tasklists/tasklists/createtasklist

SDK Method TaskLists::CreateTaskList

func (*Service) DeleteTaskList

func (s *Service) DeleteTaskList(taskListID string) *DeleteTaskListOp

DeleteTaskList deletes a task list from a room.

https://developers.docusign.com/docs/rooms-api/reference/tasklists/tasklists/deletetasklist

SDK Method TaskLists::DeleteTaskList

func (*Service) GetTaskListTemplates

func (s *Service) GetTaskListTemplates() *GetTaskListTemplatesOp

GetTaskListTemplates gets task list templates.

https://developers.docusign.com/docs/rooms-api/reference/tasklists/tasklisttemplates/gettasklisttemplates

SDK Method TaskLists::GetTaskListTemplates

func (*Service) GetTaskLists

func (s *Service) GetTaskLists(roomID string) *GetTaskListsOp

GetTaskLists gets task lists for a room.

https://developers.docusign.com/docs/rooms-api/reference/tasklists/tasklists/gettasklists

SDK Method TaskLists::GetTaskLists