folders

package
v0.9.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 5, 2021 License: BSD-3-Clause Imports: 7 Imported by: 0

Documentation

Overview

Package folders implements the DocuSign SDK category Folders.

Use the Folders category to manage envelopes in your folders.

You can list the folder contents and move envelopes between folders.

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

import (
    "github.com/thaitanloi365/esign"
    "github.com/thaitanloi365/esign/v2.1/folders"
    "github.com/thaitanloi365/esign/v2.1/model"
)
...
foldersService := folders.New(esignCredential)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ListItemsOp 

type ListItemsOp esign.Op

ListItemsOp implements DocuSign API SDK Folders::listItems

func (*ListItemsOp) Do 

func (op *ListItemsOp) Do(ctx context.Context) (*model.FolderItemsResponse, error)

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

func (*ListItemsOp) FromDate 

func (op *ListItemsOp) FromDate(val time.Time) *ListItemsOp

FromDate reserved for DocuSign.

func (*ListItemsOp) IncludeItems 

func (op *ListItemsOp) IncludeItems(val string) *ListItemsOp

IncludeItems indicates whether folder items are included in the response. If this parameter is omitted, the default is false.

func (*ListItemsOp) OwnerEmail 

func (op *ListItemsOp) OwnerEmail(val string) *ListItemsOp

OwnerEmail reserved for DocuSign.

func (*ListItemsOp) OwnerName 

func (op *ListItemsOp) OwnerName(val string) *ListItemsOp

OwnerName reserved for DocuSign.

func (*ListItemsOp) SearchText 

func (op *ListItemsOp) SearchText(val string) *ListItemsOp

SearchText reserved for DocuSign.

func (*ListItemsOp) StartPosition 

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

StartPosition reserved for DocuSign.

func (*ListItemsOp) Status 

func (op *ListItemsOp) Status(val string) *ListItemsOp

Status reserved for DocuSign.

func (*ListItemsOp) ToDate 

func (op *ListItemsOp) ToDate(val time.Time) *ListItemsOp

ToDate reserved for DocuSign.

type ListOp 

type ListOp esign.Op

ListOp implements DocuSign API SDK Folders::list

func (*ListOp) Do 

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

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

func (*ListOp) Include 

func (op *ListOp) Include(val string) *ListOp

Include is a comma-separated list of folder types to include in the response. Valid values are:

- `envelope_folders`: Returns a list of envelope folders. (Default) - `template_folders`: Returns a list of template folders. - `shared_template_folders`: Returns a list of shared template folders.

func (*ListOp) IncludeItems 

func (op *ListOp) IncludeItems(val string) *ListOp

IncludeItems indicates whether folder items are included in the response. If this parameter is omitted, the default is false.

func (*ListOp) StartPosition 

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

StartPosition is the position within the total result set from which to start returning values.

func (*ListOp) Template 

func (op *ListOp) Template(val string) *ListOp

Template this parameter is deprecated as of version 2.1. Use `include` instead.

func (*ListOp) UserFilter 

func (op *ListOp) UserFilter(val string) *ListOp

UserFilter narrows down the resulting folder list by the following values:

- `all`: Returns all templates owned or shared with the user. (default) - `owned_by_me`: Returns only templates the user owns. - `shared_with_me`: Returns only templates that are shared with the user.

type MoveEnvelopesOp 

type MoveEnvelopesOp esign.Op

MoveEnvelopesOp implements DocuSign API SDK Folders::moveEnvelopes

func (*MoveEnvelopesOp) Do 

func (op *MoveEnvelopesOp) Do(ctx context.Context) (*model.FoldersResponse, error)

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

type SearchOp 

type SearchOp esign.Op

SearchOp implements DocuSign API SDK Folders::search

func (*SearchOp) All 

func (op *SearchOp) All() *SearchOp

All specifies that all envelopes that match the criteria are returned.

func (*SearchOp) Count 

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

Count specifies the number of records returned in the cache. The number must be greater than 0 and less than or equal to 100.

func (*SearchOp) Do 

func (op *SearchOp) Do(ctx context.Context) (*model.FolderItemResponse, error)

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

func (*SearchOp) FromDate 

func (op *SearchOp) FromDate(val time.Time) *SearchOp

FromDate specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.

func (*SearchOp) IncludeRecipients 

func (op *SearchOp) IncludeRecipients() *SearchOp

IncludeRecipients when set to **true**, the recipient information is returned in the response.

func (*SearchOp) Order 

func (op *SearchOp) Order(val string) *SearchOp

Order specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order.

func (*SearchOp) OrderBy 

func (op *SearchOp) OrderBy(val string) *SearchOp

OrderBy specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`, `status`, or `subject`.

func (*SearchOp) StartPosition 

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

StartPosition specifies the the starting location in the result set of the items that are returned.

func (*SearchOp) ToDate 

func (op *SearchOp) ToDate(val time.Time) *SearchOp

ToDate specifies the end of the date range to return.

type Service 

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

Service implements DocuSign Folders Category API operations

func New 

func New(cred esign.Credential) *Service

New initializes a folders service using cred to authorize ops.

func (*Service) List 

func (s *Service) List() *ListOp

List gets a list of the folders for the account.

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

SDK Method Folders::list

func (*Service) ListItems 

func (s *Service) ListItems(folderID string) *ListItemsOp

ListItems gets a list of the envelopes in the specified folder.

https://developers.docusign.com/esign-rest-api/reference/folders/folders/listitems

SDK Method Folders::listItems

func (*Service) MoveEnvelopes 

func (s *Service) MoveEnvelopes(folderID string, foldersRequest *model.FoldersRequest) *MoveEnvelopesOp

MoveEnvelopes moves an envelope from its current folder to the specified folder.

https://developers.docusign.com/esign-rest-api/reference/folders/folders/moveenvelopes

SDK Method Folders::moveEnvelopes

func (*Service) Search 

func (s *Service) Search(searchFolderID string) *SearchOp

Search gets a list of envelopes in folders matching the specified criteria.

https://developers.docusign.com/esign-rest-api/reference/folders/folders/search

SDK Method Folders::search

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.