connect

package
v0.10.0 Latest Latest
Warning

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

 Go to latest Published: Jun 13, 2021 License: BSD-3-Clause Imports: 8 Imported by: 0

Documentation

Overview

Package connect implements the DocuSign SDK category Connect.

The Connect category enables your application to be called via HTTPS when an event of interest occurs.

Use the Connect service to "end the polling madness." With Connect, there is no need for your application to poll DocuSign every 15 minutes to learn the latest about your envelopes.

Instead, you register your interest in one or more types of envelope or recipient events. Then, when an interesting event occurs, the DocuSign platform will contact your application with the event's details and data. You can register interest in envelopes sent by particular users in your account, or for envelopes sent by any user.

## Incoming Connect Calls To use the Connect service, your application needs to provide an https url that can be called from the public internet. If your application runs on a server behind your organization's firewall, then you will need to create a "pinhole" in the firewall to allow the incoming Connect calls from DocuSign to reach your application. Other techniques for receiving the incoming calls including proxy servers and DMZ networking can also be used.

## Per-envelope Connect Configuration Instead of registering a general Connect configuration and listener, an individual envelope can have its own Connect configuration. See the `eventNotification` field for envelopes.

## Categories Use the Connect category for:

* Programmatically creating Connect configurations. Connect configurations can be created manually by using the DocuSign web service, or programmatically via the API. Configurations created via the API can be seen and updated from the web service. * Retrieving and managing the event log for your Connect configurations. * Requesting that an event be re-published to the listener.

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

import (
    "github.com/ICGGroup/esign"
    "github.com/ICGGroup/esign/v2/connect"
    "github.com/ICGGroup/esign/v2/model"
)
...
connectService := connect.New(esignCredential)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ConfigurationsCreateOp 

type ConfigurationsCreateOp esign.Op

ConfigurationsCreateOp implements DocuSign API SDK Connect::createConfiguration

func (*ConfigurationsCreateOp) Do 

func (op *ConfigurationsCreateOp) Do(ctx context.Context) (*model.ConnectCustomConfiguration, error)

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

type ConfigurationsDeleteOp 

type ConfigurationsDeleteOp esign.Op

ConfigurationsDeleteOp implements DocuSign API SDK Connect::deleteConfiguration

func (*ConfigurationsDeleteOp) Do 

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

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

type ConfigurationsGetOp 

type ConfigurationsGetOp esign.Op

ConfigurationsGetOp implements DocuSign API SDK Connect::getConfiguration

func (*ConfigurationsGetOp) Do 

func (op *ConfigurationsGetOp) Do(ctx context.Context) (*model.ConnectConfigResults, error)

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

type ConfigurationsListOp 

type ConfigurationsListOp esign.Op

ConfigurationsListOp implements DocuSign API SDK Connect::listConfigurations

func (*ConfigurationsListOp) Do 

func (op *ConfigurationsListOp) Do(ctx context.Context) (*model.ConnectConfigResults, error)

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

type ConfigurationsListUsersOp 

type ConfigurationsListUsersOp esign.Op

ConfigurationsListUsersOp implements DocuSign API SDK Connect::connectUsers

func (*ConfigurationsListUsersOp) Count 

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

Count optional. Number of items to return.

func (*ConfigurationsListUsersOp) Do 

func (op *ConfigurationsListUsersOp) Do(ctx context.Context) (*model.IntegratedUserInfoList, error)

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

func (*ConfigurationsListUsersOp) EmailSubstring 

func (op *ConfigurationsListUsersOp) EmailSubstring(val string) *ConfigurationsListUsersOp

EmailSubstring filters the returned user records by the email address or a sub-string of email address.

func (*ConfigurationsListUsersOp) ListIncludedUsers 

func (op *ConfigurationsListUsersOp) ListIncludedUsers() *ConfigurationsListUsersOp

ListIncludedUsers set the call query parameter list_included_users

func (*ConfigurationsListUsersOp) StartPosition 

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

StartPosition is the position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.

func (*ConfigurationsListUsersOp) Status 

