Contacts

client.Prism.Objects.Contacts.New(ctx context.Context, params micro.PrismObjectContactNewParams) (*micro.PrismObjectContactNewResponse, error)

client.Prism.Objects.Contacts.Update(ctx context.Context, contactID string, params micro.PrismObjectContactUpdateParams) (*micro.PrismObjectContactUpdateResponse, error)

client.Prism.Objects.Contacts.List(ctx context.Context, params micro.PrismObjectContactListParams) (*micro.PrismObjectContactListResponse, error)

client.Prism.Objects.Contacts.Delete(ctx context.Context, contactID string, params micro.PrismObjectContactDeleteParams) error

client.Prism.Objects.Contacts.BulkNew(ctx context.Context, params micro.PrismObjectContactBulkNewParams) (*micro.PrismObjectContactBulkNewResponse, error)

client.Prism.Objects.Contacts.BulkDelete(ctx context.Context, params micro.PrismObjectContactBulkDeleteParams) (*micro.PrismObjectContactBulkDeleteResponse, error)

client.Prism.Objects.Contacts.BulkUpdate(ctx context.Context, params micro.PrismObjectContactBulkUpdateParams) (*micro.PrismObjectContactBulkUpdateResponse, error)

client.Prism.Objects.Contacts.Count(ctx context.Context, params micro.PrismObjectContactCountParams) (*micro.PrismObjectContactCountResponse, error)

client.Prism.Objects.Contacts.Duplicate(ctx context.Context, contactID string, params micro.PrismObjectContactDuplicateParams) (*micro.PrismObjectContactDuplicateResponse, error)

client.Prism.Objects.Contacts.Find(ctx context.Context, slug string, value string, params micro.PrismObjectContactFindParams) (*micro.PrismObjectContactFindResponse, error)

client.Prism.Objects.Contacts.Get(ctx context.Context, contactID string, params micro.PrismObjectContactGetParams) (*micro.PrismObjectContactGetResponse, error)

client.Prism.Objects.Contacts.Query(ctx context.Context, params micro.PrismObjectContactQueryParams) (*micro.PrismObjectContactQueryResponse, error)

client.Prism.Objects.Contacts.Restore(ctx context.Context, contactID string, params micro.PrismObjectContactRestoreParams) (*micro.PrismObjectContactRestoreResponse, error)

client.Prism.Objects.Contacts.Upsert(ctx context.Context, slug string, value string, params micro.PrismObjectContactUpsertParams) (*micro.PrismObjectContactUpsertResponse, error)

type PrismObjectContactNewResponse struct {
	ID string `json:"id" api:"required" format:"uuid"`
	// Properties keyed by property slug.
	Default map[string]interface{}            `json:"default"`
	List    interface{}                       `json:"list"`
	JSON    prismObjectContactNewResponseJSON `json:"-"`
}

type PrismObjectContactUpdateResponse struct {
	ID string `json:"id" api:"required" format:"uuid"`
	// Properties keyed by property slug.
	Default map[string]interface{}               `json:"default"`
	List    interface{}                          `json:"list"`
	JSON    prismObjectContactUpdateResponseJSON `json:"-"`
}

type PrismObjectContactListResponse struct {
	Data []PrismObjectContactListResponseData `json:"data" api:"required"`
	// Accurate end-of-data signal — false on the last page, never forces clients to
	// overshoot.
	HasMore    bool   `json:"has_more" api:"required"`
	NextCursor string `json:"next_cursor" api:"nullable"`
	// Populated only when `?include_total=true` was passed.
	Total int64                              `json:"total" api:"nullable"`
	JSON  prismObjectContactListResponseJSON `json:"-"`
}

