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/reference/BulkEnvelopes Usage example:
import (
"github.com/jfcote87/esign"
"github.com/jfcote87/esign/v2.1/bulkenvelopes"
"github.com/jfcote87/esign/v2.1/model"
)
...
bulkenvelopesService := bulkenvelopes.New(esignCredential)
Index ¶
- type GetOp
- type ListOp
- type RecipientsDeleteOp
- type RecipientsListOp
- type RecipientsUpdateOp
- type 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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetOp ¶
GetOp implements DocuSign API SDK BulkEnvelopes::get
func (*GetOp) Include ¶
Include specifies which entries to include in the response. You can include multiple entries by using commas in the query string. For example: `?include="failed,queued"`.
Valid query values: * `all` - Returns all entries. This overrides all other query settings, and is the default if no query string is provided. * `failed` - Return entries with a failed status. * `processing` - Return entries with a processing status. * `queued` - Return entries with a queued status. * `sent` - Return entries with a sent status.
func (*GetOp) StartPosition ¶
StartPosition specifies the position in the list of envelopes from which to start returning bulk recipient batch status information.
type ListOp ¶
ListOp implements DocuSign API SDK BulkEnvelopes::list
func (*ListOp) Include ¶
Include specifies which entries to include in the response. You can include multiple entries by using commas in the query string. For example: `?include="failed,queued"`.
Valid query values: * `all` - Returns all entries. This overrides all other query settings, and is the default if no query string is provided. * `failed` - Return entries with a failed status. * `processing` - Return entries with a processing status. * `queued` - Return entries with a queued status. * `sent` - Return entries with a sent status.
func (*ListOp) StartPosition ¶
StartPosition specifies the position of the bulk envelope items from which to start returning results. You can use this parameter for repeated calls, when the number of bulk envelopes returned is too large to be included in a single response. The default value is 0.
type RecipientsDeleteOp ¶
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 ¶
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 when set to **true**, the response includes the tabs associated with the recipients.
func (*RecipientsListOp) StartPosition ¶
func (op *RecipientsListOp) StartPosition(val int) *RecipientsListOp
StartPosition is the starting position in the results set.
type RecipientsUpdateOp ¶
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 ¶
Get gets the status of a specified bulk send operation.
https://developers.docusign.com/esign-rest-api/reference/bulkenvelopes/bulkenvelopes/get
SDK Method BulkEnvelopes::get
func (*Service) List ¶
List gets status information about bulk recipient batches.
https://developers.docusign.com/esign-rest-api/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/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/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/reference/bulkenvelopes/envelopebulkrecipients/update
SDK Method BulkEnvelopes::updateRecipients
Source Files