Organizations

client.Prism.Objects.Organizations.New(ctx context.Context, params micro.PrismObjectOrganizationNewParams) (*micro.PrismObjectOrganizationNewResponse, error)

client.Prism.Objects.Organizations.Update(ctx context.Context, organizationID string, params micro.PrismObjectOrganizationUpdateParams) (*micro.PrismObjectOrganizationUpdateResponse, error)

client.Prism.Objects.Organizations.List(ctx context.Context, params micro.PrismObjectOrganizationListParams) (*micro.PrismObjectOrganizationListResponse, error)

client.Prism.Objects.Organizations.Delete(ctx context.Context, organizationID string, params micro.PrismObjectOrganizationDeleteParams) error

client.Prism.Objects.Organizations.BulkNew(ctx context.Context, params micro.PrismObjectOrganizationBulkNewParams) (*micro.PrismObjectOrganizationBulkNewResponse, error)

client.Prism.Objects.Organizations.BulkDelete(ctx context.Context, params micro.PrismObjectOrganizationBulkDeleteParams) (*micro.PrismObjectOrganizationBulkDeleteResponse, error)

client.Prism.Objects.Organizations.BulkUpdate(ctx context.Context, params micro.PrismObjectOrganizationBulkUpdateParams) (*micro.PrismObjectOrganizationBulkUpdateResponse, error)

client.Prism.Objects.Organizations.Count(ctx context.Context, params micro.PrismObjectOrganizationCountParams) (*micro.PrismObjectOrganizationCountResponse, error)

client.Prism.Objects.Organizations.Duplicate(ctx context.Context, organizationID string, params micro.PrismObjectOrganizationDuplicateParams) (*micro.PrismObjectOrganizationDuplicateResponse, error)

client.Prism.Objects.Organizations.Find(ctx context.Context, slug string, value string, params micro.PrismObjectOrganizationFindParams) (*micro.PrismObjectOrganizationFindResponse, error)

client.Prism.Objects.Organizations.Get(ctx context.Context, organizationID string, params micro.PrismObjectOrganizationGetParams) (*micro.PrismObjectOrganizationGetResponse, error)

client.Prism.Objects.Organizations.Query(ctx context.Context, params micro.PrismObjectOrganizationQueryParams) (*micro.PrismObjectOrganizationQueryResponse, error)

client.Prism.Objects.Organizations.Restore(ctx context.Context, organizationID string, params micro.PrismObjectOrganizationRestoreParams) (*micro.PrismObjectOrganizationRestoreResponse, error)

client.Prism.Objects.Organizations.Upsert(ctx context.Context, slug string, value string, params micro.PrismObjectOrganizationUpsertParams) (*micro.PrismObjectOrganizationUpsertResponse, error)

type PrismObjectOrganizationNewResponse 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    prismObjectOrganizationNewResponseJSON `json:"-"`
}

type PrismObjectOrganizationUpdateResponse 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    prismObjectOrganizationUpdateResponseJSON `json:"-"`
}

type PrismObjectOrganizationListResponse struct {
	Data []PrismObjectOrganizationListResponseData `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  prismObjectOrganizationListResponseJSON `json:"-"`
}

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

type PrismObjectOrganizationBulkDeleteResponse struct {
	Results []PrismObjectOrganizationBulkDeleteResponseResult `json:"results" api:"required"`
	Summary PrismObjectOrganizationBulkDeleteResponseSummary  `json:"summary" api:"required"`
	JSON    prismObjectOrganizationBulkDeleteResponseJSON     `json:"-"`
}

type PrismObjectOrganizationBulkUpdateResponse struct {
	Results []PrismObjectOrganizationBulkUpdateResponseResult `json:"results" api:"required"`
	Summary PrismObjectOrganizationBulkUpdateResponseSummary  `json:"summary" api:"required"`
	JSON    prismObjectOrganizationBulkUpdateResponseJSON     `json:"-"`
}

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

type PrismObjectOrganizationDuplicateResponse 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    prismObjectOrganizationDuplicateResponseJSON `json:"-"`
}

type PrismObjectOrganizationFindResponse 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    prismObjectOrganizationFindResponseJSON `json:"-"`
}

type PrismObjectOrganizationGetResponse 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    prismObjectOrganizationGetResponseJSON `json:"-"`
}

type PrismObjectOrganizationQueryResponse struct {
	Data []PrismObjectOrganizationQueryResponseData `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  prismObjectOrganizationQueryResponseJSON `json:"-"`
}

