Documents

client.Prism.Objects.Documents.New(ctx context.Context, params micro.PrismObjectDocumentNewParams) (*micro.PrismObjectDocumentNewResponse, error)

client.Prism.Objects.Documents.Update(ctx context.Context, documentID string, params micro.PrismObjectDocumentUpdateParams) (*micro.PrismObjectDocumentUpdateResponse, error)

client.Prism.Objects.Documents.List(ctx context.Context, params micro.PrismObjectDocumentListParams) (*micro.PrismObjectDocumentListResponse, error)

client.Prism.Objects.Documents.Delete(ctx context.Context, documentID string, params micro.PrismObjectDocumentDeleteParams) error

client.Prism.Objects.Documents.BulkNew(ctx context.Context, params micro.PrismObjectDocumentBulkNewParams) (*micro.PrismObjectDocumentBulkNewResponse, error)

client.Prism.Objects.Documents.BulkDelete(ctx context.Context, params micro.PrismObjectDocumentBulkDeleteParams) (*micro.PrismObjectDocumentBulkDeleteResponse, error)

client.Prism.Objects.Documents.BulkUpdate(ctx context.Context, params micro.PrismObjectDocumentBulkUpdateParams) (*micro.PrismObjectDocumentBulkUpdateResponse, error)

client.Prism.Objects.Documents.Count(ctx context.Context, params micro.PrismObjectDocumentCountParams) (*micro.PrismObjectDocumentCountResponse, error)

client.Prism.Objects.Documents.Duplicate(ctx context.Context, documentID string, params micro.PrismObjectDocumentDuplicateParams) (*micro.PrismObjectDocumentDuplicateResponse, error)

client.Prism.Objects.Documents.Find(ctx context.Context, slug string, value string, params micro.PrismObjectDocumentFindParams) (*micro.PrismObjectDocumentFindResponse, error)

client.Prism.Objects.Documents.Get(ctx context.Context, documentID string, params micro.PrismObjectDocumentGetParams) (*micro.PrismObjectDocumentGetResponse, error)

client.Prism.Objects.Documents.Query(ctx context.Context, params micro.PrismObjectDocumentQueryParams) (*micro.PrismObjectDocumentQueryResponse, error)

client.Prism.Objects.Documents.Restore(ctx context.Context, documentID string, params micro.PrismObjectDocumentRestoreParams) (*micro.PrismObjectDocumentRestoreResponse, error)

client.Prism.Objects.Documents.Upsert(ctx context.Context, slug string, value string, params micro.PrismObjectDocumentUpsertParams) (*micro.PrismObjectDocumentUpsertResponse, error)

type PrismObjectDocumentNewResponse 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    prismObjectDocumentNewResponseJSON `json:"-"`
}

type PrismObjectDocumentUpdateResponse 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    prismObjectDocumentUpdateResponseJSON `json:"-"`
}

type PrismObjectDocumentListResponse struct {
	Data []PrismObjectDocumentListResponseData `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  prismObjectDocumentListResponseJSON `json:"-"`
}

type PrismObjectDocumentBulkNewResponse struct {
	// Null for sync imports (results inlined). Set for async imports.
	JobID  string                                   `json:"job_id" api:"required,nullable"`
	Status PrismObjectDocumentBulkNewResponseStatus `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     PrismObjectDocumentBulkNewResponseError `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   []PrismObjectDocumentBulkNewResponseResult `json:"results"`
	Succeeded int64                                      `json:"succeeded"`
	UpdatedAt time.Time                                  `json:"updated_at" format:"date-time"`
	JSON      prismObjectDocumentBulkNewResponseJSON     `json:"-"`
}

type PrismObjectDocumentBulkDeleteResponse struct {
	Results []PrismObjectDocumentBulkDeleteResponseResult `json:"results" api:"required"`
	Summary PrismObjectDocumentBulkDeleteResponseSummary  `json:"summary" api:"required"`
	JSON    prismObjectDocumentBulkDeleteResponseJSON     `json:"-"`
}

type PrismObjectDocumentBulkUpdateResponse struct {
	Results []PrismObjectDocumentBulkUpdateResponseResult `json:"results" api:"required"`
	Summary PrismObjectDocumentBulkUpdateResponseSummary  `json:"summary" api:"required"`
	JSON    prismObjectDocumentBulkUpdateResponseJSON     `json:"-"`
}

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

type PrismObjectDocumentDuplicateResponse 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    prismObjectDocumentDuplicateResponseJSON `json:"-"`
}

type PrismObjectDocumentFindResponse 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    prismObjectDocumentFindResponseJSON `json:"-"`
}

type PrismObjectDocumentGetResponse 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    prismObjectDocumentGetResponseJSON `json:"-"`
}

type PrismObjectDocumentQueryResponse struct {
	Data []PrismObjectDocumentQueryResponseData `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  prismObjectDocumentQueryResponseJSON `json:"-"`
}

