bulkenvelopes

Documentation

Overview

Package bulkenvelopes implements the DocuSign SDK category BulkEnvelopes.

Use the BulkEnvelopes category to manage the sending of envelopes to multiple recipients.

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

import (
    "github.com/pwaterz/esign"
    "github.com/pwaterz/esign/v2/bulkenvelopes"
    "github.com/pwaterz/esign/v2/model"
)
...
bulkenvelopesService := bulkenvelopes.New(esignCredential)

Index

• type GetOp
  • func (op *GetOp) Count(val int) *GetOp
  • func (op *GetOp) Do(ctx context.Context) (*model.BulkEnvelopeStatus, error)
  • func (op *GetOp) Include(val ...string) *GetOp
  • func (op *GetOp) StartPosition(val int) *GetOp
• type ListOp
  • func (op *ListOp) Count(val int) *ListOp
  • func (op *ListOp) Do(ctx context.Context) (*model.BulkEnvelopesResponse, error)
  • func (op *ListOp) Include(val ...string) *ListOp
  • func (op *ListOp) StartPosition(val int) *ListOp
• type RecipientsDeleteOp
  • func (op *RecipientsDeleteOp) Do(ctx context.Context) (*model.BulkRecipientsUpdateResponse, error)
• type RecipientsListOp
  • func (op *RecipientsListOp) Do(ctx context.Context) (*model.BulkRecipientsResponse, error)
  • func (op *RecipientsListOp) IncludeTabs() *RecipientsListOp
  • func (op *RecipientsListOp) StartPosition(val int) *RecipientsListOp
• type RecipientsUpdateOp
  • func (op *RecipientsUpdateOp) Do(ctx context.Context) (*model.BulkRecipientsSummaryResponse, error)
• type Service
  • func New(cred esign.Credential) *Service
  • func (s *Service) Get(batchID string) *GetOp
  • func (s *Service) List() *ListOp
  • func (s *Service) RecipientsDelete(envelopeID string, recipientID string) *RecipientsDeleteOp
  • func (s *Service) RecipientsList(envelopeID string, recipientID string) *RecipientsListOp
  • func (s *Service) RecipientsUpdate(envelopeID string, recipientID string, ...) *RecipientsUpdateOp

Types

type GetOp

type GetOp esign.Op

GetOp implements DocuSign API SDK BulkEnvelopes::get

func (*GetOp) Count

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

Count specifies the number of entries to return.

func (*GetOp) Do

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

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

func (*GetOp) Include

func (op *GetOp) Include(val ...string) *GetOp

Include specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include="failed,queued")

Valid values: * all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided. * failed - Entries with a failed status. * processing - Entries with a processing status. * queued - Entries with a queued status. * sent - Entries with a sent status.

func (*GetOp) StartPosition

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

StartPosition specifies the location in the list of envelopes from which to start.

type ListOp

type ListOp esign.Op

ListOp implements DocuSign API SDK BulkEnvelopes::list

func (*ListOp) Count

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

Count is the number of results to return. This can be 1 to 20.

func (*ListOp) Do

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

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

func (*ListOp) Include

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

Include specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include="failed,queued")

Valid values: * all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided. * failed - Entries with a failed status. * processing - Entries with a processing status. * queued - Entries with a queued status. * sent - Entries with a sent status.

func (*ListOp) StartPosition

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

StartPosition is the position of the bulk envelope items in the response. This is used for repeated calls, when the number of bulk envelopes returned is too large for one return. The default value is 0.

type RecipientsDeleteOp

type RecipientsDeleteOp esign.Op

RecipientsDeleteOp implements DocuSign API SDK BulkEnvelopes::deleteRecipients

func (*RecipientsDeleteOp) Do

func (op *RecipientsDeleteOp) Do(ctx context.Context) (*model.BulkRecipientsUpdateResponse, error)

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

type RecipientsListOp

type RecipientsListOp esign.Op

RecipientsListOp implements DocuSign API SDK BulkEnvelopes::getRecipients

func (*RecipientsListOp) Do

func (op *RecipientsListOp) Do(ctx context.Context) (*model.BulkRecipientsResponse, error)

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

func (*RecipientsListOp) IncludeTabs

func (op *RecipientsListOp) IncludeTabs() *RecipientsListOp

IncludeTabs if **true** include the tabs in the the result.

func (*RecipientsListOp) StartPosition

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

StartPosition reserved for DocuSign.

type RecipientsUpdateOp

type RecipientsUpdateOp esign.Op

RecipientsUpdateOp implements DocuSign API SDK BulkEnvelopes::updateRecipients

func (*RecipientsUpdateOp) Do

func (op *RecipientsUpdateOp) Do(ctx context.Context) (*model.BulkRecipientsSummaryResponse, error)

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

type Service

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

Service implements DocuSign BulkEnvelopes Category API operations

func New

func New(cred esign.Credential) *Service

New initializes a bulkenvelopes service using cred to authorize ops.

func (*Service) Get

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

Get gets the status of a specified bulk send operation.

https://developers.docusign.com/esign-rest-api/v2/reference/bulkenvelopes/bulkenvelopes/get

SDK Method BulkEnvelopes::get

func (*Service) List

func (s *Service) List() *ListOp

List gets status information about bulk recipient batches.

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

SDK Method BulkEnvelopes::list

func (*Service) RecipientsDelete

func (s *Service) RecipientsDelete(envelopeID string, recipientID string) *RecipientsDeleteOp

RecipientsDelete deletes the bulk recipient file from an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/bulkenvelopes/envelopebulkrecipients/delete

SDK Method BulkEnvelopes::deleteRecipients

func (*Service) RecipientsList

func (s *Service) RecipientsList(envelopeID string, recipientID string) *RecipientsListOp

RecipientsList gets the bulk recipient file from an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/bulkenvelopes/envelopebulkrecipients/list

SDK Method BulkEnvelopes::getRecipients

func (*Service) RecipientsUpdate

func (s *Service) RecipientsUpdate(envelopeID string, recipientID string, bulkRecipientsRequest *model.BulkRecipientsRequest) *RecipientsUpdateOp

RecipientsUpdate adds or replaces envelope bulk recipients.

https://developers.docusign.com/esign-rest-api/v2/reference/bulkenvelopes/envelopebulkrecipients/update

SDK Method BulkEnvelopes::updateRecipients