glide

package module
v6.0.62 Latest Latest
Warning

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

 Go to latest Published: Sep 17, 2025 License: MIT Imports: 7 Imported by: 0

README

Go Glide API SDK

⚠ The SDK and underlaying API are still being developed and current APIs are bound to change, not respecting backward compatibility conventions on versioning

⚠ Current SDK Go version 1.18

This SDK is meant to be used to more easily consume Glide's external APIs while using Go after an integration app has been set up for your Brokerage at Glide.

The underlying API's spec is available for both development and production environments on the links below:

Integration App

If you don't have an integration app setup with Glide, please reach out to Glide Engineering (engineering@glide.com) for guidance. The integration app you use will dictate the client key and RS256 key pair values, and the associated brokerage's members are the Glide users you are allowed to impersonate while using these keys.

Instalation

go get github.com/retitle/go-sdk

HTTP Mocks for test development

The goal of this section is to provide snipped code that allows devs to test new resources/methods inside the sdk. Keep in mind that our mission is to verify every HTTP call made by this sdk through unit testing, hence these HTTP calls must be mocked. In order to accomplish this here is a true example that can be found in file user_management_test.go:


func parseStructToIoReadCloser[T any](v *T) io.ReadCloser {
    b, _ := json.Marshal(v)
    stringReader := strings.NewReader(string(b))
    stringReadCloser := io.NopCloser(stringReader)
    return stringReadCloser
}


func TestUserManagement(t *testing.T) {
    var (
        mockedRequest          *http.Request
        mockedResponse         *http.Response
        expectedBodyResponse   *glide.User
        bodyResponse           *glide.User
        httpRequester          *mocks.HttpClientRequester
        client                 glide.Client
        httpClient             core.HttpClient
        userManagementResource glide.UserManagementResource
        expectedErr            error
        method                 string
        err                    error
        someClientKey          = "come-valid-key"
        somePem                = []byte{}
        url                    = "http://api.glide.com/user_management"
        michaelJordanId        = "23"
    )

    ttests := []struct {
    name    string
    arrange func()
    act     func()
    assert  func()
    }{
        {
            name: "Should Call Get successfully",
            arrange: func() {
                method = "GET"
                expectedBodyResponse = &glide.User{
                    Id: michaelJordanId,
                }
                expectedErr = nil

                stringReadCloser := parseStructToIoReadCloser(expectedBodyResponse)
                mockedRequest, _ = http.NewRequest(method, fmt.Sprintf("%v/%v", url, michaelJordanId), nil)
                mockedResponse = &http.Response{StatusCode: http.StatusOK, Body: stringReadCloser}
                // HTTP mock
                httpRequester = &mocks.HttpClientRequester{}
                httpRequester.On("Do", mock.MatchedBy(func(req *http.Request) bool {
                    return req.URL.Host == mockedRequest.URL.Host && req.URL.Path == mockedRequest.URL.Path && req.Method == mockedRequest.Method && req.Body == http.NoBody
                })).
                Return(mockedResponse, nil)

                // Injecting the http mock
                httpClient = core.NewHttpClientWithRequester(httpRequester)
                client = glide.GetClient(someClientKey, core.GetRsa256KeyFromPEMBytes(somePem))
                client.SetHttpClient(httpClient)

                userManagementResource = glide.GetUserManagementResource(client)
            },
            act: func() {
                bodyResponse, err = userManagementResource.GetDetail(michaelJordanId)
            },
            assert: func() {
                assert.Equal(t, expectedErr, err)
                assert.Equal(t, expectedBodyResponse, bodyResponse)
            },
        },
    }

    for _, tt := range ttests {
        t.Run(tt.name, func(t *testing.T) {
            tt.arrange()

            tt.act()

            tt.assert()
        })
    }
}

Testing

To run the test case execute the following command

go test
Execute test covergae

Execute the following command

go test -cover

Example usage

package my_package

import (
    "github.com/retitle/go-sdk/v6"

    "fmt"
)

func main() {
    clientKey := "12345678-9abc-def0-1234-56789abcdef0"
    key := glide.GetRsa256Key("/keys/private.pem")
    /*
        Also posible to get PEM formatted key from memory using
        either `glide.GetRsa256KeyFromPEMBytes` (recives []byte)
        or `glide.GetRsa256KeyFromPEMString` (recives string)
    */
    glideClient := glide.GetClient(clientKey, key,
        glide.WithServer("api.dev.glide.com"),
    }) // exlcude WithServer option for prod (or use "api.glide.com")

    // This will fail because no user is being impersonated
    if _, err := glideClient.Users().Current(); err != nil {
        fmt.Println("This error is expected: ", err)
    }

    aGlideUsername := "your.user@domain.com"
    scopes := []string{}
    /*
       While impersonating a user, the SDK will seamlessly keep the access token refreshed.
       To stop impersonating you can use `glideClient.StopImpersonating()`, or you can use
       `glideClient.StartImpersonating(...)` with different parameters to just change the current impersonated user/scopes.
       At any point in time
       * `glideClient.IsImpersonating()`
       * `glideClient.ImpersonatingSub()`
       * `glideClient.ImpersonatingScopes()`
       can be used to find out whether or not an impersonation session is active, and find out details about it.
    */

    // From here on out, all requests will have impersonated user's objects, but no scopes were requested
    if err := glideClient.StartImpersonating(aGlideUsername, scopes); err != nil {
        panic(err)
    }

    // This works because there is an impersonated user, and the current user endpoint doesn't require any scope to be accessed
    user, err := glideClient.Users().Current()
    if err != nil {
        panic(err)
    }
    fmt.Println(*user)

    // This will fail because accessed resource (Transactions) requires missing TRANSACTIONS scope
    if _, err := glideClient.Transactions().List(); err != nil {
        fmt.Println("This error is expected: ", err)
    }

    // From here on out, all requests will have access to the TRANSACTIONS scope for impersonated user
    scopes = []string{"TRANSACTIONS"}
    if err := glideClient.StartImpersonating(aGlideUsername, scopes); err != nil {
        panic(err)
    }

    // List all transactions avaialble for impersonated user
    txns, err := glideClient.Transactions().List()
    if err != nil {
        panic(err)
    }
    fmt.Println(*txns)

    // Fetch multiple specific transactions avaialble for impersonated user
    transactionIds := []string{"2246", "1486", "490"} // Make sure all these exist, else a 404 error will occur
    txns, err = glideClient.Transactions().GetMulti(transactionIds)
    if err != nil {
        panic(err)
    }
    fmt.Println(*txns)

    // Fetch a single transactions avaialble for impersonated user
    transactionId := transactionIds[0]
    txn, err := glideClient.Transactions().GetDetail(transactionId) // Make sure this exists, else a 404 error will occur
    if err != nil {
        panic(err)
    }
    fmt.Println(*txn)

    // Fetch all parties on a transaction
    parties, err := glideClient.Transactions().Parties().List(txn.Id)
    if err != nil {
        panic(err)
    }
    fmt.Println(*parties)

    // Use page parameters to control List's methods pagination. Pagination has a limit and a cursor.
    // No custom sorting is yet supported. WithPage(nil) is equivalent to not including the option at all.
    // WithPageParams(5, "1486") is an equivalent way of writing this example
    txns, err = glideClient.Transactions().List(glide.WithPage(&glide.PageParams{Limit: 5, StartingAfter: "1486"}))
    if err != nil {
        panic(err)
    }
    fmt.Println(*txns)

    // Simplified approach to only set the Limit without setting cursor
    txns, err = glideClient.Transactions().List(glide.WithPageLimit(5))
    if err != nil {
        panic(err)
    }
    fmt.Println(*txns)

    // Simplified approach to only set the Starting after cursor while using default limit value
    txns, err = glideClient.Transactions().List(glide.WithPageStartingAfter("1486"))
    if err != nil {
        panic(err)
    }
    fmt.Println(*txns)

    // All list objects have `HasMore bool` and `NextPageParams() *PageParams` to figure out next page's attributes
    // If HasMore is false, then NextPageParams() will be nil. Otherwise, NextPageParams() will return the appropriate
    // PageParams data to request the next page.
    txns, err = glideClient.Transactions().List()
    if err != nil {
        panic(err)
    }
    for {
        fmt.Println("Fetched", len(txns.Data), "txns")
        if !txns.HasMore {
            break
        }
        txns, err = glideClient.Transactions().List(WithPage(txns.NextPageParams()))
        if err != nil {
            panic(err)
        }
    }

    // Most nested objects won't be included in the responses by default, but they can be expanded if the
    // option is included.
    // All response objects have an `IsRef() bool` to check if the content corresponds to the actual object
    // or if it's just a reference to it (i.e. it could have been expanded, but it wasn't).
    txn, err = glideClient.Transactions().GetDetail(transactionId) // Make sure this exists, else a 404 error will occur
    if err != nil {
        panic(err)
    }
    if !txn.Folders.IsRef() || !txn.Parties.IsRef() {
        panic("These should be refs!")
    }

    txn, err = glideClient.Transactions().GetDetail(transactionId,
        glide.WithExpand(
            "folders.transaction_documents",
            "parties",
        ),
    ) // Make sure this exists, else a 404 error will occur
    if err != nil {
        panic(err)
    }
    fmt.Println(txn)
    if txn.Folders.IsRef() || txn.Parties.IsRef() {
        panic("These should NOT be refs!")
    }
    for _, folder := range txn.Folders.Data {
        if folder.TransactionDocuments.IsRef() {
            panic("These should NOT be refs!")
        }
        fmt.Println(folder.Title)
        for _, td := range folder.TransactionDocuments.Data {
            fmt.Println(td)
        }
    }

    // Expansion also works for List and GetMulti methods
    _, err = glideClient.Transactions().Folders().List(txn.Id,
        glide.WithExpand(
            "transaction_documents",
        ),
    )
    if err != nil {
        panic(err)
    }

    folderIds := []string{}
    for _, f := range txn.Folders.Data {
        folderIds = append(folderIds, f.Id)
    }
    _, err = glideClient.Transactions().Folders().GetMulti(txn.Id, folderIds,
        glide.WithExpand(
            "transaction_documents",
        ),
    )
    if err != nil {
        panic(err)
    }

    // Most write operations are performed at the Transaction level. Some examples follow
    // Some operations will include some details about the performed action on its Response object,
    // while others will now
    partyCreateRes, err := glideClient.Transactions().PartyCreates(transactionId, glide.PartyCreates{
        Creates: []glide.PartyCreate{{
            Email:     "some@test.com",
            FirstName: "Test",
            LastName:  "Test",
            Roles:     []string{"LISTING_TC"},
        }},
    })
    if err != nil {
        panic(err)
    }
    fmt.Println(partyCreateRes)
    txn, err = glideClient.Transactions().GetDetail(transactionId, glide.WithExpand("parties"))
    if err != nil {
        panic(err)
    }
    var party glide.Party
    for _, p := range txn.Parties.Data {
        if p.Email == "some@test.com" {
            party = p
            break
        }
    }
    partyRemovesRes, err := glideClient.Transactions().PartyRemoves(transactionId, glide.PartyRemoves{
        Removes: []glide.PartyRemove{{
            PartyId: party.Id,
        }},
    })
    if err != nil {
        panic(err)
    }
    fmt.Println(partyRemovesRes)

    // Transaction Fields is currently the only object not included by default (it ahs to be explictly expanded) that
    // does not correspond to a related entity.
    // To include fields when fetching a transaction, the "fields" attribute has to be exapnded. Expanind "fields"
    // only or "fields[*]" will include all fields. To get a subset of fields, the required fileds can be included
    // like this "fields[property/apn,property/address,parties/seller,fieldx,fieldy...]"

    txn, err = glideClient.Transactions().GetDetail(transactionId)
    if err != nil {
        panic(err)
    }
    fmt.Println(txn.Fields) // Empty

    txn, err = glideClient.Transactions().GetDetail(transactionId,
        glide.WithExpand("fields"), // equivalent to WithExpand("fields[*]")
    )
    if err != nil {
        panic(err)
    }
    fmt.Println(txn.Fields) // All fields included

    txn, err = glideClient.Transactions().GetDetail(transactionId,
        glide.WithExpand("fields[property/apn,property/block,property/lot]"),
    )
    if err != nil {
        panic(err)
    }
    fmt.Println(txn.Fields) // Only property/apn,property/block,property/lot included

    // Writing to fields requires a TransactionFieldsWrite object
    // There, each key corresponds to a field_id, and each value is the field value
    // to write, and optionally the control_version. The controlVersion (if included)
    // will make Glide check if that value corresponds to the version # in which that field
    // was last updated, and will fail in case it's not. If not provided (or provided with
    // value 0), then it will always write. In the same TransactionFieldsWrite there could be
    // a combination of some fields having controlVersion and others not having it
    fieldsWrite := glide.TransactionFieldsWrite{
        "property/apn":   glide.GetFieldWrite("12345", 2247),    // Will fail if current version of property/apn != 2247
        "property/block": glide.GetFieldWriteNoControl("67890"), // Will always write to property/block
        "property/lot":   glide.GetFieldWrite("1233", 0),        // This is equivalent to using GetFieldWriteNoControl
    }
    fieldsRes, err := glideClient.Transactions().Fields(txn.Id, fieldsWrite)
    if err != nil {
        // err's params will detail each failing field in case some of the controled ones found a version mismatch
        fmt.Println("err.Params", err.Params)
    } else {
        // Response will detail all the values and latest versions of alterted fields
        fmt.Println("fieldsRes", fieldsRes)
    }

    // TransactionFieldsWrite can be created from txn objects, so you can get the controlVersion values from there
    txn, err = glideClient.Transactions().GetDetail(transactionId, glide.WithExpand("fields"))
    if err != nil {
        panic(err)
    }
    // This TransactionFieldsWrite will include the controlVersion that match whatever there is stored
    // on the specified fields for txn.Fields. IF the field is not present, no cotnrol will be included for it
    fieldsWrite = txn.GetFieldsWrite(glide.TransactionFieldValues{
        "property/apn":   "12345",
        "property/block": "910233",
    })
    fmt.Println("fieldsWrite", fieldsWrite)

    // Multiple TransactionFieldsWrite objects can be combined into one using CombineFieldsWrites
    fieldsWrite = CombineFieldsWrites(
        txn.GetFieldsWrite(glide.TransactionFieldValues{
            "property/apn":   "12345",
            "property/block": "910233",
        }),
        // If the same field is included in more than one of the combined TransactionFieldsWrite,
        // the last provided value will be kept
        glide.TransactionFieldsWrite{
            "property/block": GetFieldWriteNoControl("67890"),
            "property/lot":   GetFieldWrite("1233", 0),
        },
    )
    fmt.Println("fieldsWrite", fieldsWrite)
}

Documentation

Index

Constants

View Source 
const JWT_EXPIRES = 60

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessControl added in v6.0.22 

type AccessControl struct {
	Id         string `json:"id,omitempty"`
	Deleted    int    `json:"deleted,omitempty"`
	ObjectId   string `json:"object_id,omitempty"`
	ObjectType string `json:"object_type,omitempty"`
	Policy     string `json:"policy,omitempty"`
	RoleId     string `json:"role_id,omitempty"`
	RoleType   string `json:"role_type,omitempty"`
}

type AccessPolicy added in v6.0.22 

type AccessPolicy struct {
	Acl []*AccessControl `json:"acl,omitempty"`
}

type ActivitiesResource added in v6.0.18 

type ActivitiesResource interface {
	GetDetail(id string, opts ...core.RequestOption) (*ActivityListWithCursor, error)
}

func GetActivitiesResource added in v6.0.18 

func GetActivitiesResource(client Client) ActivitiesResource

type Activity added in v6.0.18 

type Activity struct {
	Id        string           `json:"id,omitempty"`
	Context   *ActivityContext `json:"context,omitempty"`
	CreatedAt int              `json:"created_at,omitempty"`
	Kind      string           `json:"kind,omitempty"`
	Object    string           `json:"object,omitempty"`
}

func (Activity) IsRef added in v6.0.18 

func (m Activity) IsRef() bool

type ActivityContext added in v6.0.25 

type ActivityContext struct {
	Documents  []*ActivityContextItem `json:"documents,omitempty"`
	Party      *ActivityContextItem   `json:"party,omitempty"`
	Recipients []*ActivityContextItem `json:"recipients,omitempty"`
	User       *ActivityContextItem   `json:"user,omitempty"`
	Object     string                 `json:"object,omitempty"`
}

func (ActivityContext) IsRef added in v6.0.25 

func (m ActivityContext) IsRef() bool

type ActivityContextItem added in v6.0.25 

type ActivityContextItem struct {
	Id     string `json:"id,omitempty"`
	Link   string `json:"link,omitempty"`
	Name   string `json:"name,omitempty"`
	Object string `json:"object,omitempty"`
}

func (ActivityContextItem) IsRef added in v6.0.25 

func (m ActivityContextItem) IsRef() bool

type ActivityListWithCursor added in v6.0.18 

type ActivityListWithCursor struct {
	Cursor  string      `json:"cursor,omitempty"`
	Data    []*Activity `json:"data,omitempty"`
	HasMore *bool       `json:"has_more,omitempty"`
	Total   int         `json:"total,omitempty"`
	Object  string      `json:"object,omitempty"`
}

func (ActivityListWithCursor) IsRef added in v6.0.18 

func (m ActivityListWithCursor) IsRef() bool

type Address 

type Address struct {
	City    string `json:"city"`
	County  string `json:"county,omitempty"`
	State   string `json:"state"`
	Street  string `json:"street"`
	Unit    string `json:"unit,omitempty"`
	ZipCode string `json:"zip_code"`
	Object  string `json:"object,omitempty"`
}

func (Address) IsRef 

func (m Address) IsRef() bool

type Agent 

type Agent struct {
	Address              *Address `json:"address,omitempty"`
	CompanyLicenseNumber string   `json:"company_license_number,omitempty"`
	CompanyName          string   `json:"company_name,omitempty"`
	CompanyPhoneNumber   string   `json:"company_phone_number,omitempty"`
	LicenseNumber        string   `json:"license_number,omitempty"`
	LicenseState         string   `json:"license_state,omitempty"`
	NrdsNumber           string   `json:"nrds_number,omitempty"`
	Object               string   `json:"object,omitempty"`
}

func (Agent) IsRef 

func (m Agent) IsRef() bool

type AgentRequest 

type AgentRequest struct {
	Address              *Address `json:"address,omitempty"`
	AddressId            string   `json:"address_id,omitempty"`
	CompanyLicenseNumber string   `json:"company_license_number,omitempty"`
	CompanyName          string   `json:"company_name,omitempty"`
	CompanyPhoneNumber   string   `json:"company_phone_number,omitempty"`
	LicenseNumber        string   `json:"license_number,omitempty"`
	LicenseState         string   `json:"license_state,omitempty"`
	NrdsNumber           string   `json:"nrds_number,omitempty"`
}

type AnalyzeSchema 

type AnalyzeSchema struct {
	Files     []http.File `json:"files,omitempty"`
	FilesMeta []*FileMeta `json:"files_meta,omitempty"`
}

type Annotations added in v6.0.22 

type Annotations struct {
	Id             string  `json:"id,omitempty"`
	FieldId        string  `json:"field_id,omitempty"`
	Height         float64 `json:"height,omitempty"`
	Kind           string  `json:"kind,omitempty"`
	Left           float64 `json:"left,omitempty"`
	RecipientColor string  `json:"recipient_color,omitempty"`
	RecipientRole  string  `json:"recipient_role,omitempty"`
	Source         string  `json:"source,omitempty"`
	Top            float64 `json:"top,omitempty"`
	Width          float64 `json:"width,omitempty"`
}

type BinaryResponse 

type BinaryResponse struct {
	ContentDisposition string       `json:"content_disposition,omitempty"`
	ContentType        string       `json:"content_type,omitempty"`
	Data               bytes.Buffer `json:"data,omitempty"`
	Object             string       `json:"object,omitempty"`
}

func (BinaryResponse) IsRef 

func (m BinaryResponse) IsRef() bool

func (*BinaryResponse) SetData 

func (m *BinaryResponse) SetData(dataSource io.Reader, metadata core.BinaryMetadata) error

type Client 

type Client interface {
	Get(res core.Response, authRequired bool, path string, opts ...core.RequestOption) error
	GetStream(res core.BinaryResponse, authRequired bool, path string, opts ...core.RequestOption) error
	Post(res core.Response, authRequired bool, path string, payload core.Request, opts ...core.RequestOption) error
	PostWithFiles(res core.Response, authRequired bool, path string, payload core.Request, files []core.File, opts ...core.RequestOption) error
	GetOptions() core.ClientOptions
	SetHttpClient(httpClient core.HttpClient)
	StartImpersonating(sub string, scopes []string) error
	IsImpersonating() bool
	ImpersonatingSub() string
	ImpersonatingScopes() []string
	StopImpersonating()
	// DO NOT remove these comments since they serve as anchors for code autogeneration
	/* Autogenerated-root-resource-interface-defs begins */
	Contacts() ContactsResource
	Documents() DocumentsResource
	Envelopes() EnvelopesResource
	Notifications() NotificationsResource
	Offers() OffersResource
	SignatureRequests() SignatureRequestsResource
	Transactions() TransactionsResource
	UserManagement() UserManagementResource
	Users() UsersResource
}

func GetClient 

func GetClient(clientKey string, key core.Key, opts ...core.ClientOption) Client

type ClientImpl 

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

func (*ClientImpl) Contacts 

func (c *ClientImpl) Contacts() ContactsResource

DO NOT remove these comments since they serve as anchors for code autogeneration 

Autogenerated-root-resource-getters begins

func (*ClientImpl) Documents 

func (c *ClientImpl) Documents() DocumentsResource

func (*ClientImpl) Envelopes added in v6.0.15 

func (c *ClientImpl) Envelopes() EnvelopesResource

func (*ClientImpl) Get 

func (c *ClientImpl) Get(res core.Response, authRequired bool, path string, opts ...core.RequestOption) error

func (*ClientImpl) GetOptions 

func (c *ClientImpl) GetOptions() core.ClientOptions

func (*ClientImpl) GetStream 

func (c *ClientImpl) GetStream(res core.BinaryResponse, authRequired bool, path string, opts ...core.RequestOption) error

func (*ClientImpl) ImpersonatingScopes 

func (c *ClientImpl) ImpersonatingScopes() []string

func (*ClientImpl) ImpersonatingSub 

func (c *ClientImpl) ImpersonatingSub() string

func (*ClientImpl) IsImpersonating 

func (c *ClientImpl) IsImpersonating() bool

func (*ClientImpl) Notifications 

func (c *ClientImpl) Notifications() NotificationsResource

func (*ClientImpl) Offers added in v6.0.13 

func (c *ClientImpl) Offers() OffersResource

func (*ClientImpl) Post 

func (c *ClientImpl) Post(res core.Response, authRequired bool, path string, payload core.Request, opts ...core.RequestOption) error

func (*ClientImpl) PostWithFiles 

func (c *ClientImpl) PostWithFiles(res core.Response, authRequired bool, path string, payload core.Request, files []core.File, opts ...core.RequestOption) error

func (*ClientImpl) SetHttpClient 

func (c *ClientImpl) SetHttpClient(httpClient core.HttpClient)

func (*ClientImpl) SignatureRequests added in v6.0.10 

func (c *ClientImpl) SignatureRequests() SignatureRequestsResource

func (*ClientImpl) StartImpersonating 

func (c *ClientImpl) StartImpersonating(sub string, scopes []string) error

func (*ClientImpl) StopImpersonating 

func (c *ClientImpl) StopImpersonating()

func (*ClientImpl) Transactions 

func (c *ClientImpl) Transactions() TransactionsResource

func (*ClientImpl) UserManagement 

func (c *ClientImpl) UserManagement() UserManagementResource

func (*ClientImpl) Users 

func (c *ClientImpl) Users() UsersResource

type ConditionalLinking added in v6.0.22 

type ConditionalLinking struct {
	LinkId        string `json:"link_id,omitempty"`
	LinkNamespace string `json:"link_namespace,omitempty"`
	Rule          string `json:"rule,omitempty"`
	Terms         string `json:"terms,omitempty"`
}

type Contact 

type Contact struct {
	Id              string         `json:"id,omitempty"`
	Address         *Address       `json:"address,omitempty"`
	Agent           *Agent         `json:"agent,omitempty"`
	AvatarUrl       string         `json:"avatar_url,omitempty"`
	BrandLogoUrl    string         `json:"brand_logo_url,omitempty"`
	CellPhone       string         `json:"cell_phone,omitempty"`
	ContactSource   *ContactSource `json:"contact_source,omitempty"`
	Email           string         `json:"email,omitempty"`
	EntityName      string         `json:"entity_name,omitempty"`
	EntityType      string         `json:"entity_type,omitempty"`
	FaxPhone        string         `json:"fax_phone,omitempty"`
	FirstName       string         `json:"first_name"`
	LastName        string         `json:"last_name,omitempty"`
	PersonalWebsite string         `json:"personal_website,omitempty"`
	TeamId          string         `json:"team_id,omitempty"`
	Title           string         `json:"title,omitempty"`
	Object          string         `json:"object,omitempty"`
}

func (Contact) IsRef 

func (m Contact) IsRef() bool

type Contact1 added in v6.0.22 

type Contact1 struct {
	Email     string `json:"email,omitempty"`
	FirstName string `json:"first_name,omitempty"`
	LastName  string `json:"last_name,omitempty"`
	Object    string `json:"object,omitempty"`
}

func (Contact1) IsRef added in v6.0.22 

func (m Contact1) IsRef() bool

type ContactCreate 

type ContactCreate struct {
	Contact *ContactRequest `json:"contact"`
}

type ContactCreateResponse 

type ContactCreateResponse struct {
	Contact *Contact `json:"contact,omitempty"`
	Object  string   `json:"object,omitempty"`
}

func (ContactCreateResponse) IsRef 

func (m ContactCreateResponse) IsRef() bool

type ContactList 

type ContactList struct {
	Data       []Contact `json:"data"`
	ListObject string    `json:"list_object"`
	Object     string    `json:"object"`
	HasMore    bool      `json:"has_more"`
}

func (ContactList) IsRef 

func (m ContactList) IsRef() bool

func (ContactList) NextPageParams 

func (m ContactList) NextPageParams() core.PageParams

type ContactRequest 

type ContactRequest struct {
	Address         *Address       `json:"address,omitempty"`
	AddressId       string         `json:"address_id,omitempty"`
	Agent           *AgentRequest  `json:"agent,omitempty"`
	AvatarUrl       string         `json:"avatar_url,omitempty"`
	BrandLogoUrl    string         `json:"brand_logo_url,omitempty"`
	CellPhone       string         `json:"cell_phone,omitempty"`
	ContactSource   *ContactSource `json:"contact_source,omitempty"`
	Email           string         `json:"email,omitempty"`
	EntityName      string         `json:"entity_name,omitempty"`
	EntityType      string         `json:"entity_type,omitempty"`
	FaxPhone        string         `json:"fax_phone,omitempty"`
	FirstName       string         `json:"first_name"`
	LastName        string         `json:"last_name,omitempty"`
	PersonalWebsite string         `json:"personal_website,omitempty"`
	Title           string         `json:"title,omitempty"`
}

type ContactSource 

type ContactSource struct {
	Id     string `json:"id,omitempty"`
	Origin string `json:"origin,omitempty"`
	Object string `json:"object,omitempty"`
}

func (ContactSource) IsRef 

func (m ContactSource) IsRef() bool

type ContactSourceRequest 

type ContactSourceRequest struct {
	Id     string `json:"id,omitempty"`
	Origin string `json:"origin,omitempty"`
}

type ContactUpdate 

type ContactUpdate struct {
	Contact *ContactRequest `json:"contact,omitempty"`
	Roles   []string        `json:"roles,omitempty"`
}

type ContactUpdateResponse 

type ContactUpdateResponse struct {
	Contact *Contact `json:"contact,omitempty"`
	Id      string   `json:"id_,omitempty"`
	Object  string   `json:"object,omitempty"`
}

func (ContactUpdateResponse) IsRef 

func (m ContactUpdateResponse) IsRef() bool

type ContactsResource 

type ContactsResource interface {
	GetDetail(id string, opts ...core.RequestOption) (*Contact, error)
	GetMulti(ids []string, opts ...core.RequestOption) (*ContactList, error)
	List(opts ...core.RequestOption) (*ContactList, error)
	Create(contactCreate ContactCreate, opts ...core.RequestOption) (*ContactCreateResponse, error)
	Update(id string, contactUpdate ContactUpdate, opts ...core.RequestOption) (*ContactUpdateResponse, error)
}

func GetContactsResource 

func GetContactsResource(client Client) ContactsResource

type CreateResponse 

type CreateResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (CreateResponse) IsRef 

func (m CreateResponse) IsRef() bool

type DeletedParties 

type DeletedParties struct {
	Data   []*DeletedParty `json:"data,omitempty"`
	Object string          `json:"object,omitempty"`
}

func (DeletedParties) IsRef 

func (m DeletedParties) IsRef() bool

type DeletedParty 

type DeletedParty struct {
	Contact   *Contact `json:"contact,omitempty"`
	DeletedAt int      `json:"deleted_at,omitempty"`
	PartyId   string   `json:"party_id,omitempty"`
	Roles     []string `json:"roles,omitempty"`
	Object    string   `json:"object,omitempty"`
}

