users

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: 7 Imported by: 0

Documentation

Overview

Package users implements the DocuSign SDK category Users.

Use the Users category to manage the users in your accounts.

You can:

* Set custom user settings. * Manage a users profile. * Add delete users. * Add and delete the intials and signature images for a user.

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

import (
    "github.com/ICGGroup/esign"
    "github.com/ICGGroup/esign/v2.1/users"
    "github.com/ICGGroup/esign/v2.1/model"
)
...
usersService := users.New(esignCredential)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ContactsCreateOp 

type ContactsCreateOp esign.Op

ContactsCreateOp implements DocuSign API SDK Users::postContacts

func (*ContactsCreateOp) Do 

func (op *ContactsCreateOp) Do(ctx context.Context) (*model.ContactUpdateResponse, error)

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

type ContactsDeleteListOp 

type ContactsDeleteListOp esign.Op

ContactsDeleteListOp implements DocuSign API SDK Users::deleteContacts

func (*ContactsDeleteListOp) Do 

func (op *ContactsDeleteListOp) Do(ctx context.Context) (*model.ContactUpdateResponse, error)

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

type ContactsDeleteOp 

type ContactsDeleteOp esign.Op

ContactsDeleteOp implements DocuSign API SDK Users::deleteContactWithId

func (*ContactsDeleteOp) Do 

func (op *ContactsDeleteOp) Do(ctx context.Context) (*model.ContactUpdateResponse, error)

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

type ContactsGetOp 

type ContactsGetOp esign.Op

ContactsGetOp implements DocuSign API SDK Users::getContactById

func (*ContactsGetOp) CloudProvider 

func (op *ContactsGetOp) CloudProvider(val string) *ContactsGetOp

CloudProvider set the call query parameter cloud_provider

func (*ContactsGetOp) Do 

func (op *ContactsGetOp) Do(ctx context.Context) (*model.ContactGetResponse, error)

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

type ContactsUpdateOp 

type ContactsUpdateOp esign.Op

ContactsUpdateOp implements DocuSign API SDK Users::putContacts

func (*ContactsUpdateOp) Do 

func (op *ContactsUpdateOp) Do(ctx context.Context) (*model.ContactUpdateResponse, error)

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

type CreateOp 

type CreateOp esign.Op

CreateOp implements DocuSign API SDK Users::create

func (*CreateOp) Do 

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

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

type CustomSettingsDeleteOp 

type CustomSettingsDeleteOp esign.Op

CustomSettingsDeleteOp implements DocuSign API SDK Users::deleteCustomSettings

func (*CustomSettingsDeleteOp) Do 

func (op *CustomSettingsDeleteOp) Do(ctx context.Context) (*model.CustomSettingsInformation, error)

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

type CustomSettingsListOp 

type CustomSettingsListOp esign.Op

CustomSettingsListOp implements DocuSign API SDK Users::listCustomSettings

func (*CustomSettingsListOp) Do 

func (op *CustomSettingsListOp) Do(ctx context.Context) (*model.CustomSettingsInformation, error)

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

type CustomSettingsUpdateOp 

type CustomSettingsUpdateOp esign.Op

CustomSettingsUpdateOp implements DocuSign API SDK Users::updateCustomSettings

func (*CustomSettingsUpdateOp) Do 

func (op *CustomSettingsUpdateOp) Do(ctx context.Context) (*model.CustomSettingsInformation, error)

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

type DeleteOp 

type DeleteOp esign.Op

DeleteOp implements DocuSign API SDK Users::delete

func (*DeleteOp) Delete 

func (op *DeleteOp) Delete(val string) *DeleteOp

Delete iD of the user to delete.

func (*DeleteOp) Do 

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

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

type DeleteProfileImageOp 

type DeleteProfileImageOp esign.Op

DeleteProfileImageOp implements DocuSign API SDK Users::deleteProfileImage

func (*DeleteProfileImageOp) Do 

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

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

