signinggroups

Documentation

Overview

Package signinggroups implements the DocuSign SDK category SigningGroups.

Use the Signing Group category to manage signing groups that allow anyone in the group to sign a document. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature.

This category shows account administrators how to create a signing group and manage the users in the group.

**Note**: To create and manage signing groups, you must be an account administrator.

For more information about this topic, see [Signing Groups](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).

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

import (
    "github.com/bradwheel/esign"
    "github.com/bradwheel/esign/v2.1/signinggroups"
    "github.com/bradwheel/esign/v2.1/model"
)
...
signinggroupsService := signinggroups.New(esignCredential)

Index

• type CreateOp
  • func (op *CreateOp) Do(ctx context.Context) (*model.SigningGroupInformation, error)
• type DeleteOp
  • func (op *DeleteOp) Do(ctx context.Context) (*model.SigningGroupInformation, error)
• type GetOp
  • func (op *GetOp) Do(ctx context.Context) (*model.SigningGroup, error)
• type ListOp
  • func (op *ListOp) Do(ctx context.Context) (*model.SigningGroupInformation, error)
  • func (op *ListOp) GroupType(val string) *ListOp
  • func (op *ListOp) IncludeUsers() *ListOp
• type Service
  • func New(cred esign.Credential) *Service
  • func (s *Service) Create(signingGroupInformation *model.SigningGroupInformation) *CreateOp
  • func (s *Service) Delete(signingGroupInformation *model.SigningGroupInformation) *DeleteOp
  • func (s *Service) Get(signingGroupID string) *GetOp
  • func (s *Service) List() *ListOp
  • func (s *Service) Update(signingGroupID string, signingGroups *model.SigningGroup) *UpdateOp
  • func (s *Service) UpdateList(signingGroupInformation *model.SigningGroupInformation) *UpdateListOp
  • func (s *Service) UsersDelete(signingGroupID string, signingGroupUsers *model.SigningGroupUsers) *UsersDeleteOp
  • func (s *Service) UsersList(signingGroupID string) *UsersListOp
  • func (s *Service) UsersUpdate(signingGroupID string, signingGroupUsers *model.SigningGroupUsers) *UsersUpdateOp
• type UpdateListOp
  • func (op *UpdateListOp) Do(ctx context.Context) (*model.SigningGroupInformation, error)
• type UpdateOp
  • func (op *UpdateOp) Do(ctx context.Context) (*model.SigningGroup, error)
• type UsersDeleteOp
  • func (op *UsersDeleteOp) Do(ctx context.Context) (*model.SigningGroupUsers, error)
• type UsersListOp
  • func (op *UsersListOp) Do(ctx context.Context) (*model.SigningGroupUsers, error)
• type UsersUpdateOp
  • func (op *UsersUpdateOp) Do(ctx context.Context) (*model.SigningGroupUsers, error)

Types

type CreateOp

type CreateOp esign.Op

CreateOp implements DocuSign API SDK SigningGroups::createList

func (*CreateOp) Do

func (op *CreateOp) Do(ctx context.Context) (*model.SigningGroupInformation, error)

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

type DeleteOp

type DeleteOp esign.Op

DeleteOp implements DocuSign API SDK SigningGroups::deleteList

func (*DeleteOp) Do

func (op *DeleteOp) Do(ctx context.Context) (*model.SigningGroupInformation, error)

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

type GetOp

type GetOp esign.Op

GetOp implements DocuSign API SDK SigningGroups::get

func (*GetOp) Do

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

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

type ListOp

type ListOp esign.Op

ListOp implements DocuSign API SDK SigningGroups::list

func (*ListOp) Do

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

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

func (*ListOp) GroupType

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

GroupType set the call query parameter group_type

func (*ListOp) IncludeUsers

func (op *ListOp) IncludeUsers() *ListOp

IncludeUsers when set to **true**, the response includes the signing group members.