type PrismObjectContactBulkNewResponse struct {
	// Null for sync imports (results inlined). Set for async imports.
	JobID  string                                  `json:"job_id" api:"required,nullable"`
	Status PrismObjectContactBulkNewResponseStatus `json:"status" api:"required"`
	// Total number of rows in the import.
	Total     int64     `json:"total" api:"required"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Set when status=failed; describes the job-level failure (not per-row).
	Error     PrismObjectContactBulkNewResponseError `json:"error"`
	ExpiresAt time.Time                              `json:"expires_at" format:"date-time"`
	Failed    int64                                  `json:"failed"`
	// Rows that have been attempted (succeeded + failed).
	Processed int64 `json:"processed"`
	// Per-row outcomes. Always present for sync imports; populated for async imports
	// once the job reaches `complete`.
	Results   []PrismObjectContactBulkNewResponseResult `json:"results"`
	Succeeded int64                                     `json:"succeeded"`
	UpdatedAt time.Time                                 `json:"updated_at" format:"date-time"`
	JSON      prismObjectContactBulkNewResponseJSON     `json:"-"`
}

type PrismObjectContactBulkDeleteResponse struct {
	Results []PrismObjectContactBulkDeleteResponseResult `json:"results" api:"required"`
	Summary PrismObjectContactBulkDeleteResponseSummary  `json:"summary" api:"required"`
	JSON    prismObjectContactBulkDeleteResponseJSON     `json:"-"`
}

type PrismObjectContactBulkUpdateResponse struct {
	Results []PrismObjectContactBulkUpdateResponseResult `json:"results" api:"required"`
	Summary PrismObjectContactBulkUpdateResponseSummary  `json:"summary" api:"required"`
	JSON    prismObjectContactBulkUpdateResponseJSON     `json:"-"`
}

type PrismObjectContactCountResponse struct {
	// Number of records matching the access scope.
	Total int64                               `json:"total" api:"required"`
	JSON  prismObjectContactCountResponseJSON `json:"-"`
}

type PrismObjectContactDuplicateResponse struct {
	ID string `json:"id" api:"required" format:"uuid"`
	// Properties keyed by property slug.
	Default map[string]interface{}                  `json:"default"`
	List    interface{}                             `json:"list"`
	JSON    prismObjectContactDuplicateResponseJSON `json:"-"`
}

type PrismObjectContactFindResponse struct {
	ID string `json:"id" api:"required" format:"uuid"`
	// Properties keyed by property slug.
	Default map[string]interface{}             `json:"default"`
	List    interface{}                        `json:"list"`
	JSON    prismObjectContactFindResponseJSON `json:"-"`
}

type PrismObjectContactGetResponse struct {
	ID string `json:"id" api:"required" format:"uuid"`
	// Properties keyed by property slug.
	Default map[string]interface{}            `json:"default"`
	List    interface{}                       `json:"list"`
	JSON    prismObjectContactGetResponseJSON `json:"-"`
}

type PrismObjectContactQueryResponse struct {
	Data []PrismObjectContactQueryResponseData `json:"data" api:"required"`
	// Accurate end-of-data signal. False when this page contains the last record; true
	// only when at least one more record exists. (Implementation note: the server
	// fetches one extra row internally to determine this — clients never need to
	// overshoot to discover the end.)
	HasMore bool `json:"has_more" api:"required"`
	// Opaque cursor pointing at the next page. Pass it back unchanged in the request
	// body (`cursor`) of the next call. Null when `has_more` is false.
	NextCursor string `json:"next_cursor" api:"nullable"`
	// Only populated when the request set `include_total: true`. Total number of
	// records matching the query, ignoring pagination. Opt-in because it costs an
	// additional pass over the result set.
	Total int64                               `json:"total" api:"nullable"`
	JSON  prismObjectContactQueryResponseJSON `json:"-"`
}

type PrismObjectContactRestoreResponse struct {
	ID string `json:"id" api:"required" format:"uuid"`
	// Properties keyed by property slug.
	Default map[string]interface{}                `json:"default"`
	List    interface{}                           `json:"list"`
	JSON    prismObjectContactRestoreResponseJSON `json:"-"`
}

type PrismObjectContactUpsertResponse struct {
	ID string `json:"id" api:"required" format:"uuid"`
	// Properties keyed by property slug.
	Default map[string]interface{}               `json:"default"`
	List    interface{}                          `json:"list"`
	JSON    prismObjectContactUpsertResponseJSON `json:"-"`
}

type PrismObjectContactNewParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	TeamID                param.Field[string]        `path:"teamId" api:"required" format:"uuid"`
	PrismObjectProperties PrismObjectPropertiesParam `json:"prism_object_properties" api:"required"`
	IdempotencyKey        param.Field[string]        `header:"Idempotency-Key"`
}

type PrismObjectContactUpdateParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	TeamID                param.Field[string]        `path:"teamId" api:"required" format:"uuid"`
	PrismObjectProperties PrismObjectPropertiesParam `json:"prism_object_properties" api:"required"`
	IdempotencyKey        param.Field[string]        `header:"Idempotency-Key"`
	IfMatch               param.Field[string]        `header:"If-Match"`
}

type PrismObjectContactListParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	TeamID param.Field[string] `path:"teamId" api:"required" format:"uuid"`
	// Opaque cursor from a previous response's `next_cursor`. Pass it back unchanged
	// to fetch the next page.
	Cursor param.Field[string] `query:"cursor"`
	// Include soft-deleted records. Pass the literal string `true`.
	Deleted param.Field[bool] `query:"deleted"`
	// When set to `true`, the response includes a `total` field with the unpaginated
	// row count. Costs an extra pass; prefer `GET .../count` for the unfiltered total.
	IncludeTotal param.Field[bool] `query:"include_total"`
	// Maximum number of rows to return. Capped server-side at 50.
	Limit param.Field[int64] `query:"limit"`
	// Scope properties to a specific list/app.
	ListID param.Field[string] `query:"list_id" format:"uuid"`
	// Comma-separated property slugs to return. Use dot notation for relationships.
	// `id` is always returned at the top level. Defaults to all properties.
	Select param.Field[string] `query:"select"`
	// Comma-separated list of slugs. Prefix with `-` for descending. Example:
	// `sort=-updated_at,name`.
	Sort param.Field[string] `query:"sort"`
}

type PrismObjectContactDeleteParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	TeamID  param.Field[string] `path:"teamId" api:"required" format:"uuid"`
	IfMatch param.Field[string] `header:"If-Match"`
}

type PrismObjectContactBulkNewParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	TeamID param.Field[string] `path:"teamId" api:"required" format:"uuid"`
	// Array of objects to import with property values keyed by slug
	Objects        param.Field[[]PrismObjectPropertiesParam]           `json:"objects" api:"required"`
	Options        param.Field[PrismObjectContactBulkNewParamsOptions] `json:"options"`
	IdempotencyKey param.Field[string]                                 `header:"Idempotency-Key"`
}

type PrismObjectContactBulkDeleteParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	TeamID         param.Field[string]   `path:"teamId" api:"required" format:"uuid"`
	IDs            param.Field[[]string] `json:"ids" api:"required" format:"uuid"`
	IdempotencyKey param.Field[string]   `header:"Idempotency-Key"`
}

type PrismObjectContactBulkUpdateParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	TeamID         param.Field[string]                                   `path:"teamId" api:"required" format:"uuid"`
	Items          param.Field[[]PrismObjectContactBulkUpdateParamsItem] `json:"items" api:"required"`
	IdempotencyKey param.Field[string]                                   `header:"Idempotency-Key"`
}

type PrismObjectContactCountParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	TeamID param.Field[string] `path:"teamId" api:"required" format:"uuid"`
	// Scope the count to a specific list/app.
	ListID param.Field[string] `query:"list_id" format:"uuid"`
}

type PrismObjectContactDuplicateParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	TeamID         param.Field[string] `path:"teamId" api:"required" format:"uuid"`
	IdempotencyKey param.Field[string] `header:"Idempotency-Key"`
}

type PrismObjectContactFindParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	TeamID param.Field[string] `path:"teamId" api:"required" format:"uuid"`
	// Scope the lookup to a specific list/app.
	ListID param.Field[string] `query:"list_id" format:"uuid"`
}

type PrismObjectContactGetParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	TeamID param.Field[string] `path:"teamId" api:"required" format:"uuid"`
	// Comma-separated property slugs to return. Use dot notation for relationships.
	// `id` is always returned at the top level. Defaults to all properties.
	Select param.Field[string] `query:"select"`
}

type PrismObjectContactQueryParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	TeamID param.Field[string]                               `path:"teamId" api:"required" format:"uuid"`
	Query  param.Field[PrismObjectContactQueryParamsQuery]   `json:"query" api:"required"`
	ID     param.Field[PrismObjectContactQueryParamsIDUnion] `json:"id" format:"uuid"`
	Boxes  param.Field[[]string]                             `json:"boxes"`
	// Alternative location for the opaque cursor (a sibling of `query`). Use whichever
	// feels more natural; if both are present, `query.cursor` wins.
	Cursor  param.Field[string] `json:"cursor"`
	Deleted param.Field[bool]   `json:"deleted"`
	// When true, the response includes a `total` field with the unpaginated row count.
	// Costs an additional pass over the result set — for unfiltered totals prefer
	// `GET /v2/prism/{teamId}/{objectType}/count` instead.
	IncludeTotal param.Field[bool]     `json:"include_total"`
	Sources      param.Field[[]string] `json:"sources" format:"uuid"`
}

type PrismObjectContactRestoreParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	TeamID         param.Field[string] `path:"teamId" api:"required" format:"uuid"`
	IdempotencyKey param.Field[string] `header:"Idempotency-Key"`
}

type PrismObjectContactUpsertParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	TeamID                param.Field[string]        `path:"teamId" api:"required" format:"uuid"`
	PrismObjectProperties PrismObjectPropertiesParam `json:"prism_object_properties" api:"required"`
	IdempotencyKey        param.Field[string]        `header:"Idempotency-Key"`
}

type PrismObjectContactListResponseData struct {
	ID           string `json:"id" api:"required" format:"uuid"`
	IsUserObject bool   `json:"is_user_object"`
	// Selected property values keyed by property slug. For select/multiselect
	// properties, option slugs are returned. For reference properties, values are
	// nested `{ id, properties }` objects.
	Properties map[string]interface{}                 `json:"properties"`
	Source     []string                               `json:"source" api:"nullable"`
	JSON       prismObjectContactListResponseDataJSON `json:"-"`
}

type PrismObjectContactBulkNewResponseStatus string

type Error = apierror.Error

type PrismObjectContactBulkNewResponseError struct {
	Code    string                                     `json:"code"`
	Message string                                     `json:"message"`
	JSON    prismObjectContactBulkNewResponseErrorJSON `json:"-"`
}

type PrismObjectContactBulkNewResponseResult struct {
	ID      string                                        `json:"id" api:"nullable" format:"uuid"`
	Created bool                                          `json:"created"`
	Error   PrismObjectContactBulkNewResponseResultsError `json:"error"`
	// True if the row matched an existing record via the dedupe key.
	Existing bool                                        `json:"existing"`
	JSON     prismObjectContactBulkNewResponseResultJSON `json:"-"`
}

type PrismObjectContactBulkDeleteResponseResult struct {
	// Item ID, or null if the input was unparseable.
	ID     string                                            `json:"id" api:"required,nullable"`
	Status PrismObjectContactBulkDeleteResponseResultsStatus `json:"status" api:"required"`
	Error  PrismObjectContactBulkDeleteResponseResultsError  `json:"error"`
	// Object returned by reads (get/create/patch/restore). id is always present.
	Record PrismObjectContactBulkDeleteResponseResultsRecord `json:"record"`
	JSON   prismObjectContactBulkDeleteResponseResultJSON    `json:"-"`
}

type PrismObjectContactBulkDeleteResponseSummary struct {
	Failed    int64                                           `json:"failed" api:"required"`
	Succeeded int64                                           `json:"succeeded" api:"required"`
	Total     int64                                           `json:"total" api:"required"`
	JSON      prismObjectContactBulkDeleteResponseSummaryJSON `json:"-"`
}

type PrismObjectContactBulkUpdateResponseResult struct {
	// Item ID, or null if the input was unparseable.
	ID     string                                            `json:"id" api:"required,nullable"`
	Status PrismObjectContactBulkUpdateResponseResultsStatus `json:"status" api:"required"`
	Error  PrismObjectContactBulkUpdateResponseResultsError  `json:"error"`
	// Object returned by reads (get/create/patch/restore). id is always present.
	Record PrismObjectContactBulkUpdateResponseResultsRecord `json:"record"`
	JSON   prismObjectContactBulkUpdateResponseResultJSON    `json:"-"`
}

type PrismObjectContactBulkUpdateResponseSummary struct {
	Failed    int64                                           `json:"failed" api:"required"`
	Succeeded int64                                           `json:"succeeded" api:"required"`
	Total     int64                                           `json:"total" api:"required"`
	JSON      prismObjectContactBulkUpdateResponseSummaryJSON `json:"-"`
}

type PrismObjectContactQueryResponseData struct {
	ID           string `json:"id" api:"required" format:"uuid"`
	IsUserObject bool   `json:"is_user_object"`
	// Selected property values keyed by property slug. For select/multiselect
	// properties, option slugs are returned. For reference properties, values are
	// nested `{ id, properties }` objects.
	Properties map[string]interface{}                  `json:"properties"`
	Source     []string                                `json:"source" api:"nullable"`
	JSON       prismObjectContactQueryResponseDataJSON `json:"-"`
}

type PrismObjectPropertiesParam struct {
	// Properties keyed by property slug. Values can be strings, numbers, booleans,
	// arrays, or null. For select/multiselect properties, values may be option slugs
	// or option UUIDs on write; option slugs are returned on read.
	Default param.Field[map[string]interface{}] `json:"default"`
	List    param.Field[interface{}]            `json:"list"`
}

type PrismObjectContactBulkNewParamsOptions struct {
	// Whether deduplication should be case insensitive
	CaseInsensitive param.Field[bool] `json:"caseInsensitive"`
	// Property slug to deduplicate on
	DedupeBy param.Field[string] `json:"dedupe_by"`
	// App/CRM ID for context (optional)
	ListID param.Field[string] `json:"list_id" format:"uuid"`
}

type PrismObjectContactBulkUpdateParamsItem struct {
	ID          param.Field[string]    `json:"id" api:"required" format:"uuid"`
	ExtraFields map[string]interface{} `json:"-,extras"`
}

type PrismObjectContactQueryParamsQuery struct {
	// Property slugs to select. Use dot notation for relationships (e.g.
	// attendee.contact.first_name). `id` is always returned at the top level of each
	// row and does not need to be selected.
	Select param.Field[[]string] `json:"select" api:"required"`
	// Logical operator for combining filters
	Combinator param.Field[PrismObjectContactQueryParamsQueryCombinator] `json:"combinator"`
	// Opaque cursor from a previous response's `next_cursor`. Pass it back unchanged
	// to fetch the next page. When set, `page` and `limit` are derived from the cursor
	// and any explicit values are ignored.
	Cursor param.Field[string] `json:"cursor"`
	// Filters as [{ slug: { operator: value } }]. For select/multiselect properties,
	// values may be option slugs or option UUIDs.
	Filter param.Field[[]map[string]PrismObjectContactQueryParamsQueryFilterUnion] `json:"filter"`
	// Maximum number of rows to return. Capped server-side at 50; requests above the
	// cap are rejected.
	Limit  param.Field[int64]  `json:"limit"`
	ListID param.Field[string] `json:"list_id" format:"uuid"`
	// Page number (1-based). Prefer `cursor`. Page-number pagination drifts under
	// concurrent writes; use it only for one-shot exports.
	//
	// Deprecated: deprecated
	Page param.Field[int64] `json:"page"`
	// Sort order as [{ slug: direction }]. Array order determines sort priority
	Sort param.Field[[]map[string]PrismObjectContactQueryParamsQuerySort] `json:"sort"`
}

type PrismObjectContactQueryParamsIDUnion interface {
	ImplementsPrismObjectContactQueryParamsIDUnion()
}

type PrismObjectContactBulkNewResponseResultsError struct {
	Code    string                                            `json:"code"`
	Message string                                            `json:"message"`
	JSON    prismObjectContactBulkNewResponseResultsErrorJSON `json:"-"`
}

type PrismObjectContactBulkDeleteResponseResultsStatus string

type PrismObjectContactBulkDeleteResponseResultsError struct {
	Code    string                                               `json:"code"`
	Message string                                               `json:"message"`
	JSON    prismObjectContactBulkDeleteResponseResultsErrorJSON `json:"-"`
}

type PrismObjectContactBulkDeleteResponseResultsRecord struct {
	ID string `json:"id" api:"required" format:"uuid"`
	// Properties keyed by property slug.
	Default map[string]interface{}                                `json:"default"`
	List    interface{}                                           `json:"list"`
	JSON    prismObjectContactBulkDeleteResponseResultsRecordJSON `json:"-"`
}

type PrismObjectContactBulkUpdateResponseResultsStatus string

type PrismObjectContactBulkUpdateResponseResultsError struct {
	Code    string                                               `json:"code"`
	Message string                                               `json:"message"`
	JSON    prismObjectContactBulkUpdateResponseResultsErrorJSON `json:"-"`
}

type PrismObjectContactBulkUpdateResponseResultsRecord struct {
	ID string `json:"id" api:"required" format:"uuid"`
	// Properties keyed by property slug.
	Default map[string]interface{}                                `json:"default"`
	List    interface{}                                           `json:"list"`
	JSON    prismObjectContactBulkUpdateResponseResultsRecordJSON `json:"-"`
}

type PrismObjectContactQueryParamsQueryCombinator string

type PrismObjectContactQueryParamsQueryFilterUnion interface {
	implementsPrismObjectContactQueryParamsQueryFilterUnion()
}

type PrismObjectContactQueryParamsQuerySort string