Documentation
¶
Overview ¶
Package powerforms implements the DocuSign SDK category PowerForms.
The PowerForms category enables PowerForms to be created and managed.
Service Api documentation may be found at: https://developers.docusign.com/esign-rest-api/v2/reference/PowerForms Usage example:
import (
"github.com/ofio/esign"
"github.com/ofio/esign/v2/powerforms"
"github.com/ofio/esign/v2/model"
)
...
powerformsService := powerforms.New(esignCredential)
Index ¶
- type CreateOp
- type DataListOp
- type DeleteListOp
- type DeleteOp
- type GetOp
- type ListOp
- type ListSendersOp
- type Service
- func (s *Service) Create(powerForms *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, powerForms *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 set the call query parameter data_layout
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 start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.
func (*DataListOp) ToDate ¶
func (op *DataListOp) ToDate(val time.Time) *DataListOp
ToDate end of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.
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 start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.
func (*ListOp) Order ¶
Order is an optional value that sets the direction order used to sort the item list.
Valid values are:
* asc = ascending sort order * desc = descending sort order
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 Category 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/esign-rest-api/v2/reference/powerforms/powerforms/create
SDK Method PowerForms::createPowerForm
func (*Service) DataList ¶
func (s *Service) DataList(powerFormID string) *DataListOp
DataList returns the form data associated with the usage of a PowerForm.
https://developers.docusign.com/esign-rest-api/v2/reference/powerforms/powerformdata/list
SDK Method PowerForms::getPowerFormData
func (*Service) Delete ¶
Delete delete a PowerForm.
https://developers.docusign.com/esign-rest-api/v2/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/v2/reference/powerforms/powerforms/deletelist
SDK Method PowerForms::deletePowerForms
func (*Service) Get ¶
Get returns a single PowerForm.
https://developers.docusign.com/esign-rest-api/v2/reference/powerforms/powerforms/get
SDK Method PowerForms::getPowerForm
func (*Service) List ¶
List returns the list of PowerForms available to the user.
https://developers.docusign.com/esign-rest-api/v2/reference/powerforms/powerforms/list
SDK Method PowerForms::listPowerForms
func (*Service) ListSenders ¶
func (s *Service) ListSenders() *ListSendersOp
ListSenders returns the list of PowerForms available to the user.
https://developers.docusign.com/esign-rest-api/v2/reference/powerforms/powerforms/listsenders
SDK Method PowerForms::listPowerFormSenders
Source Files