forms

package
v0.10.0 Latest Latest
Warning

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

 Go to latest Published: May 12, 2023 License: BSD-3-Clause Imports: 7 Imported by: 0

Documentation

Overview

Package forms implements the DocuSign SDK category Forms.

## Form groups

With the appropriate permissions, form administrators at your company can create form groups, or curated set of forms gathered from the association **form libraries** to which DocuSign provides access. Form groups enable agents to know which forms to add to rooms based on the type of transaction they are working on. When creating groups, administrators can make certain forms required, ensuring compliance. If you don't create groups, agents will have to choose forms they need from a list of association forms.

## Permissions

To manage forms, you must have the `canManageFormGroups` permission, which enables you to access the **Forms** tab in **Admin**. For all other roles, assign permissions based on how these users will be working with forms. If no form permissions are enabled for these roles, users cannot add forms to rooms.

Form administrators must have the `canManageFormGroups` permission assigned to their user role. This gives them access to the **Forms** tab in **Admin**. However, you should also consider the user's access level. For example, if the user has access to specific offices, they can only administer form groups for those offices.

Service Api documentation may be found at: https://developers.docusign.com/docs/rooms-api/reference/Forms Usage example: 

import (
    "github.com/jfcote87/esign"
    "github.com/jfcote87/esign/rooms"
)
...
formsService := forms.New(esignCredential)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AssignFormGroupFormOp 

type AssignFormGroupFormOp esign.Op

AssignFormGroupFormOp implements DocuSign API SDK Forms::AssignFormGroupForm

func (*AssignFormGroupFormOp) Do 

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

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

type CreateExternalFormFillSessionOp 

type CreateExternalFormFillSessionOp esign.Op

CreateExternalFormFillSessionOp implements DocuSign API SDK Forms::CreateExternalFormFillSession

func (*CreateExternalFormFillSessionOp) Do 

func (op *CreateExternalFormFillSessionOp) Do(ctx context.Context) (*rooms.ExternalFormFillSession, error)

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

type CreateFormGroupOp 

type CreateFormGroupOp esign.Op

CreateFormGroupOp implements DocuSign API SDK Forms::CreateFormGroup

func (*CreateFormGroupOp) Do 

func (op *CreateFormGroupOp) Do(ctx context.Context) (*rooms.FormGroup, error)

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

type DeleteFormGroupOp 

type DeleteFormGroupOp esign.Op

DeleteFormGroupOp implements DocuSign API SDK Forms::DeleteFormGroup

func (*DeleteFormGroupOp) Do 

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

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

type GetFormDetailsOp 

type GetFormDetailsOp esign.Op

GetFormDetailsOp implements DocuSign API SDK Forms::GetFormDetails

func (*GetFormDetailsOp) Do 

func (op *GetFormDetailsOp) Do(ctx context.Context) (*rooms.FormDetails, error)

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

type GetFormGroupOp 

type GetFormGroupOp esign.Op

GetFormGroupOp implements DocuSign API SDK Forms::GetFormGroup

func (*GetFormGroupOp) Do 

func (op *GetFormGroupOp) Do(ctx context.Context) (*rooms.FormGroup, error)

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

type GetFormGroupsOp 

type GetFormGroupsOp esign.Op

GetFormGroupsOp implements DocuSign API SDK Forms::GetFormGroups

func (*GetFormGroupsOp) Count 

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

Count (Optional) The number of results to return. This value must be a number between `1` and `100` (default).

func (*GetFormGroupsOp) Do 

func (op *GetFormGroupsOp) Do(ctx context.Context) (*rooms.FormGroupSummaryList, error)

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

func (*GetFormGroupsOp) StartPosition 

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

StartPosition (Optional) The starting zero-based index position of the results set. The default value is `0`.

type GetFormLibrariesOp 

type GetFormLibrariesOp esign.Op

GetFormLibrariesOp implements DocuSign API SDK Forms::GetFormLibraries

func (*GetFormLibrariesOp) Count 

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

Count (Optional) The number of results to return. This value must be a number between `1` and `100` (default).

func (*GetFormLibrariesOp) Do 

func (op *GetFormLibrariesOp) Do(ctx context.Context) (*rooms.FormLibrarySummaryList, error)

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

func (*GetFormLibrariesOp) StartPosition 

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

StartPosition (Optional) The starting zero-based index position of the results set. The default value is `0`.

type GetFormLibraryFormsOp 

type GetFormLibraryFormsOp esign.Op

GetFormLibraryFormsOp implements DocuSign API SDK Forms::GetFormLibraryForms

func (*GetFormLibraryFormsOp) Count 

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

Count (Optional) The number of results to return. This value must be a number between `1` and `100` (default).

func (*GetFormLibraryFormsOp) Do 

func (op *GetFormLibraryFormsOp) Do(ctx context.Context) (*rooms.FormSummaryList, error)

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

func (*GetFormLibraryFormsOp) StartPosition 

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

StartPosition (Optional) The starting zero-based index position of the results set. The default value is `0`.

type GrantOfficeAccessToFormGroupOp 

type GrantOfficeAccessToFormGroupOp esign.Op

GrantOfficeAccessToFormGroupOp implements DocuSign API SDK Forms::GrantOfficeAccessToFormGroup