type GetOp 

type GetOp esign.Op

GetOp implements DocuSign API SDK Users::getInformation

func (*GetOp) AdditionalInfo 

func (op *GetOp) AdditionalInfo() *GetOp

AdditionalInfo setting this parameter has no effect in this operation.

func (*GetOp) Do 

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

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

func (*GetOp) Email 

func (op *GetOp) Email(val string) *GetOp

Email setting this parameter has no effect in this operation.

type GetProfileImageOp 

type GetProfileImageOp esign.Op

GetProfileImageOp implements DocuSign API SDK Users::getProfileImage

func (*GetProfileImageOp) Do 

func (op *GetProfileImageOp) Do(ctx context.Context) (*esign.Download, error)

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

func (*GetProfileImageOp) Encoding 

func (op *GetProfileImageOp) Encoding(val string) *GetProfileImageOp

Encoding set the call query parameter encoding

type GetSettingsOp 

type GetSettingsOp esign.Op

GetSettingsOp implements DocuSign API SDK Users::getSettings

func (*GetSettingsOp) Do 

func (op *GetSettingsOp) Do(ctx context.Context) (*model.UserSettingsInformation, error)

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

type ListOp 

type ListOp esign.Op

ListOp implements DocuSign API SDK Users::list

func (*ListOp) AdditionalInfo 

func (op *ListOp) AdditionalInfo() *ListOp

AdditionalInfo when set to **true**, the custom settings information is returned for each user in the account. If this parameter is omitted, the default behavior is **false**.

func (*ListOp) Count 

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

Count number of records to return. The number must be greater than 0 and less than or equal to 100.

func (*ListOp) Do 

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

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

func (*ListOp) Email 

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

Email reserved for DocuSign.

func (*ListOp) EmailSubstring 

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

EmailSubstring reserved for DocuSign.

func (*ListOp) GroupID 

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

GroupID filters returned user records by one or more group IDs.

func (*ListOp) IncludeUsersettingsForCsv 

func (op *ListOp) IncludeUsersettingsForCsv() *ListOp

IncludeUsersettingsForCsv return the `userSettings` object data in CSV format.

func (*ListOp) LoginStatus 

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

LoginStatus return the login status of each user.

func (*ListOp) NotGroupID 

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

NotGroupID return user records excluding the specified group IDs.

func (*ListOp) StartPosition 

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

StartPosition is the position within the total result set from which to start returning values.

func (*ListOp) Status 

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

Status filters the user records by account status. One of:

* ActivationRequired * ActivationSent * Active * Closed * Disabled

func (*ListOp) UserNameSubstring 

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

UserNameSubstring filters returned user records by full user name or a substring of user name.

type ProfilesGetOp 

type ProfilesGetOp esign.Op

ProfilesGetOp implements DocuSign API SDK Users::getProfile

func (*ProfilesGetOp) Do 

func (op *ProfilesGetOp) Do(ctx context.Context) (*model.UserProfile, error)

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

type ProfilesUpdateOp 

type ProfilesUpdateOp esign.Op

ProfilesUpdateOp implements DocuSign API SDK Users::updateProfile

func (*ProfilesUpdateOp) Do 

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

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

type Service 

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

Service implements DocuSign Users Category API operations

func New 

func New(cred esign.Credential) *Service

New initializes a users service using cred to authorize ops.

func (*Service) ContactsCreate 

func (s *Service) ContactsCreate(contactModRequest *model.ContactModRequest) *ContactsCreateOp

ContactsCreate imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).

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

SDK Method Users::postContacts

func (*Service) ContactsDelete 

func (s *Service) ContactsDelete(contactID string) *ContactsDeleteOp

ContactsDelete replaces a particular contact associated with an account for the DocuSign service.

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

SDK Method Users::deleteContactWithId

func (*Service) ContactsDeleteList 

