powerforms

package
Version: 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 powerforms implements the DocuSign SDK category PowerForms.

The PowerForms category enables you to create and manage PowerForms that you can use for self service and email forms.

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

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateOp

type CreateOp esign.Op

CreateOp implements DocuSign API SDK PowerForms::createPowerForm

func (*CreateOp) Do

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

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

type DataListOp

type DataListOp esign.Op

DataListOp implements DocuSign API SDK PowerForms::getPowerFormData

func (*DataListOp) DataLayout

func (op *DataListOp) DataLayout(val string) *DataListOp

DataLayout is the layout in which to return the PowerForm data. Valid values are:

- `Native` - `Csv_Classic` - `Csv_One_Envelope_Per_Line` - `Xml_Classic`

func (*DataListOp) Do

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

func (*DataListOp) FromDate

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

FromDate is the start date for a date range in UTC DateTime format.

**Note**: If this property is null, no date filtering is applied.

func (*DataListOp) ToDate

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

ToDate is the end date of a date range in UTC DateTime format. The default value is `UtcNow`.

type DeleteListOp

type DeleteListOp esign.Op

DeleteListOp implements DocuSign API SDK PowerForms::deletePowerForms

func (*DeleteListOp) Do

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

type DeleteOp

type DeleteOp esign.Op

DeleteOp implements DocuSign API SDK PowerForms::deletePowerForm

func (*DeleteOp) Do

func (op *DeleteOp) 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 PowerForms::getPowerForm

func (*GetOp) Do

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

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

type ListOp

type ListOp esign.Op

ListOp implements DocuSign API SDK PowerForms::listPowerForms

func (*ListOp) Do

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

func (*ListOp) FromDate

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

FromDate (Optional) The start date for a date range.

**Note**: If no value is provided, no date filtering is applied.

func (*ListOp) Order

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

Order (Optional) The order in which to sort the results.

Valid values are:

* `asc`: Ascending order. * `desc`: Descending order.

func (*ListOp) OrderBy

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

OrderBy (Optional) The file attribute to use to sort the results.

Valid values are:

* `modified` * `name`

func (*ListOp) ToDate

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

ToDate (Optional) The end date for a date range.

**Note**: If no value is provided, this property defaults to the current date.

type ListSendersOp

type ListSendersOp esign.Op

ListSendersOp implements DocuSign API SDK PowerForms::listPowerFormSenders

func (*ListSendersOp) Do

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

func (*ListSendersOp) StartPosition

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

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.

type Service

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

Service implements DocuSign PowerForms Category API operations

func New

func New(cred esign.Credential) *Service

New initializes a powerforms service using cred to authorize ops.

func (*Service) Create

func (s *Service) Create(powerForms *model.PowerForm) *CreateOp

Create creates a new PowerForm.

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

SDK Method PowerForms::createPowerForm

func (*Service) DataList

func (s *Service) DataList(powerFormID string) *DataListOp

DataList returns the data that users entered in a PowerForm.

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

SDK Method PowerForms::getPowerFormData

func (*Service) Delete

func (s *Service) Delete(powerFormID string) *DeleteOp

Delete deletes a PowerForm.

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

SDK Method PowerForms::deletePowerForm

func (*Service) DeleteList

func (s *Service) DeleteList(powerFormsRequest *model.PowerFormsRequest) *DeleteListOp

DeleteList deletes one or more PowerForms.

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

SDK Method PowerForms::deletePowerForms

func (*Service) Get

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

Get returns a single PowerForm.

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

SDK Method PowerForms::getPowerForm

func (*Service) List

func (s *Service) List() *ListOp

List returns a list of PowerForms.

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

SDK Method PowerForms::listPowerForms

func (*Service) ListSenders

func (s *Service) ListSenders() *ListSendersOp

ListSenders gets PowerForm senders.

https://developers.docusign.com/esign-rest-api/reference/powerforms/powerforms/listsenders

SDK Method PowerForms::listPowerFormSenders

func (*Service) Update

func (s *Service) Update(powerFormID string, powerForms *model.PowerForm) *UpdateOp

Update updates an existing PowerForm.

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

SDK Method PowerForms::updatePowerForm

type UpdateOp

type UpdateOp esign.Op

UpdateOp implements DocuSign API SDK PowerForms::updatePowerForm

func (*UpdateOp) Do

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

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

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL