Versions in this module Expand all Collapse all v2 v2.0.2 Aug 1, 2022 Changes in this version + const ContactScope + const JWT_EXPIRES + const JwtExpirationInMinutes + const TransactionScope + func GetExpandFields(fieldIds ...string) string + func GetRsa256Key(privateKeyFilePath string) rsa256Key + func GetRsa256KeyFromPEMBytes(privateKeyBytes []byte) rsa256Key + func GetRsa256KeyFromPEMString(privateKeyString string) rsa256Key + func TestTransactionUpdateMeta(t *testing.T) + func WithAudience(audience string) clientOption + func WithBasePath(basePath string) clientOption + func WithExpand(paths ...string) requestOption + func WithHost(host string) clientOption + func WithPage(pageParams *PageParams) requestOption + func WithPageLimit(limit int) requestOption + func WithPageParams(limit int, startingAfter string) requestOption + func WithPageStartingAfter(startingAfter string) requestOption + func WithProtocol(protocol string) clientOption + func WithQueryParam(qParam string, value string) requestOption + func WithQueryParamList(qParam string, values ...string) requestOption + func WithURL(URL string) clientOption + func WithUpdatedAfter(ts int) requestOption + type Address struct + City string + Object string + State string + Street string + Unit string + ZipCode string + func (m Address) IsRef() bool + type Agent struct + CompanyLicenseNumber string + CompanyName string + CompanyPhoneNumber string + LicenseNumber string + LicenseState string + NrdsNumber string + Object string + func (m Agent) IsRef() bool + type AgentRequest struct + CompanyLicenseNumber string + CompanyName string + CompanyPhoneNumber string + LicenseNumber string + LicenseState string + NrdsNumber string + type ApiError struct + Description string + Err error + Params map[string]interface{} + ResponseHeaders http.Header + StatusCode int + func GetApiError(e error) *ApiError + func (e *ApiError) Error() string + func (e *ApiError) GetMissingScopes() []string + func (e *ApiError) HasToRequestScopes() bool + func (e *ApiError) IsMissingScopes() bool + func (e *ApiError) RequestScopesUrl() string + func (e *ApiError) Unwrap() error + type Client interface + Contacts func() ContactsResource + Documents func() DocumentsResource + ImpersonatingScopes func() []string + ImpersonatingSub func() string + IsImpersonating func() bool + Listings func() ListingsResource + Notifications func() NotificationsResource + StartImpersonating func(sub string, scopes []string) error + StopImpersonating func() + Transactions func() TransactionsResource + UserManagement func() UserManagementResource + Users func() UsersResource + func GetClient(clientKey string, key Key, opts ...clientOption) Client + type Contact struct + Address *Address + Agent *Agent + AvatarUrl string + BrandLogoUrl string + CellPhone string + Email string + EntityName string + EntityType string + FirstName string + Id string + LastName string + Object string + PersonalWebsite string + Title string + func (m Contact) IsRef() bool + type ContactCreate struct + Contact *ContactRequest + type ContactCreateResponse struct + Contact *Contact + Object string + func (m ContactCreateResponse) IsRef() bool + type ContactList struct + Data []Contact + HasMore bool + ListObject string + Object string + func (m ContactList) IsRef() bool + func (m ContactList) NextPageParams() *PageParams + type ContactRequest struct + Address *Address + Agent *AgentRequest + AvatarUrl string + BrandLogoUrl string + CellPhone string + Email string + EntityName string + EntityType string + FirstName string + LastName string + PersonalWebsite string + Title string + type ContactSource struct + Id string + Object string + Origin string + func (m ContactSource) IsRef() bool + type ContactSourceRequest struct + Id string + Origin string + type ContactUpdate struct + Contact *ContactRequest + Roles []string + type ContactUpdateResponse struct + Contact *Contact + Id string + Object string + func (m ContactUpdateResponse) IsRef() bool + type ContactsResource interface + Create func(contactCreate ContactCreate, opts ...requestOption) (*ContactCreateResponse, error) + GetDetail func(id string, opts ...requestOption) (*Contact, error) + GetMulti func(ids []string, opts ...requestOption) (*ContactList, error) + List func(opts ...requestOption) (*ContactList, error) + Update func(id string, contactUpdate ContactUpdate, opts ...requestOption) (*ContactUpdateResponse, error) + type CreateResponse struct + Object string + TransactionId string + func (m CreateResponse) IsRef() bool + type DeletedParties struct + Data []*DeletedParty + Object string + func (m DeletedParties) IsRef() bool + type DeletedParty struct + Contact *Contact + DeletedAt int + Object string + PartyId string + Roles []string + func (m DeletedParty) IsRef() bool + type DocumentSplitAsyncResponse struct + Object string + ReqId string + Suggestions map[string]*DocumentSplitSuggestion + func (m DocumentSplitAsyncResponse) IsRef() bool + type DocumentSplitResponse struct + Object string + ReqId string + Result *DocumentSplitAsyncResponse + func (m DocumentSplitResponse) IsRef() bool + type DocumentSplitSchema struct + Files []http.File + ReState string + ReqId string + Uploads []*DocumentUpload + type DocumentSplitSuggestion struct + EndPage int + Filename string + FormId string + FormSeriesId string + Object string + StartPage int + func (m DocumentSplitSuggestion) IsRef() bool + type DocumentUpload struct + Title string + type DocumentZone struct + FormId string + Id string + Kind string + Name string + Object string + OriginalLocation []*DocumentZoneLocation + Page int + Vertices []*DocumentZoneVertex + func (m DocumentZone) IsRef() bool + type DocumentZoneLocation struct + Object string + XMax float64 + XMin float64 + YMax float64 + YMin float64 + func (m DocumentZoneLocation) IsRef() bool + type DocumentZoneVertex struct + Object string + X int + Y int + func (m DocumentZoneVertex) IsRef() bool + type DocumentsResource interface + DocumentSplit func(documentSplitSchema DocumentSplitSchema, opts ...requestOption) (*DocumentSplitResponse, error) + SignatureDetection func(signatureDetectionSchema SignatureDetectionSchema, opts ...requestOption) (*SignatureDetectionResponse, error) + type Field struct + Object string + Timestamp int + Value map[string]interface{} + func (m Field) IsRef() bool + type FieldOutOfDateDetail struct + ControlTimestamp int + Object string + Timestamp int + func (m FieldOutOfDateDetail) IsRef() bool + type FieldResponse struct + Object string + Timestamp int + Value map[string]interface{} + func (m FieldResponse) IsRef() bool + type FieldResponseWarnings struct + Object string + OutOfDateFields map[string]*FieldOutOfDateDetail + func (m FieldResponseWarnings) IsRef() bool + type FieldWrite struct + ControlTimestamp int + Value map[string]interface{} + type FieldWriteDict struct + ControlPolicy string + Fields TransactionFieldsWrite + type FieldsResponse struct + Object string + Result *FieldsResponseResult + TransactionId string + func (m FieldsResponse) IsRef() bool + type FieldsResponseResult struct + Fields TransactionFields + Object string + Warnings *FieldResponseWarnings + func (m FieldsResponseResult) IsRef() bool + type Folder struct + Id string + Kind string + LastModified int + Object string + Title string + TransactionDocuments *TransactionDocumentList + func (m Folder) IsRef() bool + type FolderCreate struct + Title string + type FolderCreates struct + Creates []*FolderCreate + type FolderCreatesResponse struct + Object string + Result *FolderCreatesResponseResult + TransactionId string + func (m FolderCreatesResponse) IsRef() bool + type FolderCreatesResponseResult struct + FolderIds []string + Object string + func (m FolderCreatesResponseResult) IsRef() bool + type FolderList struct + Data []Folder + HasMore bool + ListObject string + Object string + func (m FolderList) IsRef() bool + func (m FolderList) NextPageParams() *PageParams + type FolderRename struct + FolderId string + Title string + type FolderRenames struct + Renames []*FolderRename + type FolderRenamesResponse struct + Object string + TransactionId string + func (m FolderRenamesResponse) IsRef() bool + type FoldersResource interface + GetDetail func(transactionId string, id string, opts ...requestOption) (*Folder, error) + GetMulti func(transactionId string, ids []string, opts ...requestOption) (*FolderList, error) + List func(transactionId string, opts ...requestOption) (*FolderList, error) + type FormImportsResponse struct + Object string + TransactionId string + func (m FormImportsResponse) IsRef() bool + type HttpReqFuncType func(string) (*http.Response, error) + type ItemDeletes struct + Ids []string + type ItemDeletesResponse struct + Object string + TransactionId string + func (m ItemDeletesResponse) IsRef() bool + type Key interface + GetDecoded func() (crypto.PrivateKey, error) + GetJwtSigningMethod func() jwt.SigningMethod + type LinkListingInfo struct + MlsKind string + MlsNumber string + type LinkListingInfoResponse struct + Object string + TransactionId string + func (m LinkListingInfoResponse) IsRef() bool + type Listing struct + Address *Location + Bath float64 + BathFull float64 + BathHalf float64 + BathOneQuarter float64 + BathThreeQuarter float64 + Bed float64 + CloseDate string + ClosePrice float64 + Dom float64 + Id string + ListingDate string + ListingPrice float64 + ListingType string + MediaUrls []string + MlsKind string + MlsNumber string + MlsStatus string + Object string + OriginalListPrice float64 + PropertyType string + StatusDate string + UsedInActiveTransaction *bool + YearBuilt string + func (m Listing) IsRef() bool + type ListingList struct + Data []Listing + HasMore bool + ListObject string + Object string + func (m ListingList) IsRef() bool + func (m ListingList) NextPageParams() *PageParams + type ListingsResource interface + GetDetail func(id string, opts ...requestOption) (*Listing, error) + GetMulti func(ids []string, opts ...requestOption) (*ListingList, error) + List func(opts ...requestOption) (*ListingList, error) + type Location struct + AgentAddress string + City string + County string + Object string + PrettyAddress string + State string + Street string + StreetNumber string + StreetType string + UnitNumber string + UnitType string + ZipCode string + func (m Location) IsRef() bool + type Notification struct + Bcc []string + Cc []string + Context map[string]interface{} + IncludeSignature *bool + Recipients []string + SeparateEmails *bool + Template string + type NotificationResponse struct + Object string + Results []string + func (m NotificationResponse) IsRef() bool + type NotificationsResource interface + SendEmail func(notification Notification, opts ...requestOption) (*NotificationResponse, error) + type PageParams struct + Limit int + StartingAfter string + func (p PageParams) GetQueryParams() map[string]string + type PartiesResource interface + GetDetail func(transactionId string, id string, opts ...requestOption) (*Party, error) + GetMulti func(transactionId string, ids []string, opts ...requestOption) (*PartyList, error) + List func(transactionId string, opts ...requestOption) (*PartyList, error) + type Party struct + Contact *Contact + CreatedAt int + Id string + Object string + Roles []string + Transaction *Transaction + UpdatedAt int + UserContactId string + UserContactSource *ContactSource + UserId string + func (m Party) IsRef() bool + type PartyCreate struct + Body string + Contact *ContactRequest + Invite *bool + InviteRestrictions []string + PromoteToPrimaryAgent *bool + Roles []string + Subject string + SuppressInviteEmail *bool + UserContactId string + UserContactSource *ContactSourceRequest + type PartyCreates struct + Creates []*PartyCreate + type PartyCreatesResponse struct + Object string + TransactionId string + func (m PartyCreatesResponse) IsRef() bool + type PartyInvite struct + Body string + InviteRestrictions []string + PartyId string + Subject string + SuppressInviteEmail *bool + type PartyInvites struct + Invites []*PartyInvite + type PartyInvitesResponse struct + Object string + TransactionId string + func (m PartyInvitesResponse) IsRef() bool + type PartyList struct + Data []Party + HasMore bool + ListObject string + Object string + func (m PartyList) IsRef() bool + func (m PartyList) NextPageParams() *PageParams + type PartyPatch struct + Contact *ContactRequest + PartyId string + Roles []string + type PartyPatches struct + Patches []*PartyPatch + type PartyPatchesResponse struct + Object string + TransactionId string + func (m PartyPatchesResponse) IsRef() bool + type PartyRemove struct + PartyId string + type PartyRemoves struct + Removes []*PartyRemove + type PartyRemovesResponse struct + Object string + TransactionId string + func (m PartyRemovesResponse) IsRef() bool + type PartyRoles struct + Data []string + Object string + func (m PartyRoles) IsRef() bool + type PartyUpdateContactDetails struct + Contact *ContactRequest + PartyId string + PromoteToPrimaryAgent *bool + Roles []string + type PartyUpdateContactDetailsResponse struct + Object string + TransactionId string + func (m PartyUpdateContactDetailsResponse) IsRef() bool + type QueryParams map[string]string + type Request interface + type Response interface + IsRef func() bool + type SignatureDetectionAnalysisResult struct + DocumentZone *DocumentZone + Object string + Score float64 + func (m SignatureDetectionAnalysisResult) IsRef() bool + type SignatureDetectionAsyncResponse struct + Object string + ReqId string + Signatures map[string]*SignatureDetectionAnalysisResult + func (m SignatureDetectionAsyncResponse) IsRef() bool + type SignatureDetectionResponse struct + Object string + ReqId string + Result *SignatureDetectionAsyncResponse + func (m SignatureDetectionResponse) IsRef() bool + type SignatureDetectionSchema struct + Files []http.File + Uploads []*DocumentUpload + type Transaction struct + Address *Address + Archived *bool + Fields TransactionFields + Folders *FolderList + Id string + IngestDocumentsEmail string + IsLease *bool + Object string + Parties *PartyList + ReState string + SecondaryAddressesIds []string + Side string + Stage string + Title string + TransactionDocuments *TransactionDocumentList + func (m Transaction) IsRef() bool + func (t Transaction) GetFields(fieldIds ...string) TransactionFields + func (t Transaction) GetFieldsWrite(fieldValues TransactionFieldValues) TransactionFieldsWrite + type TransactionArchivalStatus struct + Archived *bool + type TransactionByOrgSchema struct + Cursor string + Data []string + HasMore *bool + Object string + Total int + func (m TransactionByOrgSchema) IsRef() bool + type TransactionCreate struct + AdditionalParties []*PartyCreate + Address *Address + Creator *TransactionCreator + CreatorRoles []string + IsLease *bool + ReState string + Stage string + Title string + type TransactionCreator struct + UserContactId string + UserContactSource *ContactSourceRequest + type TransactionDocument struct + Folder *Folder + FolderKind string + Id string + LastModified int + Object string + Order int + Title string + Transaction *Transaction + Url string + func (m TransactionDocument) IsRef() bool + type TransactionDocumentAssignment struct + FolderId string + Order int + TransactionDocumentId string + type TransactionDocumentAssignments struct + Assignments []*TransactionDocumentAssignment + type TransactionDocumentAssignmentsResponse struct + Object string + TransactionId string + func (m TransactionDocumentAssignmentsResponse) IsRef() bool + type TransactionDocumentList struct + Data []TransactionDocument + HasMore bool + ListObject string + Object string + func (m TransactionDocumentList) IsRef() bool + func (m TransactionDocumentList) NextPageParams() *PageParams + type TransactionDocumentRename struct + Title string + TransactionDocumentId string + type TransactionDocumentRenames struct + Renames []*TransactionDocumentRename + type TransactionDocumentRenamesResponse struct + Object string + TransactionId string + func (m TransactionDocumentRenamesResponse) IsRef() bool + type TransactionDocumentRestoresResponse struct + Object string + TransactionId string + func (m TransactionDocumentRestoresResponse) IsRef() bool + type TransactionDocumentTrashes struct + TransactionDocumentIds []string + type TransactionDocumentTrashesResponse struct + Object string + TransactionId string + func (m TransactionDocumentTrashesResponse) IsRef() bool + type TransactionDocumentUpload struct + FolderId string + Title string + type TransactionDocumentUploads struct + Files []http.File + Uploads []*TransactionDocumentUpload + type TransactionDocumentsResource interface + GetDetail func(transactionId string, id string, opts ...requestOption) (*TransactionDocument, error) + GetMulti func(transactionId string, ids []string, opts ...requestOption) (*TransactionDocumentList, error) + List func(transactionId string, opts ...requestOption) (*TransactionDocumentList, error) + Uploads func(transactionId string, transactionDocumentUploads TransactionDocumentUploads, ...) (*UploadsResponse, error) + type TransactionDocumentsRestore struct + FolderId string + TransactionDocumentId string + type TransactionDocumentsRestores struct + Restores []*TransactionDocumentsRestore + type TransactionField struct + Timestamp int + Value TransactionFieldValue + type TransactionFieldValue = interface + type TransactionFieldValues = map[string]TransactionFieldValue + type TransactionFieldWrite struct + ControlTimestamp int + Value TransactionFieldValue + func GetFieldWrite(value TransactionFieldValue, controlTimestamp int) TransactionFieldWrite + func GetFieldWriteNoControl(value TransactionFieldValue) TransactionFieldWrite + type TransactionFields = map[string]TransactionField + type TransactionFieldsWrite = map[string]TransactionFieldWrite + func CombineFieldsWrites(fieldWrites ...TransactionFieldsWrite) TransactionFieldsWrite + type TransactionFormImport struct + FormId string + Title string + type TransactionFormImports struct + FolderId string + Imports []*TransactionFormImport + type TransactionList struct + Data []Transaction + HasMore bool + ListObject string + Object string + func (m TransactionList) IsRef() bool + func (m TransactionList) NextPageParams() *PageParams + type TransactionMeta struct + IsLease *bool + Title string + type TransactionMetaUpdate struct + Data *TransactionMeta + type TransactionsResource interface + AvailablePartyRoles func(opts ...requestOption) (*PartyRoles, error) + Create func(transactionCreate TransactionCreate, opts ...requestOption) (*CreateResponse, error) + DeletedParties func(id string, opts ...requestOption) (*DeletedParties, error) + Fields func(id string, fieldsWrites TransactionFieldsWrite, controlPolicy string, ...) (*FieldsResponse, error) + FolderCreates func(id string, folderCreates FolderCreates, opts ...requestOption) (*FolderCreatesResponse, error) + FolderRenames func(id string, folderRenames FolderRenames, opts ...requestOption) (*FolderRenamesResponse, error) + Folders func() FoldersResource + FormImports func(id string, transactionFormImports TransactionFormImports, ...) (*FormImportsResponse, error) + GetDetail func(id string, opts ...requestOption) (*Transaction, error) + GetMulti func(ids []string, opts ...requestOption) (*TransactionList, error) + ItemDeletes func(id string, itemDeletes ItemDeletes, opts ...requestOption) (*ItemDeletesResponse, error) + LinkListingInfo func(id string, linkListingInfo LinkListingInfo, opts ...requestOption) (*LinkListingInfoResponse, error) + List func(opts ...requestOption) (*TransactionList, error) + OrgsTransactionsIds func(opts ...requestOption) (*TransactionByOrgSchema, error) + Parties func() PartiesResource + PartyCreates func(id string, partyCreates PartyCreates, opts ...requestOption) (*PartyCreatesResponse, error) + PartyInvites func(id string, partyInvites PartyInvites, opts ...requestOption) (*PartyInvitesResponse, error) + PartyPatches func(id string, partyPatches PartyPatches, opts ...requestOption) (*PartyPatchesResponse, error) + PartyRemoves func(id string, partyRemoves PartyRemoves, opts ...requestOption) (*PartyRemovesResponse, error) + PartyUpdateContactDetails func(id string, partyUpdateContactDetails PartyUpdateContactDetails, ...) (*PartyUpdateContactDetailsResponse, error) + TransactionDocumentAssignments func(id string, transactionDocumentAssignments TransactionDocumentAssignments, ...) (*TransactionDocumentAssignmentsResponse, error) + TransactionDocumentRenames func(id string, transactionDocumentRenames TransactionDocumentRenames, ...) (*TransactionDocumentRenamesResponse, error) + TransactionDocumentRestores func(id string, transactionDocumentsRestores TransactionDocumentsRestores, ...) (*TransactionDocumentRestoresResponse, error) + TransactionDocumentTrashes func(id string, transactionDocumentTrashes TransactionDocumentTrashes, ...) (*TransactionDocumentTrashesResponse, error) + TransactionDocuments func() TransactionDocumentsResource + UpdateArchivalStatus func(id string, transactionArchivalStatus TransactionArchivalStatus, ...) (*UpdateArchivalStatusResponse, error) + UpdateTransactionMeta func(id string, transactionMetaUpdate TransactionMetaUpdate, opts ...requestOption) (*UpdateTransactionMetaResponse, error) + func GetTransactionsClient() (TransactionsResource, error) + type UpdateArchivalStatusResponse struct + Object string + TransactionId string + func (m UpdateArchivalStatusResponse) IsRef() bool + type UpdateTransactionMetaResponse struct + Object string + TransactionId string + func (m UpdateTransactionMetaResponse) IsRef() bool + type UploadsResponse struct + Object string + TransactionId string + func (m UploadsResponse) IsRef() bool + type User struct + AgentAddress *Address + Contact *Contact + Id string + Object string + Uuid string + func (m User) IsRef() bool + type UserBillingInfo struct + Object string + StripeCustomerId string + func (m UserBillingInfo) IsRef() bool + type UserList struct + Data []User + HasMore bool + ListObject string + Object string + func (m UserList) IsRef() bool + func (m UserList) NextPageParams() *PageParams + type UserManagementResource interface + GetDetail func(id string, opts ...requestOption) (*User, error) + List func(opts ...requestOption) (*UserList, error) + Upsert func(userManagementSchema UserManagementSchema, opts ...requestOption) (*User, error) + type UserManagementSchema struct + Email string + FirstName string + LastName string + LinkedSubjectId string + MarketIds []string + SubmarketIds []string + UsState string + type UsersResource interface + Current func(opts ...requestOption) (*User, error) + CurrentBilling func(opts ...requestOption) (*UserBillingInfo, error) + GetDetail func(id string, opts ...requestOption) (*User, error) Other modules containing this package github.com/retitle/go-sdk github.com/retitle/go-sdk/v3 github.com/retitle/go-sdk/v4 github.com/retitle/go-sdk/v5 github.com/retitle/go-sdk/v6
Go to main page