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/v2/reference/Folders Usage example:
import ( "github.com/thaitanloi365/esign" "github.com/thaitanloi365/esign/v2/folders" "github.com/thaitanloi365/esign/v2/model" ) ... foldersService := folders.New(esignCredential)
Index ¶
- type ListItemsOp
- func (op *ListItemsOp) Do(ctx context.Context) (*model.FolderItemsResponse, error)
- func (op *ListItemsOp) FromDate(val time.Time) *ListItemsOp
- func (op *ListItemsOp) OwnerEmail(val string) *ListItemsOp
- func (op *ListItemsOp) OwnerName(val string) *ListItemsOp
- func (op *ListItemsOp) SearchText(val string) *ListItemsOp
- func (op *ListItemsOp) StartPosition(val int) *ListItemsOp
- func (op *ListItemsOp) Status(val string) *ListItemsOp
- func (op *ListItemsOp) ToDate(val time.Time) *ListItemsOp
- type ListOp
- type MoveEnvelopesOp
- type SearchOp
- func (op *SearchOp) All() *SearchOp
- func (op *SearchOp) Count(val int) *SearchOp
- func (op *SearchOp) Do(ctx context.Context) (*model.FolderItemResponse, error)
- func (op *SearchOp) FromDate(val time.Time) *SearchOp
- func (op *SearchOp) IncludeRecipients() *SearchOp
- func (op *SearchOp) Order(val string) *SearchOp
- func (op *SearchOp) OrderBy(val string) *SearchOp
- func (op *SearchOp) StartPosition(val int) *SearchOp
- func (op *SearchOp) ToDate(val time.Time) *SearchOp
- type Service
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ListItemsOp ¶
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 only return items on or after this date. If no value is provided, the default search is the previous 30 days.
func (*ListItemsOp) OwnerEmail ¶
func (op *ListItemsOp) OwnerEmail(val string) *ListItemsOp
OwnerEmail is the email of the folder owner.
func (*ListItemsOp) OwnerName ¶
func (op *ListItemsOp) OwnerName(val string) *ListItemsOp
OwnerName is the name of the folder owner.
func (*ListItemsOp) SearchText ¶
func (op *ListItemsOp) SearchText(val string) *ListItemsOp
SearchText is the search text used to search the items of the envelope. The search looks at recipient names and emails, envelope custom fields, sender name, and subject.
func (*ListItemsOp) StartPosition ¶
func (op *ListItemsOp) StartPosition(val int) *ListItemsOp
StartPosition is the position of the folder items to return. This is used for repeated calls, when the number of envelopes returned is too much for one return (calls return 100 envelopes at a time). The default value is 0.
func (*ListItemsOp) Status ¶
func (op *ListItemsOp) Status(val string) *ListItemsOp
Status is a comma-separated list of current envelope statuses to included in the response. Possible values are:
* completed * created * declined * deleted * delivered * processing * sent * signed * timedout * voided
The `any` value is equivalent to any status.
func (*ListItemsOp) ToDate ¶
func (op *ListItemsOp) ToDate(val time.Time) *ListItemsOp
ToDate only return items up to this date. If no value is provided, the default search is to the current date.
type ListOp ¶
ListOp implements DocuSign API SDK Folders::list
func (*ListOp) StartPosition ¶
StartPosition reserved for DocuSign.
func (*ListOp) Template ¶
Template specifies the items that are returned. Valid values are:
* include - The folder list will return normal folders plus template folders. * only - Only the list of template folders are returned.
func (*ListOp) UserFilter ¶
UserFilter reserved for DocuSign.
type MoveEnvelopesOp ¶
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 ¶
SearchOp implements DocuSign API SDK Folders::search
func (*SearchOp) Count ¶
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) FromDate ¶
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 ¶
IncludeRecipients when set to **true**, the recipient information is returned in the response.
func (*SearchOp) Order ¶
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 ¶
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 ¶
StartPosition specifies the the starting location in the result set of the items that are returned.
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 ¶
List gets a list of the folders for the account.
https://developers.docusign.com/esign-rest-api/v2/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/v2/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/v2/reference/folders/folders/moveenvelopes
SDK Method Folders::moveEnvelopes