type PrismObjectOrganizationRestoreResponse 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    prismObjectOrganizationRestoreResponseJSON `json:"-"`
}

type PrismObjectOrganizationUpsertResponse 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    prismObjectOrganizationUpsertResponseJSON `json:"-"`
}

type PrismObjectOrganizationNewParams 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 PrismObjectOrganizationUpdateParams 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 PrismObjectOrganizationListParams 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 PrismObjectOrganizationDeleteParams 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 PrismObjectOrganizationBulkNewParams 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[PrismObjectOrganizationBulkNewParamsOptions] `json:"options"`
	IdempotencyKey param.Field[string]                                      `header:"Idempotency-Key"`
}

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

type PrismObjectOrganizationCountParams 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 PrismObjectOrganizationDuplicateParams 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 PrismObjectOrganizationFindParams 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 PrismObjectOrganizationGetParams 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 PrismObjectOrganizationQueryParams 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[PrismObjectOrganizationQueryParamsQuery]   `json:"query" api:"required"`
	ID     param.Field[PrismObjectOrganizationQueryParamsIDUnion] `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 PrismObjectOrganizationRestoreParams 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 PrismObjectOrganizationUpsertParams 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 PrismObjectOrganizationListResponseData 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       prismObjectOrganizationListResponseDataJSON `json:"-"`
}

type PrismObjectOrganizationBulkNewResponseStatus string

type Error = apierror.Error

type PrismObjectOrganizationBulkNewResponseError struct {
	Code    string                                          `json:"code"`
	Message string                                          `json:"message"`
	JSON    prismObjectOrganizationBulkNewResponseErrorJSON `json:"-"`
}

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

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

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

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

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

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

type PrismObjectOrganizationQueryParamsQuery 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[PrismObjectOrganizationQueryParamsQueryCombinator] `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]PrismObjectOrganizationQueryParamsQueryFilterUnion] `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]PrismObjectOrganizationQueryParamsQuerySort] `json:"sort"`
}

type PrismObjectOrganizationQueryParamsIDUnion interface {
	ImplementsPrismObjectOrganizationQueryParamsIDUnion()
}

type PrismObjectOrganizationBulkNewResponseResultsError struct {
	Code    string                                                 `json:"code"`
	Message string                                                 `json:"message"`
	JSON    prismObjectOrganizationBulkNewResponseResultsErrorJSON `json:"-"`
}

type PrismObjectOrganizationBulkDeleteResponseResultsStatus string

type PrismObjectOrganizationBulkDeleteResponseResultsError struct {
	Code    string                                                    `json:"code"`
	Message string                                                    `json:"message"`
	JSON    prismObjectOrganizationBulkDeleteResponseResultsErrorJSON `json:"-"`
}

type PrismObjectOrganizationBulkDeleteResponseResultsRecord 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    prismObjectOrganizationBulkDeleteResponseResultsRecordJSON `json:"-"`
}

type PrismObjectOrganizationBulkUpdateResponseResultsStatus string

type PrismObjectOrganizationBulkUpdateResponseResultsError struct {
	Code    string                                                    `json:"code"`
	Message string                                                    `json:"message"`
	JSON    prismObjectOrganizationBulkUpdateResponseResultsErrorJSON `json:"-"`
}

type PrismObjectOrganizationBulkUpdateResponseResultsRecord 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    prismObjectOrganizationBulkUpdateResponseResultsRecordJSON `json:"-"`
}

type PrismObjectOrganizationQueryParamsQueryCombinator string

type PrismObjectOrganizationQueryParamsQueryFilterUnion interface {
	implementsPrismObjectOrganizationQueryParamsQueryFilterUnion()
}

type PrismObjectOrganizationQueryParamsQuerySort string