func (DeletedParty) IsRef 

func (m DeletedParty) IsRef() bool

type Document added in v6.0.11 

type Document struct {
	Id                 string `json:"id"`
	FileName           string `json:"file_name"`
	Object             string `json:"object,omitempty"`
	PspdfkitDocumentId string `json:"pspdfkit_document_id,omitempty"`
}

func (Document) IsRef added in v6.0.11 

func (m Document) IsRef() bool

type DocumentAnalysisAsyncResponse 

type DocumentAnalysisAsyncResponse struct {
	ResultsByFileReferenceId map[string]*DocumentAnalysisResult `json:"results_by_file_reference_id,omitempty"`
	Object                   string                             `json:"object,omitempty"`
}

func (DocumentAnalysisAsyncResponse) IsRef 

func (m DocumentAnalysisAsyncResponse) IsRef() bool

type DocumentAnalysisResult 

type DocumentAnalysisResult struct {
	DatapointExtractionSucceeded *bool        `json:"datapoint_extraction_succeeded"`
	Error                        string       `json:"error,omitempty"`
	FormMatches                  []*FormMatch `json:"form_matches,omitempty"`
	FormMatchingSucceeded        *bool        `json:"form_matching_succeeded"`
	SignatureDetectionSucceeded  *bool        `json:"signature_detection_succeeded"`
	Status                       string       `json:"status,omitempty"`
	Object                       string       `json:"object,omitempty"`
}

func (DocumentAnalysisResult) IsRef 

func (m DocumentAnalysisResult) IsRef() bool

type DocumentFileMeta added in v6.0.11 

type DocumentFileMeta struct {
	FileName string `json:"file_name"`
}

type DocumentMergeSchema 

type DocumentMergeSchema struct {
	DeleteOriginalDocuments       *bool    `json:"delete_original_documents,omitempty"`
	IsAsync                       *bool    `json:"is_async,omitempty"`
	NewDocumentFolderId           string   `json:"new_document_folder_id"`
	NewDocumentTitle              string   `json:"new_document_title"`
	TransactionDocumentVersionIds []string `json:"transaction_document_version_ids,omitempty"`
}

type DocumentPspdfkitDetailsResponse added in v6.0.54 

type DocumentPspdfkitDetailsResponse struct {
	JwtToken           string `json:"jwt_token,omitempty"`
	PspdfkitDocumentId string `json:"pspdfkit_document_id,omitempty"`
	Object             string `json:"object,omitempty"`
}

func (DocumentPspdfkitDetailsResponse) IsRef added in v6.0.54 

func (m DocumentPspdfkitDetailsResponse) IsRef() bool

type DocumentSplitAsyncResponse 

type DocumentSplitAsyncResponse struct {
	ReqId       string                              `json:"req_id,omitempty"`
	Suggestions map[string]*DocumentSplitSuggestion `json:"suggestions,omitempty"`
	Object      string                              `json:"object,omitempty"`
}

func (DocumentSplitAsyncResponse) IsRef 

func (m DocumentSplitAsyncResponse) IsRef() bool

type DocumentSplitResponse 

type DocumentSplitResponse struct {
	ReqId  string                      `json:"req_id,omitempty"`
	Result *DocumentSplitAsyncResponse `json:"result,omitempty"`
	Object string                      `json:"object,omitempty"`
}

func (DocumentSplitResponse) IsRef 

func (m DocumentSplitResponse) IsRef() bool

type DocumentSplitSchema 

type DocumentSplitSchema struct {
	Files   []http.File       `json:"files,omitempty"`
	ReState string            `json:"re_state,omitempty"`
	ReqId   string            `json:"req_id"`
	Uploads []*DocumentUpload `json:"uploads,omitempty"`
}

type DocumentSplitSuggestion 

type DocumentSplitSuggestion struct {
	EndPage      int    `json:"end_page,omitempty"`
	Filename     string `json:"filename,omitempty"`
	FormId       string `json:"form_id,omitempty"`
	FormSeriesId string `json:"form_series_id,omitempty"`
	StartPage    int    `json:"start_page,omitempty"`
	Object       string `json:"object,omitempty"`
}

func (DocumentSplitSuggestion) IsRef 

func (m DocumentSplitSuggestion) IsRef() bool

type DocumentUpload 

type DocumentUpload struct {
	Title string `json:"title,omitempty"`
}

type DocumentUploadResponse added in v6.0.11 

type DocumentUploadResponse struct {
	Documents []*Document    `json:"documents,omitempty"`
	Errors    []*UploadError `json:"errors,omitempty"`
	Object    string         `json:"object,omitempty"`
}

func (DocumentUploadResponse) IsRef added in v6.0.11 

func (m DocumentUploadResponse) IsRef() bool

type DocumentUploadSchema added in v6.0.11 

type DocumentUploadSchema struct {
	Files          []http.File         `json:"files,omitempty"`
	FilesMeta      []*DocumentFileMeta `json:"files_meta,omitempty"`
	CreatePspdfkit bool                `json:"create_pspdfkit,omitempty"`
}

type DocumentZone 

type DocumentZone struct {
	Id               string                  `json:"id,omitempty"`
	FormId           string                  `json:"form_id,omitempty"`
	Kind             string                  `json:"kind,omitempty"`
	Name             string                  `json:"name,omitempty"`
	OriginalLocation []*DocumentZoneLocation `json:"original_location,omitempty"`
	Page             int                     `json:"page,omitempty"`
	Vertices         []*DocumentZoneVertex   `json:"vertices,omitempty"`
	Object           string                  `json:"object,omitempty"`
}

func (DocumentZone) IsRef 

func (m DocumentZone) IsRef() bool

type DocumentZoneLocation 

type DocumentZoneLocation struct {
	XMax   float64 `json:"x_max,omitempty"`
	XMin   float64 `json:"x_min,omitempty"`
	YMax   float64 `json:"y_max,omitempty"`
	YMin   float64 `json:"y_min,omitempty"`
	Object string  `json:"object,omitempty"`
}

func (DocumentZoneLocation) IsRef 

func (m DocumentZoneLocation) IsRef() bool

type DocumentZoneVertex 

type DocumentZoneVertex struct {
	X      int    `json:"x,omitempty"`
	Y      int    `json:"y,omitempty"`
	Object string `json:"object,omitempty"`
}

func (DocumentZoneVertex) IsRef 

func (m DocumentZoneVertex) IsRef() bool

type DocumentsResource 

type DocumentsResource interface {
	AnalyzeSynchronous(analyzeSchema AnalyzeSchema, files []core.File, opts ...core.RequestOption) (*DocumentAnalysisAsyncResponse, error)
	DocumentSplit(documentSplitSchema DocumentSplitSchema, files []core.File, opts ...core.RequestOption) (*DocumentSplitResponse, error)
	DownloadZip(opts ...core.RequestOption) (*BinaryResponse, error)
	PspdfkitDetails(opts ...core.RequestOption) (*DocumentPspdfkitDetailsResponse, error)
	SignatureDetection(signatureDetectionSchema SignatureDetectionSchema, files []core.File, opts ...core.RequestOption) (*SignatureDetectionResponse, error)
	UploadFile(documentUploadSchema DocumentUploadSchema, files []core.File, opts ...core.RequestOption) (*DocumentUploadResponse, error)
	Download(id string, opts ...core.RequestOption) (*BinaryResponse, error)
}

func GetDocumentsResource 

func GetDocumentsResource(client Client) DocumentsResource

type ESignAnnotation added in v6.0.19 

type ESignAnnotation struct {
	Id           string       `json:"id,omitempty"`
	DefaultValue string       `json:"default_value,omitempty"`
	FieldId      string       `json:"field_id,omitempty"`
	FieldParams  *FieldParams `json:"field_params,omitempty"`
	FieldPart    int          `json:"field_part,omitempty"`
	Height       float64      `json:"height,omitempty"`
	IsRequired   *bool        `json:"is_required,omitempty"`
	Kind         string       `json:"kind,omitempty"`
	Left         float64      `json:"left,omitempty"`
	Optional     *bool        `json:"optional,omitempty"`
	OwnerId      string       `json:"owner_id,omitempty"`
	Page         int          `json:"page,omitempty"`
	Top          float64      `json:"top,omitempty"`
	Width        float64      `json:"width,omitempty"`
	Object       string       `json:"object,omitempty"`
}

func (ESignAnnotation) IsRef added in v6.0.22 

func (m ESignAnnotation) IsRef() bool

type ESignFillConfig added in v6.0.19 

type ESignFillConfig struct {
	Annotations []*ESignAnnotation `json:"annotations,omitempty"`
	TdvId       string             `json:"tdv_id,omitempty"`
	Object      string             `json:"object,omitempty"`
}

func (ESignFillConfig) IsRef added in v6.0.22 

func (m ESignFillConfig) IsRef() bool

type Envelope added in v6.0.15 

type Envelope struct {
	Id                string                 `json:"id,omitempty"`
	CreatedAt         int                    `json:"created_at,omitempty"`
	Creator           string                 `json:"creator,omitempty"`
	EnvelopeDocument  *EnvelopeDocumentList  `json:"envelope_document,omitempty"`
	EnvelopeRecipient *EnvelopeRecipientList `json:"envelope_recipient,omitempty"`
	SigningUrl        string                 `json:"signing_url,omitempty"`
	Status            string                 `json:"status,omitempty"`
	Step              *StepList              `json:"step,omitempty"`
	Title             string                 `json:"title,omitempty"`
	Uuid              string                 `json:"uuid,omitempty"`
	Object            string                 `json:"object,omitempty"`
}

func (Envelope) IsRef added in v6.0.15 

func (m Envelope) IsRef() bool

type EnvelopeCancelRevisionResponse added in v6.0.42 

type EnvelopeCancelRevisionResponse struct {
	EnvelopeId string `json:"envelope_id,omitempty"`
	Object     string `json:"object,omitempty"`
}

func (EnvelopeCancelRevisionResponse) IsRef added in v6.0.42 

func (m EnvelopeCancelRevisionResponse) IsRef() bool

type EnvelopeContact added in v6.0.22 

type EnvelopeContact struct {
	Email          string   `json:"email,omitempty"`
	EmailAddresses []string `json:"email_addresses,omitempty"`
	EntityType     string   `json:"entity_type,omitempty"`
	FirstName      string   `json:"first_name,omitempty"`
	LastName       string   `json:"last_name,omitempty"`
	PhoneNumbers   []string `json:"phone_numbers,omitempty"`
}

type EnvelopeCreateIntentSchema added in v6.0.22 

type EnvelopeCreateIntentSchema struct {
	AccessPolicy  *AccessPolicy              `json:"access_policy,omitempty"`
	CallbackPath  string                     `json:"callback_path,omitempty"`
	Documents     []*InitialEnvelopeDocument `json:"documents,omitempty"`
	EmailSubject  string                     `json:"email_subject,omitempty"`
	EmailMessage  string                     `json:"email_message,omitempty"`
	Recipients    []*InitialRecipient        `json:"recipients,omitempty"`
	TransactionId string                     `json:"transaction_id,omitempty"`
}

type EnvelopeCreateResponse added in v6.0.57 

type EnvelopeCreateResponse struct {
	Envelope   *EnvelopeResponse `json:"envelope,omitempty"`
	EnvelopeId string            `json:"envelope_id,omitempty"`
	Object     string            `json:"object,omitempty"`
}

func (EnvelopeCreateResponse) IsRef added in v6.0.57 

func (m EnvelopeCreateResponse) IsRef() bool

type EnvelopeDocument added in v6.0.22 

type EnvelopeDocument struct {
	Id                 string `json:"id,omitempty"`
	EnvelopeDocumentId string `json:"envelope_document_id,omitempty"`
	Filename           string `json:"filename,omitempty"`
	Url                string `json:"url,omitempty"`
	Object             string `json:"object,omitempty"`
}

func (EnvelopeDocument) IsRef added in v6.0.22 

func (m EnvelopeDocument) IsRef() bool

type EnvelopeDocumentList added in v6.0.22 

type EnvelopeDocumentList struct {
	Data       []EnvelopeDocument `json:"data"`
	ListObject string             `json:"list_object"`
	Object     string             `json:"object"`
	HasMore    bool               `json:"has_more"`
}

func (EnvelopeDocumentList) IsRef added in v6.0.22 

func (m EnvelopeDocumentList) IsRef() bool

func (EnvelopeDocumentList) NextPageParams added in v6.0.22 

func (m EnvelopeDocumentList) NextPageParams() core.PageParams

type EnvelopeField added in v6.0.22 

type EnvelopeField struct {
	Id                 string                `json:"id,omitempty"`
	ConditionalLinking []*ConditionalLinking `json:"conditional_linking,omitempty"`
	FillConditions     []*FillCondition      `json:"fill_conditions,omitempty"`
	Kind               string                `json:"kind,omitempty"`
	LinkId             string                `json:"link_id,omitempty"`
	LinkNamespace      string                `json:"link_namespace,omitempty"`
	OverflowPdfFormat  string                `json:"overflow_pdf_format,omitempty"`
	OwnerId            string                `json:"owner_id,omitempty"`
}

type EnvelopeRecipient added in v6.0.22 

type EnvelopeRecipient struct {
	Id             string          `json:"id,omitempty"`
	Contact        *Contact1       `json:"contact,omitempty"`
	ExternalId     string          `json:"external_id,omitempty"`
	Index          int             `json:"index,omitempty"`
	InitialsImage  *SignatureImage `json:"initials_image,omitempty"`
	RecipientRole  string          `json:"recipient_role,omitempty"`
	SignatureImage *SignatureImage `json:"signature_image,omitempty"`
	Object         string          `json:"object,omitempty"`
}

func (EnvelopeRecipient) IsRef added in v6.0.22 

func (m EnvelopeRecipient) IsRef() bool

type EnvelopeRecipientList added in v6.0.22 

type EnvelopeRecipientList struct {
	Data       []EnvelopeRecipient `json:"data"`
	ListObject string              `json:"list_object"`
	Object     string              `json:"object"`
	HasMore    bool                `json:"has_more"`
}

func (EnvelopeRecipientList) IsRef added in v6.0.22 

func (m EnvelopeRecipientList) IsRef() bool

func (EnvelopeRecipientList) NextPageParams added in v6.0.22 

func (m EnvelopeRecipientList) NextPageParams() core.PageParams

type EnvelopeResponse added in v6.0.22 

type EnvelopeResponse struct {
	LatestVersionId string `json:"latest_version_id,omitempty"`
	SigningUrl      string `json:"signing_url,omitempty"`
	Uuid            string `json:"uuid,omitempty"`
	Object          string `json:"object,omitempty"`
}

func (EnvelopeResponse) IsRef added in v6.0.22 

func (m EnvelopeResponse) IsRef() bool

type EnvelopeStartRevisionResponse added in v6.0.42 