type PrismObjectDocumentRestoreResponse 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    prismObjectDocumentRestoreResponseJSON `json:"-"`
}

type PrismObjectDocumentUpsertResponse 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    prismObjectDocumentUpsertResponseJSON `json:"-"`
}

type PrismObjectDocumentNewParams 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 PrismObjectDocumentUpdateParams 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 PrismObjectDocumentListParams 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 PrismObjectDocumentDeleteParams 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 PrismObjectDocumentBulkNewParams 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[PrismObjectDocumentBulkNewParamsOptions] `json:"options"`
	IdempotencyKey param.Field[string]                                  `header:"Idempotency-Key"`
}

type PrismObjectDocumentBulkDeleteParams 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 PrismObjectDocumentBulkUpdateParams 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[[]PrismObjectDocumentBulkUpdateParamsItem] `json:"items" api:"required"`
	IdempotencyKey param.Field[string]                                    `header:"Idempotency-Key"`
}

type PrismObjectDocumentCountParams 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 PrismObjectDocumentDuplicateParams 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 PrismObjectDocumentFindParams 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 PrismObjectDocumentGetParams 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 PrismObjectDocumentQueryParams 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[PrismObjectDocumentQueryParamsQuery]   `json:"query" api:"required"`
	ID     param.Field[PrismObjectDocumentQueryParamsIDUnion] `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 PrismObjectDocumentRestoreParams 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 PrismObjectDocumentUpsertParams 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 PrismObjectDocumentListResponseData 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       prismObjectDocumentListResponseDataJSON `json:"-"`
}

type PrismObjectDocumentBulkNewResponseStatus string

type Error = apierror.Error

type PrismObjectDocumentBulkNewResponseError struct {
	Code    string                                      `json:"code"`
	Message string                                      `json:"message"`
	JSON    prismObjectDocumentBulkNewResponseErrorJSON `json:"-"`
}

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

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

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

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

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

type PrismObjectDocumentQueryResponseData 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       prismObjectDocumentQueryResponseDataJSON `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 PrismObjectDocumentBulkNewParamsOptions 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 PrismObjectDocumentBulkUpdateParamsItem struct {
	ID          param.Field[string]    `json:"id" api:"required" format:"uuid"`
	ExtraFields map[string]interface{} `json:"-,extras"`
}

type PrismObjectDocumentQueryParamsQuery 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[PrismObjectDocumentQueryParamsQueryCombinator] `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]PrismObjectDocumentQueryParamsQueryFilterUnion] `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]PrismObjectDocumentQueryParamsQuerySort] `json:"sort"`
}

type PrismObjectDocumentQueryParamsIDUnion interface {
	ImplementsPrismObjectDocumentQueryParamsIDUnion()
}

type PrismObjectDocumentBulkNewResponseResultsError struct {
	Code    string                                             `json:"code"`
	Message string                                             `json:"message"`
	JSON    prismObjectDocumentBulkNewResponseResultsErrorJSON `json:"-"`
}

type PrismObjectDocumentBulkDeleteResponseResultsStatus string

type PrismObjectDocumentBulkDeleteResponseResultsError struct {
	Code    string                                                `json:"code"`
	Message string                                                `json:"message"`
	JSON    prismObjectDocumentBulkDeleteResponseResultsErrorJSON `json:"-"`
}

type PrismObjectDocumentBulkDeleteResponseResultsRecord 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    prismObjectDocumentBulkDeleteResponseResultsRecordJSON `json:"-"`
}

type PrismObjectDocumentBulkUpdateResponseResultsStatus string

type PrismObjectDocumentBulkUpdateResponseResultsError struct {
	Code    string                                                `json:"code"`
	Message string                                                `json:"message"`
	JSON    prismObjectDocumentBulkUpdateResponseResultsErrorJSON `json:"-"`
}

type PrismObjectDocumentBulkUpdateResponseResultsRecord 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    prismObjectDocumentBulkUpdateResponseResultsRecordJSON `json:"-"`
}

type PrismObjectDocumentQueryParamsQueryCombinator string

type PrismObjectDocumentQueryParamsQueryFilterUnion interface {
	implementsPrismObjectDocumentQueryParamsQueryFilterUnion()
}

type PrismObjectDocumentQueryParamsQuerySort string