func (s *Service) ContactsDeleteList(contactModRequest *model.ContactModRequest) *ContactsDeleteListOp

ContactsDeleteList delete contacts associated with an account for the DocuSign service.

https://developers.docusign.com/esign-rest-api/reference/users/contacts/deletelist

SDK Method Users::deleteContacts

func (*Service) ContactsGet 

func (s *Service) ContactsGet(contactID string) *ContactsGetOp

ContactsGet gets a particular contact associated with the user's account.

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

SDK Method Users::getContactById

func (*Service) ContactsUpdate 

func (s *Service) ContactsUpdate(contactModRequest *model.ContactModRequest) *ContactsUpdateOp

ContactsUpdate replaces contacts associated with an account for the DocuSign service.

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

SDK Method Users::putContacts

func (*Service) Create 

func (s *Service) Create(newUsersDefinition *model.NewUsersDefinition) *CreateOp

Create adds new users to the specified account.

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

SDK Method Users::create

func (*Service) CustomSettingsDelete 

func (s *Service) CustomSettingsDelete(userID string, userCustomSettings *model.CustomSettingsInformation) *CustomSettingsDeleteOp

CustomSettingsDelete deletes custom user settings for a specified user.

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

SDK Method Users::deleteCustomSettings

func (*Service) CustomSettingsList 

func (s *Service) CustomSettingsList(userID string) *CustomSettingsListOp

CustomSettingsList retrieves the custom user settings for a specified user.

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

SDK Method Users::listCustomSettings

func (*Service) CustomSettingsUpdate 

func (s *Service) CustomSettingsUpdate(userID string, userCustomSettings *model.CustomSettingsInformation) *CustomSettingsUpdateOp

CustomSettingsUpdate adds or updates custom user settings for the specified user.

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

SDK Method Users::updateCustomSettings

func (*Service) Delete 

func (s *Service) Delete(userInfoList *model.UserInfoList) *DeleteOp

Delete removes users account privileges.

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

SDK Method Users::delete

func (*Service) DeleteProfileImage 

func (s *Service) DeleteProfileImage(userID string) *DeleteProfileImageOp

DeleteProfileImage deletes the user profile image for the specified user.

https://developers.docusign.com/esign-rest-api/reference/users/users/deleteprofileimage

SDK Method Users::deleteProfileImage

func (*Service) Get 

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

Get gets the user information for a specified user.

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

SDK Method Users::getInformation

func (*Service) GetProfileImage 

func (s *Service) GetProfileImage(userID string) *GetProfileImageOp

GetProfileImage retrieves the user profile image for the specified user.

https://developers.docusign.com/esign-rest-api/reference/users/users/getprofileimage

SDK Method Users::getProfileImage

func (*Service) GetSettings 

func (s *Service) GetSettings(userID string) *GetSettingsOp

GetSettings gets the user account settings for a specified user.

https://developers.docusign.com/esign-rest-api/reference/users/users/getsettings

SDK Method Users::getSettings

func (*Service) List 

func (s *Service) List() *ListOp

List retrieves the list of users for the specified account.

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

SDK Method Users::list

func (*Service) ProfilesGet 

func (s *Service) ProfilesGet(userID string) *ProfilesGetOp

ProfilesGet retrieves the user profile for a specified user.

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

SDK Method Users::getProfile

func (*Service) ProfilesUpdate 

func (s *Service) ProfilesUpdate(userID string, userProfiles *model.UserProfile) *ProfilesUpdateOp

ProfilesUpdate updates the user profile information for the specified user.

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

SDK Method Users::updateProfile

func (*Service) SignaturesCreate 

func (s *Service) SignaturesCreate(userID string, userSignaturesInformation *model.UserSignaturesInformation, uploads ...*esign.UploadFile) *SignaturesCreateOp

SignaturesCreate adds user Signature and initials images to a Signature. If any uploads[x].Reader is an io.ReadCloser(s), Do() will always close Reader.

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

SDK Method Users::createSignatures

