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/docs/esign-rest-api/reference/PowerForms Usage example:
import (
"github.com/jfcote87/esign"
"github.com/jfcote87/esign/v2.1/model"
)
...
powerformsService := powerforms.New(esignCredential)
Index ¶
- type CreateOp
- type DataListOp
- type DeleteListOp
- type DeleteOp
- type GetOp
- type ListOp
- func (op *ListOp) Do(ctx context.Context) (*model.PowerFormsResponse, error)
- func (op *ListOp) FromDate(val time.Time) *ListOp
- func (op *ListOp) Order(val string) *ListOp
- func (op *ListOp) OrderBy(val string) *ListOp
- func (op *ListOp) SearchFields(val string) *ListOp
- func (op *ListOp) SearchText(val string) *ListOp
- func (op *ListOp) ToDate(val time.Time) *ListOp
- type ListSendersOp
- type Service
- func (s *Service) Create(powerForm *model.PowerForm) *CreateOp
- func (s *Service) DataList(powerFormID string) *DataListOp
- func (s *Service) Delete(powerFormID string) *DeleteOp
- func (s *Service) DeleteList(powerFormsRequest *model.PowerFormsRequest) *DeleteListOp
- func (s *Service) Get(powerFormID string) *GetOp
- func (s *Service) List() *ListOp
- func (s *Service) ListSenders() *ListSendersOp
- func (s *Service) Update(powerFormID string, powerForm *model.PowerForm) *UpdateOp
- type UpdateOp
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DataListOp ¶
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 ¶
func (op *DataListOp) Do(ctx context.Context) (*model.PowerFormsFormDataResponse, error)
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 ¶
DeleteListOp implements DocuSign API SDK PowerForms::deletePowerForms
func (*DeleteListOp) Do ¶
func (op *DeleteListOp) Do(ctx context.Context) (*model.PowerFormsResponse, error)
Do executes the op. A nil context will return error.
type ListOp ¶
ListOp implements DocuSign API SDK PowerForms::listPowerForms
func (*ListOp) FromDate ¶
FromDate is the start date for a date range.
**Note:** If no value is provided, no date filtering is applied.
func (*ListOp) Order ¶
Order is the order in which to sort the results.
Valid values are:
* `asc`: Ascending order. * `desc`: Descending order.
func (*ListOp) OrderBy ¶
OrderBy is the file attribute to use to sort the results.
Valid values are:
- `sender` - `auth` - `used` - `remaining` - `lastused` - `status` - `type` - `templatename` - `created`
func (*ListOp) SearchFields ¶ added in v0.10.0
SearchFields is a comma-separated list of additional properties to include in a search.
- `sender`: Include sender name and email in the search. - `recipients`: Include recipient names and emails in the search. - `envelope`: Include envelope information in the search.
func (*ListOp) SearchText ¶ added in v0.10.0
SearchText use this parameter to search for specific text.
type ListSendersOp ¶
ListSendersOp implements DocuSign API SDK PowerForms::listPowerFormSenders
func (*ListSendersOp) Do ¶
func (op *ListSendersOp) Do(ctx context.Context) (*model.PowerFormSendersResponse, error)
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 API operations
func New ¶
func New(cred esign.Credential) *Service
New initializes a powerforms service using cred to authorize ops.
func (*Service) Create ¶
Create creates a new PowerForm
https://developers.docusign.com/docs/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/docs/esign-rest-api/reference/powerforms/powerformdata/list
SDK Method PowerForms::getPowerFormData
func (*Service) Delete ¶
Delete deletes a PowerForm.
https://developers.docusign.com/docs/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/docs/esign-rest-api/reference/powerforms/powerforms/deletelist
SDK Method PowerForms::deletePowerForms
func (*Service) Get ¶
Get returns a single PowerForm.
https://developers.docusign.com/docs/esign-rest-api/reference/powerforms/powerforms/get
SDK Method PowerForms::getPowerForm
func (*Service) List ¶
List returns a list of PowerForms.
https://developers.docusign.com/docs/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/docs/esign-rest-api/reference/powerforms/powerforms/listsenders
SDK Method PowerForms::listPowerFormSenders
Source Files