usergroups

package
v1.1.2 Latest Latest
Warning

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

 Go to latest Published: Oct 17, 2021 License: BSD-3-Clause Imports: 6 Imported by: 0

Documentation

Overview

Package usergroups implements the DocuSign SDK category UserGroups.

Use the User Groups category to manage your permissions groups.

You can:

* Create and delete groups. * Add users to, and delete users from, your groups. * Manage the brand information associated with a group.

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

import (
    "github.com/jfcote87/esign"
    "github.com/jfcote87/esign/v2.1/usergroups"
    "github.com/jfcote87/esign/v2.1/model"
)
...
usergroupsService := usergroups.New(esignCredential)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GroupBrandsDeleteOp 

type GroupBrandsDeleteOp esign.Op

GroupBrandsDeleteOp implements DocuSign API SDK UserGroups::deleteBrands

func (*GroupBrandsDeleteOp) Do 

func (op *GroupBrandsDeleteOp) Do(ctx context.Context) (*model.BrandsResponse, error)

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

type GroupBrandsGetOp 

type GroupBrandsGetOp esign.Op

GroupBrandsGetOp implements DocuSign API SDK UserGroups::getBrands

func (*GroupBrandsGetOp) Do 

func (op *GroupBrandsGetOp) Do(ctx context.Context) (*model.BrandsResponse, error)

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

type GroupBrandsUpdateOp 

type GroupBrandsUpdateOp esign.Op

GroupBrandsUpdateOp implements DocuSign API SDK UserGroups::updateBrands

func (*GroupBrandsUpdateOp) Do 

func (op *GroupBrandsUpdateOp) Do(ctx context.Context) (*model.BrandsResponse, error)

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

type GroupUsersDeleteOp 

type GroupUsersDeleteOp esign.Op

GroupUsersDeleteOp implements DocuSign API SDK UserGroups::deleteGroupUsers

func (*GroupUsersDeleteOp) Do 

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

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

type GroupUsersListOp 

type GroupUsersListOp esign.Op

GroupUsersListOp implements DocuSign API SDK UserGroups::listGroupUsers

func (*GroupUsersListOp) Count 

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

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

func (*GroupUsersListOp) Do 

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

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

func (*GroupUsersListOp) StartPosition 

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

StartPosition starting value for the list.

type GroupUsersUpdateOp 

type GroupUsersUpdateOp esign.Op

GroupUsersUpdateOp implements DocuSign API SDK UserGroups::updateGroupUsers

func (*GroupUsersUpdateOp) Do 

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

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

type GroupsCreateOp 

type GroupsCreateOp esign.Op

GroupsCreateOp implements DocuSign API SDK UserGroups::createGroups

func (*GroupsCreateOp) Do 

func (op *GroupsCreateOp) Do(ctx context.Context) (*model.GroupInformation, error)

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

type GroupsDeleteOp 

type GroupsDeleteOp esign.Op

GroupsDeleteOp implements DocuSign API SDK UserGroups::deleteGroups

func (*GroupsDeleteOp) Do 

func (op *GroupsDeleteOp) Do(ctx context.Context) (*model.GroupInformation, error)

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

type GroupsListOp 

type GroupsListOp esign.Op

GroupsListOp implements DocuSign API SDK UserGroups::listGroups

func (*GroupsListOp) Count 

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

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

func (*GroupsListOp) Do 

func (op *GroupsListOp) Do(ctx context.Context) (*model.GroupInformation, error)

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

func (*GroupsListOp) GroupType 

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

GroupType set the call query parameter group_type

func (*GroupsListOp) IncludeUsercount 

func (op *GroupsListOp) IncludeUsercount(val string) *GroupsListOp

IncludeUsercount when set to **true**, every group returned in the response includes a `userCount` property that contains the total number of users in the group. The default is **true**.

func (*GroupsListOp) SearchText 

func (op *GroupsListOp) SearchText(val string) *GroupsListOp

SearchText filters the results of a GET request based on the text that you specify.

func (*GroupsListOp) StartPosition 

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

StartPosition is the starting value for the list.

type GroupsUpdateOp 

type GroupsUpdateOp esign.Op

GroupsUpdateOp implements DocuSign API SDK UserGroups::updateGroups

func (*GroupsUpdateOp) Do 

func (op *GroupsUpdateOp) Do(ctx context.Context) (*model.GroupInformation, error)

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

type Service 

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

Service implements DocuSign UserGroups Category API operations

func New 

func New(cred esign.Credential) *Service

New initializes a usergroups service using cred to authorize ops.

func (*Service) GroupBrandsDelete 

func (s *Service) GroupBrandsDelete(groupID string, brandsRequest *model.BrandsRequest) *GroupBrandsDeleteOp

GroupBrandsDelete deletes brand information from the requested group.

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

SDK Method UserGroups::deleteBrands

func (*Service) GroupBrandsGet 

func (s *Service) GroupBrandsGet(groupID string) *GroupBrandsGetOp

GroupBrandsGet gets group brand ID Information.

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

SDK Method UserGroups::getBrands

func (*Service) GroupBrandsUpdate 

func (s *Service) GroupBrandsUpdate(groupID string, brandsRequest *model.BrandsRequest) *GroupBrandsUpdateOp

GroupBrandsUpdate adds group brand ID information to a group.

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

SDK Method UserGroups::updateBrands

func (*Service) GroupUsersDelete 

func (s *Service) GroupUsersDelete(groupID string, userInfoList *model.UserInfoList) *GroupUsersDeleteOp

GroupUsersDelete deletes one or more users from a group

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

SDK Method UserGroups::deleteGroupUsers

func (*Service) GroupUsersList 

func (s *Service) GroupUsersList(groupID string) *GroupUsersListOp

GroupUsersList gets a list of users in a group.

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

SDK Method UserGroups::listGroupUsers

func (*Service) GroupUsersUpdate 

func (s *Service) GroupUsersUpdate(groupID string, userInfoList *model.UserInfoList) *GroupUsersUpdateOp

GroupUsersUpdate adds one or more users to an existing group.

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

SDK Method UserGroups::updateGroupUsers

func (*Service) GroupsCreate 

func (s *Service) GroupsCreate(groups *model.GroupInformation) *GroupsCreateOp

GroupsCreate creates one or more groups for the account.

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

SDK Method UserGroups::createGroups

func (*Service) GroupsDelete 

func (s *Service) GroupsDelete(groups *model.GroupInformation) *GroupsDeleteOp

GroupsDelete deletes an existing user group.

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

SDK Method UserGroups::deleteGroups

func (*Service) GroupsList 

func (s *Service) GroupsList() *GroupsListOp

GroupsList gets information about groups associated with the account.

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

SDK Method UserGroups::listGroups

func (*Service) GroupsUpdate 

func (s *Service) GroupsUpdate(groups *model.GroupInformation) *GroupsUpdateOp

GroupsUpdate updates the group information for a group.

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

SDK Method UserGroups::updateGroups

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.
JackTT - Gopher 🇻🇳