Class FieldValues

Index

Methods

all create delete update

Methods

all

all(params): Promise<FieldValueResponse>
Fetches field values based on the provided parameters.
Parameters
- params: AllQueryParameters
Returns Promise<FieldValueResponse>
An array of field value objects.
Example
```
const fieldValues = await affinity.fieldValues.getAll({ person_id: 1234 })
console.log(fieldValues)
```
- Defined in src/v1/field_values.ts:245

create

create(data): Promise<FieldValue>
Creates a new field value.
Parameters
- data: CreateFieldValueRequest
  Object containing the data for creating a new field value
Returns Promise<FieldValue>
The created field value object.
Example
```
const newFieldValue = await affinity.fieldValues.create({
    field_id: 1284,
    entity_id: 38706,
    value: "Architecture"
})
console.log(newFieldValue)
```
- Defined in src/v1/field_values.ts:277

delete

delete(__namedParameters): Promise<boolean>
Deletes a specific field value.
Parameters
- __namedParameters: {
  field_value_id: number;
  }
  - field_value_id: number
Returns Promise<boolean>
boolean indicating whether the field value was successfully deleted.
Example
```
const success = await affinity.fieldValues.delete({
    field_value_id: 20406836
})
console.log(success ? 'Field value deleted': 'Field value not deleted')
```
- Defined in src/v1/field_values.ts:346

update

update(data): Promise<FieldValue>
Updates an existing field value.
Parameters
- data: UpdateFieldValueRequest
  Object containing the data for updating a field value
Returns Promise<FieldValue>
The updated field value object.
Example
```
const updatedFieldValue = await affinity.fieldValues.update({
    field_value_id: 20406836,
    value: "Healthcare"
})
console.log(updatedFieldValue)
```
- Defined in src/v1/field_values.ts:313