func (*GrantOfficeAccessToFormGroupOp) Do 

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

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

type RemoveFormGroupFormOp 

type RemoveFormGroupFormOp esign.Op

RemoveFormGroupFormOp implements DocuSign API SDK Forms::RemoveFormGroupForm

func (*RemoveFormGroupFormOp) Do 

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

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

type RenameFormGroupOp 

type RenameFormGroupOp esign.Op

RenameFormGroupOp implements DocuSign API SDK Forms::RenameFormGroup

func (*RenameFormGroupOp) Do 

func (op *RenameFormGroupOp) Do(ctx context.Context) (*rooms.FormGroup, error)

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

type RevokeOfficeAccessFromFormGroupOp 

type RevokeOfficeAccessFromFormGroupOp esign.Op

RevokeOfficeAccessFromFormGroupOp implements DocuSign API SDK Forms::RevokeOfficeAccessFromFormGroup

func (*RevokeOfficeAccessFromFormGroupOp) Do 

func (op *RevokeOfficeAccessFromFormGroupOp) 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 Forms API operations

func New 

func New(cred esign.Credential) *Service

New initializes a forms service using cred to authorize ops.

func (*Service) AssignFormGroupForm 

func (s *Service) AssignFormGroupForm(formGroupID string, body *rooms.FormGroupFormToAssign) *AssignFormGroupFormOp

AssignFormGroupForm assigns a form to a form group.

https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/assignformgroupform

SDK Method Forms::AssignFormGroupForm

func (*Service) CreateExternalFormFillSession 

func (s *Service) CreateExternalFormFillSession(body *rooms.ExternalFormFillSessionForCreate) *CreateExternalFormFillSessionOp

CreateExternalFormFillSession creates an external form fill session.

https://developers.docusign.com/docs/rooms-api/reference/forms/externalformfillsessions/createexternalformfillsession

SDK Method Forms::CreateExternalFormFillSession

func (*Service) CreateFormGroup 

func (s *Service) CreateFormGroup(body *rooms.FormGroupForCreate) *CreateFormGroupOp

CreateFormGroup creates a form group.

https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/createformgroup

SDK Method Forms::CreateFormGroup

func (*Service) DeleteFormGroup 

func (s *Service) DeleteFormGroup(formGroupID string) *DeleteFormGroupOp

DeleteFormGroup deletes a form group.

https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/deleteformgroup

SDK Method Forms::DeleteFormGroup

func (*Service) GetFormDetails 

func (s *Service) GetFormDetails(formID string) *GetFormDetailsOp

GetFormDetails gets form details.

https://developers.docusign.com/docs/rooms-api/reference/forms/formdetails/getformdetails

SDK Method Forms::GetFormDetails

func (*Service) GetFormGroup 

func (s *Service) GetFormGroup(formGroupID string) *GetFormGroupOp

GetFormGroup gets a form group.

https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/getformgroup

SDK Method Forms::GetFormGroup

func (*Service) GetFormGroups 

func (s *Service) GetFormGroups() *GetFormGroupsOp

GetFormGroups gets form groups.

https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/getformgroups

SDK Method Forms::GetFormGroups

func (*Service) GetFormLibraries 

func (s *Service) GetFormLibraries() *GetFormLibrariesOp

GetFormLibraries gets form libraries.

https://developers.docusign.com/docs/rooms-api/reference/forms/formlibraries/getformlibraries

SDK Method Forms::GetFormLibraries

func (*Service) GetFormLibraryForms 

func (s *Service) GetFormLibraryForms(formLibraryID string) *GetFormLibraryFormsOp

GetFormLibraryForms gets the forms in a form library.

https://developers.docusign.com/docs/rooms-api/reference/forms/formlibraries/getformlibraryforms

SDK Method Forms::GetFormLibraryForms

func (*Service) GrantOfficeAccessToFormGroup 

func (s *Service) GrantOfficeAccessToFormGroup(formGroupID string, officeID string, media io.Reader, mimeType string) *GrantOfficeAccessToFormGroupOp

GrantOfficeAccessToFormGroup grants an office access to a form group. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/grantofficeaccesstoformgroup

SDK Method Forms::GrantOfficeAccessToFormGroup

func (*Service) RemoveFormGroupForm 

func (s *Service) RemoveFormGroupForm(formGroupID string, formID string, media io.Reader, mimeType string) *RemoveFormGroupFormOp

RemoveFormGroupForm removes a form from a form group. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/removeformgroupform

SDK Method Forms::RemoveFormGroupForm

func (*Service) RenameFormGroup 

func (s *Service) RenameFormGroup(formGroupID string, body *rooms.FormGroupForUpdate) *RenameFormGroupOp

RenameFormGroup renames a form group.

https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/renameformgroup

SDK Method Forms::RenameFormGroup

func (*Service) RevokeOfficeAccessFromFormGroup 

func (s *Service) RevokeOfficeAccessFromFormGroup(formGroupID string, officeID string, media io.Reader, mimeType string) *RevokeOfficeAccessFromFormGroupOp

RevokeOfficeAccessFromFormGroup revoke an office's access to a form group. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/revokeofficeaccessfromformgroup

SDK Method Forms::RevokeOfficeAccessFromFormGroup

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.