type Service

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

Service implements DocuSign SigningGroups Category API operations

func New

func New(cred esign.Credential) *Service

New initializes a signinggroups service using cred to authorize ops.

func (*Service) Create

func (s *Service) Create(signingGroupInformation *model.SigningGroupInformation) *CreateOp

Create creates a signing group.

https://developers.docusign.com/esign-rest-api/reference/signinggroups/signinggroups/create

SDK Method SigningGroups::createList

func (*Service) Delete

func (s *Service) Delete(signingGroupInformation *model.SigningGroupInformation) *DeleteOp

Delete deletes one or more signing groups.

https://developers.docusign.com/esign-rest-api/reference/signinggroups/signinggroups/delete

SDK Method SigningGroups::deleteList

func (*Service) Get

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

Get gets information about a signing group.

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

SDK Method SigningGroups::get

func (*Service) List

func (s *Service) List() *ListOp

List gets a list of the Signing Groups in an account.

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

SDK Method SigningGroups::list

func (*Service) Update

func (s *Service) Update(signingGroupID string, signingGroups *model.SigningGroup) *UpdateOp

Update updates a signing group.

https://developers.docusign.com/esign-rest-api/reference/signinggroups/signinggroups/update

SDK Method SigningGroups::update

func (*Service) UpdateList

func (s *Service) UpdateList(signingGroupInformation *model.SigningGroupInformation) *UpdateListOp

UpdateList updates signing group names.

https://developers.docusign.com/esign-rest-api/reference/signinggroups/signinggroups/updatelist

SDK Method SigningGroups::updateList

func (*Service) UsersDelete

func (s *Service) UsersDelete(signingGroupID string, signingGroupUsers *model.SigningGroupUsers) *UsersDeleteOp

UsersDelete deletes one or more members from a signing group.

https://developers.docusign.com/esign-rest-api/reference/signinggroups/signinggroupusers/delete

SDK Method SigningGroups::deleteUsers

func (*Service) UsersList

func (s *Service) UsersList(signingGroupID string) *UsersListOp

UsersList gets a list of members in a Signing Group.

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

SDK Method SigningGroups::listUsers

func (*Service) UsersUpdate

func (s *Service) UsersUpdate(signingGroupID string, signingGroupUsers *model.SigningGroupUsers) *UsersUpdateOp

UsersUpdate adds members to a signing group.

https://developers.docusign.com/esign-rest-api/reference/signinggroups/signinggroupusers/update

SDK Method SigningGroups::updateUsers

type UpdateListOp

type UpdateListOp esign.Op

UpdateListOp implements DocuSign API SDK SigningGroups::updateList

func (*UpdateListOp) Do

func (op *UpdateListOp) Do(ctx context.Context) (*model.SigningGroupInformation, error)

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

type UpdateOp

type UpdateOp esign.Op

UpdateOp implements DocuSign API SDK SigningGroups::update

func (*UpdateOp) Do

func (op *UpdateOp) Do(ctx context.Context) (*model.SigningGroup, error)

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

type UsersDeleteOp

type UsersDeleteOp esign.Op

UsersDeleteOp implements DocuSign API SDK SigningGroups::deleteUsers

func (*UsersDeleteOp) Do

func (op *UsersDeleteOp) Do(ctx context.Context) (*model.SigningGroupUsers, error)

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

type UsersListOp

type UsersListOp esign.Op

UsersListOp implements DocuSign API SDK SigningGroups::listUsers

func (*UsersListOp) Do

func (op *UsersListOp) Do(ctx context.Context) (*model.SigningGroupUsers, error)

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

type UsersUpdateOp

type UsersUpdateOp esign.Op

UsersUpdateOp implements DocuSign API SDK SigningGroups::updateUsers

func (*UsersUpdateOp) Do

func (op *UsersUpdateOp) Do(ctx context.Context) (*model.SigningGroupUsers, error)

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