type EnvelopeStartRevisionResponse struct {
	EnvelopeId string `json:"envelope_id,omitempty"`
	Object     string `json:"object,omitempty"`
}

func (EnvelopeStartRevisionResponse) IsRef added in v6.0.42 

func (m EnvelopeStartRevisionResponse) IsRef() bool

type EnvelopeVoidResponse added in v6.0.60 

type EnvelopeVoidResponse struct {
	EnvelopeId string `json:"envelope_id,omitempty"`
	Object     string `json:"object,omitempty"`
}

func (EnvelopeVoidResponse) IsRef added in v6.0.60 

func (m EnvelopeVoidResponse) IsRef() bool

type EnvelopeVoidSchema added in v6.0.60 

type EnvelopeVoidSchema struct {
	Message string `json:"message,omitempty"`
}

type EnvelopesResource added in v6.0.15 

type EnvelopesResource interface {
	GetDetail(id string, opts ...core.RequestOption) (*Envelope, error)
	Create(envelopeCreateIntentSchema EnvelopeCreateIntentSchema, opts ...core.RequestOption) (*EnvelopeCreateResponse, error)
	StartRevision(id string, opts ...core.RequestOption) (*EnvelopeStartRevisionResponse, error)
	CancelRevision(id string, opts ...core.RequestOption) (*EnvelopeCancelRevisionResponse, error)
	Void(id string, envelopeVoidSchema EnvelopeVoidSchema, opts ...core.RequestOption) (*EnvelopeVoidResponse, error)
}

func GetEnvelopesResource added in v6.0.15 

func GetEnvelopesResource(client Client) EnvelopesResource

type EsignTabConfig added in v6.0.19 

type EsignTabConfig struct {
	FillConfigs []*ESignFillConfig `json:"fill_configs,omitempty"`
}

type ExtractedField 

type ExtractedField struct {
	ExtractedData          string `json:"extracted_data,omitempty"`
	FormPage               int    `json:"form_page,omitempty"`
	GlideDataDictionaryKey string `json:"glide_data_dictionary_key"`
	Object                 string `json:"object,omitempty"`
}

func (ExtractedField) IsRef 

func (m ExtractedField) IsRef() bool

type Field 

type Field struct {
	Timestamp int                    `json:"timestamp,omitempty"`
	Value     map[string]interface{} `json:"value,omitempty"`
	Object    string                 `json:"object,omitempty"`
}

func (Field) IsRef 

func (m Field) IsRef() bool

type FieldOutOfDateDetail 

type FieldOutOfDateDetail struct {
	ControlTimestamp int    `json:"control_timestamp,omitempty"`
	Timestamp        int    `json:"timestamp,omitempty"`
	Object           string `json:"object,omitempty"`
}

func (FieldOutOfDateDetail) IsRef 

func (m FieldOutOfDateDetail) IsRef() bool

type FieldParams added in v6.0.19 

type FieldParams struct {
	Options []string `json:"options,omitempty"`
	Object  string   `json:"object,omitempty"`
}

func (FieldParams) IsRef added in v6.0.22 

func (m FieldParams) IsRef() bool

type FieldResponse 

type FieldResponse struct {
	Timestamp int                    `json:"timestamp,omitempty"`
	Value     map[string]interface{} `json:"value,omitempty"`
	Object    string                 `json:"object,omitempty"`
}

func (FieldResponse) IsRef 

func (m FieldResponse) IsRef() bool

type FieldResponseWarnings 

type FieldResponseWarnings struct {
	OutOfDateFields map[string]*FieldOutOfDateDetail `json:"out_of_date_fields,omitempty"`
	Object          string                           `json:"object,omitempty"`
}

func (FieldResponseWarnings) IsRef 

func (m FieldResponseWarnings) IsRef() bool

type FieldWrite 

type FieldWrite struct {
	ControlTimestamp int                    `json:"control_timestamp,omitempty"`
	Value            map[string]interface{} `json:"value,omitempty"`
}

type FieldWriteDict 

type FieldWriteDict struct {
	ControlPolicy string                 `json:"control_policy,omitempty"`
	Fields        TransactionFieldsWrite `json:"fields,omitempty"`
}

type FieldsResponse 

type FieldsResponse struct {
	Result        *FieldsResponseResult `json:"result,omitempty"`
	TransactionId string                `json:"transaction_id,omitempty"`
	Object        string                `json:"object,omitempty"`
}

func (FieldsResponse) IsRef 

func (m FieldsResponse) IsRef() bool

type FieldsResponseResult 

type FieldsResponseResult struct {
	Fields   TransactionFields      `json:"fields,omitempty"`
	Warnings *FieldResponseWarnings `json:"warnings,omitempty"`
	Object   string                 `json:"object,omitempty"`
}

func (FieldsResponseResult) IsRef 

func (m FieldsResponseResult) IsRef() bool

type FileMeta 

type FileMeta struct {
	Data                       http.File `json:"data,omitempty"`
	FileName                   string    `json:"file_name"`
	FileReferenceId            string    `json:"file_reference_id"`
	IncludeDatapointExtraction *bool     `json:"include_datapoint_extraction,omitempty"`
	IncludeFormMatching        *bool     `json:"include_form_matching,omitempty"`
	IncludeSignatureDetection  *bool     `json:"include_signature_detection,omitempty"`
	MimeType                   string    `json:"mime_type,omitempty"`
	StateCode                  string    `json:"state_code"`
	Url                        string    `json:"url,omitempty"`
}

type FillCondition added in v6.0.22 

type FillCondition struct {
	Id      string `json:"id,omitempty"`
	Level   string `json:"level,omitempty"`
	Message string `json:"message,omitempty"`
	Rule    string `json:"rule,omitempty"`
	Terms   string `json:"terms,omitempty"`
}

type FillConfig added in v6.0.22 

type FillConfig struct {
	Annotations        []*Annotations      `json:"annotations,omitempty"`
	ReformForm         *Form               `json:"reform_form,omitempty"`
	ReformFormPrepared *ReformFormPrepared `json:"reform_form_prepared,omitempty"`
}

type Folder 

type Folder struct {
	Id                        string                     `json:"id,omitempty"`
	Can                       map[string]*bool           `json:"can,omitempty"`
	IntegratedServicesPartner *IntegratedServicesPartner `json:"integrated_services_partner,omitempty"`
	Kind                      string                     `json:"kind,omitempty"`
	LastModified              int                        `json:"last_modified,omitempty"`
	OrderIndex                int                        `json:"order_index,omitempty"`
	PropertyInfo              *PropertyInfo              `json:"property_info,omitempty"`
	Title                     string                     `json:"title,omitempty"`
	TransactionDocuments      *TransactionDocumentList   `json:"transaction_documents,omitempty"`
	TransactionPackage        *TransactionPackage        `json:"transaction_package,omitempty"`
	Object                    string                     `json:"object,omitempty"`
}

func (Folder) IsRef 

func (m Folder) IsRef() bool

type FolderCreate 

type FolderCreate struct {
	IntegratedServicesPartner *FolderCreateIntegratedServicesPartner `json:"integrated_services_partner,omitempty"`
	Kind                      int                                    `json:"kind,omitempty"`
	Title                     string                                 `json:"title,omitempty"`
}

type FolderCreateIntegratedServicesPartner added in v6.0.45 

type FolderCreateIntegratedServicesPartner struct {
	DisplayName string `json:"display_name,omitempty"`
	EnumValue   int    `json:"enum_value,omitempty"`
}

type FolderCreates 

type FolderCreates struct {
	Creates []*FolderCreate `json:"creates,omitempty"`
}

type FolderCreatesResponse 

type FolderCreatesResponse struct {
	Result        *FolderCreatesResponseResult `json:"result,omitempty"`
	TransactionId string                       `json:"transaction_id,omitempty"`
	Object        string                       `json:"object,omitempty"`
}

func (FolderCreatesResponse) IsRef 

func (m FolderCreatesResponse) IsRef() bool

type FolderCreatesResponseResult 

type FolderCreatesResponseResult struct {
	FolderIds []string `json:"folder_ids,omitempty"`
	Object    string   `json:"object,omitempty"`
}

func (FolderCreatesResponseResult) IsRef 

func (m FolderCreatesResponseResult) IsRef() bool

type FolderList 

type FolderList struct {
	Data       []Folder `json:"data"`
	ListObject string   `json:"list_object"`
	Object     string   `json:"object"`
	HasMore    bool     `json:"has_more"`
}

func (FolderList) IsRef 

func (m FolderList) IsRef() bool

func (FolderList) NextPageParams 

func (m FolderList) NextPageParams() core.PageParams

type FolderRename 

type FolderRename struct {
	FolderId string `json:"folder_id,omitempty"`
	Title    string `json:"title,omitempty"`
}

type FolderRenames 

type FolderRenames struct {
	Renames []*FolderRename `json:"renames,omitempty"`
}

type FolderRenamesResponse 

type FolderRenamesResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (FolderRenamesResponse) IsRef 

func (m FolderRenamesResponse) IsRef() bool

type FoldersResource 

type FoldersResource interface {
	GetDetail(transactionId string, id string, opts ...core.RequestOption) (*Folder, error)
	GetMulti(transactionId string, ids []string, opts ...core.RequestOption) (*FolderList, error)
	List(transactionId string, opts ...core.RequestOption) (*FolderList, error)
}

func GetFoldersResource 

func GetFoldersResource(client Client) FoldersResource

type Form added in v6.0.22 

type Form struct {
	Fields []*EnvelopeField `json:"fields,omitempty"`
}

type FormImportsResponse 

type FormImportsResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (FormImportsResponse) IsRef 

func (m FormImportsResponse) IsRef() bool

type FormMatch 

type FormMatch struct {
	EndPage                 int                         `json:"end_page"`
	ExtractedFields         []*ExtractedField           `json:"extracted_fields,omitempty"`
	Form                    *GlideForm                  `json:"form,omitempty"`
	Score                   float64                     `json:"score,omitempty"`
	SignatureResultsByParty map[string]*SignatureResult `json:"signature_results_by_party,omitempty"`
	StartPage               int                         `json:"start_page"`
	Object                  string                      `json:"object,omitempty"`
}

func (FormMatch) IsRef 

func (m FormMatch) IsRef() bool

type GetSignatureRequestFlowDocumentsResponse added in v6.0.16 

type GetSignatureRequestFlowDocumentsResponse struct {
	DestinationFolderId          string                                         `json:"destination_folder_id,omitempty"`
	HideFieldMoveOriginalToTrash *bool                                          `json:"hide_field_move_original_to_trash,omitempty"`
	LockedTransactionDocumentIds []string                                       `json:"locked_transaction_document_ids,omitempty"`
	MakeDocumentsVisibleInCd     *bool                                          `json:"make_documents_visible_in_cd,omitempty"`
	MoveOriginalToTrash          *bool                                          `json:"move_original_to_trash,omitempty"`
	TransactionDocumentIds       []string                                       `json:"transaction_document_ids,omitempty"`
	TransactionDocuments         []*SignatureRequestExpandedTransactionDocument `json:"transaction_documents,omitempty"`
	Object                       string                                         `json:"object,omitempty"`
}

func (GetSignatureRequestFlowDocumentsResponse) IsRef added in v6.0.16 

func (m GetSignatureRequestFlowDocumentsResponse) IsRef() bool

type GetSignatureRequestFlowRecipientsResponse added in v6.0.26 

type GetSignatureRequestFlowRecipientsResponse struct {
	IsSigningOrderApplied *bool        `json:"is_signing_order_applied,omitempty"`
	LockedOrderSignerKeys []string     `json:"locked_order_signer_keys,omitempty"`
	LockedSignerKeys      []string     `json:"locked_signer_keys,omitempty"`
	Recipients            []*Recipient `json:"recipients,omitempty"`
	Object                string       `json:"object,omitempty"`
}

func (GetSignatureRequestFlowRecipientsResponse) IsRef added in v6.0.26 

func (m GetSignatureRequestFlowRecipientsResponse) IsRef() bool

type GetSignatureRequestFlowReviewResponse added in v6.0.24 

type GetSignatureRequestFlowReviewResponse struct {
	MakeDocumentsVisibleInCd *bool                                          `json:"make_documents_visible_in_cd,omitempty"`
	MessageBody              string                                         `json:"message_body,omitempty"`
	MessageSubject           string                                         `json:"message_subject,omitempty"`
	Recipients               []*Recipient                                   `json:"recipients,omitempty"`
	Subject                  string                                         `json:"subject,omitempty"`
	TransactionDocumentIds   []string                                       `json:"transaction_document_ids,omitempty"`
	TransactionDocuments     []*SignatureRequestExpandedTransactionDocument `json:"transaction_documents,omitempty"`
	Object                   string                                         `json:"object,omitempty"`
}

func (GetSignatureRequestFlowReviewResponse) IsRef added in v6.0.24 

func (m GetSignatureRequestFlowReviewResponse) IsRef() bool

type GlideForm 

type GlideForm struct {
	GlideFormSeriesId int      `json:"glide_form_series_id"`
	Tags              []string `json:"tags,omitempty"`
	Title             string   `json:"title"`
	Object            string   `json:"object,omitempty"`
}

func (GlideForm) IsRef 

func (m GlideForm) IsRef() bool

type Imports added in v6.0.22 

type Imports struct {
	Id    string `json:"id,omitempty"`
	Alias string `json:"alias,omitempty"`
}

type InitialEnvelopeDocument added in v6.0.22 

type InitialEnvelopeDocument struct {
	Id          string                 `json:"id,omitempty"`
	Annotations []*SignatureAnnotation `json:"annotations,omitempty"`
	ExternalId  string                 `json:"external_id,omitempty"`
}

type InitialRecipient added in v6.0.57 

type InitialRecipient struct {
	Contact       *EnvelopeContact `json:"contact,omitempty"`
	ExternalId    string           `json:"external_id,omitempty"`
	RecipientRole string           `json:"recipient_role,omitempty"`
	Source        *RecipientSource `json:"source,omitempty"`
}

type IntegratedServicesPartner added in v6.0.41 

type IntegratedServicesPartner struct {
	BannerDismissed *bool  `json:"banner_dismissed,omitempty"`
	DisplayName     string `json:"display_name,omitempty"`
	EnumValue       int    `json:"enum_value,omitempty"`
	Object          string `json:"object,omitempty"`
}

func (IntegratedServicesPartner) IsRef added in v6.0.41 

func (m IntegratedServicesPartner) IsRef() bool

type ItemDeletes 

type ItemDeletes struct {
	Ids []string `json:"ids,omitempty"`
}

type ItemDeletesResponse 

type ItemDeletesResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (ItemDeletesResponse) IsRef 

func (m ItemDeletesResponse) IsRef() bool

type Member added in v6.0.5 

