Documentation ¶
Index ¶
- func Bool(v bool) *bool
- func Int(v int) *int
- func String(v string) *string
- type Client
- type File
- type FileObject
- type FileObjectRequest
- type FileObjectService
- type FileRequest
- type FileService
- type Member
- type MemberFileObject
- type MemberRequest
- type MemberService
- type ModeSmsConfiguration
- type Msg
- type Procedure
- type ProcedureConfig
- type ProcedureConfigEmail
- type ProcedureConfigReminder
- type ProcedureConfigWebhook
- type ProcedureRequest
- type ProceduresService
- type ReminderConfig
- type ReminderConfigEmail
- type ServerStamp
- type ServerStampConfig
- type ServerStampRequest
- type ServerStampService
- type User
- type UserGroup
- type UserGroupService
- type UserRequest
- type UserService
- type Webhook
- type WebhookHeader
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Client ¶
type Client struct { User *UserService UserGroup *UserGroupService Member *MemberService File *FileService FileObject *FileObjectService Procedure *ProceduresService ServerStamp *ServerStampService // contains filtered or unexported fields }
func NewClient ¶
NewClient returns a new YouSign API client. You must provide a valid apiKey retrieved from your YouSign account.
func NewClientStaging ¶
func (*Client) Do ¶
Do performs the request, the json received in the response is decoded and stored in the value pointed by v. Do can be used to perform the request created with NewRequest, which should be used only for API requests not implemented in this library.
func (*Client) NewRequest ¶
func (c *Client) NewRequest(method, urlStr string, opt interface{}, body interface{}) (*http.Request, error)
NewRequest creates an API request. This method can be used to performs API request not implemented in this library. Otherwise it should not be be used directly. Relative URLs should always be specified without a preceding slash.
type File ¶
type File struct { ID *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Type *string `json:"type,omitempty"` ContentType *string `json:"contentType,omitempty"` Description *string `json:"description,omitempty"` CreatedAt *time.Time `json:"createdAt,omitempty"` UpdatedAt *time.Time `json:"updatedAt,omitempty"` Metadata json.RawMessage `json:"metadata,omitempty"` Company *string `json:"company,omitempty"` Creator *string `json:"creator,omitempty"` }
type FileObject ¶
type FileObject struct { ID *string `json:"id,omitempty"` File *string `json:"file,omitempty"` Member *Member `json:"member,omitempty"` Page *int `json:"page,omitempty"` Position *string `json:"position,omitempty"` FieldName *string `json:"fieldName,omitempty"` Mention *string `json:"mention,omitempty"` Mention2Internal *string `json:"mention2 (internal),omitempty"` CreatedAt *time.Time `json:"createdAt,omitempty"` UpdatedAt *time.Time `json:"updatedAt,omitempty"` ExecutedAt *time.Time `json:"executedAt,omitempty"` }
type FileObjectRequest ¶
type FileObjectRequest struct { File *string `json:"file,omitempty"` Page *int `json:"page,omitempty"` Position *string `json:"position,omitempty"` FieldName *string `json:"fieldName,omitempty"` Mention *string `json:"mention,omitempty"` Mention2 *string `json:"mention2,omitempty"` Member *string `json:"member,omitempty"` }
type FileObjectService ¶
type FileObjectService struct {
// contains filtered or unexported fields
}
func (*FileObjectService) Create ¶
func (s *FileObjectService) Create(r *FileObjectRequest) (*FileObject, *http.Response, error)
func (*FileObjectService) Get ¶
func (s *FileObjectService) Get(id string) (*FileObject, *http.Response, error)
type FileRequest ¶
type FileRequest struct { Name *string `json:"name,omitempty"` Type *string `json:"type,omitempty"` Password *string `json:"password,omitempty"` Description *string `json:"description,omitempty"` Metadata map[string]string `json:"metadata,omitempty"` Content *string `json:"content,omitempty"` Procedure *string `json:"procedure,omitempty"` }
type FileService ¶
type FileService struct {
// contains filtered or unexported fields
}
func (*FileService) Create ¶
func (s *FileService) Create(r *FileRequest) (*File, *http.Response, error)
type Member ¶
type Member struct { ID *string `json:"id,omitempty"` User *string `json:"user,omitempty"` Type *string `json:"type,omitempty"` Firstname *string `json:"firstname,omitempty"` Lastname *string `json:"lastname,omitempty"` Email *string `json:"email,omitempty"` Phone *string `json:"phone,omitempty"` Position *int `json:"position,omitempty"` CreatedAt *time.Time `json:"createdAt,omitempty"` UpdatedAt *time.Time `json:"updatedAt,omitempty"` Status *string `json:"status,omitempty"` FileObjects []MemberFileObject `json:"fileObjects,omitempty"` Comment *string `json:"comment,omitempty"` Procedure *string `json:"procedure,omitempty"` OperationLevel *string `json:"operationLevel,omitempty"` OperationCustomModes []string `json:"operationCustomModes,omitempty"` ModeSmsConfiguration *ModeSmsConfiguration `json:"modeSmsConfiguration,omitempty"` }
type MemberFileObject ¶
type MemberFileObject struct { ID *string `json:"id,omitempty"` File *File `json:"file,omitempty"` Page *int `json:"page,omitempty"` Position *string `json:"position,omitempty"` FieldName *string `json:"fieldName,omitempty"` Mention *string `json:"mention,omitempty"` Mention2Internal *string `json:"mention2 (internal),omitempty"` CreatedAt *time.Time `json:"createdAt,omitempty"` UpdatedAt *time.Time `json:"updatedAt,omitempty"` ExecutedAt *time.Time `json:"executedAt,omitempty"` }
type MemberRequest ¶
type MemberRequest struct { User *string `json:"user,omitempty"` Type *string `json:"type,omitempty"` Firstname *string `json:"firstname,omitempty"` Lastname *string `json:"lastname,omitempty"` Email *string `json:"email,omitempty"` Phone *string `json:"phone,omitempty"` Position *int `json:"position,omitempty"` FileObjects []FileObjectRequest `json:"fileObjects,omitempty"` Procedure *string `json:"procedure,omitempty"` OperationLevel *string `json:"operationLevel,omitempty"` OperationCustomModes []string `json:"operationCustomModes,omitempty"` ModeSmsConfiguration *ModeSmsConfiguration `json:"modeSmsConfiguration,omitempty"` }
type MemberService ¶
type MemberService struct {
// contains filtered or unexported fields
}
func (*MemberService) Create ¶
func (s *MemberService) Create(r *MemberRequest) (*Member, *http.Response, error)
type ModeSmsConfiguration ¶
type ModeSmsConfiguration struct {
Content string `json:"content,omitempty"`
}
type Procedure ¶
type Procedure struct { ID *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Description *string `json:"description,omitempty"` CreatedAt *time.Time `json:"createdAt,omitempty"` UpdatedAt *time.Time `json:"updatedAt,omitempty"` ExpiresAt *time.Time `json:"expiresAt,omitempty"` Status *string `json:"status,omitempty"` Creator *string `json:"creator,omitempty"` CreatorFirstName *string `json:"creatorFirstName,omitempty"` CreatorLastName *string `json:"creatorLastName,omitempty"` Company *string `json:"company,omitempty"` Template *bool `json:"template,omitempty"` Ordered *bool `json:"ordered,omitempty"` Parent *string `json:"parent,omitempty"` Metadata json.RawMessage `json:"metadata,omitempty"` Config json.RawMessage `json:"config,omitempty"` Members []Member `json:"members,omitempty"` Files []File `json:"files,omitempty"` RelatedFilesEnable *bool `json:"relatedFilesEnable,omitempty"` Archive *bool `json:"archive,omitempty"` }
type ProcedureConfig ¶
type ProcedureConfig struct { Email ProcedureConfigEmail `json:"email,omitempty"` Reminders []ProcedureConfigReminder `json:"reminders,omitempty"` Webhook ProcedureConfigWebhook `json:"webhook,omitempty"` }
type ProcedureConfigEmail ¶
type ProcedureConfigEmail struct { ProcedureStarted []Msg `json:"procedure.started,omitempty"` ProcedureFinished []Msg `json:"procedure.finished,omitempty"` ProcedureRefused []Msg `json:"procedure.refused,omitempty"` ProcedureExpired []Msg `json:"procedure.expired,omitempty"` ProcedureDeleted []Msg `json:"procedure.deleted,omitempty"` MemberStarted []Msg `json:"member.started,omitempty"` MemberFinished []Msg `json:"member.finished,omitempty"` CommentCreated []Msg `json:"comment.created,omitempty"` }
type ProcedureConfigReminder ¶
type ProcedureConfigReminder struct { Interval *int `json:"interval,omitempty"` Limit *int `json:"limit,omitempty"` Config ReminderConfig `json:"config,omitempty"` }
type ProcedureConfigWebhook ¶
type ProcedureConfigWebhook struct { ProcedureStarted []Webhook `json:"procedure.started,omitempty"` ProcedureFinished []Webhook `json:"procedure.finished,omitempty"` ProcedureRefused []Webhook `json:"procedure.refused,omitempty"` ProcedureExpired []Webhook `json:"procedure.expired,omitempty"` ProcedureDeleted []Webhook `json:"procedure.deleted,omitempty"` MemberStarted []Webhook `json:"member.started,omitempty"` MemberFinished []Webhook `json:"member.finished,omitempty"` CommentCreated []Webhook `json:"comment.created,omitempty"` }
type ProcedureRequest ¶
type ProcedureRequest struct { Name *string `json:"name,omitempty"` Description *string `json:"description,omitempty"` ExpiresAt *string `json:"expiresAt,omitempty"` Template *bool `json:"template,omitempty"` Ordered *bool `json:"ordered,omitempty"` Metadata map[string]string `json:"metadata,omitempty"` Config *ProcedureConfig `json:"config,omitempty"` Members []MemberRequest `json:"members,omitempty"` Start *bool `json:"start,omitempty"` RelatedFilesEnable *bool `json:"relatedFilesEnable,omitempty"` Archive *bool `json:"archive,omitempty"` }
type ProceduresService ¶
type ProceduresService struct {
// contains filtered or unexported fields
}
func (*ProceduresService) Create ¶
func (s *ProceduresService) Create(r *ProcedureRequest) (*Procedure, *http.Response, error)
func (*ProceduresService) Update ¶
func (s *ProceduresService) Update(id string, r *ProcedureRequest) (*Procedure, *http.Response, error)
type ReminderConfig ¶
type ReminderConfig struct {
Email ReminderConfigEmail `json:"email,omitempty"`
}
type ReminderConfigEmail ¶
type ReminderConfigEmail struct {
ReminderExecuted []Msg `json:"reminder.executed,omitempty"`
}
type ServerStamp ¶
type ServerStamp struct { ID *string `json:"id,omitempty"` File *string `json:"file,omitempty"` Certificate *string `json:"certificate,omitempty"` FileObjects []FileObject `json:"fileObjects,omitempty"` Config json.RawMessage `json:"config,omitempty"` CreatedAt *time.Time `json:"createdAt,omitempty"` UpdatedAt *time.Time `json:"updatedAt,omitempty"` FinishedAt *time.Time `json:"finishedAt,omitempty"` Status *string `json:"status,omitempty"` Company *string `json:"company,omitempty"` }
type ServerStampConfig ¶
type ServerStampConfig struct { Webhook struct { ServerStampFinished []Webhook `json:"server_stamp.finished,omitempty"` } }
type ServerStampRequest ¶
type ServerStampRequest struct { File *string `json:"file,omitempty"` Certificate *string `json:"certificate,omitempty"` Config *ServerStampConfig `json:"config,omitempty"` FileObjects []FileObjectRequest `json:"fileObjects,omitempty"` SignImage *string `json:"signImage,omitempty"` }
type ServerStampService ¶
type ServerStampService struct {
// contains filtered or unexported fields
}
func (*ServerStampService) Create ¶
func (s *ServerStampService) Create(r *ServerStampRequest) (*ServerStamp, *http.Response, error)
func (*ServerStampService) Get ¶
func (s *ServerStampService) Get(id string) (*ServerStamp, *http.Response, error)
type User ¶
type User struct { ID *string `json:"id,omitempty"` Firstname *string `json:"firstname,omitempty"` Lastname *string `json:"lastname,omitempty"` FullName *string `json:"fullName,omitempty"` Title *string `json:"title,omitempty"` Email *string `json:"email,omitempty"` Phone *string `json:"phone,omitempty"` Status *string `json:"status,omitempty"` Company *string `json:"company,omitempty"` CreatedAt *time.Time `json:"createdAt,omitempty"` UpdatedAt *time.Time `json:"updatedAt,omitempty"` Config interface{} `json:"config,omitempty"` SamlNameID *string `json:"samlNameId,omitempty"` DefaultSignImage *string `json:"defaultSignImage,omitempty"` FastSign *bool `json:"fastSign,omitempty"` Group *UserGroup `json:"group,omitempty"` Notifications interface{} `json:"notifications,omitempty"` Deleted *bool `json:"deleted,omitempty"` DeletedAt *time.Time `json:"deletedAt,omitempty"` }
type UserGroupService ¶
type UserGroupService struct {
// contains filtered or unexported fields
}
type UserRequest ¶
type UserRequest struct { Firstname *string `json:"firstname,omitempty"` Lastname *string `json:"lastname,omitempty"` Title *string `json:"title,omitempty"` Phone *string `json:"phone,omitempty"` Company *string `json:"company,omitempty"` Config interface{} `json:"config,omitempty"` Group *string `json:"group,omitempty"` DefaultSignImage *string `json:"defaultSignImage,omitempty"` Notifications *string `json:"notifications,omitempty"` }
type UserService ¶
type UserService struct {
// contains filtered or unexported fields
}
type Webhook ¶
type Webhook struct { URL *string `json:"url,omitempty"` Method *string `json:"method,omitempty"` Headers *WebhookHeader `json:"headers,omitempty"` }
type WebhookHeader ¶
type WebhookHeader struct {
XYousignCustomHeader string `json:"X-Yousign-Custom-Header,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.