func (op *ConfigurationsListUsersOp) Status(val ...string) *ConfigurationsListUsersOp

Status filters the results by user status. You can specify a comma-separated list of the following statuses:

* ActivationRequired * ActivationSent * Active * Closed * Disabled

func (*ConfigurationsListUsersOp) UserNameSubstring 

func (op *ConfigurationsListUsersOp) UserNameSubstring(val string) *ConfigurationsListUsersOp

UserNameSubstring filters the user records returned by the user name or a sub-string of user name.

type ConfigurationsUpdateOp 

type ConfigurationsUpdateOp esign.Op

ConfigurationsUpdateOp implements DocuSign API SDK Connect::updateConfiguration

func (*ConfigurationsUpdateOp) Do 

func (op *ConfigurationsUpdateOp) Do(ctx context.Context) (*model.ConnectCustomConfiguration, error)

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

type EventsDeleteFailureOp 

type EventsDeleteFailureOp esign.Op

EventsDeleteFailureOp implements DocuSign API SDK Connect::deleteEventFailureLog

func (*EventsDeleteFailureOp) Do 

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

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

type EventsDeleteListOp 

type EventsDeleteListOp esign.Op

EventsDeleteListOp implements DocuSign API SDK Connect::deleteEventLogs

func (*EventsDeleteListOp) Do 

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

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

type EventsDeleteOp 

type EventsDeleteOp esign.Op

EventsDeleteOp implements DocuSign API SDK Connect::deleteEventLog

func (*EventsDeleteOp) Do 

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

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

type EventsGetOp 

type EventsGetOp esign.Op

EventsGetOp implements DocuSign API SDK Connect::getEventLog

func (*EventsGetOp) AdditionalInfo 

func (op *EventsGetOp) AdditionalInfo() *EventsGetOp

AdditionalInfo when true, the connectDebugLog information is included in the response.

func (*EventsGetOp) Do 

func (op *EventsGetOp) Do(ctx context.Context) (*model.ConnectLog, error)

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

type EventsListFailuresOp 

type EventsListFailuresOp esign.Op

EventsListFailuresOp implements DocuSign API SDK Connect::listEventFailureLogs

func (*EventsListFailuresOp) Do 

func (op *EventsListFailuresOp) Do(ctx context.Context) (*model.ConnectLogs, error)

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

func (*EventsListFailuresOp) FromDate 

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

FromDate start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.

func (*EventsListFailuresOp) ToDate 

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

ToDate end of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.

type EventsListOp 

type EventsListOp esign.Op

EventsListOp implements DocuSign API SDK Connect::listEventLogs

func (*EventsListOp) Do 

func (op *EventsListOp) Do(ctx context.Context) (*model.ConnectLogs, error)

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

func (*EventsListOp) FromDate 

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

FromDate start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.

func (*EventsListOp) ToDate 

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

ToDate end of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.

type EventsRetryForEnvelopeOp 

type EventsRetryForEnvelopeOp esign.Op

EventsRetryForEnvelopeOp implements DocuSign API SDK Connect::retryEventForEnvelope

func (*EventsRetryForEnvelopeOp) Do 

func (op *EventsRetryForEnvelopeOp) Do(ctx context.Context) (*model.ConnectFailureResults, error)

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

type EventsRetryForEnvelopesOp 

type EventsRetryForEnvelopesOp esign.Op

EventsRetryForEnvelopesOp implements DocuSign API SDK Connect::retryEventForEnvelopes

func (*EventsRetryForEnvelopesOp) Do 

func (op *EventsRetryForEnvelopesOp) Do(ctx context.Context) (*model.ConnectFailureResults, error)

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

type Service 

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

Service implements DocuSign Connect Category API operations

func New 

func New(cred esign.Credential) *Service

New initializes a connect service using cred to authorize ops.

func (*Service) ConfigurationsCreate 

func (s *Service) ConfigurationsCreate(connectConfigurations *model.ConnectCustomConfiguration) *ConfigurationsCreateOp

ConfigurationsCreate creates a connect configuration for the specified account.