func (*Service) SignaturesDelete 

func (s *Service) SignaturesDelete(signatureID string, userID string) *SignaturesDeleteOp

SignaturesDelete removes removes signature information for the specified user.

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

SDK Method Users::deleteSignature

func (*Service) SignaturesDeleteImage 

func (s *Service) SignaturesDeleteImage(imageType string, signatureID string, userID string) *SignaturesDeleteImageOp

SignaturesDeleteImage deletes the user initials image or the user signature image for the specified user.

https://developers.docusign.com/esign-rest-api/reference/users/usersignatures/deleteimage

SDK Method Users::deleteSignatureImage

func (*Service) SignaturesGet 

func (s *Service) SignaturesGet(signatureID string, userID string) *SignaturesGetOp

SignaturesGet gets the user signature information for the specified user.

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

SDK Method Users::getSignature

func (*Service) SignaturesGetImage 

func (s *Service) SignaturesGetImage(imageType string, signatureID string, userID string) *SignaturesGetImageOp

SignaturesGetImage retrieves the user initials image or the user signature image for the specified user.

https://developers.docusign.com/esign-rest-api/reference/users/usersignatures/getimage

SDK Method Users::getSignatureImage

func (*Service) SignaturesList 

func (s *Service) SignaturesList(userID string) *SignaturesListOp

SignaturesList retrieves a list of user signature definitions for a specified user.

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

SDK Method Users::listSignatures

func (*Service) SignaturesUpdate 

func (s *Service) SignaturesUpdate(signatureID string, userID string, userSignatureDefinition *model.UserSignatureDefinition) *SignaturesUpdateOp

SignaturesUpdate updates the user signature for a specified user.

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

SDK Method Users::updateSignature

func (*Service) SignaturesUpdateImage 

func (s *Service) SignaturesUpdateImage(imageType string, signatureID string, userID string, media io.Reader, mimeType string) *SignaturesUpdateImageOp

SignaturesUpdateImage updates the user signature image or user initials image for the specified user. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/esign-rest-api/reference/users/usersignatures/updateimage

SDK Method Users::updateSignatureImage

func (*Service) SignaturesUpdateList 

func (s *Service) SignaturesUpdateList(userID string, userSignaturesInformation *model.UserSignaturesInformation) *SignaturesUpdateListOp

SignaturesUpdateList adds/updates a user signature.

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

SDK Method Users::updateSignatures

func (*Service) Update 

func (s *Service) Update(userID string, users *model.UserInformation) *UpdateOp

Update updates user information for the specified user.

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

SDK Method Users::updateUser

func (*Service) UpdateList 

func (s *Service) UpdateList(userInformationList *model.UserInformationList) *UpdateListOp

UpdateList change one or more user in the specified account.

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

SDK Method Users::updateUsers

func (*Service) UpdateProfileImage 

func (s *Service) UpdateProfileImage(userID string, media io.Reader, mimeType string) *UpdateProfileImageOp

UpdateProfileImage updates the user profile image for a specified user. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/esign-rest-api/reference/users/users/updateprofileimage

SDK Method Users::updateProfileImage

func (*Service) UpdateSettings 

func (s *Service) UpdateSettings(userID string, userSettingsInformation *model.UserSettingsInformation) *UpdateSettingsOp

UpdateSettings updates the user account settings for a specified user.

https://developers.docusign.com/esign-rest-api/reference/users/users/updatesettings

SDK Method Users::updateSettings

type SignaturesCreateOp 

type SignaturesCreateOp esign.Op

SignaturesCreateOp implements DocuSign API SDK Users::createSignatures

func (*SignaturesCreateOp) Do 

func (op *SignaturesCreateOp) Do(ctx context.Context) (*model.UserSignaturesInformation, error)

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

type SignaturesDeleteImageOp 

type SignaturesDeleteImageOp esign.Op

