api.md

Data

Objects

Types:

• UObject
• ObjectCreateResponse
• ObjectRetrieveResponse
• ObjectUpdateResponse
• ObjectListResponse
• ObjectDeleteResponse

Methods:

• client.data.objects.create({ ...params }) -> ObjectCreateResponse
• client.data.objects.retrieve(objectName) -> ObjectRetrieveResponse
• client.data.objects.update(objectName, { ...params }) -> ObjectUpdateResponse
• client.data.objects.list() -> ObjectListResponse
• client.data.objects.delete(objectName) -> ObjectDeleteResponse

Attributes

Types:

• UAttribute
• UAttributeOptionUpdateItem
• UReferenceCardinality
• URelatedReferenceAttribute
• AttributeCreateResponse
• AttributeRetrieveResponse
• AttributeUpdateResponse
• AttributeListResponse
• AttributeDeleteResponse

Methods:

• client.data.attributes.create(objectName, { ...params }) -> AttributeCreateResponse
• client.data.attributes.retrieve(attributeName, { ...params }) -> AttributeRetrieveResponse
• client.data.attributes.update(attributeName, { ...params }) -> AttributeUpdateResponse
• client.data.attributes.list(objectName) -> AttributeListResponse
• client.data.attributes.delete(attributeName, { ...params }) -> AttributeDeleteResponse

Options

Types:

• UAttributeOption
• OptionCreateResponse
• OptionRetrieveResponse
• OptionUpdateResponse
• OptionListResponse
• OptionDeleteResponse

Methods:

• client.data.attributes.options.create(attributeName, { ...params }) -> OptionCreateResponse
• client.data.attributes.options.retrieve(optionName, { ...params }) -> OptionRetrieveResponse
• client.data.attributes.options.update(optionName, { ...params }) -> OptionUpdateResponse
• client.data.attributes.options.list(attributeName, { ...params }) -> OptionListResponse
• client.data.attributes.options.delete(optionName, { ...params }) -> OptionDeleteResponse

Records

Types:

• UAddress
• UBoolean
• UCompanyAttributes
• UCountry
• UCurrency
• UDate
• UDatetime
• UDecimal
• UEmail
• UInteger
• UMultiselect
• UOpportunityAttributes
• UPersonAttributes
• UPhoneNumber
• URecord
• URecordAttributes
• UReferenceByID
• UReferenceByMatch
• UReferenceByUpsert
• USelect
• UText
• UURL
• UUuid
• UValue
• ValidationMode
• RecordCreateResponse
• RecordRetrieveResponse
• RecordUpdateResponse
• RecordDeleteResponse
• RecordFindUniqueResponse
• RecordUpsertResponse

Methods:

• client.data.records.create(objectName, { ...params }) -> RecordCreateResponse
• client.data.records.retrieve(recordID, { ...params }) -> RecordRetrieveResponse
• client.data.records.update(recordID, { ...params }) -> RecordUpdateResponse
• client.data.records.delete(recordID, { ...params }) -> RecordDeleteResponse
• client.data.records.findUnique(objectName, { ...params }) -> RecordFindUniqueResponse
• client.data.records.upsert(objectName, { ...params }) -> RecordUpsertResponse