https://developers.docusign.com/esign-rest-api/v2/reference/connect/connectconfigurations/create

SDK Method Connect::createConfiguration

func (*Service) ConfigurationsDelete 

func (s *Service) ConfigurationsDelete(connectID string) *ConfigurationsDeleteOp

ConfigurationsDelete deletes the specified connect configuration.

https://developers.docusign.com/esign-rest-api/v2/reference/connect/connectconfigurations/delete

SDK Method Connect::deleteConfiguration

func (*Service) ConfigurationsGet 

func (s *Service) ConfigurationsGet(connectID string) *ConfigurationsGetOp

ConfigurationsGet get information on a Connect Configuration

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

SDK Method Connect::getConfiguration

func (*Service) ConfigurationsList 

func (s *Service) ConfigurationsList() *ConfigurationsListOp

ConfigurationsList get Connect Configuration Information

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

SDK Method Connect::listConfigurations

func (*Service) ConfigurationsListUsers 

func (s *Service) ConfigurationsListUsers(connectID string) *ConfigurationsListUsersOp

ConfigurationsListUsers returns users from the configured Connect service.

https://developers.docusign.com/esign-rest-api/v2/reference/connect/connectconfigurations/listusers

SDK Method Connect::connectUsers

func (*Service) ConfigurationsUpdate 

func (s *Service) ConfigurationsUpdate(connectConfigurations *model.ConnectCustomConfiguration) *ConfigurationsUpdateOp

ConfigurationsUpdate updates a specified Connect configuration.

https://developers.docusign.com/esign-rest-api/v2/reference/connect/connectconfigurations/update

SDK Method Connect::updateConfiguration

func (*Service) EventsDelete 

func (s *Service) EventsDelete(logID string) *EventsDeleteOp

EventsDelete deletes a specified Connect log entry.

https://developers.docusign.com/esign-rest-api/v2/reference/connect/connectevents/delete

SDK Method Connect::deleteEventLog

func (*Service) EventsDeleteFailure 

func (s *Service) EventsDeleteFailure(failureID string) *EventsDeleteFailureOp

EventsDeleteFailure deletes a Connect failure log entry.

https://developers.docusign.com/esign-rest-api/v2/reference/connect/connectevents/deletefailure

SDK Method Connect::deleteEventFailureLog

func (*Service) EventsDeleteList 

func (s *Service) EventsDeleteList() *EventsDeleteListOp

EventsDeleteList gets a list of Connect log entries.

https://developers.docusign.com/esign-rest-api/v2/reference/connect/connectevents/deletelist

SDK Method Connect::deleteEventLogs

func (*Service) EventsGet 

func (s *Service) EventsGet(logID string) *EventsGetOp

EventsGet get the specified Connect log entry.

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

SDK Method Connect::getEventLog

func (*Service) EventsList 

func (s *Service) EventsList() *EventsListOp

EventsList gets the Connect log.

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

SDK Method Connect::listEventLogs

func (*Service) EventsListFailures 

func (s *Service) EventsListFailures() *EventsListFailuresOp

EventsListFailures gets the Connect failure log information.

https://developers.docusign.com/esign-rest-api/v2/reference/connect/connectevents/listfailures

SDK Method Connect::listEventFailureLogs

func (*Service) EventsRetryForEnvelope 

func (s *Service) EventsRetryForEnvelope(envelopeID string, media io.Reader, mimeType string) *EventsRetryForEnvelopeOp

EventsRetryForEnvelope republishes Connect information for the specified envelope. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/esign-rest-api/v2/reference/connect/connectevents/retryforenvelope

SDK Method Connect::retryEventForEnvelope

func (*Service) EventsRetryForEnvelopes 

func (s *Service) EventsRetryForEnvelopes(connectFailureFilter *model.ConnectFailureFilter) *EventsRetryForEnvelopesOp

EventsRetryForEnvelopes republishes Connect information for multiple envelopes.

https://developers.docusign.com/esign-rest-api/v2/reference/connect/connectevents/retryforenvelopes

SDK Method Connect::retryEventForEnvelopes

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.