SignaturesDeleteImageOp implements DocuSign API SDK Users::deleteSignatureImage

func (*SignaturesDeleteImageOp) Do 

func (op *SignaturesDeleteImageOp) Do(ctx context.Context) (*model.UserSignature, error)

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

type SignaturesDeleteOp 

type SignaturesDeleteOp esign.Op

SignaturesDeleteOp implements DocuSign API SDK Users::deleteSignature

func (*SignaturesDeleteOp) Do 

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

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

type SignaturesGetImageOp 

type SignaturesGetImageOp esign.Op

SignaturesGetImageOp implements DocuSign API SDK Users::getSignatureImage

func (*SignaturesGetImageOp) Do 

func (op *SignaturesGetImageOp) Do(ctx context.Context) (*esign.Download, error)

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

func (*SignaturesGetImageOp) IncludeChrome 

func (op *SignaturesGetImageOp) IncludeChrome() *SignaturesGetImageOp

IncludeChrome set the call query parameter include_chrome

type SignaturesGetOp 

type SignaturesGetOp esign.Op

SignaturesGetOp implements DocuSign API SDK Users::getSignature

func (*SignaturesGetOp) Do 

func (op *SignaturesGetOp) Do(ctx context.Context) (*model.UserSignature, error)

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

type SignaturesListOp 

type SignaturesListOp esign.Op

SignaturesListOp implements DocuSign API SDK Users::listSignatures

func (*SignaturesListOp) Do 

func (op *SignaturesListOp) Do(ctx context.Context) (*model.UserSignaturesInformation, error)

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

func (*SignaturesListOp) StampType 

func (op *SignaturesListOp) StampType(val string) *SignaturesListOp

StampType set the call query parameter stamp_type

type SignaturesUpdateImageOp 

type SignaturesUpdateImageOp esign.Op

SignaturesUpdateImageOp implements DocuSign API SDK Users::updateSignatureImage

func (*SignaturesUpdateImageOp) Do 

func (op *SignaturesUpdateImageOp) Do(ctx context.Context) (*model.UserSignature, error)

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

func (*SignaturesUpdateImageOp) TransparentPng 

func (op *SignaturesUpdateImageOp) TransparentPng(val string) *SignaturesUpdateImageOp

TransparentPng set the call query parameter transparent_png

type SignaturesUpdateListOp 

type SignaturesUpdateListOp esign.Op

SignaturesUpdateListOp implements DocuSign API SDK Users::updateSignatures

func (*SignaturesUpdateListOp) Do 

func (op *SignaturesUpdateListOp) Do(ctx context.Context) (*model.UserSignaturesInformation, error)

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

type SignaturesUpdateOp 

type SignaturesUpdateOp esign.Op

SignaturesUpdateOp implements DocuSign API SDK Users::updateSignature

func (*SignaturesUpdateOp) CloseExistingSignature 

func (op *SignaturesUpdateOp) CloseExistingSignature() *SignaturesUpdateOp

CloseExistingSignature when set to **true**, closes the current signature.

func (*SignaturesUpdateOp) Do 

func (op *SignaturesUpdateOp) Do(ctx context.Context) (*model.UserSignature, error)

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

type UpdateListOp 

type UpdateListOp esign.Op

UpdateListOp implements DocuSign API SDK Users::updateUsers

func (*UpdateListOp) Do 

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

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

type UpdateOp 

type UpdateOp esign.Op

UpdateOp implements DocuSign API SDK Users::updateUser

func (*UpdateOp) Do 

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

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

type UpdateProfileImageOp 

type UpdateProfileImageOp esign.Op

UpdateProfileImageOp implements DocuSign API SDK Users::updateProfileImage

func (*UpdateProfileImageOp) Do 

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

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

type UpdateSettingsOp 

type UpdateSettingsOp esign.Op

UpdateSettingsOp implements DocuSign API SDK Users::updateSettings

func (*UpdateSettingsOp) Do 

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

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

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.