type Member struct {
	Id     string `json:"id,omitempty"`
	Offer  *Offer `json:"offer,omitempty"`
	Object string `json:"object,omitempty"`
}

func (Member) IsRef added in v6.0.5 

func (m Member) IsRef() bool

type MergeDocumentsResponse 

type MergeDocumentsResponse struct {
	IsDelayed     *bool  `json:"is_delayed,omitempty"`
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (MergeDocumentsResponse) IsRef 

func (m MergeDocumentsResponse) IsRef() bool

type NewContactRecipient added in v6.0.10 

type NewContactRecipient struct {
	Contact *Contact `json:"contact,omitempty"`
	Roles   []string `json:"roles,omitempty"`
	Object  string   `json:"object,omitempty"`
}

func (NewContactRecipient) IsRef added in v6.0.22 

func (m NewContactRecipient) IsRef() bool

type Notification 

type Notification struct {
	Bcc              []string               `json:"bcc,omitempty"`
	Cc               []string               `json:"cc,omitempty"`
	Context          map[string]interface{} `json:"context,omitempty"`
	IncludeSignature *bool                  `json:"include_signature,omitempty"`
	Recipients       []string               `json:"recipients,omitempty"`
	SeparateEmails   *bool                  `json:"separate_emails,omitempty"`
	Template         string                 `json:"template"`
}

type NotificationResponse 

type NotificationResponse struct {
	Results []string `json:"results"`
	Object  string   `json:"object,omitempty"`
}

func (NotificationResponse) IsRef 

func (m NotificationResponse) IsRef() bool

type NotificationsResource 

type NotificationsResource interface {
	SendEmail(notification Notification, opts ...core.RequestOption) (*NotificationResponse, error)
}

func GetNotificationsResource 

func GetNotificationsResource(client Client) NotificationsResource

type Offer added in v6.0.5 

type Offer struct {
	Id              string   `json:"id,omitempty"`
	Archived        *bool    `json:"archived,omitempty"`
	Favorite        *bool    `json:"favorite,omitempty"`
	Notifications   []string `json:"notifications,omitempty"`
	Status          string   `json:"status,omitempty"`
	TransactionSide string   `json:"transaction_side,omitempty"`
	Object          string   `json:"object,omitempty"`
}

func (Offer) IsRef added in v6.0.5 

func (m Offer) IsRef() bool

type OfferPartiesResource added in v6.0.15 

type OfferPartiesResource interface {
	GetDetail(id string, opts ...core.RequestOption) (*OfferPartiesResponse, error)
}

func GetOfferPartiesResource added in v6.0.15 

func GetOfferPartiesResource(client Client) OfferPartiesResource

type OfferPartiesResponse added in v6.0.13 

type OfferPartiesResponse struct {
	Data   []*OfferParty `json:"data,omitempty"`
	Object string        `json:"object,omitempty"`
}

func (OfferPartiesResponse) IsRef added in v6.0.13 

func (m OfferPartiesResponse) IsRef() bool

type OfferParty added in v6.0.22 

type OfferParty struct {
	Id               string       `json:"id,omitempty"`
	ClientVisibility string       `json:"client_visibility,omitempty"`
	Contact          *Contact     `json:"contact,omitempty"`
	CreatedAt        int          `json:"created_at,omitempty"`
	Roles            []string     `json:"roles,omitempty"`
	Transaction      *Transaction `json:"transaction,omitempty"`
	UpdatedAt        int          `json:"updated_at,omitempty"`
	UserId           string       `json:"user_id,omitempty"`
	Object           string       `json:"object,omitempty"`
}

func (OfferParty) IsRef added in v6.0.22 

func (m OfferParty) IsRef() bool

type OffersResource added in v6.0.13 

type OffersResource interface {
	OfferParties() OfferPartiesResource
	List(opts ...core.RequestOption) (*OffersResponse, error)
}

func GetOffersResource added in v6.0.13 

func GetOffersResource(client Client) OffersResource

type OffersResponse added in v6.0.13 

type OffersResponse struct {
	Data   string `json:"data,omitempty"`
	Object string `json:"object,omitempty"`
}

func (OffersResponse) IsRef added in v6.0.13 

func (m OffersResponse) IsRef() bool

type Output added in v6.0.22 

type Output struct {
	Id      string     `json:"id,omitempty"`
	Handler string     `json:"handler,omitempty"`
	Imports []*Imports `json:"imports,omitempty"`
	OutKind string     `json:"out_kind,omitempty"`
}

type PartiesResource 

type PartiesResource interface {
	GetDetail(transactionId string, id string, opts ...core.RequestOption) (*Party, error)
	GetMulti(transactionId string, ids []string, opts ...core.RequestOption) (*PartyList, error)
	List(transactionId string, opts ...core.RequestOption) (*PartyList, error)
}

func GetPartiesResource 

func GetPartiesResource(client Client) PartiesResource

type PartnerFolderUploadsResponse added in v6.0.58 

type PartnerFolderUploadsResponse struct {
	Result        *TransactionDocumentUploadResult `json:"result,omitempty"`
	TransactionId string                           `json:"transaction_id,omitempty"`
	Object        string                           `json:"object,omitempty"`
}

func (PartnerFolderUploadsResponse) IsRef added in v6.0.58 

func (m PartnerFolderUploadsResponse) IsRef() bool

type Party 

type Party struct {
	Id               string       `json:"id,omitempty"`
	ClientVisibility string       `json:"client_visibility,omitempty"`
	Contact          *Contact     `json:"contact,omitempty"`
	CreatedAt        int          `json:"created_at,omitempty"`
	Roles            []string     `json:"roles,omitempty"`
	Transaction      *Transaction `json:"transaction,omitempty"`
	UpdatedAt        int          `json:"updated_at,omitempty"`
	UserId           string       `json:"user_id,omitempty"`
	Object           string       `json:"object,omitempty"`
}

func (Party) IsRef 

func (m Party) IsRef() bool

type PartyCreate 

type PartyCreate struct {
	Body                  string          `json:"body,omitempty"`
	ClientVisibility      string          `json:"client_visibility,omitempty"`
	Contact               *ContactRequest `json:"contact,omitempty"`
	Invite                *bool           `json:"invite,omitempty"`
	InviteRestrictions    []string        `json:"invite_restrictions,omitempty"`
	PromoteToPrimaryAgent *bool           `json:"promote_to_primary_agent,omitempty"`
	Roles                 []string        `json:"roles,omitempty"`
	Subject               string          `json:"subject,omitempty"`
	SuppressInviteEmail   *bool           `json:"suppress_invite_email,omitempty"`
	TeamId                string          `json:"team_id,omitempty"`
}

type PartyCreates 

type PartyCreates struct {
	Creates []*PartyCreate `json:"creates"`
}

type PartyCreatesResponse 

type PartyCreatesResponse struct {
	Result        *PartyCreatesResult `json:"result,omitempty"`
	TransactionId string              `json:"transaction_id,omitempty"`
	Object        string              `json:"object,omitempty"`
}

func (PartyCreatesResponse) IsRef 

func (m PartyCreatesResponse) IsRef() bool

type PartyCreatesResult added in v6.0.22 

type PartyCreatesResult struct {
	Parties []*Party `json:"parties,omitempty"`
	Object  string   `json:"object,omitempty"`
}

func (PartyCreatesResult) IsRef added in v6.0.22 

func (m PartyCreatesResult) IsRef() bool

type PartyInvite 

type PartyInvite struct {
	Body                string   `json:"body,omitempty"`
	InviteRestrictions  []string `json:"invite_restrictions,omitempty"`
	PartyId             string   `json:"party_id"`
	Subject             string   `json:"subject,omitempty"`
	SuppressInviteEmail *bool    `json:"suppress_invite_email,omitempty"`
}

type PartyInvites 

type PartyInvites struct {
	Invites []*PartyInvite `json:"invites"`
}

type PartyInvitesResponse 

type PartyInvitesResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (PartyInvitesResponse) IsRef 

func (m PartyInvitesResponse) IsRef() bool

type PartyList 

type PartyList struct {
	Data       []Party `json:"data"`
	ListObject string  `json:"list_object"`
	Object     string  `json:"object"`
	HasMore    bool    `json:"has_more"`
}

func (PartyList) IsRef 

func (m PartyList) IsRef() bool

func (PartyList) NextPageParams 

func (m PartyList) NextPageParams() core.PageParams

type PartyPatch 

type PartyPatch struct {
	ClientVisibility string          `json:"client_visibility,omitempty"`
	Contact          *ContactRequest `json:"contact,omitempty"`
	PartyId          string          `json:"party_id,omitempty"`
	Roles            []string        `json:"roles,omitempty"`
	TeamId           string          `json:"team_id,omitempty"`
}

type PartyPatches 

type PartyPatches struct {
	Patches []*PartyPatch `json:"patches,omitempty"`
}

type PartyPatchesResponse 

type PartyPatchesResponse struct {
	Result        *PartyPatchesResult `json:"result,omitempty"`
	TransactionId string              `json:"transaction_id,omitempty"`
	Object        string              `json:"object,omitempty"`
}

func (PartyPatchesResponse) IsRef 

func (m PartyPatchesResponse) IsRef() bool

type PartyPatchesResult added in v6.0.22 

type PartyPatchesResult struct {
	Parties []*Party `json:"parties,omitempty"`
	Object  string   `json:"object,omitempty"`
}

func (PartyPatchesResult) IsRef added in v6.0.22 

func (m PartyPatchesResult) IsRef() bool

type PartyRecipient added in v6.0.10 

type PartyRecipient struct {
	Id      string   `json:"id,omitempty"`
	Contact *Contact `json:"contact,omitempty"`
	Roles   []string `json:"roles,omitempty"`
	Vers    string   `json:"vers,omitempty"`
	Object  string   `json:"object,omitempty"`
}

func (PartyRecipient) IsRef added in v6.0.22 

func (m PartyRecipient) IsRef() bool

type PartyRemove 

type PartyRemove struct {
	PartyId string `json:"party_id,omitempty"`
}

type PartyRemoves 

type PartyRemoves struct {
	Removes []*PartyRemove `json:"removes,omitempty"`
}

type PartyRemovesResponse 

type PartyRemovesResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (PartyRemovesResponse) IsRef 

func (m PartyRemovesResponse) IsRef() bool

type PartyRoles 

type PartyRoles struct {
	Data   []string `json:"data,omitempty"`
	Object string   `json:"object,omitempty"`
}

func (PartyRoles) IsRef 

func (m PartyRoles) IsRef() bool

type PartyUpdateContactDetails 

type PartyUpdateContactDetails struct {
	ClientVisibility      string          `json:"client_visibility,omitempty"`
	Contact               *ContactRequest `json:"contact,omitempty"`
	PartyId               string          `json:"party_id,omitempty"`
	PromoteToPrimaryAgent *bool           `json:"promote_to_primary_agent,omitempty"`
	Roles                 []string        `json:"roles,omitempty"`
	TeamId                string          `json:"team_id,omitempty"`
}

type PartyUpdateContactDetailsResponse 

type PartyUpdateContactDetailsResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (PartyUpdateContactDetailsResponse) IsRef 

func (m PartyUpdateContactDetailsResponse) IsRef() bool

type PartyUpdateContactSource 

type PartyUpdateContactSource struct {
	ContactSource *ContactSource `json:"contact_source,omitempty"`
	PartyId       string         `json:"party_id"`
}

type PartyUpdateContactSourceResponse 

type PartyUpdateContactSourceResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (PartyUpdateContactSourceResponse) IsRef 

func (m PartyUpdateContactSourceResponse) IsRef() bool

type PropertiesInfoResource added in v6.0.5 

type PropertiesInfoResource interface {
	GetDetail(transactionId string, id string, opts ...core.RequestOption) (*PropertyInfo, error)
	GetMulti(transactionId string, ids []string, opts ...core.RequestOption) (*PropertyInfoList, error)
	List(transactionId string, opts ...core.RequestOption) (*PropertyInfoList, error)
}

func GetPropertiesInfoResource added in v6.0.5 

func GetPropertiesInfoResource(client Client) PropertiesInfoResource

type PropertyInfo added in v6.0.5 

type PropertyInfo struct {
	Id           string       `json:"id,omitempty"`
	Address      *Address     `json:"address,omitempty"`
	EmailAddress string       `json:"email_address,omitempty"`
	IsSecondary  *bool        `json:"is_secondary,omitempty"`
	PropertyType string       `json:"property_type,omitempty"`
	Transaction  *Transaction `json:"transaction,omitempty"`
	Object       string       `json:"object,omitempty"`
}

func (PropertyInfo) IsRef added in v6.0.5 

func (m PropertyInfo) IsRef() bool

type PropertyInfoList added in v6.0.5 

type PropertyInfoList struct {
	Data       []PropertyInfo `json:"data"`
	ListObject string         `json:"list_object"`
	Object     string         `json:"object"`
	HasMore    bool           `json:"has_more"`
}

func (PropertyInfoList) IsRef added in v6.0.5 

func (m PropertyInfoList) IsRef() bool

func (PropertyInfoList) NextPageParams added in v6.0.5 

func (m PropertyInfoList) NextPageParams() core.PageParams

type Recipient added in v6.0.10 

type Recipient struct {
	Key           string                `json:"key,omitempty"`
	Kind          string                `json:"kind,omitempty"`
	NewContact    *NewContactRecipient  `json:"new_contact,omitempty"`
	Order         int                   `json:"order,omitempty"`
	Party         *PartyRecipient       `json:"party,omitempty"`
	RecipientRole string                `json:"recipient_role,omitempty"`
	UserContact   *UserContactRecipient `json:"user_contact,omitempty"`
	Object        string                `json:"object,omitempty"`
}

func (Recipient) IsRef added in v6.0.22 

func (m Recipient) IsRef() bool

type RecipientSource added in v6.0.22 

type RecipientSource struct {
	Kind        string       `json:"kind,omitempty"`
	UserContact *UserContact `json:"user_contact,omitempty"`
}

type ReformFormPrepareField added in v6.0.22 

type ReformFormPrepareField struct {
	Id                 string                `json:"id,omitempty"`
	ConditionalLinking []*ConditionalLinking `json:"conditional_linking,omitempty"`
	FillConditions     []*FillCondition      `json:"fill_conditions,omitempty"`
	Kind               string                `json:"kind,omitempty"`
	LinkId             string                `json:"link_id,omitempty"`
	LinkNamespace      string                `json:"link_namespace,omitempty"`
	OverflowPdfFormat  string                `json:"overflow_pdf_format,omitempty"`
	OwnerId            string                `json:"owner_id,omitempty"`
	Validations        []*Validation         `json:"validations,omitempty"`
}

type ReformFormPrepared added in v6.0.22 

type ReformFormPrepared struct {
	Fields  []*ReformFormPrepareField `json:"fields,omitempty"`
	Outputs []*Output                 `json:"outputs,omitempty"`
}

type ReorderFoldersResponse 

type ReorderFoldersResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (ReorderFoldersResponse) IsRef 

func (m ReorderFoldersResponse) IsRef() bool

type Signature added in v6.0.22 

type Signature struct {
	Kind   string `json:"kind,omitempty"`
	Text   string `json:"text,omitempty"`
	Object string `json:"object,omitempty"`
}

func (Signature) IsRef added in v6.0.22 

func (m Signature) IsRef() bool

type SignatureAnnotation added in v6.0.57 

type SignatureAnnotation struct {
	Id             string                     `json:"id,omitempty"`
	Color          string                     `json:"color,omitempty"`
	ExtraParams    *SignatureAnnotationParams `json:"extra_params,omitempty"`
	FieldId        string                     `json:"field_id,omitempty"`
	Height         float64                    `json:"height,omitempty"`
	Kind           string                     `json:"kind,omitempty"`
	Left           float64                    `json:"left,omitempty"`
	MultiPartIndex int                        `json:"multi_part_index,omitempty"`
	Optional       *bool                      `json:"optional,omitempty"`
	PageIndex      int                        `json:"page_index,omitempty"`
	ReadOnly       *bool                      `json:"read_only,omitempty"`
	RecipientId    string                     `json:"recipient_id,omitempty"`
	Top            float64                    `json:"top,omitempty"`
	Width          float64                    `json:"width,omitempty"`
}

type SignatureAnnotationParams added in v6.0.57 

type SignatureAnnotationParams struct {
	AllowInput   *bool                  `json:"allow_input,omitempty"`
	DefaultValue map[string]interface{} `json:"default_value,omitempty"`
	ExportValue  map[string]interface{} `json:"export_value,omitempty"`
	Options      []string               `json:"options,omitempty"`
}

type SignatureDetectionAnalysisResult 

type SignatureDetectionAnalysisResult struct {
	DocumentZone *DocumentZone `json:"document_zone,omitempty"`
	Score        float64       `json:"score,omitempty"`
	Object       string        `json:"object,omitempty"`
}

func (SignatureDetectionAnalysisResult) IsRef 

func (m SignatureDetectionAnalysisResult) IsRef() bool

type SignatureDetectionAsyncResponse 

type SignatureDetectionAsyncResponse struct {
	ReqId      string                                       `json:"req_id,omitempty"`
	Signatures map[string]*SignatureDetectionAnalysisResult `json:"signatures,omitempty"`
	Object     string                                       `json:"object,omitempty"`
}

func (SignatureDetectionAsyncResponse) IsRef 

func (m SignatureDetectionAsyncResponse) IsRef() bool

type SignatureDetectionResponse 

type SignatureDetectionResponse struct {
	ReqId  string                           `json:"req_id,omitempty"`
	Result *SignatureDetectionAsyncResponse `json:"result,omitempty"`
	Object string                           `json:"object,omitempty"`
}

func (SignatureDetectionResponse) IsRef 

func (m SignatureDetectionResponse) IsRef() bool

type SignatureDetectionSchema 

type SignatureDetectionSchema struct {
	Files   []http.File       `json:"files,omitempty"`
	Uploads []*DocumentUpload `json:"uploads,omitempty"`
}

type SignatureImage added in v6.0.22 

type SignatureImage struct {
	DocumentId string     `json:"document_id,omitempty"`
	Signature  *Signature `json:"signature,omitempty"`
	Object     string     `json:"object,omitempty"`
}

func (SignatureImage) IsRef added in v6.0.22 

func (m SignatureImage) IsRef() bool

type SignatureIntent added in v6.0.22 

type SignatureIntent struct {
	MaxLength int `json:"max_length,omitempty"`
}

type SignatureRequest added in v6.0.11 

type SignatureRequest struct {
	Id               string                       `json:"id,omitempty"`
	Activities       *ActivityListWithCursor      `json:"activities,omitempty"`
	CompletedAt      int                          `json:"completed_at,omitempty"`
	CreatedAt        int                          `json:"created_at,omitempty"`
	CurrentFlowPage  string                       `json:"current_flow_page,omitempty"`
	DealId           string                       `json:"deal_id,omitempty"`
	Documents        []*SignatureRequestDocument  `json:"documents,omitempty"`
	EnvelopeId       string                       `json:"envelope_id,omitempty"`
	FlowId           string                       `json:"flow_id,omitempty"`
	IsArchived       *bool                        `json:"is_archived,omitempty"`
	Message          string                       `json:"message,omitempty"`
	Provider         string                       `json:"provider,omitempty"`
	Recipients       []*SignatureRequestRecipient `json:"recipients,omitempty"`
	RevisionFlowId   string                       `json:"revision_flow_id,omitempty"`
	SentAt           int                          `json:"sent_at,omitempty"`
	SignNowUrl       string                       `json:"sign_now_url,omitempty"`
	Status           string                       `json:"status,omitempty"`
	Title            string                       `json:"title,omitempty"`
	TransactionId    string                       `json:"transaction_id,omitempty"`
	TransactionTitle string                       `json:"transaction_title,omitempty"`
	UpdatedAt        int                          `json:"updated_at,omitempty"`
	Object           string                       `json:"object,omitempty"`
}

func (SignatureRequest) IsRef added in v6.0.11 

func (m SignatureRequest) IsRef() bool

type SignatureRequestArchiveResponse added in v6.0.36 

type SignatureRequestArchiveResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (SignatureRequestArchiveResponse) IsRef added in v6.0.36 

func (m SignatureRequestArchiveResponse) IsRef() bool

type SignatureRequestDocument added in v6.0.11 

type SignatureRequestDocument struct {
	Id                 string `json:"id,omitempty"`
	EnvelopeDocumentId string `json:"envelope_document_id,omitempty"`
	LatestVersionId    string `json:"latest_version_id,omitempty"`
	Name               string `json:"name,omitempty"`
	Seq                int    `json:"seq,omitempty"`
	Object             string `json:"object,omitempty"`
}

func (SignatureRequestDocument) IsRef added in v6.0.11 

func (m SignatureRequestDocument) IsRef() bool

type SignatureRequestDuplicateResponse added in v6.0.31 

type SignatureRequestDuplicateResponse struct {
	FlowId             string `json:"flow_id,omitempty"`
	SignatureRequestId string `json:"signature_request_id,omitempty"`
	Object             string `json:"object,omitempty"`
}

func (SignatureRequestDuplicateResponse) IsRef added in v6.0.31 

func (m SignatureRequestDuplicateResponse) IsRef() bool

type SignatureRequestExpandedTransactionDocument added in v6.0.24 

type SignatureRequestExpandedTransactionDocument struct {
	Id                 string `json:"id,omitempty"`
	EnvelopeDocumentId string `json:"envelope_document_id,omitempty"`
	LastModified       int    `json:"last_modified,omitempty"`
	LatestVersionId    string `json:"latest_version_id,omitempty"`
	SignatureStatus    string `json:"signature_status,omitempty"`
	Title              string `json:"title,omitempty"`
	Object             string `json:"object,omitempty"`
}

func (SignatureRequestExpandedTransactionDocument) IsRef added in v6.0.24 

func (m SignatureRequestExpandedTransactionDocument) IsRef() bool

type SignatureRequestFlowDocumentsRequest added in v6.0.14 

type SignatureRequestFlowDocumentsRequest struct {
	FlowId                  string   `json:"flow_id,omitempty"`
	MoveOriginalToTrash     *bool    `json:"move_original_to_trash,omitempty"`
	TransactionDocumentsIds []string `json:"transaction_documents_ids,omitempty"`
}

type SignatureRequestFlowDocumentsResponse added in v6.0.14 

type SignatureRequestFlowDocumentsResponse struct {
	FlowId string `json:"flow_id,omitempty"`
	Object string `json:"object,omitempty"`
}

func (SignatureRequestFlowDocumentsResponse) IsRef added in v6.0.14 

func (m SignatureRequestFlowDocumentsResponse) IsRef() bool

type SignatureRequestFlowRecipientsRequest added in v6.0.27 

type SignatureRequestFlowRecipientsRequest struct {
	FlowId     string       `json:"flow_id"`
	Recipients []*Recipient `json:"recipients,omitempty"`
}

type SignatureRequestFlowRecipientsResponse added in v6.0.27 

type SignatureRequestFlowRecipientsResponse struct {
	FlowId string `json:"flow_id,omitempty"`
	Object string `json:"object,omitempty"`
}

func (SignatureRequestFlowRecipientsResponse) IsRef added in v6.0.27 

func (m SignatureRequestFlowRecipientsResponse) IsRef() bool

type SignatureRequestFlowRequest added in v6.0.10 

type SignatureRequestFlowRequest struct {
	Recipients              []*Recipient `json:"recipients,omitempty"`
	TransactionDocumentsIds []string     `json:"transaction_documents_ids,omitempty"`
	TransactionId           string       `json:"transaction_id,omitempty"`
}

type SignatureRequestFlowResponse added in v6.0.10 

type SignatureRequestFlowResponse struct {
	FlowId string `json:"flow_id,omitempty"`
	Object string `json:"object,omitempty"`
}

func (SignatureRequestFlowResponse) IsRef added in v6.0.10 

func (m SignatureRequestFlowResponse) IsRef() bool

type SignatureRequestFlowReviewRequest added in v6.0.20 

type SignatureRequestFlowReviewRequest struct {
	Body                     string `json:"body,omitempty"`
	FlowId                   string `json:"flow_id"`
	MakeDocumentsVisibleInCd *bool  `json:"make_documents_visible_in_cd,omitempty"`
	Subject                  string `json:"subject,omitempty"`
}

type SignatureRequestFlowReviewResponse added in v6.0.20 

type SignatureRequestFlowReviewResponse struct {
	FlowId string `json:"flow_id,omitempty"`
	Object string `json:"object,omitempty"`
}

func (SignatureRequestFlowReviewResponse) IsRef added in v6.0.20 

func (m SignatureRequestFlowReviewResponse) IsRef() bool

type SignatureRequestFlowSendRequest added in v6.0.28 

type SignatureRequestFlowSendRequest struct {
	FlowId string `json:"flow_id"`
}

type SignatureRequestFlowSendResponse added in v6.0.28 

type SignatureRequestFlowSendResponse struct {
	SignatureRequest *SignatureRequest `json:"signature_request,omitempty"`
	Object           string            `json:"object,omitempty"`
}

func (SignatureRequestFlowSendResponse) IsRef added in v6.0.28 

func (m SignatureRequestFlowSendResponse) IsRef() bool

type SignatureRequestFlowSendRevisionResponse added in v6.0.46 

type SignatureRequestFlowSendRevisionResponse struct {
	SignatureRequest *SignatureRequest `json:"signature_request,omitempty"`
	Object           string            `json:"object,omitempty"`
}

func (SignatureRequestFlowSendRevisionResponse) IsRef added in v6.0.46 

func (m SignatureRequestFlowSendRevisionResponse) IsRef() bool

type SignatureRequestList added in v6.0.11 

type SignatureRequestList struct {
	Data       []SignatureRequest `json:"data"`
	ListObject string             `json:"list_object"`
	Object     string             `json:"object"`
	HasMore    bool               `json:"has_more"`
}

func (SignatureRequestList) IsRef added in v6.0.11 

func (m SignatureRequestList) IsRef() bool

func (SignatureRequestList) NextPageParams added in v6.0.12 

func (m SignatureRequestList) NextPageParams() core.PageParams

type SignatureRequestRecipient added in v6.0.11 

type SignatureRequestRecipient struct {
	Id            string `json:"id,omitempty"`
	Email         string `json:"email,omitempty"`
	FirstName     string `json:"first_name,omitempty"`
	LastName      string `json:"last_name,omitempty"`
	Order         int    `json:"order,omitempty"`
	RecipientRole string `json:"recipient_role,omitempty"`
	Status        string `json:"status,omitempty"`
	UserName      string `json:"user_name,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (SignatureRequestRecipient) IsRef added in v6.0.11 

func (m SignatureRequestRecipient) IsRef() bool

type SignatureRequestReviseRequest added in v6.0.46 

type SignatureRequestReviseRequest struct {
	RevisionFlowId string `json:"revision_flow_id"`
}

type SignatureRequestSaveTabConfigRequest added in v6.0.19 

type SignatureRequestSaveTabConfigRequest struct {
	Data   *EsignTabConfig `json:"data"`
	FlowId string          `json:"flow_id"`
}

type SignatureRequestSaveTabConfigResponse added in v6.0.19 

type SignatureRequestSaveTabConfigResponse struct {
	FlowId string `json:"flow_id,omitempty"`
	Object string `json:"object,omitempty"`
}

func (SignatureRequestSaveTabConfigResponse) IsRef added in v6.0.19 

func (m SignatureRequestSaveTabConfigResponse) IsRef() bool

type SignatureRequestStartRevisionResponse added in v6.0.39 

type SignatureRequestStartRevisionResponse struct {
	FlowId string `json:"flow_id,omitempty"`
	Object string `json:"object,omitempty"`
}

func (SignatureRequestStartRevisionResponse) IsRef added in v6.0.39 

func (m SignatureRequestStartRevisionResponse) IsRef() bool

type SignatureRequestTabConfigDetailResponse added in v6.0.21 

type SignatureRequestTabConfigDetailResponse struct {
	FillConfigs             []*ESignFillConfig                             `json:"fill_configs,omitempty"`
	LockedSignerKeysByTdvId map[string][]string                            `json:"locked_signer_keys_by_tdv_id,omitempty"`
	Recipients              []*Recipient                                   `json:"recipients,omitempty"`
	TransactionDocuments    []*SignatureRequestExpandedTransactionDocument `json:"transaction_documents,omitempty"`
	Object                  string                                         `json:"object,omitempty"`
}

func (SignatureRequestTabConfigDetailResponse) IsRef added in v6.0.21 

func (m SignatureRequestTabConfigDetailResponse) IsRef() bool

type SignatureRequestVoidRequest added in v6.0.33 

type SignatureRequestVoidRequest struct {
	VoidReason string `json:"void_reason,omitempty"`
}

type SignatureRequestVoidResponse added in v6.0.33 

type SignatureRequestVoidResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (SignatureRequestVoidResponse) IsRef added in v6.0.33 

func (m SignatureRequestVoidResponse) IsRef() bool

type SignatureRequestsResource added in v6.0.10 

type SignatureRequestsResource interface {
	Activities() ActivitiesResource
	GetDetail(id string, opts ...core.RequestOption) (*SignatureRequest, error)
	GetMulti(ids []string, opts ...core.RequestOption) (*SignatureRequestList, error)
	List(opts ...core.RequestOption) (*SignatureRequestList, error)
	DownloadEnvelopeDocument(opts ...core.RequestOption) (*BinaryResponse, error)
	Flow(signatureRequestFlowRequest SignatureRequestFlowRequest, opts ...core.RequestOption) (*SignatureRequestFlowResponse, error)
	FlowDocuments(signatureRequestFlowDocumentsRequest SignatureRequestFlowDocumentsRequest, opts ...core.RequestOption) (*SignatureRequestFlowDocumentsResponse, error)
	FlowDocumentsDetail(opts ...core.RequestOption) (*GetSignatureRequestFlowDocumentsResponse, error)
	FlowRecipients(signatureRequestFlowRecipientsRequest SignatureRequestFlowRecipientsRequest, opts ...core.RequestOption) (*SignatureRequestFlowRecipientsResponse, error)
	FlowRecipientsDetail(opts ...core.RequestOption) (*GetSignatureRequestFlowRecipientsResponse, error)
	FlowReview(signatureRequestFlowReviewRequest SignatureRequestFlowReviewRequest, opts ...core.RequestOption) (*SignatureRequestFlowReviewResponse, error)
	FlowReviewDetail(opts ...core.RequestOption) (*GetSignatureRequestFlowReviewResponse, error)
	FlowSend(signatureRequestFlowSendRequest SignatureRequestFlowSendRequest, opts ...core.RequestOption) (*SignatureRequestFlowSendResponse, error)
	FlowSendRevision(signatureRequestReviseRequest SignatureRequestReviseRequest, opts ...core.RequestOption) (*SignatureRequestFlowSendRevisionResponse, error)
	SaveTabConfig(signatureRequestSaveTabConfigRequest SignatureRequestSaveTabConfigRequest, opts ...core.RequestOption) (*SignatureRequestSaveTabConfigResponse, error)
	SplitText(splitAnnotationTextRequest SplitAnnotationTextRequest, opts ...core.RequestOption) (*SplitAnnotationTextResponse, error)
	TabConfigDetail(opts ...core.RequestOption) (*SignatureRequestTabConfigDetailResponse, error)
	Archive(id string, opts ...core.RequestOption) (*SignatureRequestArchiveResponse, error)
	CancelRevision(id string, opts ...core.RequestOption) error
	Duplicate(id string, opts ...core.RequestOption) (*SignatureRequestDuplicateResponse, error)
	Resend(id string, opts ...core.RequestOption) error
	StartRevision(id string, opts ...core.RequestOption) (*SignatureRequestStartRevisionResponse, error)
	Void(id string, signatureRequestVoidRequest SignatureRequestVoidRequest, opts ...core.RequestOption) (*SignatureRequestVoidResponse, error)
}

func GetSignatureRequestsResource added in v6.0.10 

func GetSignatureRequestsResource(client Client) SignatureRequestsResource

type SignatureResult 

type SignatureResult struct {
	SignedSignatureFields int    `json:"signed_signature_fields"`
	TotalSignatureFields  int    `json:"total_signature_fields"`
	Object                string `json:"object,omitempty"`
}

func (SignatureResult) IsRef 

func (m SignatureResult) IsRef() bool

type SplitAnnotationTextRequest added in v6.0.23 

type SplitAnnotationTextRequest struct {
	SplitTexts []*TextSplitRequest `json:"split_texts"`
}

type SplitAnnotationTextResponse added in v6.0.23 

type SplitAnnotationTextResponse struct {
	Splits []*TextSplitResponse `json:"splits,omitempty"`
	Object string               `json:"object,omitempty"`
}

func (SplitAnnotationTextResponse) IsRef added in v6.0.23 

func (m SplitAnnotationTextResponse) IsRef() bool

type Step added in v6.0.22 

type Step struct {
	Id       string `json:"id,omitempty"`
	ClosedAt int    `json:"closed_at,omitempty"`
	State    string `json:"state,omitempty"`
	Status   string `json:"status,omitempty"`
	StepKind string `json:"step_kind,omitempty"`
	Object   string `json:"object,omitempty"`
}

func (Step) IsRef added in v6.0.22 

func (m Step) IsRef() bool

type StepList added in v6.0.22 

type StepList struct {
	Data       []Step `json:"data"`
	ListObject string `json:"list_object"`
	Object     string `json:"object"`
	HasMore    bool   `json:"has_more"`
}

func (StepList) IsRef added in v6.0.22 

func (m StepList) IsRef() bool

func (StepList) NextPageParams added in v6.0.22 

func (m StepList) NextPageParams() core.PageParams

type Task 

type Task struct {
	Id          string       `json:"id,omitempty"`
	BoardId     string       `json:"board_id,omitempty"`
	Name        string       `json:"name,omitempty"`
	OrderIndex  int          `json:"order_index,omitempty"`
	Status      string       `json:"status,omitempty"`
	TaskKind    string       `json:"task_kind,omitempty"`
	Title       string       `json:"title,omitempty"`
	Transaction *Transaction `json:"transaction,omitempty"`
	Type        string       `json:"type,omitempty"`
	Object      string       `json:"object,omitempty"`
}

func (Task) IsRef 

func (m Task) IsRef() bool

type TaskList 

type TaskList struct {
	Data       []Task `json:"data"`
	ListObject string `json:"list_object"`
	Object     string `json:"object"`
	HasMore    bool   `json:"has_more"`
}

func (TaskList) IsRef 

func (m TaskList) IsRef() bool

func (TaskList) NextPageParams 

func (m TaskList) NextPageParams() core.PageParams

type TasksResource 

type TasksResource interface {
	GetDetail(transactionId string, id string, opts ...core.RequestOption) (*Task, error)
	GetMulti(transactionId string, ids []string, opts ...core.RequestOption) (*TaskList, error)
	List(transactionId string, opts ...core.RequestOption) (*TaskList, error)
}

func GetTasksResource 

func GetTasksResource(client Client) TasksResource

type TextSplitRequest added in v6.0.23 

type TextSplitRequest struct {
	Annotations []*ESignAnnotation `json:"annotations,omitempty"`
	Text        string             `json:"text,omitempty"`
}

type TextSplitResponse added in v6.0.23 

type TextSplitResponse struct {
	Remainder string   `json:"remainder,omitempty"`
	TextParts []string `json:"text_parts,omitempty"`
	Object    string   `json:"object,omitempty"`
}

func (TextSplitResponse) IsRef added in v6.0.23 

func (m TextSplitResponse) IsRef() bool

type TimelineSignatureRequest added in v6.0.22 

type TimelineSignatureRequest struct {
	Id         string                       `json:"id,omitempty"`
	Recipients []*SignatureRequestRecipient `json:"recipients,omitempty"`
	SignNowUrl string                       `json:"sign_now_url,omitempty"`
	Object     string                       `json:"object,omitempty"`
}

func (TimelineSignatureRequest) IsRef added in v6.0.22 

func (m TimelineSignatureRequest) IsRef() bool

type TimelineSignatureRequests added in v6.0.22 

type TimelineSignatureRequests struct {
	Data   []*TimelineSignatureRequest `json:"data,omitempty"`
	Object string                      `json:"object,omitempty"`
}

func (TimelineSignatureRequests) IsRef added in v6.0.22 

func (m TimelineSignatureRequests) IsRef() bool

type Transaction 

type Transaction struct {
	Id                           string                   `json:"id,omitempty"`
	Address                      *Address                 `json:"address,omitempty"`
	Archived                     *bool                    `json:"archived,omitempty"`
	DealId                       string                   `json:"deal_id,omitempty"`
	Fields                       TransactionFields        `json:"fields,omitempty"`
	Folders                      *FolderList              `json:"folders,omitempty"`
	IngestDocumentsEmail         string                   `json:"ingest_documents_email,omitempty"`
	IsLease                      *bool                    `json:"is_lease,omitempty"`
	IsReferral                   *bool                    `json:"is_referral,omitempty"`
	Parties                      *PartyList               `json:"parties,omitempty"`
	PropertiesInfo               *PropertyInfoList        `json:"properties_info,omitempty"`
	ReState                      string                   `json:"re_state,omitempty"`
	SecondaryAddressesIds        []string                 `json:"secondary_addresses_ids,omitempty"`
	Side                         string                   `json:"side,omitempty"`
	Stage                        string                   `json:"stage,omitempty"`
	Tasks                        *TaskList                `json:"tasks,omitempty"`
	Title                        string                   `json:"title,omitempty"`
	TransactionDocuments         *TransactionDocumentList `json:"transaction_documents,omitempty"`
	TransactionPackages          *TransactionPackageList  `json:"transaction_packages,omitempty"`
	TransactionSignatureRequests *SignatureRequestList    `json:"transaction_signature_requests,omitempty"`
	Object                       string                   `json:"object,omitempty"`
}

func (Transaction) GetFields 

func (t Transaction) GetFields(fieldIds ...string) TransactionFields

func (Transaction) GetFieldsWrite 

func (t Transaction) GetFieldsWrite(fieldValues TransactionFieldValues) TransactionFieldsWrite

func (Transaction) IsRef 

func (m Transaction) IsRef() bool

type TransactionArchivalStatus 

type TransactionArchivalStatus struct {
	Archived *bool `json:"archived,omitempty"`
}

type TransactionByOrgSchema 

type TransactionByOrgSchema struct {
	Cursor  string   `json:"cursor,omitempty"`
	Data    []string `json:"data,omitempty"`
	HasMore *bool    `json:"has_more,omitempty"`
	Total   int      `json:"total,omitempty"`
	Object  string   `json:"object,omitempty"`
}

func (TransactionByOrgSchema) IsRef 

func (m TransactionByOrgSchema) IsRef() bool

type TransactionCreate 

type TransactionCreate struct {
	AdditionalParties []*PartyCreate      `json:"additional_parties,omitempty"`
	Address           *Address            `json:"address,omitempty"`
	Creator           *TransactionCreator `json:"creator,omitempty"`
	CreatorRoles      []string            `json:"creator_roles,omitempty"`
	DealId            string              `json:"deal_id,omitempty"`
	IsLease           *bool               `json:"is_lease,omitempty"`
	IsReferral        *bool               `json:"is_referral,omitempty"`
	ReState           string              `json:"re_state,omitempty"`
	Stage             string              `json:"stage,omitempty"`
	TeamId            string              `json:"team_id,omitempty"`
	Title             string              `json:"title,omitempty"`
}

type TransactionCreator 

type TransactionCreator struct {
	UserContactId     string                `json:"user_contact_id,omitempty"`
	UserContactSource *ContactSourceRequest `json:"user_contact_source,omitempty"`
}

type TransactionDocument 

type TransactionDocument struct {
	Id                        string           `json:"id,omitempty"`
	Can                       map[string]*bool `json:"can,omitempty"`
	ClientDocumentProperty    string           `json:"client_document_property,omitempty"`
	ClientDocumentType        string           `json:"client_document_type,omitempty"`
	ClientVisibilityChangedAt int              `json:"client_visibility_changed_at,omitempty"`
	ClientVisibilityStatus    string           `json:"client_visibility_status,omitempty"`
	Folder                    *Folder          `json:"folder,omitempty"`
	FolderKind                string           `json:"folder_kind,omitempty"`
	FormId                    string           `json:"form_id,omitempty"`
	Kind                      string           `json:"kind,omitempty"`
	LastModified              int              `json:"last_modified,omitempty"`
	LatestVersionId           string           `json:"latest_version_id,omitempty"`
	Order                     int              `json:"order,omitempty"`
	Origin                    string           `json:"origin,omitempty"`
	PageCount                 int              `json:"page_count,omitempty"`
	SignatureStatus           string           `json:"signature_status,omitempty"`
	Title                     string           `json:"title,omitempty"`
	Transaction               *Transaction     `json:"transaction,omitempty"`
	UploadedBy                *UploadedBy      `json:"uploaded_by,omitempty"`
	Url                       string           `json:"url,omitempty"`
	Object                    string           `json:"object,omitempty"`
}

func (TransactionDocument) IsRef 

func (m TransactionDocument) IsRef() bool

type TransactionDocumentAssignment 

type TransactionDocumentAssignment struct {
	FolderId              string `json:"folder_id,omitempty"`
	Order                 int    `json:"order,omitempty"`
	TransactionDocumentId string `json:"transaction_document_id,omitempty"`
}

type TransactionDocumentAssignments 

type TransactionDocumentAssignments struct {
	Assignments []*TransactionDocumentAssignment `json:"assignments,omitempty"`
}

type TransactionDocumentAssignmentsResponse 

type TransactionDocumentAssignmentsResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (TransactionDocumentAssignmentsResponse) IsRef 

func (m TransactionDocumentAssignmentsResponse) IsRef() bool

type TransactionDocumentList 

type TransactionDocumentList struct {
	Data       []TransactionDocument `json:"data"`
	ListObject string                `json:"list_object"`
	Object     string                `json:"object"`
	HasMore    bool                  `json:"has_more"`
}

func (TransactionDocumentList) IsRef 

func (m TransactionDocumentList) IsRef() bool

func (TransactionDocumentList) NextPageParams 

func (m TransactionDocumentList) NextPageParams() core.PageParams

type TransactionDocumentRename 

type TransactionDocumentRename struct {
	Title                 string `json:"title,omitempty"`
	TransactionDocumentId string `json:"transaction_document_id,omitempty"`
}

type TransactionDocumentRenames 

type TransactionDocumentRenames struct {
	Renames []*TransactionDocumentRename `json:"renames,omitempty"`
}

type TransactionDocumentRenamesResponse 

type TransactionDocumentRenamesResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (TransactionDocumentRenamesResponse) IsRef 

func (m TransactionDocumentRenamesResponse) IsRef() bool

type TransactionDocumentReorderFolder 

type TransactionDocumentReorderFolder struct {
	FolderId   string `json:"folder_id,omitempty"`
	OrderIndex int    `json:"order_index,omitempty"`
}

type TransactionDocumentReorderFolders 

type TransactionDocumentReorderFolders struct {
	Folders []*TransactionDocumentReorderFolder `json:"folders,omitempty"`
}

type TransactionDocumentRestoresResponse 

type TransactionDocumentRestoresResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (TransactionDocumentRestoresResponse) IsRef 

func (m TransactionDocumentRestoresResponse) IsRef() bool

type TransactionDocumentTrashes 

type TransactionDocumentTrashes struct {
	TransactionDocumentIds []string `json:"transaction_document_ids,omitempty"`
}

type TransactionDocumentTrashesResponse 

type TransactionDocumentTrashesResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (TransactionDocumentTrashesResponse) IsRef 

func (m TransactionDocumentTrashesResponse) IsRef() bool

type TransactionDocumentUpload 

type TransactionDocumentUpload struct {
	Folder                    *FolderCreate                          `json:"folder,omitempty"`
	FolderId                  string                                 `json:"folder_id,omitempty"`
	IntegratedServicesPartner *FolderCreateIntegratedServicesPartner `json:"integrated_services_partner,omitempty"`
	MimeType                  string                                 `json:"mime_type,omitempty"`
	Title                     string                                 `json:"title,omitempty"`
}

type TransactionDocumentUploadResult added in v6.0.7 

type TransactionDocumentUploadResult struct {
	TransactionDocuments []*TransactionDocument `json:"transaction_documents,omitempty"`
	Object               string                 `json:"object,omitempty"`
}

func (TransactionDocumentUploadResult) IsRef added in v6.0.7 

func (m TransactionDocumentUploadResult) IsRef() bool

type TransactionDocumentUploads 

type TransactionDocumentUploads struct {
	Files   []http.File                  `json:"files,omitempty"`
	Uploads []*TransactionDocumentUpload `json:"uploads,omitempty"`
}

type TransactionDocumentsResource 

type TransactionDocumentsResource interface {
	GetDetail(transactionId string, id string, opts ...core.RequestOption) (*TransactionDocument, error)
	GetMulti(transactionId string, ids []string, opts ...core.RequestOption) (*TransactionDocumentList, error)
	List(transactionId string, opts ...core.RequestOption) (*TransactionDocumentList, error)
	PartnerFolderUploads(transactionId string, transactionDocumentUploads TransactionDocumentUploads, files []core.File, opts ...core.RequestOption) (*PartnerFolderUploadsResponse, error)
	Uploads(transactionId string, transactionDocumentUploads TransactionDocumentUploads, files []core.File, opts ...core.RequestOption) (*UploadsResponse, error)
}

func GetTransactionDocumentsResource 

func GetTransactionDocumentsResource(client Client) TransactionDocumentsResource

type TransactionDocumentsRestore 

type TransactionDocumentsRestore struct {
	FolderId              string `json:"folder_id,omitempty"`
	TransactionDocumentId string `json:"transaction_document_id,omitempty"`
}

type TransactionDocumentsRestores 

type TransactionDocumentsRestores struct {
	Restores []*TransactionDocumentsRestore `json:"restores,omitempty"`
}

type TransactionField 

type TransactionField struct {
	Value     TransactionFieldValue `json:"value"`
	Timestamp int                   `json:"timestamp"`
}

type TransactionFieldValue 

type TransactionFieldValue = interface{}

type TransactionFieldValues 

type TransactionFieldValues = map[string]TransactionFieldValue

type TransactionFieldWrite 

type TransactionFieldWrite struct {
	Value            TransactionFieldValue `json:"value"`
	ControlTimestamp int                   `json:"control_timestamp"`
}

func GetFieldWrite 

func GetFieldWrite(value TransactionFieldValue, controlTimestamp int) TransactionFieldWrite

func GetFieldWriteNoControl 

func GetFieldWriteNoControl(value TransactionFieldValue) TransactionFieldWrite

type TransactionFields 

type TransactionFields = map[string]TransactionField

type TransactionFieldsWrite 

type TransactionFieldsWrite = map[string]TransactionFieldWrite

func CombineFieldsWrites 

func CombineFieldsWrites(fieldWrites ...TransactionFieldsWrite) TransactionFieldsWrite

type TransactionFormImport 

type TransactionFormImport struct {
	FormId string `json:"form_id"`
	Title  string `json:"title,omitempty"`
}

type TransactionFormImports 

type TransactionFormImports struct {
	FolderId string                   `json:"folder_id,omitempty"`
	Imports  []*TransactionFormImport `json:"imports"`
}

type TransactionList 

type TransactionList struct {
	Data       []Transaction `json:"data"`
	ListObject string        `json:"list_object"`
	Object     string        `json:"object"`
	HasMore    bool          `json:"has_more"`
}

func (TransactionList) IsRef 

func (m TransactionList) IsRef() bool

func (TransactionList) NextPageParams 

func (m TransactionList) NextPageParams() core.PageParams

type TransactionMeta 

type TransactionMeta struct {
	IsLease *bool  `json:"is_lease,omitempty"`
	Title   string `json:"title,omitempty"`
}

type TransactionMetaUpdate 

type TransactionMetaUpdate struct {
	Data *TransactionMeta `json:"data,omitempty"`
}

type TransactionPackage added in v6.0.5 

type TransactionPackage struct {
	Id            string        `json:"id,omitempty"`
	Members       []*Member     `json:"members,omitempty"`
	PackageId     string        `json:"package_id,omitempty"`
	PackageKind   string        `json:"package_kind,omitempty"`
	PackageStatus string        `json:"package_status,omitempty"`
	PropertyInfo  *PropertyInfo `json:"property_info,omitempty"`
	Title         string        `json:"title,omitempty"`
	Transaction   *Transaction  `json:"transaction,omitempty"`
	Object        string        `json:"object,omitempty"`
}

func (TransactionPackage) IsRef added in v6.0.5 

func (m TransactionPackage) IsRef() bool

type TransactionPackageList added in v6.0.5 

type TransactionPackageList struct {
	Data       []TransactionPackage `json:"data"`
	ListObject string               `json:"list_object"`
	Object     string               `json:"object"`
	HasMore    bool                 `json:"has_more"`
}

func (TransactionPackageList) IsRef added in v6.0.5 

func (m TransactionPackageList) IsRef() bool

func (TransactionPackageList) NextPageParams added in v6.0.5 

func (m TransactionPackageList) NextPageParams() core.PageParams

type TransactionPackagesResource added in v6.0.5 

type TransactionPackagesResource interface {
	GetDetail(transactionId string, id string, opts ...core.RequestOption) (*TransactionPackage, error)
	GetMulti(transactionId string, ids []string, opts ...core.RequestOption) (*TransactionPackageList, error)
	List(transactionId string, opts ...core.RequestOption) (*TransactionPackageList, error)
}

func GetTransactionPackagesResource added in v6.0.5 

func GetTransactionPackagesResource(client Client) TransactionPackagesResource

type TransactionSignatureRequestsResource added in v6.0.12 

type TransactionSignatureRequestsResource interface {
	GetDetail(transactionId string, id string, opts ...core.RequestOption) (*SignatureRequest, error)
	GetMulti(transactionId string, ids []string, opts ...core.RequestOption) (*SignatureRequestList, error)
	List(transactionId string, opts ...core.RequestOption) (*SignatureRequestList, error)
	TimelineEnrichment(transactionId string, opts ...core.RequestOption) (*TimelineSignatureRequests, error)
}

func GetTransactionSignatureRequestsResource added in v6.0.12 

func GetTransactionSignatureRequestsResource(client Client) TransactionSignatureRequestsResource

type TransactionsResource 

type TransactionsResource interface {
	Folders() FoldersResource
	Parties() PartiesResource
	PropertiesInfo() PropertiesInfoResource
	Tasks() TasksResource
	TransactionDocuments() TransactionDocumentsResource
	TransactionPackages() TransactionPackagesResource
	TransactionSignatureRequests() TransactionSignatureRequestsResource
	GetDetail(id string, opts ...core.RequestOption) (*Transaction, error)
	GetMulti(ids []string, opts ...core.RequestOption) (*TransactionList, error)
	List(opts ...core.RequestOption) (*TransactionList, error)
	Create(transactionCreate TransactionCreate, opts ...core.RequestOption) (*CreateResponse, error)
	AvailablePartyRoles(opts ...core.RequestOption) (*PartyRoles, error)
	OrgsTransactionsIds(opts ...core.RequestOption) (*TransactionByOrgSchema, error)
	DeletedParties(id string, opts ...core.RequestOption) (*DeletedParties, error)
	Fields(id string, fieldsWrites TransactionFieldsWrite, controlPolicy string, opts ...core.RequestOption) (*FieldsResponse, error)
	FolderCreates(id string, folderCreates FolderCreates, opts ...core.RequestOption) (*FolderCreatesResponse, error)
	FolderRenames(id string, folderRenames FolderRenames, opts ...core.RequestOption) (*FolderRenamesResponse, error)
	FormImports(id string, transactionFormImports TransactionFormImports, opts ...core.RequestOption) (*FormImportsResponse, error)
	ItemDeletes(id string, itemDeletes ItemDeletes, opts ...core.RequestOption) (*ItemDeletesResponse, error)
	MergeDocuments(id string, documentMergeSchema DocumentMergeSchema, opts ...core.RequestOption) (*MergeDocumentsResponse, error)
	PartyCreates(id string, partyCreates PartyCreates, opts ...core.RequestOption) (*PartyCreatesResponse, error)
	PartyInvites(id string, partyInvites PartyInvites, opts ...core.RequestOption) (*PartyInvitesResponse, error)
	PartyPatches(id string, partyPatches PartyPatches, opts ...core.RequestOption) (*PartyPatchesResponse, error)
	PartyRemoves(id string, partyRemoves PartyRemoves, opts ...core.RequestOption) (*PartyRemovesResponse, error)
	PartyUpdateContactDetails(id string, partyUpdateContactDetails PartyUpdateContactDetails, opts ...core.RequestOption) (*PartyUpdateContactDetailsResponse, error)
	PartyUpdateContactSource(id string, partyUpdateContactSource PartyUpdateContactSource, opts ...core.RequestOption) (*PartyUpdateContactSourceResponse, error)
	ReorderFolders(id string, transactionDocumentReorderFolders TransactionDocumentReorderFolders, opts ...core.RequestOption) (*ReorderFoldersResponse, error)
	TransactionDocumentAssignments(id string, transactionDocumentAssignments TransactionDocumentAssignments, opts ...core.RequestOption) (*TransactionDocumentAssignmentsResponse, error)
	TransactionDocumentRenames(id string, transactionDocumentRenames TransactionDocumentRenames, opts ...core.RequestOption) (*TransactionDocumentRenamesResponse, error)
	TransactionDocumentRestores(id string, transactionDocumentsRestores TransactionDocumentsRestores, opts ...core.RequestOption) (*TransactionDocumentRestoresResponse, error)
	TransactionDocumentTrashes(id string, transactionDocumentTrashes TransactionDocumentTrashes, opts ...core.RequestOption) (*TransactionDocumentTrashesResponse, error)
	UpdateArchivalStatus(id string, transactionArchivalStatus TransactionArchivalStatus, opts ...core.RequestOption) (*UpdateArchivalStatusResponse, error)
	UpdateTransactionMeta(id string, transactionMetaUpdate TransactionMetaUpdate, opts ...core.RequestOption) (*UpdateTransactionMetaResponse, error)
}

func GetTransactionsResource 

func GetTransactionsResource(client Client) TransactionsResource

type UpdateArchivalStatusResponse 

type UpdateArchivalStatusResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (UpdateArchivalStatusResponse) IsRef 

func (m UpdateArchivalStatusResponse) IsRef() bool

type UpdateTransactionMetaResponse 

type UpdateTransactionMetaResponse struct {
	TransactionId string `json:"transaction_id,omitempty"`
	Object        string `json:"object,omitempty"`
}

func (UpdateTransactionMetaResponse) IsRef 

func (m UpdateTransactionMetaResponse) IsRef() bool

type UploadError added in v6.0.11 

type UploadError struct {
	Error    string `json:"error"`
	Filename string `json:"filename"`
	Size     int    `json:"size,omitempty"`
	Object   string `json:"object,omitempty"`
}

func (UploadError) IsRef added in v6.0.11 

func (m UploadError) IsRef() bool

type UploadedBy added in v6.0.41 

type UploadedBy struct {
	Name     string `json:"name,omitempty"`
	PersonId string `json:"person_id,omitempty"`
	Object   string `json:"object,omitempty"`
}

func (UploadedBy) IsRef added in v6.0.41 

func (m UploadedBy) IsRef() bool

type UploadsResponse 

type UploadsResponse struct {
	Result        *TransactionDocumentUploadResult `json:"result,omitempty"`
	TransactionId string                           `json:"transaction_id,omitempty"`
	Object        string                           `json:"object,omitempty"`
}

func (UploadsResponse) IsRef 

func (m UploadsResponse) IsRef() bool

type User 

type User struct {
	Id           string   `json:"id,omitempty"`
	AgentAddress *Address `json:"agent_address,omitempty"`
	Contact      *Contact `json:"contact,omitempty"`
	Uuid         string   `json:"uuid,omitempty"`
	Object       string   `json:"object,omitempty"`
}

func (User) IsRef 

func (m User) IsRef() bool

type UserBillingInfo 

type UserBillingInfo struct {
	StripeCustomerId string `json:"stripe_customer_id,omitempty"`
	Object           string `json:"object,omitempty"`
}

func (UserBillingInfo) IsRef 

func (m UserBillingInfo) IsRef() bool

type UserContact added in v6.0.22 

type UserContact struct {
	UserContactId string `json:"user_contact_id,omitempty"`
}

type UserContactRecipient added in v6.0.10 

type UserContactRecipient struct {
	Contact           *Contact       `json:"contact,omitempty"`
	Roles             []string       `json:"roles,omitempty"`
	UserContactId     string         `json:"user_contact_id,omitempty"`
	UserContactSource *ContactSource `json:"user_contact_source,omitempty"`
	Object            string         `json:"object,omitempty"`
}

func (UserContactRecipient) IsRef added in v6.0.22 

func (m UserContactRecipient) IsRef() bool

type UserList 

type UserList struct {
	Data       []User `json:"data"`
	ListObject string `json:"list_object"`
	Object     string `json:"object"`
	HasMore    bool   `json:"has_more"`
}

func (UserList) IsRef 

func (m UserList) IsRef() bool

func (UserList) NextPageParams 

func (m UserList) NextPageParams() core.PageParams

type UserManagementResource 

type UserManagementResource interface {
	GetDetail(id string, opts ...core.RequestOption) (*User, error)
	List(opts ...core.RequestOption) (*UserList, error)
	Upsert(userManagementSchema UserManagementSchema, opts ...core.RequestOption) (*User, error)
}

func GetUserManagementResource 

func GetUserManagementResource(client Client) UserManagementResource

type UserManagementSchema 

type UserManagementSchema struct {
	Email           string   `json:"email"`
	FirstName       string   `json:"first_name"`
	LastName        string   `json:"last_name"`
	LinkedSubjectId string   `json:"linked_subject_id"`
	MarketIds       []string `json:"market_ids,omitempty"`
	SubmarketIds    []string `json:"submarket_ids,omitempty"`
	UsState         string   `json:"us_state,omitempty"`
}

type UsersResource 

type UsersResource interface {
	GetDetail(id string, opts ...core.RequestOption) (*User, error)
	Current(opts ...core.RequestOption) (*User, error)
	CurrentBilling(opts ...core.RequestOption) (*UserBillingInfo, error)
}

func GetUsersResource 

func GetUsersResource(client Client) UsersResource

type Validation added in v6.0.22 

type Validation struct {
	Kind      string           `json:"kind,omitempty"`
	Signature *SignatureIntent `json:"signature,omitempty"`
}

Source Files

View all Source files

Directories

Path Synopsis
mocks

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.