api.md

Data

Objects

Types:

from unify.types.data import (
    UObject,
    ObjectCreateResponse,
    ObjectRetrieveResponse,
    ObjectUpdateResponse,
    ObjectListResponse,
    ObjectDeleteResponse,
)

Methods:

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

Attributes

Types:

from unify.types.data import (
    UAttribute,
    UAttributeOptionUpdateItem,
    UReferenceCardinality,
    URelatedReferenceAttribute,
    AttributeCreateResponse,
    AttributeRetrieveResponse,
    AttributeUpdateResponse,
    AttributeListResponse,
    AttributeDeleteResponse,
)

Methods:

• client.data.attributes.create(object_name, **params) -> AttributeCreateResponse
• client.data.attributes.retrieve(attribute_name, *, object_name) -> AttributeRetrieveResponse
• client.data.attributes.update(attribute_name, *, object_name, **params) -> AttributeUpdateResponse
• client.data.attributes.list(object_name) -> AttributeListResponse
• client.data.attributes.delete(attribute_name, *, object_name) -> AttributeDeleteResponse

Options

Types:

from unify.types.data.attributes import (
    UAttributeOption,
    OptionCreateResponse,
    OptionRetrieveResponse,
    OptionUpdateResponse,
    OptionListResponse,
    OptionDeleteResponse,
)

Methods:

• client.data.attributes.options.create(attribute_name, *, object_name, **params) -> OptionCreateResponse
• client.data.attributes.options.retrieve(option_name, *, object_name, attribute_name) -> OptionRetrieveResponse
• client.data.attributes.options.update(option_name, *, object_name, attribute_name, **params) -> OptionUpdateResponse
• client.data.attributes.options.list(attribute_name, *, object_name) -> OptionListResponse
• client.data.attributes.options.delete(option_name, *, object_name, attribute_name) -> OptionDeleteResponse

Records

Types:

from unify.types.data import (
    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(object_name, **params) -> RecordCreateResponse
• client.data.records.retrieve(record_id, *, object_name) -> RecordRetrieveResponse
• client.data.records.update(record_id, *, object_name, **params) -> RecordUpdateResponse
• client.data.records.delete(record_id, *, object_name) -> RecordDeleteResponse
• client.data.records.find_unique(object_name, **params) -> RecordFindUniqueResponse
• client.data.records.upsert(object_name, **params) -> RecordUpsertResponse