/** * Caraer API Documentation * This documentation provides an overview of the Caraer API, including authentication methods, endpoint details, data models, and integration guidelines for building on the Caraer platform. * * The version of the OpenAPI document: 2.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * A user, team, or app that can receive record access on an object. */ export interface AccessGrantTargetDTO { /** * UUID of the principal */ 'uuid'?: string; /** * Primary display label */ 'label'?: string; /** * Secondary line (e.g. email) */ 'subtitle'?: string; } export interface AdvancedRecordQueryPlan { 'version'?: number; 'mainObject'?: string; 'mainObjects'?: Array; 'query'?: string; 'filter'?: Filter; 'sort'?: Set; 'show'?: Set; 'strategy'?: AdvancedRecordQueryPlanStrategyEnum; 'anchorRecordUuid'?: string; 'criteria'?: Array; 'graphTraversals'?: Array; 'scoreWeights'?: { [key: string]: number; }; 'includeEvidence'?: boolean; 'maxTraversalDepth'?: number; 'page'?: number; 'limit'?: number; } export declare const AdvancedRecordQueryPlanStrategyEnum: { readonly Auto: "AUTO"; readonly Structured: "STRUCTURED"; readonly Lexical: "LEXICAL"; readonly Semantic: "SEMANTIC"; readonly Hybrid: "HYBRID"; readonly Graph: "GRAPH"; }; export type AdvancedRecordQueryPlanStrategyEnum = typeof AdvancedRecordQueryPlanStrategyEnum[keyof typeof AdvancedRecordQueryPlanStrategyEnum]; /** * Advanced record query. Provide either question or plan, not both. */ export interface AdvancedRecordQueryRequest { /** * Natural-language question to plan and execute. */ 'question'?: string; /** * Validated declarative query plan. */ 'plan'?: AdvancedRecordQueryPlan; /** * Optional main object hint. Use mainObjects for multi-type queries. */ 'mainObject'?: string; /** * Optional object list for multi-type queries (e.g. candidate and vacancy together). */ 'mainObjects'?: Array; 'strategy'?: AdvancedRecordQueryRequestStrategyEnum; 'page'?: number; 'limit'?: number; 'preview'?: string; 'parse'?: any; 'archived'?: boolean; /** * When true, include normalized plan, scores, and evidence. */ 'explain'?: boolean; 'recordReturnFormat'?: string; } export declare const AdvancedRecordQueryRequestStrategyEnum: { readonly Auto: "AUTO"; readonly Structured: "STRUCTURED"; readonly Lexical: "LEXICAL"; readonly Semantic: "SEMANTIC"; readonly Hybrid: "HYBRID"; readonly Graph: "GRAPH"; }; export type AdvancedRecordQueryRequestStrategyEnum = typeof AdvancedRecordQueryRequestStrategyEnum[keyof typeof AdvancedRecordQueryRequestStrategyEnum]; /** * Advanced record query response with scores and evidence. */ export interface AdvancedRecordQueryResponse { 'data'?: Array; 'results'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; 'plan'?: AdvancedRecordQueryPlan; 'confidence'?: number; 'warnings'?: Array; 'diagnostics'?: { [key: string]: any | null; }; } export interface AdvancedRecordQueryResultItem { 'record'?: any; 'recordUuid'?: string; 'objectName'?: string; 'scores'?: ScoreBreakdown; 'criteria'?: Array; 'supportingEvidence'?: Array; 'contradictingEvidence'?: Array; } /** * Batch aggregation request for loading a dashboard. */ export interface AggregateBatchRequest { 'requests'?: Array; } /** * Aggregation request for analytics charts over Neo4j records. */ export interface AggregateRequest { 'xaxis'?: AnalyticsAxisConfig; 'yaxis'?: AnalyticsAxisConfig; /** * Optional client widget id, echoed in batch responses. */ 'id'?: string; 'mainObject'?: string; 'filter'?: Filter; 'query'?: string; 'xAxis'?: AnalyticsAxisConfig; 'yAxis'?: AnalyticsAxisConfig; 'series'?: AnalyticsSeriesConfig; /** * Optional top-N series limit. For additive metrics (count, countDistinct, sum), keeps the N series with the highest total Y. Null or <= 0 means no truncation. */ 'limit'?: number; 'sort'?: string; /** * When true, omit null/blank/(empty) category buckets from the response. Useful for bar and pie charts grouped by optional properties. */ 'excludeEmptyValues'?: boolean; } export interface AnalyticsAxisConfig { 'property'?: AnalyticsPropertyRef; 'timeBucket'?: string; 'timeZone'?: string; 'windowDays'?: number; 'binCount'?: number; 'metric'?: string; 'label'?: string; } export interface AnalyticsComparisonMetric { 'key'?: string; 'label'?: string; 'mainObject'?: string; 'filter'?: Filter; 'yAxis'?: AnalyticsAxisConfig; } export interface AnalyticsDashboardConfig { 'version'?: number; 'columns'?: number; 'widgets'?: Array; } export interface AnalyticsPropertyRef { 'object'?: string; 'relation'?: string; 'propertyName'?: string; } export interface AnalyticsReferenceLine { 'value'?: number; 'label'?: string; 'color'?: string; } export interface AnalyticsSeriesConfig { 'groupBy'?: AnalyticsPropertyRef; } export interface AnalyticsTrendConfig { 'property'?: AnalyticsPropertyRef; 'windowDays'?: number; } export interface AnalyticsWidgetConfig { 'id'?: string; 'title'?: string; 'chartType'?: string; 'mainObject'?: string; 'x'?: number; 'y'?: number; 'w'?: number; 'h'?: number; 'filter'?: Filter; 'xAxis'?: AnalyticsAxisConfig; 'yAxis'?: AnalyticsAxisConfig; 'series'?: AnalyticsSeriesConfig; 'comparisonMetrics'?: Array; 'trend'?: AnalyticsTrendConfig; 'limit'?: number; 'sort'?: string; 'excludeEmptyValues'?: boolean; 'style'?: AnalyticsWidgetStyle; } export interface AnalyticsWidgetStyle { 'showLegend'?: boolean; 'showGrid'?: boolean; 'showValueLabels'?: boolean; 'barOrientation'?: string; 'barGrouping'?: string; 'colors'?: { [key: string]: string; }; 'referenceLines'?: Array; } /** * Data transfer object for an app bar (location-specific settings and action config) */ export interface AppBarDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * Bar location: RECORD_PREVIEW, RECORD_OVERVIEW, RECORD_DETAIL, TOOL_BAR, TRAIT_BAR, RECORD_TRAIT */ 'location'?: AppBarDTOLocationEnum; /** * URL for iframe-based locations (supports {recordUuid}, {object}, {viewId}, {trait}, {companyUuid} placeholders) */ 'iframeUrl'?: string; /** * Optional icon name/key for this app bar */ 'icon'?: string; /** * Description shown under the dialog title for action-based bars */ 'description'?: string; /** * Tooltip label for buttons and sidebar entries */ 'tooltipLabel'?: string; /** * Primary button label in the action dialog */ 'actionLabel'?: string; /** * JSON array of AppSettingFieldSchema (field definitions for action locations) */ 'settingsSchema'?: Array; /** * Webhook configuration for action-based locations */ 'webhook'?: SubscribeWebhookDTO; } export declare const AppBarDTOLocationEnum: { readonly RecordPreview: "RECORD_PREVIEW"; readonly RecordOverview: "RECORD_OVERVIEW"; readonly RecordDetail: "RECORD_DETAIL"; readonly ToolBar: "TOOL_BAR"; readonly TraitBar: "TRAIT_BAR"; readonly RecordTrait: "RECORD_TRAIT"; }; export type AppBarDTOLocationEnum = typeof AppBarDTOLocationEnum[keyof typeof AppBarDTOLocationEnum]; /** * Request body for creating an iframe session token */ export interface AppBarIframeSessionRequest { /** * Object name in context */ 'object'?: string; /** * UUID of the record in context */ 'recordUuid'?: string; /** * View ID in context */ 'viewId'?: string; /** * Trait name in context */ 'trait'?: string; /** * Current view data for rebuilding the active index */ 'viewData'?: { [key: string]: any | null; }; } /** * Request body for validating an iframe session token */ export interface AppBarIframeSessionValidateRequest { /** * Opaque iframe session token from the iframe URL */ 'token'?: string; } /** * Request body for triggering an action-based app bar */ export interface AppBarTriggerRequest { /** * UUID of the record in context */ 'recordUuid'?: string; /** * Object name in context */ 'object'?: string; /** * View ID in context */ 'viewId'?: string; /** * Trait name in context */ 'trait'?: string; /** * Current view data for rebuilding the active index */ 'viewData'?: { [key: string]: any | null; }; /** * Values for settingsSchema fields supplied at trigger time */ 'settingsValues'?: { [key: string]: any | null; }; } export interface AppBarVisibilityEntry { 'objects'?: Array; 'suites'?: Array; 'traits'?: Array; } export interface AppConnectionStatusDTO { 'id'?: string; 'name'?: string; 'label'?: string; 'preset'?: string; 'logo'?: string; 'connected'?: boolean; 'ownerType'?: string; 'ownerUserUuid'?: string; 'accountLabel'?: string; 'connectedAt'?: number; } /** * Full app payload (AppCreatorDTO) to apply */ export interface AppDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * Indicates whether this app is private (only available to the creator\'s company) */ 'privateApp'?: boolean; /** * Whether to hide the API token field in marketplace installer UI. Defaults to true when omitted. Private apps show the key regardless. */ 'hideApiKeyField'?: boolean; /** * Additional details and specifications about the application */ 'details'?: AppDetailsDTO; /** * App bars (location-specific configuration and actions) */ 'appBars'?: Array; /** * Serverless functions owned by this app */ 'serverlessFunctions'?: Array; /** * Webhook triggered when the app is installed */ 'installWebhook'?: SubscribeWebhookDTO; /** * Webhook triggered when the app is uninstalled */ 'uninstallWebhook'?: SubscribeWebhookDTO; /** * Webhook triggered when the app installation token is rotated */ 'rotateWebhook'?: SubscribeWebhookDTO; /** * Webhook triggered when an already installed app is saved again */ 'updateWebhook'?: SubscribeWebhookDTO; /** * JSON array of AppSettingFieldSchema (app-level setting field definitions) */ 'settingsSchema'?: Array; /** * Optional UI grouping of settingsSchema fields into installer cards */ 'settingsSections'?: Array; /** * External OAuth providers installers can Connect (name/logo only; no secrets) */ 'externalOAuthProviders'?: Array; /** * Webhook rate limit per minute */ 'webhookRateLimitPerMinute'?: number; /** * App job enqueue rate limit per minute per installation */ 'jobRateLimitPerMinute'?: number; /** * Publish and review state for the app in the marketplace (creator view) */ 'appPublish'?: AppPublishDTO; /** * Installation link (company–app) with token, scopes, and per-installation settingsValues; present when includeSettings is true */ 'hasApp'?: HasAppDTO; /** * URL to the application\'s image or icon (derived from details.image) */ 'image'?: string; /** * URL where the application can be accessed (derived from details.url) */ 'url'?: string; /** * Category the application belongs to (derived from details.category) */ 'category'?: string; /** * Whether the app is installed for the current company */ 'installed'?: boolean; /** * Required scopes requested by the app (macro patterns or concrete scope strings). */ 'requiredScopes'?: Array; /** * Resolved concrete required scopes derived from requiredScopes and dynamic availableScopes. */ 'resolvedRequiredScopes'?: Array; /** * Authentication method for this app (API_KEY default, OAUTH2 for OAuth 2.0) */ 'authMethod'?: AppDTOAuthMethodEnum; /** * OAuth 2.0 client identifier (OAuth apps only) */ 'oauthClientId'?: string; /** * OAuth 2.0 client secret; only returned once on create or secret rotation */ 'oauthClientSecret'?: string; /** * Whether an OAuth client secret is stored for this app (plain value is not re-readable) */ 'oauthClientSecretConfigured'?: boolean; /** * Registered OAuth redirect URIs (OAuth apps only) */ 'oauthRedirectUris'?: Array; /** * OAuth authorization endpoint URL */ 'oauthAuthorizeUrl'?: string; /** * OAuth token endpoint URL */ 'oauthTokenUrl'?: string; /** * External URL where end users install this app (e.g. ChatGPT connector page) */ 'installUrl'?: string; /** * Square brandmark URL used in compact app surfaces */ 'brandmark'?: string; /** * Internal app description used in Caraer admin views */ 'description'?: string; /** * App platform version: 1 = legacy per-function Cloud Functions; 2 = one container per app */ 'platformVersion'?: number; /** * Serverless runtime for platform V2 apps (nodejs22 or python312) */ 'runtime'?: string; /** * Base HTTPS URL of the V2 app container runtime */ 'runtimeBaseUrl'?: string; /** * Last deployed runtime revision id */ 'runtimeRevision'?: string; /** * V2 runtime status: PENDING, PROVISIONING, READY, FAILED */ 'runtimeStatus'?: string; /** * Last V2 runtime error message when FAILED */ 'runtimeError'?: string; /** * Monotonic generation for async runtime jobs */ 'runtimeGeneration'?: number; } export declare const AppDTOAuthMethodEnum: { readonly ApiKey: "API_KEY"; readonly Oauth2: "OAUTH2"; }; export type AppDTOAuthMethodEnum = typeof AppDTOAuthMethodEnum[keyof typeof AppDTOAuthMethodEnum]; /** * Detailed DTO representing an application with all available configuration and visibility metadata for the current company context */ export interface AppDetailsDTO { 'title'?: string; /** * Short marketplace description shown on app cards and detail pages */ 'description'?: string; 'image'?: string; /** * Hex accent color (#RRGGBB) for installed app-bar action buttons and toolbar icons */ 'brandColor'?: string; /** * Hex text color (#RRGGBB) for text on brand-colored marketplace UI elements */ 'textColor'?: string; 'url'?: string; /** * Main marketplace category key from GET /api/v2/apps/categories */ 'category'?: string; /** * Selected subcategory keys under the main category */ 'subcategories'?: Array; 'privacyPolicy'?: string; 'termsAndConditions'?: string; 'processingAgreement'?: string; 'disclaimer'?: string; /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; } /** * Third-party OAuth provider declared on an app */ export interface AppExternalOAuthProviderDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * Ignored. Set authorizeUrl and tokenUrl explicitly. * @deprecated */ 'preset'?: string; /** * Optional logo URL shown on the Connect button */ 'logo'?: string; 'authorizeUrl'?: string; 'tokenUrl'?: string; 'clientId'?: string; 'clientSecret'?: string; 'hasClientSecret'?: boolean; 'scopes'?: Array; 'pkce'?: boolean; 'connectionOwner'?: string; } /** * Lightweight external OAuth provider summary (no secrets) */ export interface AppExternalOAuthProviderSummaryDTO { 'name'?: string; 'label'?: string; 'logo'?: string; 'connectionOwner'?: string; } /** * Public inbound route into an app function */ export interface AppInboundRouteDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; 'authMode'?: string; 'enqueue'?: boolean; 'hasSharedSecret'?: boolean; 'sharedSecret'?: string; 'serverlessFunction'?: ServerlessFunctionRefDTO; } export interface AppOAuthStartResponseDTO { 'authorizeUrl'?: string; } /** * Publish and review state for a public app in the marketplace */ export interface AppPublishDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * Publish state: DRAFT, SUBMITTED, IN_REVIEW, APPROVED, PUBLISHED, REJECTED, CHANGES_REQUESTED */ 'publishState'?: string; /** * Timestamp when developer submitted for review */ 'submittedAt'?: number; /** * Timestamp when review was completed */ 'reviewedAt'?: number; /** * Timestamp when app went live in marketplace */ 'publishedAt'?: number; /** * Feedback shown to developer (e.g. rejection reason) */ 'feedback'?: string; /** * Internal reviewer notes. Only returned for SUPER_ADMIN callers; never exposed to app creators. */ 'reviewerNotes'?: string; } /** * Settings required to uninstall the application */ export interface AppRequest { /** * A map of configuration settings. The keys are strings representing the setting names, and the values represent the setting values, which can be different types. */ 'settings'?: Array; } /** * App schedule definition (cron → function) */ export interface AppScheduleDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; 'schedule'?: string; 'enabled'?: boolean; 'payloadTemplate'?: string; 'serverlessFunction'?: ServerlessFunctionRefDTO; } export interface AppSettingActionSource { 'type'?: string; 'serverlessFunctionUuid'?: string; 'serverlessFunctionName'?: string; 'enqueue'?: boolean; } export interface AppSettingCondition { 'field'?: string; 'operator'?: string; 'value'?: any; } export interface AppSettingFieldMappingStructure { 'objectName'?: string; 'targetKind'?: string; 'items'?: Array; 'recordTarget'?: boolean; } export interface AppSettingFieldMappingStructureItem { 'fieldLabel'?: string; 'fieldName'?: string; 'fieldHelpText'?: string; 'isRequired'?: boolean; 'allowedPropertyTypes'?: Array; 'allowedPropertyFormats'?: Array; 'propertyName'?: string; 'recordUuid'?: string; } export interface AppSettingFieldSchema { 'name'?: string; 'label'?: string; 'type'?: string; 'required'?: boolean; 'helpText'?: string; 'options'?: Array; 'optionsSource'?: AppSettingOptionsSource; 'actionSource'?: AppSettingActionSource; 'defaultValue'?: any; 'hidden'?: boolean; 'advanced'?: boolean; 'filterTraits'?: Array; 'visibleWhen'?: Array; 'itemFields'?: Array; 'min'?: number; 'max'?: number; 'itemLabel'?: string; 'value'?: any; 'hasValue'?: boolean; 'mappingValue'?: AppSettingFieldMappingStructure; 'valueScope'?: string; 'action'?: boolean; } export interface AppSettingOptionsSource { 'type'?: string; 'serverlessFunctionUuid'?: string; 'serverlessFunctionName'?: string; 'dependsOn'?: Array; 'searchable'?: boolean; 'minQueryLength'?: number; } export interface AppSettingsSection { 'title'?: string; 'subtitle'?: string; 'settings'?: Array; } /** * The billing settings of the company. */ export interface BillingSettingsDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * The email address of the billing contact. */ 'billingEmail'?: string; /** * The address of the billing contact. */ 'address'?: string; /** * The city of the billing contact. */ 'city'?: string; /** * The state of the billing contact. */ 'state'?: string; /** * The zip code of the billing contact. */ 'zip'?: string; /** * The country of the billing contact. */ 'country'?: string; } /** * Payload of a bulk delete records response. */ export interface BulkDeleteRecordsData { /** * UUIDs that were successfully deleted. */ 'uuids'?: Array; } /** * Request to archive, anonymize, or permanently delete multiple records. */ export interface BulkDeleteRecordsRequest { /** * Record UUIDs to delete. */ 'uuids': Array; /** * Deletion mode: \'archive\', \'anonymize\', or \'delete\'. */ 'mode': string; } /** * Response for a bulk delete records operation. */ export interface BulkDeleteRecordsResponse { /** * Result message. */ 'message'?: string; /** * Successfully deleted record UUIDs. */ 'data'?: BulkDeleteRecordsData; /** * Per-record errors when one or more items failed. */ 'errors'?: Array; } /** * Validation or processing errors for a single record in a bulk edit operation. */ export interface BulkEditRecordErrorItem { /** * UUID of the record that failed, if known. */ 'uuid'?: string; /** * Client reference echoed from the request, if provided. */ 'clientRef'?: string; /** * Summary message for this record\'s failure. */ 'message'?: string; /** * Field-level validation errors. */ 'errors'?: Array; } /** * A single record to create or update in a bulk edit request. */ export interface BulkEditRecordItem { /** * UUID of an existing record to update. Omit to create a new record. */ 'uuid'?: string; /** * Client-side reference for matching the item back after create (e.g. row-3). */ 'clientRef'?: string; /** * Property values to set on the record. */ 'properties'?: { [key: string]: any | null; }; /** * Relations to create or merge after the record is saved. Same shape as createOrUpdate. */ 'relations'?: Array; } /** * A successfully saved record from a bulk edit operation. */ export interface BulkEditRecordResultItem { /** * UUID of the saved record. */ 'uuid'?: string; /** * Client reference echoed from the request, if provided. */ 'clientRef'?: string; /** * True when the record was created; false when updated. */ 'created'?: boolean; } /** * Payload of a bulk edit records response. */ export interface BulkEditRecordsData { /** * Successfully saved records. */ 'records'?: Array; } /** * Request to create or update multiple records in one operation. */ export interface BulkEditRecordsRequest { /** * Records to create or update. */ 'records'?: Array; } /** * Response for a bulk create/update records operation. */ export interface BulkEditRecordsResponse { /** * Result message. */ 'message'?: string; /** * Successfully saved records. */ 'data'?: BulkEditRecordsData; /** * Per-record errors when one or more items failed validation. */ 'errors'?: Array; } export interface CRUD { 'sessionType'?: CRUDSessionTypeEnum; 'httpSessionId'?: string; 'turnOffMetaRelationships'?: boolean; } export declare const CRUDSessionTypeEnum: { readonly Main: "MAIN"; readonly User: "USER"; }; export type CRUDSessionTypeEnum = typeof CRUDSessionTypeEnum[keyof typeof CRUDSessionTypeEnum]; export interface CalendarBootstrapDTO { 'defaultCalendar'?: CalendarRecordDTO; 'calendars'?: Array; 'backfilled'?: number; 'teamCalendarsCreated'?: number; 'companyCalendarCreated'?: boolean; } export interface CalendarCreateRequest { 'title'?: string; 'color'?: string; 'teamUuid'?: string; 'company'?: boolean; } export interface CalendarRecordDTO { 'default'?: boolean; 'uuid'?: string; 'title'?: string; 'color'?: string; 'colorHex'?: string; 'isDefault'?: boolean; 'ownerUuid'?: string; 'ownerName'?: string; 'ownedByCurrentUser'?: boolean; 'teamUuid'?: string; 'teamName'?: string; 'companyCalendar'?: boolean; 'companyName'?: string; 'members'?: Array; } export interface CalendarTeamMemberDTO { 'uuid'?: string; 'label'?: string; 'objectName'?: string; 'hasUserTrait'?: boolean; } export interface CalendarTeamOptionDTO { 'uuid'?: string; 'name'?: string; 'members'?: Array; } export interface CaraerErrorType { /** * The error message providing details about the failure. */ 'message': string; /** * The type of error. */ 'type': CaraerErrorTypeTypeEnum; /** * A suggestion on how to correct the error. */ 'correctionSuggestion': string; } export declare const CaraerErrorTypeTypeEnum: { readonly Validation: "VALIDATION"; readonly NotFound: "NOT_FOUND"; readonly Test: "TEST"; readonly RelationNotAllowed: "RELATION_NOT_ALLOWED"; readonly InvalidValue: "INVALID_VALUE"; readonly General: "GENERAL"; readonly InvalidFileType: "INVALID_FILE_TYPE"; readonly InternalServerError: "INTERNAL_SERVER_ERROR"; readonly CaraerError: "CARAER_ERROR"; readonly InvalidEmail: "INVALID_EMAIL"; readonly InvalidDate: "INVALID_DATE"; }; export type CaraerErrorTypeTypeEnum = typeof CaraerErrorTypeTypeEnum[keyof typeof CaraerErrorTypeTypeEnum]; /** * Data transfer object representing a Caraer object with its configuration, properties, relations, and views */ export interface CaraerObjectDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * Unique identifier name for the object */ 'name'?: string; /** * Display label for the object */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering objects */ 'index'?: number; /** * Plural form of the object\'s name, used for display purposes */ 'plural'?: string; /** * Detailed description of the object\'s purpose and usage */ 'description'?: string; /** * Collection of group names this object belongs to */ 'groups'?: Array; /** * Icon identifier for visual representation of the object */ 'icon'?: string; /** * Name of the default trait applied to this object */ 'defaultTrait'?: string; /** * List of trait names associated with this object */ 'traits'?: Array; /** * List of view configurations for displaying this object */ 'views'?: Array; /** * List of properties defined for this object */ 'properties'?: Array; /** * List of relations this object has with other objects */ 'relations'?: Array; /** * List of suite names this object belongs to */ 'suites'?: Array; /** * List of objects this object extends to */ 'extendsTo'?: Array; /** * When false, the object schema cannot be updated or deleted via the API */ 'editable'?: boolean; } export interface CmsEnvironmentDTO { 'uuid'?: string; 'key'?: string; 'label'?: string; 'routing'?: string; 'slugPrefix'?: string; 'hostLabel'?: string; 'requiresAuth'?: boolean; 'htmlLang'?: string; 'default'?: boolean; } export interface CmsModuleDTO { 'uuid'?: string; 'name'?: string; 'label'?: string; 'ref'?: string; 'kind'?: string; 'description'?: string; 'category'?: string; 'icon'?: string; 'preview'?: string; 'appUuid'?: string; 'appName'?: string; 'appLabel'?: string; 'packageName'?: string; 'version'?: string; 'retired'?: boolean; 'fields'?: Array; 'frameworks'?: { [key: string]: string; }; } export interface CmsPageDTO { 'uuid'?: string; 'title'?: string; 'slug'?: string; 'locale'?: string; 'environment'?: string; 'state'?: string; 'published'?: boolean; 'document'?: CmsPageDocument; 'record'?: RecordSummary; 'protection'?: { [key: string]: any | null; }; 'locales'?: Array; 'publishAt'?: number; 'unpublishAt'?: number; } export interface CmsPageDocument { 'version'?: number; 'revision'?: number; 'modules'?: Array; 'seo'?: { [key: string]: any | null; }; 'title'?: string; 'slug'?: string; 'excerpt'?: string; 'css'?: string; 'headJs'?: string; 'bodyJs'?: string; } export interface CmsPageModuleInstance { 'id'?: string; 'module'?: string; 'fields'?: { [key: string]: any | null; }; 'hidden'?: boolean; } export interface CmsPagePatch { 'op'?: string; 'moduleId'?: string; 'ref'?: string; 'field'?: string; 'value'?: any; 'fields'?: { [key: string]: any | null; }; 'module'?: CmsPageModuleInstance; 'index'?: number; 'toIndex'?: number; 'hidden'?: boolean; 'modules'?: Array; 'seo'?: { [key: string]: any | null; }; } export interface CmsPagePatchRequest { 'locale'?: string; 'patches'?: Array; 'expectedRevision'?: number; } export interface CmsPublicMenuDTO { 'location'?: string; 'title'?: string; 'items'?: Array; } /** * A DTO representing a company with its various settings and details. */ export interface CompanyDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * The details of the company. */ 'details'?: CompanyDetailsDTO; /** * The digital identity of the company. */ 'digitalIdentity'?: DigitalIdentityDTO; /** * The website settings of the company. */ 'websiteSettings'?: WebsiteSettingsDTO; /** * The billing settings of the company. */ 'billingSettings'?: BillingSettingsDTO; /** * Which CMS serves this company: 1 = WerkenBij, 2 = caraer-web */ 'cmsVersion'?: number; /** * Origin of the v2 sidecar site while the live hostname is still v1 */ 'cmsV2PreviewOrigin'?: string; 'cmsV2ProjectId'?: string; 'cmsV1ProjectId'?: string; } /** * A DTO representing the details of a company. */ export interface CompanyDetailsDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * The twitter/X url of the company. */ 'twitter'?: string; /** * The linkedin url of the company. */ 'linkedIn'?: string; /** * The facebook url of the company. */ 'facebook'?: string; /** * The youtube url of the company. */ 'youtube'?: string; /** * The instagram url of the company. */ 'instagram'?: string; /** * The address of the company. */ 'address'?: string; /** * The city of the company. */ 'city'?: string; /** * The state of the company. */ 'state'?: string; /** * The zip code of the company. */ 'zip'?: string; /** * The country of the company. */ 'country'?: string; /** * The phone number of the company. */ 'phone'?: string; /** * The email of the company. */ 'email'?: string; /** * The website of the company. */ 'website'?: string; /** * The unsubscribe link of the company. */ 'unsubscribeLink'?: string; /** * The cookie policy of the company. */ 'cookiePolicy'?: string; /** * The privacy policy of the company. */ 'privacyPolicy'?: string; /** * The terms and conditions of the company. */ 'termsAndConditions'?: string; /** * The disclaimer of the company. */ 'disclaimer'?: string; } export interface CopyPropertiesToObjectRequest { 'propertyUuids'?: Array; } export interface CopyPropertyToEnvironmentsRequest { 'objectUuid'?: string; /** * @deprecated */ 'propertyUuid'?: string; 'propertyUuids'?: Array; 'environments'?: Array; 'fillCopiedValues'?: boolean; } /** * DTO representing a request to create a new company, including the company\'s name and subdomain. */ export interface CreateCompanyRequest { /** * The name of the company to be created. */ 'name'?: string; /** * The desired subdomain for the company. This will be used for company-specific URLs. */ 'subdomain'?: string; /** * The company name. */ 'companyName'?: string; /** * The copy database id. */ 'copyDatabaseId'?: string; /** * Whether to include records in the company. */ 'includeRecords'?: boolean; } /** * Request body for creating (or fetching an existing) developer project for an app. */ export interface CreateDeveloperProjectRequest { /** * UUID of the app to link this project to. */ 'appUuid'?: string; /** * Project name. */ 'name'?: string; /** * Optional human-readable label for the project. */ 'label'?: string; } /** * Request body for creating a developer sandbox. */ export interface CreateDeveloperSandboxRequest { /** * Sandbox name. */ 'name'?: string; /** * Optional human-readable label for the sandbox. */ 'label'?: string; } export interface CreateOrUpdateEnvironmentRequest { 'environment'?: string; 'webpageObjects'?: Array; } /** * Private app creation request with label and optional description */ export interface CreatePrivateAppRequest { /** * The display label for the private app. */ 'label': string; /** * Optional description text for the app. */ 'description'?: string; /** * Authentication method (API_KEY default, OAUTH2 for OAuth 2.0) */ 'authMethod'?: CreatePrivateAppRequestAuthMethodEnum; /** * Registered OAuth redirect URIs (required when authMethod is OAUTH2) */ 'oauthRedirectUris'?: Array; /** * Ignored; new private apps are always platform version 2 (async container runtime). */ 'platformVersion'?: number; /** * Serverless runtime for the app: nodejs22 or python312. Defaults to nodejs22. */ 'runtime'?: string; } export declare const CreatePrivateAppRequestAuthMethodEnum: { readonly ApiKey: "API_KEY"; readonly Oauth2: "OAUTH2"; }; export type CreatePrivateAppRequestAuthMethodEnum = typeof CreatePrivateAppRequestAuthMethodEnum[keyof typeof CreatePrivateAppRequestAuthMethodEnum]; /** * Request body for uploading a developer project build archive. */ export interface CreateProjectBuildRequest { /** * Base64-encoded zip archive containing caraer.project.json and src/app. */ 'archiveBase64'?: string; /** * Original archive filename, for traceability. */ 'filename'?: string; /** * Deploy target: production or sandbox. */ 'target'?: string; /** * Semantic version for this build (MAJOR.MINOR.PATCH). Auto-bumped when omitted. */ 'version'?: string; /** * Release notes for this build. */ 'releaseNotes'?: string; } /** * Response for a successful resource creation operation. */ export interface CreateResponse { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: any; } /** * Response for a successful resource creation operation. */ export interface CreateResponseAppExternalOAuthProviderDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: AppExternalOAuthProviderDTO; } /** * Response for a successful resource creation operation. */ export interface CreateResponseAppInboundRouteDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: AppInboundRouteDTO; } /** * Response for a successful resource creation operation. */ export interface CreateResponseAppScheduleDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: AppScheduleDTO; } /** * Response for a successful resource creation operation. */ export interface CreateResponseCalendarRecordDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: CalendarRecordDTO; } /** * Response for a successful resource creation operation. */ export interface CreateResponseFeedDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: FeedDTO; } /** * Success response (CreateResponseMapStringString). */ export interface CreateResponseMapStringString { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Response for a successful resource creation operation. */ export interface CreateResponseSignedUrlResultDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: SignedUrlResultDTO; } export interface CreateSignedUrlRequest { 'ttlSeconds'?: number; } export interface CriterionScore { 'criterion'?: string; 'score'?: number; 'weight'?: number; 'rationale'?: string; 'supportingEvidence'?: Array; 'contradictingEvidence'?: Array; } /** * Request DTO for searching records across multiple objects. */ export interface CrossObjectRecordSearchRequest { /** * Free-text search query. */ 'query'?: string; /** * Event (or source) object UUID used with relationName to resolve target objects. */ 'fromObjectUuid'?: string; /** * Relation name whose connected target objects are searched (e.g. attendees). */ 'relationName'?: string; /** * Object UUIDs to search. Used on their own when relationName is omitted; combined with relationName they narrow the relation\'s target objects. */ 'objectUuids'?: Array; /** * Object internal names to search. Behaves like objectUuids and may be combined with it. */ 'objectNames'?: Array; /** * Preview template name. */ 'preview'?: string; /** * Page number (1-based). */ 'page'?: number; /** * Maximum records returned. */ 'limit'?: number; /** * Optional record UUID to exclude from results. */ 'excludeRecordUuid'?: string; } export interface Currency extends PropertyFormat { } export interface CurrencyRange extends PropertyFormat { } /** * Cursor location */ export interface CursorLocation { 'x'?: number; 'y'?: number; 'z'?: number; } export interface CustomFontDTO { 'familyName'?: string; 'variants'?: Array; } export interface DateRange extends PropertyFormat { } /** * Response class representing the result of a delete operation. */ export interface DeleteResponse { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: any; } /** * Response class representing the result of a delete operation. */ export interface DeleteResponseFeedDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: FeedDTO; } /** * Response class representing the result of a delete operation. */ export interface DeleteResponseString { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: string; } /** * Response class representing the result of a delete operation. */ export interface DeleteResponseVoid { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: any; } /** * Request body for deploying a developer project build. */ export interface DeployBuildRequest { /** * Deploy target: production or sandbox. Defaults to the build\'s target. */ 'target'?: string; /** * When true, soft-delete remote functions/webhooks/schedules/inbound routes/OAuth providers that are absent from the build archive. Defaults to false. */ 'prune'?: boolean; } /** * Developer sandbox: a Neo4j DB clone of the owning company. Activate via X-Caraer-Sandbox-Uuid; company identity stays the owner. */ export interface DeveloperSandboxDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * UUID of the owning company — send this as X-Caraer-Company-Uuid */ 'ownerCompanyUuid'?: string; /** * Neo4j database id of the sandbox clone */ 'databaseId'?: string; } /** * Approve a pending device-code login (authenticated browser session) */ export interface DeviceApproveRequest { /** * User-facing code shown by the CLI */ 'userCode': string; } /** * Poll a device-code login session */ export interface DevicePollRequest { /** * Device code returned by /auth/device/start */ 'deviceCode': string; } /** * A DTO representing the digital identity of a company. */ export interface DigitalIdentityDTO { /** * The primary color of the company in light mode. */ 'lightPrimaryColor'?: string; /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * The font color of the company in light mode. */ 'lightFontColor'?: string; /** * The secondary color of the company in light mode. */ 'lightSecondaryColor'?: string; /** * The primary 100 color of the company in light mode. */ 'lightPrimary100Color'?: string; /** * The accent color of the company in light mode. */ 'lightAccentColor'?: string; /** * The lightPrimary50Color of the company. */ 'lightPrimary50Color'?: string; /** * The lightPrimary200Color of the company. */ 'lightPrimary200Color'?: string; /** * The lightPrimary300Color of the company. */ 'lightPrimary300Color'?: string; /** * The lightPrimary400Color of the company. */ 'lightPrimary400Color'?: string; /** * The lightPrimary600Color of the company. */ 'lightPrimary600Color'?: string; /** * The lightPrimary700Color of the company. */ 'lightPrimary700Color'?: string; /** * The lightPrimary800Color of the company. */ 'lightPrimary800Color'?: string; /** * The lightPrimary900Color of the company. */ 'lightPrimary900Color'?: string; /** * The lightSecondary50Color of the company. */ 'lightSecondary50Color'?: string; /** * The lightSecondary100Color of the company. */ 'lightSecondary100Color'?: string; /** * The lightSecondary200Color of the company. */ 'lightSecondary200Color'?: string; /** * The lightSecondary300Color of the company. */ 'lightSecondary300Color'?: string; /** * The lightSecondary400Color of the company. */ 'lightSecondary400Color'?: string; /** * The lightSecondary600Color of the company. */ 'lightSecondary600Color'?: string; /** * The lightSecondary700Color of the company. */ 'lightSecondary700Color'?: string; /** * The lightSecondary800Color of the company. */ 'lightSecondary800Color'?: string; /** * The lightSecondary900Color of the company. */ 'lightSecondary900Color'?: string; /** * The lightAccent50Color of the company. */ 'lightAccent50Color'?: string; /** * The lightAccent100Color of the company. */ 'lightAccent100Color'?: string; /** * The lightAccent200Color of the company. */ 'lightAccent200Color'?: string; /** * The lightAccent300Color of the company. */ 'lightAccent300Color'?: string; /** * The lightAccent400Color of the company. */ 'lightAccent400Color'?: string; /** * The lightAccent600Color of the company. */ 'lightAccent600Color'?: string; /** * The lightAccent700Color of the company. */ 'lightAccent700Color'?: string; /** * The lightAccent800Color of the company. */ 'lightAccent800Color'?: string; /** * The lightAccent900Color of the company. */ 'lightAccent900Color'?: string; /** * The black color of the company in light mode. */ 'lightBlackColor'?: string; /** * The gray 900 color of the company in light mode. */ 'lightGray900Color'?: string; /** * The gray 800 color of the company in light mode. */ 'lightGray800Color'?: string; /** * The gray 700 color of the company in light mode. */ 'lightGray700Color'?: string; /** * The gray 600 color of the company in light mode. */ 'lightGray600Color'?: string; /** * The gray 500 color of the company in light mode. */ 'lightGray500Color'?: string; /** * The gray 400 color of the company in light mode. */ 'lightGray400Color'?: string; /** * The gray 300 color of the company in light mode. */ 'lightGray300Color'?: string; /** * The gray 200 color of the company in light mode. */ 'lightGray200Color'?: string; /** * The gray 100 color of the company in light mode. */ 'lightGray100Color'?: string; /** * The gray 50 color of the company in light mode. */ 'lightGray50Color'?: string; /** * The white color of the company in light mode. */ 'lightWhiteColor'?: string; /** * The background color of the company in light mode. */ 'lightBackgroundColor'?: string; /** * The destructive color of the company in light mode. */ 'lightDestructiveColor'?: string; /** * The font color of the company in dark mode. */ 'darkFontColor'?: string; /** * The primary color of the company in dark mode. */ 'darkPrimaryColor'?: string; /** * The secondary color of the company in dark mode. */ 'darkSecondaryColor'?: string; /** * The primary 100 color of the company in dark mode. */ 'darkPrimary100Color'?: string; /** * The accent color of the company in dark mode. */ 'darkAccentColor'?: string; /** * The darkPrimary50Color of the company. */ 'darkPrimary50Color'?: string; /** * The darkPrimary200Color of the company. */ 'darkPrimary200Color'?: string; /** * The darkPrimary300Color of the company. */ 'darkPrimary300Color'?: string; /** * The darkPrimary400Color of the company. */ 'darkPrimary400Color'?: string; /** * The darkPrimary600Color of the company. */ 'darkPrimary600Color'?: string; /** * The darkPrimary700Color of the company. */ 'darkPrimary700Color'?: string; /** * The darkPrimary800Color of the company. */ 'darkPrimary800Color'?: string; /** * The darkPrimary900Color of the company. */ 'darkPrimary900Color'?: string; /** * The darkSecondary50Color of the company. */ 'darkSecondary50Color'?: string; /** * The darkSecondary100Color of the company. */ 'darkSecondary100Color'?: string; /** * The darkSecondary200Color of the company. */ 'darkSecondary200Color'?: string; /** * The darkSecondary300Color of the company. */ 'darkSecondary300Color'?: string; /** * The darkSecondary400Color of the company. */ 'darkSecondary400Color'?: string; /** * The darkSecondary600Color of the company. */ 'darkSecondary600Color'?: string; /** * The darkSecondary700Color of the company. */ 'darkSecondary700Color'?: string; /** * The darkSecondary800Color of the company. */ 'darkSecondary800Color'?: string; /** * The darkSecondary900Color of the company. */ 'darkSecondary900Color'?: string; /** * The darkAccent50Color of the company. */ 'darkAccent50Color'?: string; /** * The darkAccent100Color of the company. */ 'darkAccent100Color'?: string; /** * The darkAccent200Color of the company. */ 'darkAccent200Color'?: string; /** * The darkAccent300Color of the company. */ 'darkAccent300Color'?: string; /** * The darkAccent400Color of the company. */ 'darkAccent400Color'?: string; /** * The darkAccent600Color of the company. */ 'darkAccent600Color'?: string; /** * The darkAccent700Color of the company. */ 'darkAccent700Color'?: string; /** * The darkAccent800Color of the company. */ 'darkAccent800Color'?: string; /** * The darkAccent900Color of the company. */ 'darkAccent900Color'?: string; /** * The black color of the company in dark mode. */ 'darkBlackColor'?: string; /** * The gray 900 color of the company in dark mode. */ 'darkGray900Color'?: string; /** * The gray 800 color of the company in dark mode. */ 'darkGray800Color'?: string; /** * The gray 700 color of the company in dark mode. */ 'darkGray700Color'?: string; /** * The gray 600 color of the company in dark mode. */ 'darkGray600Color'?: string; /** * The gray 500 color of the company in dark mode. */ 'darkGray500Color'?: string; /** * The gray 400 color of the company in dark mode. */ 'darkGray400Color'?: string; /** * The gray 300 color of the company in dark mode. */ 'darkGray300Color'?: string; /** * The gray 200 color of the company in dark mode. */ 'darkGray200Color'?: string; /** * The gray 100 color of the company in dark mode. */ 'darkGray100Color'?: string; /** * The gray 50 color of the company in dark mode. */ 'darkGray50Color'?: string; /** * The white color of the company in dark mode. */ 'darkWhiteColor'?: string; /** * The background color of the company in dark mode. */ 'darkBackgroundColor'?: string; /** * The destructive color of the company in dark mode. */ 'darkDestructiveColor'?: string; } export interface Duration extends PropertyFormat { } export interface Email extends PropertyFormat { } export interface EngagementBatchRequest { 'visitorId'?: string; 'sessionId'?: string; 'events'?: Array; } /** * Defines the structure of error responses returned by the API. */ export interface ErrorResponse { /** * The error message providing details about the failure. */ 'message'?: string; /** * A list of error types providing further details about the error. */ 'errors'?: Array; /** * The HTTP status code associated with the error. */ 'status'?: number; 'stackTrace'?: string; /** * Roles the caller is missing when the failure is an authorization error. */ 'roles'?: Array; /** * Scopes the caller is missing when the failure is an authorization error. */ 'scopes'?: Array; /** * Request correlation ID for support and log tracing. */ 'requestId'?: string; } export declare const ErrorResponseRolesEnum: { readonly User: "USER"; readonly Admin: "ADMIN"; readonly Reseller: "RESELLER"; readonly Developer: "DEVELOPER"; readonly SuperAdmin: "SUPER_ADMIN"; }; export type ErrorResponseRolesEnum = typeof ErrorResponseRolesEnum[keyof typeof ErrorResponseRolesEnum]; export interface EventRsvpRequest { /** * Participation status on the attendees edge */ 'partstat': EventRsvpRequestPartstatEnum; /** * Series scope for recurring events. Defaults to this. */ 'scope'?: EventRsvpRequestScopeEnum; } export declare const EventRsvpRequestPartstatEnum: { readonly NeedsAction: "needs_action"; readonly Accepted: "accepted"; readonly Declined: "declined"; readonly Tentative: "tentative"; }; export type EventRsvpRequestPartstatEnum = typeof EventRsvpRequestPartstatEnum[keyof typeof EventRsvpRequestPartstatEnum]; export declare const EventRsvpRequestScopeEnum: { readonly This: "this"; readonly ThisAndFuture: "this_and_future"; readonly All: "all"; }; export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum]; export interface ExistingWidgetSummary { 'xproperty'?: string; 'yproperty'?: string; 'ymetric'?: string; 'title'?: string; 'chartType'?: string; 'xProperty'?: string; 'yMetric'?: string; 'yProperty'?: string; } /** * Request to extend a record */ export interface ExtendRecordRequest { /** * The objects to extend the record into */ 'objects'?: Set; } export interface FeedDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; 'slug'?: string; 'format'?: string; 'mainObject'?: string; 'isPublic'?: boolean; 'publicToken'?: string; 'filter'?: any; 'filterJson'?: string; 'mapping'?: any; 'mappingJson'?: string; 'parseRecord'?: boolean; 'rootElement'?: string; 'itemElement'?: string; 'cacheTtlSeconds'?: number; 'active'?: boolean; } export interface FileListItemDTO { 'key'?: string; 'name'?: string; 'size'?: number; 'lastModified'?: number; 'contentType'?: string; } export interface FilledProperty { 'name'?: string; 'value'?: any; 'type'?: string; 'icon'?: string; 'label'?: string; } /** * DTO representing a filter composed of filter groups for querying records. The filter groups are combined using a logical OR operation. The filter items within each group are combined using a logical AND operation. */ export interface Filter { /** * A collection of filter groups. */ 'groups'?: Set; } /** * A DTO that defines a group of filter items used for record filtering. */ export interface FilterGroup { /** * A set of filter items included in the group. */ 'items'?: FilterItem; } /** * DTO representing a filter used in querying records. */ export interface FilterItem { /** * The name of the object to which this pagination item belongs. */ 'object'?: string; /** * The relationship between objects. */ 'relation'?: string; /** * Optional relation direction: outgoing (related→main), incoming (main→related), or omit for undirected. */ 'relationDirection'?: string; /** * The name of the property within the object. */ 'property'?: string; /** * Specifies whether the relation is included. */ 'relationIncluded'?: boolean; /** * Defines the operator used in the filter. Available operators are defined in the API documentation. */ 'operator'?: string; /** * Represents the value to filter against. */ 'value'?: any; /** * When true, filter fields contain smart content placeholders resolved at runtime. */ 'smartContent'?: boolean; /** * When true, propertyName refers to a property stored on the relation edge itself (declared on the relation schema, e.g. partstat on attendees) instead of a property of the related record. Requires relation and propertyName. */ 'edgeProperty'?: boolean; } /** * Request DTO for paginated data flow with filters, sorting, displayed items, and related information. */ export interface FlowPaginationRequest { 'crud'?: CRUD; 'showItems'?: Set; /** * The page index (one-based) to request. */ 'page'?: number; /** * The number of records to retrieve per page. */ 'limit'?: number; /** * Filters applied to the query. */ 'filter'?: Filter; /** * Sorting options for the query. */ 'sort'?: Set; /** * Specifies what data to show in the response. */ 'show'?: Array; /** * A free-text search query applied to the records. */ 'query'?: string; /** * Preview information for the records, if supported. */ 'preview'?: string; /** * The main object for categorization or context. */ 'mainObject'?: string; /** * Column name for sorting or filtering data */ 'column'?: string; /** * UUID of the property used in the request */ 'property'?: string; } export interface FontVariantDTO { 'weight'?: number; 'style'?: string; 'url'?: string; } /** * Data transfer object representing a form with its associated properties and structure */ export interface FormDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * The associated Caraer object that this form belongs to */ 'object'?: CaraerObjectDTO; /** * List of form items that make up the form\'s structure. Each grid represents a section or group of form elements */ 'grids'?: Array; /** * Descriptive text providing additional information about the form */ 'description'?: string; /** * The styling of the form. Can be \'standard\', \'underline\' or \'plain\' */ 'styling'?: string; /** * List of lead scoring rules associated with this form. Used to evaluate and score form submissions */ 'leadscores'?: Array; /** * List of form relations that define the relationships between this form conversion record and other records in the system */ 'relations'?: Array; /** * Indicates if the form should be displayed as a step-by-step wizard interface */ 'wizard'?: boolean; /** * Metadata associated with the form */ 'metadata'?: { [key: string]: string; }; /** * Thank you message to be displayed after the form is submitted */ 'thankYouMessage'?: string; /** * Redirect URL to be displayed after the form is submitted */ 'redirectUrl'?: string; } /** * Represents a section or group within a form, containing a grid of form elements */ export interface FormItemDTO { 'aiprompt'?: string; /** * The title or heading of this form section */ 'title'?: string; /** * Additional descriptive text explaining the purpose or instructions for this section */ 'description'?: string; /** * The type of form section (e.g., \'grid\', \'section\', etc.) */ 'type'?: string; /** * The AI prompt for the form section. Only applicable to steps. */ 'AIPrompt'?: string; /** * A two-dimensional array representing the layout of form elements. Each inner list represents a row of elements */ 'grid'?: Array>; } /** * Data transfer object representing a form relation */ export interface FormRelationDTO { /** * The type of the form relation. The options are: CONVERSION_PAGE_RECORD, RELATED_RECORD_TO_CONVERSION_PAGE_RECORD, STATIC */ 'type'?: string; /** * The relation to be created. */ 'relation'?: RelationDTO; /** * The related relation associated with conversion page record */ 'relatedRelation'?: RelationDTO; /** * The related object associated with conversion page record or for static */ 'relatedObject'?: CaraerObjectDTO; /** * UUID of the record for the static connection. */ 'recordUuid'?: string; /** * The connection type for the related object. The options are: PRIMARY, ALL */ 'relatedObjectConnection'?: string; } /** * Data transfer object representing a form with its associated properties and structure */ export interface FormWithAiPromptDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * The associated Caraer object that this form belongs to */ 'object'?: CaraerObjectDTO; /** * List of form items that make up the form\'s structure. Each grid represents a section or group of form elements */ 'grids'?: Array; /** * Descriptive text providing additional information about the form */ 'description'?: string; /** * The styling of the form. Can be \'standard\', \'underline\' or \'plain\' */ 'styling'?: string; /** * List of lead scoring rules associated with this form. Used to evaluate and score form submissions */ 'leadscores'?: Array; /** * List of form relations that define the relationships between this form conversion record and other records in the system */ 'relations'?: Array; /** * Indicates if the form should be displayed as a step-by-step wizard interface */ 'wizard'?: boolean; /** * Metadata associated with the form */ 'metadata'?: { [key: string]: string; }; /** * Thank you message to be displayed after the form is submitted */ 'thankYouMessage'?: string; /** * Redirect URL to be displayed after the form is submitted */ 'redirectUrl'?: string; /** * AI prompt to be used for the form */ 'aiPrompt'?: string; } export interface GraphPathEvidence { 'path'?: Array<{ [key: string]: any | null; }>; 'summary'?: string; 'relation'?: string; 'targetObject'?: string; 'recordUuid'?: string; } export interface GraphTraversalSpec { 'relation'?: string; 'targetObject'?: string; 'direction'?: string; 'maxDepth'?: number; 'includeLifecycle'?: boolean; 'includeActivities'?: boolean; 'perRelationLimit'?: number; } /** * Represents a single cell within a form grid, which can contain a property, text, nested form, or other form elements */ export interface GridItemDTO { /** * The property associated with this grid item, typically representing a form field or input */ 'property'?: PropertyDTO; /** * Static text content to be displayed in this grid cell */ 'text'?: string; /** * A nested form that can be embedded within this grid cell */ 'form'?: FormDTO; /** * The text of the submit button for this grid item */ 'submitButton'?: string; /** * Configuration settings for this grid item, including display and validation rules */ 'settings'?: GridItemSettingsDTO; /** * The value of this grid item, used for form submissions */ 'value'?: string; } /** * Configuration settings for a grid item in a form, including property settings and form-related settings */ export interface GridItemSettingsDTO { /** * Defines the relationship between this form field and other entities or forms */ 'relation'?: RelationDTO; /** * UUID of a record to be pre-filled in this form field */ 'record'?: ModelRecord; 'aiprompt'?: string; /** * The display label for the form field */ 'label'?: string; /** * The default value to be pre-filled in the form field */ 'defaultValue'?: string; /** * Indicates whether this field must be filled out before form submission */ 'isRequired'?: boolean; /** * Indicates whether this field should be hidden from view */ 'hidden'?: boolean; /** * The placeholder text for the form field */ 'placeholder'?: string; /** * The help text for the form field */ 'helpText'?: string; /** * The AI prompt for the form field. Only applicable to text fields. */ 'AIPrompt'?: string; /** * The styling for the form field. Can be \'dropdown\', \'grid\' or \'boxes\' */ 'styling'?: string; /** * Whether the form field should be stretched to the full width of the form */ 'stretch'?: boolean; /** * The alignment of the form field. Can be \'left\', \'center\' or \'right\' */ 'align'?: string; /** * The minimum value for the slider field */ 'rangeMin'?: number; /** * The maximum value for the slider field */ 'rangeMax'?: number; } /** * Installation link between a company and an app (per-installation settings and token) */ export interface HasAppDTO { /** * Unique identifier for the installation relationship */ 'uuid'?: string; /** * Installation token */ 'token'?: string; /** * Scopes granted to this installation */ 'scopes'?: Array; /** * Per-installation app setting values (JSON object keyed by setting name) */ 'settingsValues'?: string; /** * Per-object record filters for this installation (object name → filter) */ 'filters'?: { [key: string]: Filter; }; /** * Per-app-bar placement config keyed by app bar UUID */ 'appBarVisibility'?: { [key: string]: AppBarVisibilityEntry; }; /** * Whether OAuth tokens have been issued for this installation */ 'oauthConnected'?: boolean; /** * OAuth access token expiry (epoch ms), if connected via OAuth */ 'oauthAccessTokenExpiresAt'?: number; } /** * Optional initial configuration settings */ export interface InstallAppRequest { /** * Optional initial configuration settings (key-value via AppSettingFieldSchema name/value). */ 'settings'?: Array; /** * Optional scopes to grant to the app. */ 'scopes'?: Array; /** * Optional per-object record filters for this installation (object name → filter). */ 'filters'?: { [key: string]: Filter; }; /** * Optional per-app-bar placement config keyed by app bar UUID. */ 'appBarVisibility'?: { [key: string]: AppBarVisibilityEntry; }; } export interface Item { 'id'?: string; 'title'?: string; 'body'?: string; 'type'?: string; 'icon'?: string; 'actionTitle'?: string; 'action'?: string; 'data'?: { [key: string]: any | null; }; 'sender'?: string; 'company'?: string; 'targetUserUuid'?: string; 'createdAt'?: string; 'updatedAt'?: string; 'readAt'?: string; 'sourceAppUuid'?: string; 'appLogo'?: string; } /** * DTO representing a lead score rule */ export interface Leadscore { /** * The name of the object to which this pagination item belongs. */ 'object'?: string; /** * The relationship between objects. */ 'relation'?: string; /** * Optional relation direction: outgoing (related→main), incoming (main→related), or omit for undirected. */ 'relationDirection'?: string; /** * The name of the property within the object. */ 'property'?: string; /** * Specifies whether the relation is included. */ 'relationIncluded'?: boolean; /** * Defines the operator used in the filter. Available operators are defined in the API documentation. */ 'operator'?: string; /** * Represents the value to filter against. */ 'value'?: any; /** * When true, filter fields contain smart content placeholders resolved at runtime. */ 'smartContent'?: boolean; /** * When true, propertyName refers to a property stored on the relation edge itself (declared on the relation schema, e.g. partstat on attendees) instead of a property of the related record. Requires relation and propertyName. */ 'edgeProperty'?: boolean; /** * Whether the value is a smart value */ 'smart_value'?: boolean; /** * The score to assign if the rule is met */ 'score'?: number; } export interface LinkedProperty extends PropertyFormat { 'linkedProperty'?: PropertyDTO; } /** * Request to load dynamic options for a SINGLE_SELECT or MULTI_SELECT setting field. */ export interface LoadAppSettingOptionsRequest { /** * Name of the setting field to load options for. */ 'fieldName': string; /** * Optional search query typed by the installer. */ 'query'?: string; /** * Current draft settings schema with values from the installer UI. */ 'settingsSchema': Array; /** * When loading options for an app bar field, the app bar UUID. */ 'appBarUuid'?: string; /** * Record in context when the options field is on an action dialog. */ 'recordUuid'?: string; /** * Object name in context when the options field is on an action dialog. */ 'object'?: string; } export interface Location extends PropertyFormat { } export interface LoginRequest { 'email': string; 'password': string; } /** * A map marker from one source: custom lat/lng, a page location property, or an object */ export interface MapLocationDTO { 'latitude'?: number; 'longitude'?: number; /** * UUID of a location property */ 'propertyUuid'?: string; /** * Name of a location property (fallback if uuid missing) */ 'propertyName'?: string; /** * When set, resolve markers from published records of this object. Exclusive with propertyUuid and custom lat/lng. */ 'objectUuid'?: string; /** * Object name fallback when uuid is missing */ 'objectName'?: string; /** * FontAwesome icon key for the marker */ 'icon'?: string; /** * Marker icon color (hex or rgba) */ 'iconColor'?: string; /** * Marker pin background fill color (hex or rgba) */ 'iconBackgroundColor'?: string; /** * Marker pin size in CSS pixels */ 'markerSize'?: number; /** * Marker glyph size in CSS pixels */ 'iconSize'?: number; /** * Text shown when hovering the marker (supports smart content) */ 'label'?: string; /** * UUID of a property whose value is shown as hover text */ 'labelPropertyUuid'?: string; /** * Name of a property whose value is shown as hover text */ 'labelPropertyName'?: string; /** * UUID of the preview shown when hovering a bound marker */ 'hoverPreviewUuid'?: string; /** * Name of the preview shown when hovering a bound marker */ 'hoverPreviewName'?: string; /** * Record this concrete public marker was resolved from */ 'recordUuid'?: string; /** * Marker click target: liveUrl, custom, or unset */ 'clickLinkType'?: string; /** * Custom URL used when clickLinkType is custom */ 'clickLinkUrl'?: string; /** * Open the marker link in a new tab */ 'clickLinkOpenInNewWindow'?: boolean; /** * Resolved public URL for this concrete marker */ 'href'?: string; /** * Properties exposed as public filters for object-bound markers */ 'filterProperties'?: Array; /** * Resolved property values used to filter this concrete marker */ 'filterValues'?: { [key: string]: any | null; }; } export interface MapMarkerPreviewRequest { 'recordUuid'?: string; 'previewUuid'?: string; 'previewName'?: string; } export interface MappingDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; 'sourceUrl'?: string; 'syncRate'?: number; 'active'?: boolean; 'mappingItems'?: Array; 'object'?: CaraerObjectDTO; 'unpublishWhenNotInSource'?: boolean; } export interface MappingItemDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; 'sourceField'?: string; 'targetObject'?: CaraerObjectDTO; 'targetProperty'?: PropertyDTO; 'conversionFunction'?: string; } /** * Request to migrate an existing V1 app to platform V2 (shared container runtime) */ export interface MigrateAppToV2Request { /** * Required when functions disagree or none set: nodejs22 or python312 */ 'runtime'?: string; } export interface ModelDate extends PropertyFormat { } export interface ModelFile extends PropertyFormat { } export interface ModelRecord { 'name': string; 'label'?: string; 'createdAt'?: number; 'updatedAt'?: number; 'deletedAt'?: number; 'createdByUuid'?: string; 'updatedByUuid'?: string; 'deletedByUuid'?: string; 'index'?: number; 'complete'?: boolean; 'deleted'?: boolean; 'uuid': string; 'properties'?: Array; 'objects'?: { [key: string]: any | null; }; 'user'?: PublicUserDTO; } export interface MultiFile extends PropertyFormat { } export interface MultiLine extends PropertyFormat { } export interface MultiSelect extends PropertyFormat { } export interface MultiValueMapStringString { [key: string]: Array | any; 'all'?: { [key: string]: string; }; 'empty'?: boolean; } export interface NotFoundError { 'cause'?: NotFoundErrorCause; 'stackTrace'?: Array; /** * The error message providing details about the failure. */ 'errors'?: Array; /** * The HTTP status code associated with the error. */ 'code'?: number; /** * A suggestion on how to correct the error. */ 'correctionSuggestion': string; /** * The error message providing details about the failure. */ 'message': string; 'suppressed'?: Array; 'localizedMessage'?: string; 'resourceKind'?: string; 'identifier'?: string; 'identifierType'?: string; 'referencedBy'?: Array; } export interface NotFoundErrorCause { 'stackTrace'?: Array; 'message'?: string; 'localizedMessage'?: string; } export interface NotFoundErrorCauseStackTraceInner { 'classLoaderName'?: string; 'moduleName'?: string; 'moduleVersion'?: string; 'methodName'?: string; 'fileName'?: string; 'lineNumber'?: number; 'className'?: string; 'nativeMethod'?: boolean; } export interface NotificationInboxDTO { 'notifications'?: Array; 'unreadCount'?: number; } export interface Number extends PropertyFormat { } export interface NumberRange extends PropertyFormat { } export interface OAuthRegistrationRequest { 'redirect_uris'?: Array; 'client_name'?: string; 'token_endpoint_auth_method'?: string; 'application_type'?: string; } /** * Users, teams, and installed apps available for object access grants. */ export interface ObjectAccessGrantCandidatesDTO { /** * Company users with HAS_ACCESS_TO */ 'users'?: Array; /** * Teams in the tenant */ 'teams'?: Array; /** * Apps installed for the current company */ 'apps'?: Array; } /** * Request to grant record-level access on an object to users, teams, and apps. */ export interface ObjectAccessGrantRequestDTO { /** * User grants */ 'users'?: ObjectAccessGrantSectionDTO; /** * Team grants */ 'teams'?: ObjectAccessGrantSectionDTO; /** * Installed app grants */ 'apps'?: ObjectAccessGrantSectionDTO; } /** * Access grant selection for one principal type (users, teams, or apps). */ export interface ObjectAccessGrantSectionDTO { /** * UUIDs to grant access to */ 'uuids'?: Array; /** * Record scopes applied to every selected UUID */ 'globalScopes'?: Array; /** * Per-UUID scope overrides merged with globalScopes */ 'overrides'?: { [key: string]: Array; }; } /** * Data transfer object representing a webpage content */ export interface PageContentDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * Category of the content */ 'category'?: string; /** * Unique identifier for the parent content */ 'parentUuid'?: string; /** * Type of the content (\'box\' or \'component\') */ 'type'?: string; /** * Display of the content for box (\'column\', \'row\' or \'wrap\') and for component () */ 'display'?: string; /** * Text content of the content */ 'text'?: string; /** * Direct CSS for this content node, scoped to data-component-uuid at render time */ 'customCss'?: string; /** * Styling of the content */ 'styling'?: PageContentStylingDTO; /** * Settings for the content */ 'settings'?: PageContentSettingsDTO; /** * Children of the content */ 'children'?: Array; /** * Module storage scope: company or personal */ 'scope'?: string; /** * Module kind: content (section/component) or page (full page design) */ 'moduleKind'?: string; /** * Page-level custom CSS for page modules */ 'pageCustomCss'?: string; /** * Page-level custom JS for the head for page modules */ 'pageCustomJsHead'?: string; /** * Page-level custom JS for the body for page modules */ 'pageCustomJsBody'?: string; /** * Sidebar preview UUID for page modules */ 'sidebarUuid'?: string; /** * Sidebar relation UUID for page modules */ 'sidebarRelationUuid'?: string; /** * Sidebar object UUID for page modules */ 'sidebarObjectUuid'?: string; } /** * Data transfer object representing the settings for a content */ export interface PageContentSettingsDTO { /** * The form associated with the content */ 'form'?: FormDTO; /** * The icon to display when the accordion is open */ 'openIcon'?: string; /** * The icon to display when the accordion is closed */ 'closeIcon'?: string; /** * The alt text of the image */ 'alt'?: string; /** * The key of the image */ 'key'?: string; /** * Whether the video should play automatically */ 'playVideo'?: boolean; /** * Whether the image should start muted */ 'startMuted'?: boolean; /** * Whether the video should loop */ 'loopVideo'?: boolean; /** * The start offset of the video */ 'startOffset'?: number; /** * The link of the button */ 'link'?: string; /** * The style of the button. Primary, secondary, tertiary or custom */ 'style'?: string; /** * Optional CTA tracking identifier for CMS buttons */ 'ctaId'?: string; /** * Whether the link should open in a new window */ 'openInNewWindow'?: boolean; /** * The slider type. Dots, arrows and swipe */ 'sliderType'?: string; /** * The carousel speed. */ 'carouselSpeed'?: number; /** * Whether carousel prev/next controls are shown */ 'enableControls'?: boolean; /** * The object of the previews */ 'previewObject'?: CaraerObjectDTO; /** * The previews associated with the layouts */ 'previews'?: { [key: string]: PreviewDTO; }; /** * The order of preview layouts */ 'previewLayoutOrder'?: Array; /** * The filter associated with the settings */ 'filter'?: Filter; /** * The order by property associated with the settings */ 'orderBy'?: PropertyDTO; /** * The order by direction associated with the settings. ASC or DESC, default is ASC */ 'orderByDirection'?: string; /** * Whether the previews should be shown as webpages */ 'asWebpages'?: boolean; /** * Whether the previews should loop */ 'loop'?: boolean; /** * The limit associated with the settings */ 'limit'?: number; /** * The group by property associated with the settings */ 'groupBy'?: PropertyDTO; /** * Whether the previews should be hidden when there are no results */ 'hideOnNoResults'?: boolean; /** * The type of the filter block. left_bar or top_search */ 'filterType'?: string; /** * The single result string of the filter block */ 'searchResultSingleString'?: string; /** * The Plural result string of the filter block */ 'searchResultPluralString'?: string; /** * The no results string of the filter block */ 'noResultsString'?: string; /** * Whether the search field should be enabled */ 'searchFieldEnabled'?: boolean; /** * The placeholder of the search field */ 'searchFieldPlaceholder'?: string; /** * Whether the filter block should be enabled */ 'filterBlockEnabled'?: boolean; /** * The title of the filter block */ 'filterTitle'?: string; /** * The subtitle of the filter block */ 'filterSubtitle'?: string; /** * The properties of the filter block */ 'filterProperties'?: Array; /** * Whether the filter tiles should be enabled */ 'enableFilterTiles'?: boolean; /** * Whether the filter query should be enabled */ 'enableFilterQuery'?: boolean; /** * Whether the remove all filters button should be enabled */ 'enableRemoveAllFiltersButton'?: boolean; /** * Whether the CTA should be enabled */ 'ctaEnabled'?: boolean; /** * The title of the CTA */ 'ctaTitle'?: string; /** * The text of the CTA */ 'ctaText'?: string; /** * The button text of the CTA */ 'ctaButtonText'?: string; /** * The button link of the CTA */ 'ctaButtonLink'?: string; /** * The platforms shown in the share component */ 'platforms'?: Array; /** * Latitude for the map component */ 'mapLatitude'?: number; /** * Longitude for the map component */ 'mapLongitude'?: number; /** * Multiple map markers */ 'mapLocations'?: Array; /** * Show a public distance-from-location filter on this map */ 'distanceFilterEnabled'?: boolean; /** * Show a public contains filter for city, street, or postcode on this map */ 'locationContainsFilterEnabled'?: boolean; } export interface PageContentStylingDTO { /** * The style set for all devices */ 'all'?: StyleSetDTO; /** * The style set for the mobile device */ 'mobile'?: StyleSetDTO; /** * The style set for the tablet device */ 'tablet'?: StyleSetDTO; /** * The style set for the desktop device */ 'desktop'?: StyleSetDTO; } /** * Pagination and filtering options for the request */ export interface PaginationRequest { /** * A list of key-value pairs representing filter criteria for the request. Keys represent fields to filter by, operator can be any of the following: \'=\', \'>\', \'<\', \'>=\', \'<=\', (not) \'in\', \'(not) contains\', \'(not) startswith\', \'(not) endswith\', \'(not) isnull\'. */ 'filters'?: Array<{ [key: string]: any | null; }>; /** * A list of key-value pairs representing sorting criteria. Keys represent fields to sort by, and values define the sort direction (e.g., \'asc\' or \'desc\'). */ 'sort'?: Array<{ [key: string]: string; }>; /** * A list of field names specifying which fields to include in the response. */ 'show'?: Array; /** * The maximum number of items to retrieve per page. */ 'limit'?: number; /** * The page number to retrieve in the paginated response (1-based index). */ 'page'?: number; /** * Optional search query to filter results. This will apply to all properties on the entity. */ 'query'?: string; } /** * Paginated response (PaginationResponseAppDTO). */ export interface PaginationResponseAppDTO { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Paginated response (PaginationResponseCaraerObjectDTO). */ export interface PaginationResponseCaraerObjectDTO { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Response object for paginated data. */ export interface PaginationResponseCompanyDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data returned in the current page of the pagination. */ 'data'?: Array; /** * The total number of items available. */ 'total'?: number; /** * The current page number (starts from 1). */ 'page'?: number; /** * The number of items displayed per page. */ 'perPage'?: number; /** * The last page number available for the pagination. */ 'lastPage'?: number; } /** * Response object for paginated data. */ export interface PaginationResponseFeedDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data returned in the current page of the pagination. */ 'data'?: Array; /** * The total number of items available. */ 'total'?: number; /** * The current page number (starts from 1). */ 'page'?: number; /** * The number of items displayed per page. */ 'perPage'?: number; /** * The last page number available for the pagination. */ 'lastPage'?: number; } /** * Paginated response (PaginationResponseFormDTO). */ export interface PaginationResponseFormDTO { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Response object for paginated data. */ export interface PaginationResponseMapStringObject { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data returned in the current page of the pagination. */ 'data'?: Array<{ [key: string]: any | null; }>; /** * The total number of items available. */ 'total'?: number; /** * The current page number (starts from 1). */ 'page'?: number; /** * The number of items displayed per page. */ 'perPage'?: number; /** * The last page number available for the pagination. */ 'lastPage'?: number; } /** * Paginated response (PaginationResponseObject). */ export interface PaginationResponseObject { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Paginated response (PaginationResponsePageContentDTO). */ export interface PaginationResponsePageContentDTO { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Response object for paginated data. */ export interface PaginationResponsePreviewDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data returned in the current page of the pagination. */ 'data'?: Array; /** * The total number of items available. */ 'total'?: number; /** * The current page number (starts from 1). */ 'page'?: number; /** * The number of items displayed per page. */ 'perPage'?: number; /** * The last page number available for the pagination. */ 'lastPage'?: number; } /** * Paginated response (PaginationResponsePropertyCalculationTypeDTO). */ export interface PaginationResponsePropertyCalculationTypeDTO { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Paginated response (PaginationResponsePropertyDTO). */ export interface PaginationResponsePropertyDTO { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Paginated response (PaginationResponsePropertyFormat). */ export interface PaginationResponsePropertyFormat { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Response object for paginated data. */ export interface PaginationResponsePropertyOption { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data returned in the current page of the pagination. */ 'data'?: Array; /** * The total number of items available. */ 'total'?: number; /** * The current page number (starts from 1). */ 'page'?: number; /** * The number of items displayed per page. */ 'perPage'?: number; /** * The last page number available for the pagination. */ 'lastPage'?: number; } /** * Paginated response (PaginationResponsePublicEnvironmentDTO). */ export interface PaginationResponsePublicEnvironmentDTO { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Response object for paginated data. */ export interface PaginationResponsePublicFormDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data returned in the current page of the pagination. */ 'data'?: Array; /** * The total number of items available. */ 'total'?: number; /** * The current page number (starts from 1). */ 'page'?: number; /** * The number of items displayed per page. */ 'perPage'?: number; /** * The last page number available for the pagination. */ 'lastPage'?: number; } /** * Paginated response (PaginationResponseRelationDTO). */ export interface PaginationResponseRelationDTO { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Paginated response (PaginationResponseSavedFilterDTO). */ export interface PaginationResponseSavedFilterDTO { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Paginated response (PaginationResponseServerlessFunctionDTO). */ export interface PaginationResponseServerlessFunctionDTO { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Paginated response (PaginationResponseSubscribeWebhookDTO). */ export interface PaginationResponseSubscribeWebhookDTO { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Paginated response (PaginationResponseSyncDTO). */ export interface PaginationResponseSyncDTO { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Paginated response (PaginationResponseTraitDTO). */ export interface PaginationResponseTraitDTO { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Paginated response (PaginationResponseViewDTO). */ export interface PaginationResponseViewDTO { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Paginated response (PaginationResponseWebMenuDTO). */ export interface PaginationResponseWebMenuDTO { 'message'?: string; 'data'?: Array; 'total'?: number; 'page'?: number; 'perPage'?: number; 'lastPage'?: number; } /** * Response object for paginated data. */ export interface PaginationResponseWebpageAccessGrantDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data returned in the current page of the pagination. */ 'data'?: Array; /** * The total number of items available. */ 'total'?: number; /** * The current page number (starts from 1). */ 'page'?: number; /** * The number of items displayed per page. */ 'perPage'?: number; /** * The last page number available for the pagination. */ 'lastPage'?: number; } export interface Phone extends PropertyFormat { } /** * Data transfer object representing a preview entity */ export interface PreviewDTO { /** * Description of the preview */ 'description'?: string; /** * The Caraer object associated with this preview */ 'object'?: CaraerObjectDTO; /** * UUID of the associated record */ 'recordUuid'?: string; /** * Indicates whether this preview is the primary one */ 'primary'?: boolean; /** * Values stored on the relation edge for properties declared on the relation schema. Only present when the preview was loaded through such a relation. */ 'edgeProperties'?: { [key: string]: any | null; }; /** * Rows of the preview grid */ 'grid'?: Array>; /** * Preview type */ 'previewType'?: string; /** * Profile image property */ 'profileImage'?: PropertyDTO; /** * Profile image position (top, left, right, bottom, background) */ 'profileImagePosition'?: string; /** * Style set for the profile image */ 'profileImageStyling'?: PageContentStylingDTO; /** * First initial property */ 'firstInitialProperty'?: PropertyDTO; /** * Second initial property */ 'secondInitialProperty'?: PropertyDTO; /** * Value of the profile image */ 'profileImageValue'?: string; /** * Value of the first initial property */ 'firstInitialPropertyValue'?: string; /** * Value of the second initial property */ 'secondInitialPropertyValue'?: string; /** * Custom CSS styles for the preview */ 'customCss'?: string; /** * URL of the preview */ 'url'?: string; /** * The styling of the preview */ 'styling'?: PageContentStylingDTO; /** * Property name used for server-side list sorting */ 'sortProperty'?: string; /** * Raw stored value of the sort property for this record */ 'sortValue'?: any; /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; } /** * Data Transfer Object for PreviewItem, used for transferring preview details. */ export interface PreviewItemDTO { /** * The property details associated with the preview item. */ 'property'?: PropertyDTO; /** * The text content associated with the preview item. */ 'text'?: string; /** * The value associated with the preview item. This can hold custom data. */ 'value'?: any; /** * The related object information for the preview item. */ 'relatedObject'?: PreviewRelatedObjectDTO; /** * The related object value associated with this preview item. */ 'relatedObjectValue'?: any; /** * Whether the preview item is a divider. (solid, dashed, dotted, spacer) */ 'divider'?: string; /** * The button text associated with the preview item. */ 'buttonText'?: string; /** * The button url associated with the preview item. */ 'buttonUrl'?: string; /** * The button text value associated with the preview item. */ 'buttonTextValue'?: any; /** * The button value associated with the preview item. */ 'buttonUrlValue'?: any; /** * The settings associated with the preview item. */ 'settings'?: PreviewItemSettingsDTO; /** * The styling associated with the preview item. */ 'styling'?: PageContentStylingDTO; } /** * Data Transfer Object for PreviewItemSettings, used for transferring preview item settings. */ export interface PreviewItemSettingsDTO { /** * Whether the preview item should show the icon. */ 'showIcon'?: boolean; /** * The padding of the icon. */ 'iconPadding'?: number; /** * The color of the icon. */ 'iconColor'?: string; /** * The size of the icon. */ 'iconSize'?: number; /** * The default value of the preview item. */ 'defaultValue'?: string; /** * Whether this preview property is editable inline. */ 'editable'?: boolean; /** * The help text of the preview item. */ 'helpText'?: string; /** * The paragraph of the preview item p, h1, h2, h3, h4, h5, h6. */ 'paragraph'?: string; /** * Whether the preview item should show the color of the select option. */ 'showColor'?: boolean; /** * Whether the preview item should show the border around the select option. */ 'showBorder'?: boolean; /** * What type the button should be (primary, secondary or tertiary) */ 'buttonType'?: string; /** * Whether to show the favicon of the button URL. */ 'showFavicon'?: boolean; } /** * Data transfer object representing a PreviewRelatedObject, constructed using related object and relation data. */ export interface PreviewRelatedObjectDTO { /** * The related object data. */ 'object'?: CaraerObjectDTO; /** * The type of relation between objects. */ 'relation'?: RelationDTO; } export interface Progress extends PropertyFormat { 'checkboxProperty'?: PropertyDTO; } /** * Data transfer object for a developer project build artifact. */ export interface ProjectBuildDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * UUID of the owning developer project */ 'projectUuid'?: string; /** * PENDING, READY, or FAILED */ 'status'?: string; /** * production or sandbox */ 'target'?: string; /** * GCS object path of the uploaded build archive */ 'artifactGcsPath'?: string; /** * Parsed build manifest (functions, webhooks, app fields), serialized as JSON */ 'manifestJson'?: string; /** * Error message if the build failed */ 'errorMessage'?: string; /** * Semantic version for this build */ 'version'?: string; /** * Release notes for this build */ 'releaseNotes'?: string; } /** * Data transfer object for a developer project deploy. */ export interface ProjectDeployDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * UUID of the owning developer project */ 'projectUuid'?: string; /** * UUID of the build that was deployed */ 'buildUuid'?: string; /** * Semantic version of the deployed build */ 'version'?: string; /** * PENDING, SUCCEEDED, FAILED, or PARTIAL */ 'status'?: string; /** * production or sandbox */ 'target'?: string; /** * Per-component reconciliation results (app, functions, webhooks), serialized as JSON */ 'resultsJson'?: string; /** * Unix timestamp (ms) when this deploy was activated */ 'activatedAt'?: number; } /** * Data transfer object representing a property with its configuration and metadata */ export interface PropertyDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name identifier of the property */ 'name'?: string; /** * Display label for the property */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * Detailed description of the property\'s purpose and usage */ 'description'?: string; /** * The data type of the property (e.g., \'string\', \'number\', \'date\', etc.) */ 'type'?: string; /** * List of predefined options for properties that support selection */ 'options'?: Array; /** * Group name for organizing related properties */ 'group'?: string; 'format'?: PropertyDTOFormat; /** * Collection of validation rules applied to the property */ 'rules'?: Array; /** * Indicates if the property value cannot be modified after initial creation */ 'immutable'?: boolean; /** * Indicates if the property should be hidden from view */ 'hidden'?: boolean; /** * When true, property value changes are tracked as lifecycle records */ 'lifecycleActive'?: boolean; /** * When this filter matches the record being saved, the property becomes required */ 'requiredFilter'?: Filter; /** * Indicates if the property should be excluded from public APIs */ 'nonPublic'?: boolean; /** * Indicates if the property should be indexed for searching */ 'indexed'?: boolean; /** * Indicates if the property value can be modified */ 'editable'?: boolean; /** * Additional format-specific settings for the property */ 'formatSettings'?: { [key: string]: any | null; }; /** * Information about where this property is used in the system */ 'usedIn'?: UsedInResult; /** * Icon identifier for visual representation of the property */ 'icon'?: string; /** * Indicates if the property can be used in webpages */ 'webpagePublic'?: boolean; /** * Indicates if the property can be embedded in other properties * @deprecated */ 'embeddable'?: boolean; /** * When true, exclude from advanced query evidence */ 'sensitive'?: boolean; /** * The minimum and maximum value of the property */ 'minAndMaxValue'?: Tuple2LongLong; /** * Indicates if the property is pinned by the logged-in user */ 'pinned'?: boolean; } /** * @type PropertyDTOFormat * Format configuration for the property\'s display and validation */ export type PropertyDTOFormat = Currency | CurrencyRange | DateRange | Duration | Email | LinkedProperty | Location | ModelDate | ModelFile | MultiFile | MultiLine | MultiSelect | Number | NumberRange | Phone | Progress | Recurrence | SingleCheckbox | SingleLine | SingleSelect | Structure | Tag | Url; export interface PropertyFormat { 'label'?: string; 'name'?: string; 'icon'?: string; 'type'?: string; 'settings'?: Array; 'filters'?: Array; 'rules'?: Array; } export interface PropertyOption { 'name'?: string; 'label'?: string; 'icon'?: string; 'color'?: string; 'disabled'?: boolean; 'completed'?: boolean; 'usedIn'?: UsedInResult; } /** * Data transfer object representing a form with its associated properties and structure */ export interface PublicFormDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * The associated Caraer object that this form belongs to */ 'object'?: CaraerObjectDTO; /** * List of form items that make up the form\'s structure. Each grid represents a section or group of form elements */ 'grids'?: Array; /** * Descriptive text providing additional information about the form */ 'description'?: string; /** * The styling of the form. Can be \'standard\', \'underline\' or \'plain\' */ 'styling'?: string; /** * Indicates if the form should be displayed as a step-by-step wizard interface */ 'wizard'?: boolean; /** * Metadata associated with the form */ 'metadata'?: { [key: string]: string; }; /** * Thank you message to be displayed after the form is submitted */ 'thankYouMessage'?: string; /** * Redirect URL to be displayed after the form is submitted */ 'redirectUrl'?: string; } export interface PublicUserDTO { 'uuid'?: string; 'email'?: string; 'firstname'?: string; 'lastname'?: string; 'initials'?: string; 'scopes'?: Array; 'filters'?: { [key: string]: Filter; }; 'role'?: string; 'record'?: ModelRecord; } export interface QueryEvidence { 'type'?: string; 'polarity'?: string; 'summary'?: string; 'sourceObject'?: string; 'sourceRecordUuid'?: string; 'relation'?: string; 'timestamp'?: number; 'recencyWeight'?: number; 'confidence'?: number; 'properties'?: { [key: string]: any | null; }; 'paths'?: Array; } /** * Data Transfer Object for representing a record with dynamic properties. */ export interface RecordDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * Property values as a name→value map, or a LEGACY array of {name,type,value} objects (same shape as LEGACY GET responses). */ 'properties'?: { [key: string]: any | null; }; /** * The user of the record if the user trait is enabled. */ 'user'?: PublicUserDTO; /** * Relations to create or merge after the record is saved. Each item links to an existing record (uuid) or creates a nested record first. */ 'relations'?: Array; } /** * Contains pagination details and optional query parameters such as filter, sort, and show options. */ export interface RecordPaginationRequest { /** * The page index (one-based) to request. */ 'page'?: number; /** * The number of records to retrieve per page. */ 'limit'?: number; /** * Filters applied to the query. */ 'filter'?: object; /** * Sorting options for the query. */ 'sort'?: Array; /** * Specifies what data to show in the response. */ 'show'?: Array; /** * A free-text search query applied to the records. */ 'query'?: string; /** * Preview information for the records, if supported. */ 'preview'?: string; /** * The main object for categorization or context. */ 'mainObject'?: string; /** * The column to group the records by. */ 'column'?: string; } /** * Relation to create when saving a record */ export interface RecordRelationRequestDTO { /** * Name of the relation type */ 'relationName': string; /** * UUID of an existing record to link to */ 'uuid'?: string; /** * Properties to update on the existing record referenced by uuid before linking */ 'properties'?: { [key: string]: any | null; }; /** * Values for properties declared on the relation schema, stored on the relation edge itself (not on either record). Omit to leave existing edge values untouched; a null value clears a key. */ 'edgeProperties'?: { [key: string]: any | null; }; /** * Nested record to create or update (by uuid or unique properties) before linking */ 'record'?: RecordDTO; /** * Object name for nested record create when relation allows multiple target types */ 'objectName'?: string; /** * When true, marks this relation edge as primary */ 'primary'?: boolean; /** * When true, MERGE relation edge instead of CREATE */ 'merge'?: boolean; } export interface RecordSummary { 'uuid'?: string; 'object'?: string; 'properties'?: { [key: string]: any | null; }; 'parsedProperties'?: { [key: string]: any | null; }; } export interface Recurrence extends PropertyFormat { } export interface Reference { 'kind'?: string; 'identifier'?: string; 'label'?: string; 'field'?: string; } /** * Exchange a refresh token for a new access token */ export interface RefreshTokenRequest { /** * Refresh token issued by device poll / refresh */ 'refreshToken': string; } export interface RegisterRequest { 'email': string; 'password': string; 'firstname': string; 'lastname': string; } /** * Data transfer object representing a relation between Caraer objects */ export interface RelationDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * Unique identifier name for the relation */ 'name'?: string; /** * Display label for the relation */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * Detailed description of the relation\'s purpose and usage */ 'description'?: string; /** * Set of Caraer objects that are part of this relation */ 'objects'?: Set; /** * Whether the relation is immutable */ 'immutable'?: boolean; /** * Whether the relation is editable */ 'editable'?: boolean; } /** * Optional relation edge payload */ export interface RelationEdgeRequestDTO { /** * Values for properties declared on the relation schema, stored on the edge itself. A null value clears that key. */ 'edgeProperties'?: { [key: string]: any | null; }; /** * When true, marks this relation edge as primary. Overrides the primary query parameter. */ 'primary'?: boolean; } export interface ResetPasswordRequest { 'email'?: string; 'token'?: string; 'password'?: string; } /** * Represents the response returned when a restore operation is performed successfully. */ export interface RestoreResponse { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: any; } /** * Represents the response returned when a restore operation is performed successfully. */ export interface RestoreResponseCaraerObjectDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: CaraerObjectDTO; } /** * Represents the response returned when a restore operation is performed successfully. */ export interface RestoreResponseSavedFilterDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: SavedFilterDTO; } /** * Represents the response returned when a restore operation is performed successfully. */ export interface RestoreResponseTeamDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: TeamDTO; } /** * Represents the response returned when a restore operation is performed successfully. */ export interface RestoreResponseViewDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: ViewDTO; } /** * Review request with feedback, reviewer notes, and publish state */ export interface ReviewRequest { /** * Feedback shown to the developer. */ 'feedback'?: string; /** * Internal notes for reviewers (not shown to the developer). */ 'reviewerNotes'?: string; /** * Publish state after review: APPROVED, REJECTED, CHANGES_REQUESTED. */ 'publishState'?: string; } /** * Request body for generating a sample webhook payload from a record and event type. */ export interface SamplePayloadRequest { /** * UUID of the record to base the sample payload on. */ 'recordUuid'?: string; /** * Event type to simulate (created, updated, deleted, etc.). */ 'eventType'?: string; } /** * DTO representing a property to be saved */ export interface SavePropertyDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The internal name of the property */ 'name'?: string; /** * The display label of the property */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * A brief description of the property */ 'description'?: string; /** * The data type of the property */ 'type'?: string; /** * List of available options for the property */ 'options'?: Array; /** * The group to which this property belongs */ 'group'?: string; /** * Property format type */ 'format'?: string; /** * Collection of rules applied to the property */ 'rules'?: Array; /** * Indicates if the property is hidden by default */ 'hidden'?: boolean; /** * When true, property value changes are tracked as lifecycle records */ 'lifecycleActive'?: boolean; /** * When this filter matches the record being saved, the property becomes required */ 'requiredFilter'?: Filter; /** * Indicates if the property is not accessible publicly */ 'nonPublic'?: boolean; /** * Indicates if the property is indexed */ 'indexed'?: boolean; /** * Settings to configure the format of the property */ 'formatSettings'?: { [key: string]: any | null; }; /** * Indicates if the property is immutable */ 'immutable'?: boolean; /** * Indicates if the property can be edited */ 'editable'?: boolean; /** * The icon associated with the property */ 'icon'?: string; /** * Indicates if the property is webpage public */ 'webpagePublic'?: boolean; /** * Deprecated. Use sensitive instead. * @deprecated */ 'embeddable'?: boolean; /** * When true, exclude from advanced query evidence */ 'sensitive'?: boolean; } /** * Data transfer object representing a saved filter configuration */ export interface SavedFilterDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name identifier of the saved filter */ 'name': string; /** * Display label for the saved filter */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * Description of what this saved filter is used for */ 'description'?: string; /** * The main object for the saved filter */ 'mainObject'?: string; /** * The filter definition used when querying records */ 'filter'?: Filter; } export interface ScoreBreakdown { 'overall'?: number; 'structured'?: number; 'lexical'?: number; 'semantic'?: number; 'graph'?: number; 'evidenceAdjustment'?: number; 'confidence'?: number; 'components'?: { [key: string]: number; }; } /** * Request DTO for searching records. */ export interface SearchRequest { /** * The query to search for. */ 'query'?: string; /** * The UUID of the object to search in. */ 'objectUuid'?: string; /** * The limit of the search. */ 'limit'?: number; /** * The page of the search. */ 'page'?: number; /** * The preview of the search. */ 'preview'?: string; } /** * Request body for sending an in-app notification in a company */ export interface SendNotificationRequest { /** * Optional. Aim this notification at one user in the company. Omit to notify every user who has access to the company. */ 'targetUserUuid'?: string; /** * Notification title */ 'title': string; /** * Notification body (supports Markdown for links) */ 'body': string; /** * Notification type identifier */ 'type'?: string; /** * Optional icon identifier */ 'icon'?: string; /** * Optional structured action identifier */ 'action'?: string; /** * Optional label for the action button */ 'actionTitle'?: string; /** * Optional action payload */ 'data'?: { [key: string]: any | null; }; } /** * Data transfer object for a serverless function (runtime and code) owned by an app */ export interface ServerlessFunctionDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * Runtime identifier (e.g. javascript, python) */ 'runtime'?: string; /** * Function source code */ 'code'?: string; /** * Additional source files relative to the function folder (e.g. shared.js) */ 'sourceFiles'?: { [key: string]: string; }; /** * Optional description of the serverless function */ 'description'?: string; } /** * Reference to a serverless function by uuid and/or name */ export interface ServerlessFunctionRefDTO { 'uuid'?: string; 'name'?: string; 'label'?: string; } export interface SettingField { 'name'?: string; 'label'?: string; 'helpText'?: string; 'type'?: SettingFieldTypeEnum; 'required'?: boolean; 'dynamic'?: boolean; 'hidden'?: boolean; 'disabled'?: boolean; 'options'?: Array; 'value'?: any; 'defaultValue'?: any; } export declare const SettingFieldTypeEnum: { readonly String: "STRING"; readonly Number: "NUMBER"; readonly SingleSelect: "SINGLE_SELECT"; readonly MultiSelect: "MULTI_SELECT"; readonly Date: "DATE"; readonly File: "FILE"; }; export type SettingFieldTypeEnum = typeof SettingFieldTypeEnum[keyof typeof SettingFieldTypeEnum]; export interface SettingOption { 'name'?: string; 'label'?: string; 'helpText'?: string; 'preview'?: string; } /** * DTO representing an item with properties defined for displaying and handling in UI related operations. */ export interface ShowItem { /** * The name of the object to which this pagination item belongs. */ 'object'?: string; /** * The relationship between objects. */ 'relation'?: string; /** * Optional relation direction: outgoing (related→main), incoming (main→related), or omit for undirected. */ 'relationDirection'?: string; /** * The name of the property within the object. */ 'property'?: string; /** * Separator string used to visually separate this item. */ 'separator'?: string; /** * Flag indicating whether this item is sticky and will stay fixed in the list. */ 'sticky'?: boolean; /** * Width of the item in pixels. */ 'width'?: number; /** * Calculation function used to calculate the value of the item. */ 'calculationFunction'?: string; /** * Result of the calculation. */ 'calculationResult'?: any; } /** * Success response (ShowResponse). */ export interface ShowResponse { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (ShowResponseAnalyticsDashboardConfig). */ export interface ShowResponseAnalyticsDashboardConfig { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (ShowResponseAppBarIframeSessionContextDTO). */ export interface ShowResponseAppBarIframeSessionContextDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (ShowResponseAppBarIframeSessionTokenDTO). */ export interface ShowResponseAppBarIframeSessionTokenDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseAppDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: AppDTO; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseAppExternalOAuthProviderDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: AppExternalOAuthProviderDTO; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseAppInboundRouteDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: AppInboundRouteDTO; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseAppOAuthStartResponseDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: AppOAuthStartResponseDTO; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseAppScheduleDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: AppScheduleDTO; } /** * Success response (ShowResponseBillingStatusDTO). */ export interface ShowResponseBillingStatusDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (ShowResponseCaraerObjectDTO). */ export interface ShowResponseCaraerObjectDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseCmsEnvironmentDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: CmsEnvironmentDTO; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseCmsPageDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: CmsPageDTO; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseCmsPageDocument { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: CmsPageDocument; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseCompanyDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: CompanyDTO; } /** * Success response (ShowResponseDeveloperProjectDTO). */ export interface ShowResponseDeveloperProjectDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (ShowResponseDigitalIdentityDTO). */ export interface ShowResponseDigitalIdentityDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseFeedDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: FeedDTO; } /** * Success response (ShowResponseFormDTO). */ export interface ShowResponseFormDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseListAppConnectionStatusDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseListCmsEnvironmentDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseListCmsModuleDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseListCmsPageDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseListCmsPublicMenuDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Success response (ShowResponseListEnvironmentDTO). */ export interface ShowResponseListEnvironmentDTO { 'message'?: string; 'data'?: Array; } /** * Success response (ShowResponseListFormObjectSummaryDTO). */ export interface ShowResponseListFormObjectSummaryDTO { 'message'?: string; 'data'?: Array; } /** * Success response (ShowResponseListInstalledAppBarDTO). */ export interface ShowResponseListInstalledAppBarDTO { 'message'?: string; 'data'?: Array; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseListMapStringObject { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array<{ [key: string]: any | null; }>; } /** * Success response (ShowResponseListPropertyDTO). */ export interface ShowResponseListPropertyDTO { 'message'?: string; 'data'?: Array; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseListString { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseListWebpageAccessGrantDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Success response (ShowResponseListWebpagePickerItemDTO). */ export interface ShowResponseListWebpagePickerItemDTO { 'message'?: string; 'data'?: Array; } /** * Success response (ShowResponseLoadAppSettingOptionsResponse). */ export interface ShowResponseLoadAppSettingOptionsResponse { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (ShowResponseMapStringAnalyticsDashboardConfig). */ export interface ShowResponseMapStringAnalyticsDashboardConfig { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (ShowResponseMapStringBoolean). */ export interface ShowResponseMapStringBoolean { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseMapStringObject { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: { [key: string]: any | null; }; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseMapStringString { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: { [key: string]: string; }; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseNotificationInboxDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: NotificationInboxDTO; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseObject { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: any; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseObjectAccessGrantCandidatesDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: ObjectAccessGrantCandidatesDTO; } /** * Success response (ShowResponsePageContentDTO). */ export interface ShowResponsePageContentDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponsePreviewDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: PreviewDTO; } /** * Success response (ShowResponsePropertyDTO). */ export interface ShowResponsePropertyDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (ShowResponsePublicFormDTO). */ export interface ShowResponsePublicFormDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (ShowResponseRelationDTO). */ export interface ShowResponseRelationDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (ShowResponseSavedFilterDTO). */ export interface ShowResponseSavedFilterDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (ShowResponseServerlessFunctionDTO). */ export interface ShowResponseServerlessFunctionDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseSignedUrlResultDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: SignedUrlResultDTO; } /** * Success response (ShowResponseString). */ export interface ShowResponseString { 'message'?: string; 'data'?: string; } /** * Success response (ShowResponseSubscribeWebhookDTO). */ export interface ShowResponseSubscribeWebhookDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (ShowResponseTemplateWebpageDTO). */ export interface ShowResponseTemplateWebpageDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (ShowResponseTraitDTO). */ export interface ShowResponseTraitDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseViewDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: ViewDTO; } /** * Success response (ShowResponseWebMenuDTO). */ export interface ShowResponseWebMenuDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseWebpageMapLocationsDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: WebpageMapLocationsDTO; } /** * Represents the response for viewing or showing a specific resource. */ export interface ShowResponseWebpageProtectionInfoDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: WebpageProtectionInfoDTO; } /** * Success response (ShowResponseWebsiteSettingsDTO). */ export interface ShowResponseWebsiteSettingsDTO { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Generated signed URL for a protected webpage */ export interface SignedUrlResultDTO { 'grantUuid'?: string; 'token'?: string; 'expiresAt'?: number; 'queryParams'?: string; } /** * Data Transfer Object representing a public-facing view of a company */ export interface SimplePublicCompanyDTO { /** * Unique identifier of the company */ 'uuid'?: string; /** * Timestamp of the last update (in milliseconds since epoch) */ 'updatedAt'?: number; /** * The website URL of the company */ 'website'?: string; /** * Cookie policy URL of the company */ 'cookiePolicy'?: string; /** * Path to the company\'s favicon */ 'favicon'?: string; /** * Privacy policy URL of the company */ 'privacyPolicy'?: string; /** * The accent color used by the company */ 'accentColor'?: string; /** * Twitter URL of the company\'s social media page */ 'twitterUrl'?: string; /** * The company\'s primary color used in branding */ 'primaryColor'?: string; /** * Terms and conditions URL of the company */ 'termsAndConditions'?: string; /** * URL to the company\'s Facebook page */ 'facebookUrl'?: string; /** * URL to the company\'s YouTube page */ 'youtubeUrl'?: string; /** * Company\'s branding color */ 'companyColor'?: string; /** * Name of the company */ 'name'?: string; /** * Path to the company\'s logo image */ 'logo'?: string; /** * URL to the company\'s Instagram page */ 'instagramUrl'?: string; /** * Font color used in company\'s branding */ 'fontColor'?: string; /** * Secondary color used in company\'s branding */ 'secondaryColor'?: string; /** * Boolean flag indicating if the right navigation bar button is enabled */ 'rightNavBarButtonEnabled'?: boolean; /** * Title of the right navigation bar button */ 'rightNavBarButtonTitle'?: string; /** * Link for the right navigation bar button */ 'rightNavBarButtonLink'?: string; /** * CSS scripts added by the company */ 'cssScript'?: string; /** * JavaScript code injected into the head tag of the HTML page */ 'jsHeadScript'?: string; /** * JavaScript code injected into the body tag of the HTML page */ 'jsBodyScript'?: string; /** * Custom domain name used by the company */ 'customDomain'?: string; } export interface SingleCheckbox extends PropertyFormat { } export interface SingleLine extends PropertyFormat { } export interface SingleSelect extends PropertyFormat { } /** * Represents a sortable item, including object, relation, property, and sort direction. */ export interface SortItem { /** * The name of the object to which this pagination item belongs. */ 'object'?: string; /** * The relationship between objects. */ 'relation'?: string; /** * Optional relation direction: outgoing (related→main), incoming (main→related), or omit for undirected. */ 'relationDirection'?: string; /** * The name of the property within the object. */ 'property'?: string; /** * The direction for sorting. Can be ASC (ascending) or DESC (descending). */ 'direction'?: SortItemDirectionEnum; } export declare const SortItemDirectionEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type SortItemDirectionEnum = typeof SortItemDirectionEnum[keyof typeof SortItemDirectionEnum]; export interface SseEmitter { 'timeout'?: number; } export interface Structure extends PropertyFormat { } export interface StyleSetDTO { 'hide'?: boolean; 'customID'?: string; 'customClass'?: string; 'customAnchor'?: string; 'spacing'?: any; 'directionLTR'?: boolean; 'alignContent'?: string; 'alignItems'?: string; 'justifyContent'?: string; 'alignSelf'?: string; 'flexWrap'?: string; 'flexDirection'?: string; 'overflow'?: string; 'transformX'?: any; 'transformY'?: any; 'topMargin'?: any; 'bottomMargin'?: any; 'leftMargin'?: any; 'rightMargin'?: any; 'topPadding'?: any; 'bottomPadding'?: any; 'leftPadding'?: any; 'rightPadding'?: any; 'fullWidthEnabled'?: boolean; 'maxWidth'?: any; 'minWidth'?: any; 'width'?: any; 'flex'?: number; 'minHeight'?: any; 'maxHeight'?: any; 'height'?: any; 'borderRadiusTopLeft'?: any; 'borderRadiusTopRight'?: any; 'borderRadiusBottomLeft'?: any; 'borderRadiusBottomRight'?: any; 'borderWidthTop'?: any; 'borderWidthBottom'?: any; 'borderWidthLeft'?: any; 'borderWidthRight'?: any; 'borderColorTop'?: string; 'borderColorBottom'?: string; 'borderColorLeft'?: string; 'borderColorRight'?: string; 'borderStyleTop'?: string; 'borderStyleBottom'?: string; 'borderStyleLeft'?: string; 'borderStyleRight'?: string; 'backgroundVideo'?: string; 'backgroundImage'?: string; 'backgroundMediaRepeat'?: string; 'backgroundMediaFit'?: string; 'backgroundMediaSizeWidth'?: any; 'backgroundMediaSizeHeight'?: any; 'backgroundMediaPosition'?: string; 'backgroundMediaScroll'?: string; 'backgroundMediaParallax'?: boolean; 'backgroundMediaAutoPlay'?: boolean; 'backgroundMediaMuted'?: boolean; 'backgroundMediaLoop'?: boolean; 'backgroundColorOverlayColor'?: string; 'backgroundColorOverlayOpacity'?: number; 'backgroundGradientOverlayColors'?: Array; 'backgroundGradientOverlayOpacity'?: number; 'backgroundGradientOverlayDirection'?: string; 'backgroundColor'?: string; 'backgroundColorOffsetBottom'?: any; 'backgroundColorOffsetLeft'?: any; 'backgroundColorOffsetRight'?: any; 'backgroundColorOffsetTop'?: any; 'backgroundGradientColors'?: Array; 'backgroundGradientOpacity'?: number; 'backgroundGradientDirection'?: string; 'animationDelay'?: number; 'animationDuration'?: number; 'animationIn'?: string; 'animationOut'?: string; 'animationRepeat'?: string; 'animationDirection'?: string; 'animationTimingFunction'?: string; 'animationFillMode'?: string; 'mediaHover'?: string; 'mediaAlignment'?: string; 'mediaFit'?: string; 'mediaPosition'?: string; 'enlargeOnClickBorderRadiusTopLeft'?: any; 'enlargeOnClickBorderRadiusTopRight'?: any; 'enlargeOnClickBorderRadiusBottomLeft'?: any; 'enlargeOnClickBorderRadiusBottomRight'?: any; 'enlargeOnClickBorderWidthTop'?: any; 'enlargeOnClickBorderWidthBottom'?: any; 'enlargeOnClickBorderWidthLeft'?: any; 'enlargeOnClickBorderWidthRight'?: any; 'enlargeOnClickBorderColorTop'?: string; 'enlargeOnClickBorderColorBottom'?: string; 'enlargeOnClickBorderColorLeft'?: string; 'enlargeOnClickBorderColorRight'?: string; 'enlargeOnClickBorderStyleTop'?: string; 'enlargeOnClickBorderStyleBottom'?: string; 'enlargeOnClickBorderStyleLeft'?: string; 'enlargeOnClickBorderStyleRight'?: string; 'enlargeOnClickShadowOffsetX'?: any; 'enlargeOnClickShadowOffsetY'?: any; 'enlargeOnClickShadowBlur'?: any; 'enlargeOnClickShadowColor'?: string; 'enlargeOnClickShadowSpread'?: any; 'enlargeOnClickShadowInset'?: boolean; 'enlargeOnClickShadowOpacity'?: number; 'enlargeOnClickScale'?: number; 'shadowOffsetX'?: any; 'shadowOffsetY'?: any; 'shadowBlur'?: any; 'shadowBorderRadiusTopLeft'?: any; 'shadowBorderRadiusTopRight'?: any; 'shadowBorderRadiusBottomLeft'?: any; 'shadowBorderRadiusBottomRight'?: any; 'shadowColor'?: string; 'shadowSpread'?: any; 'shadowInset'?: boolean; 'shadowOpacity'?: number; 'textGradientOverlayColors'?: Array; 'textGradientOverlayOpacity'?: number; 'textGradientOverlayDirection'?: string; 'darkTextEnabled'?: boolean; 'textAlign'?: string; 'transitionScrollSpeed'?: number; 'autoRotate'?: boolean; 'autoRotateInterval'?: number; 'buttonIcon'?: string; 'buttonIconPosition'?: string; 'buttonIconColor'?: string; 'openInNewWindow'?: boolean; 'sidebar'?: boolean; 'sidebarPosition'?: string; 'sidebarAnimation'?: string; 'sidebarAnimationDuration'?: number; 'sidebarAnimationTimingFunction'?: string; 'fontFamily'?: string; 'fontSize'?: any; 'fontWeight'?: string; 'fontDecoration'?: string; 'fontTextTransform'?: string; 'fontLineHeight'?: any; 'fontLetterSpacing'?: any; 'fontColorLight'?: string; 'fontColorDark'?: string; 'xxLargeFontSize'?: any; 'largeFontSize'?: any; 'mediumFontSize'?: any; 'smallFontSize'?: any; 'h1FontFamily'?: string; 'h1FontSize'?: any; 'h1FontWeight'?: string; 'h1FontDecoration'?: string; 'h1TextTransform'?: string; 'h1LineHeight'?: any; 'h1LetterSpacing'?: any; 'h1ColorLight'?: string; 'h1ColorDark'?: string; 'h2FontFamily'?: string; 'h2FontSize'?: any; 'h2FontWeight'?: string; 'h2FontDecoration'?: string; 'h2TextTransform'?: string; 'h2LineHeight'?: any; 'h2LetterSpacing'?: any; 'h2ColorLight'?: string; 'h2ColorDark'?: string; 'h3FontFamily'?: string; 'h3FontSize'?: any; 'h3FontWeight'?: string; 'h3FontDecoration'?: string; 'h3TextTransform'?: string; 'h3LineHeight'?: any; 'h3LetterSpacing'?: any; 'h3ColorLight'?: string; 'h3ColorDark'?: string; 'h4FontFamily'?: string; 'h4FontSize'?: any; 'h4FontWeight'?: string; 'h4FontDecoration'?: string; 'h4TextTransform'?: string; 'h4LineHeight'?: any; 'h4LetterSpacing'?: any; 'h4ColorLight'?: string; 'h4ColorDark'?: string; 'h5FontFamily'?: string; 'h5FontSize'?: any; 'h5FontWeight'?: string; 'h5FontDecoration'?: string; 'h5TextTransform'?: string; 'h5LineHeight'?: any; 'h5LetterSpacing'?: any; 'h5ColorLight'?: string; 'h5ColorDark'?: string; 'h6FontFamily'?: string; 'h6FontSize'?: any; 'h6FontWeight'?: string; 'h6FontDecoration'?: string; 'h6TextTransform'?: string; 'h6LineHeight'?: any; 'h6LetterSpacing'?: any; 'h6ColorLight'?: string; 'h6ColorDark'?: string; 'navigationFontFamily'?: string; 'navigationFontSize'?: any; 'navigationFontWeight'?: string; 'navigationFontDecoration'?: string; 'navigationTextTransform'?: string; 'navigationLineHeight'?: any; 'navigationLetterSpacing'?: any; 'navigationColorLight'?: string; 'navigationColorDark'?: string; 'subNavigationFontFamily'?: string; 'subNavigationFontSize'?: any; 'subNavigationFontWeight'?: string; 'subNavigationFontDecoration'?: string; 'subNavigationTextTransform'?: string; 'subNavigationLineHeight'?: any; 'subNavigationLetterSpacing'?: any; 'subNavigationColorLight'?: string; 'subNavigationColorDark'?: string; 'bodyFontFamily'?: string; 'bodyFontSize'?: any; 'bodyFontWeight'?: string; 'bodyFontDecoration'?: string; 'bodyTextTransform'?: string; 'bodyLineHeight'?: any; 'bodyLetterSpacing'?: any; 'bodyColorLight'?: string; 'bodyColorDark'?: string; 'hyperlinkFontFamily'?: string; 'hyperlinkFontSize'?: any; 'hyperlinkFontWeight'?: string; 'hyperlinkFontDecoration'?: string; 'hyperlinkTextTransform'?: string; 'hyperlinkLineHeight'?: any; 'hyperlinkLetterSpacing'?: any; 'hyperlinkColorLight'?: string; 'hyperlinkColorDark'?: string; 'zindex'?: number; 'xLargeFontSize'?: any; 'xSmallFontSize'?: any; } /** * Data Transfer Object for subscribing to a webhook. This DTO represents the details required to configure a webhook subscription. */ export interface SubscribeWebhookDTO { /** * The URL of the webhook where requests will be sent. */ 'url'?: string; /** * UUID of the serverless function to invoke when the webhook is triggered (must belong to the same app). */ 'serverlessFunction'?: ServerlessFunctionDTO; /** * Delivery mode for this webhook: HTTP (use url) or SERVERLESS (use serverlessFunctionUuid). If omitted, legacy behavior applies based on presence of url/serverlessFunctionUuid. */ 'deliveryMode'?: string; /** * When true, install or settings save waits for this lifecycle hook to finish and returns the settings it wrote. */ 'waitUntilComplete'?: boolean; /** * The secret used for webhook validation. */ 'secret'?: string; /** * The topic for which the webhook is subscribed. */ 'topic'?: string; /** * Optional human-readable description for this webhook */ 'description'?: string; /** * Webhook payload format (LEGACY, USER_FRIENDLY) */ 'webhookFormat'?: string; /** * Whether to parse the record before returning it */ 'parseRecord'?: boolean; /** * Filter criteria for webhook triggers */ 'filter'?: Filter; /** * Records to include in webhook payload */ 'includeRelations'?: Array; /** * Filter criteria for relations */ 'relationFilters'?: { [key: string]: Filter; }; /** * Maximum number of relations to include */ 'relationLimit'?: number; /** * Whether retry is enabled for failed deliveries (defaults to true if omitted) */ 'retryEnabled'?: boolean; /** * Maximum number of retries */ 'maxRetries'?: number; /** * Retry backoff in milliseconds */ 'retryBackoffMs'?: number; /** * Offset from the target date in seconds (required for date_due webhooks) */ 'triggerOffsetSeconds'?: number; /** * Whether the webhook fires BEFORE or AFTER the target date */ 'scheduleDirection'?: string; /** * Recurrence for date_due webhooks: NONE, DAILY, WEEKLY, MONTHLY, QUARTERLY, HALF_YEARLY, YEARLY, or CRON */ 'scheduleRecurring'?: string; /** * Spring cron expression used when scheduleRecurring is CRON */ 'scheduleCronExpression'?: string; /** * Internal schedule version incremented when schedule config changes */ 'scheduleVersion'?: number; /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; } /** * Success response (SuccessResponseAggregateResponse). */ export interface SuccessResponseAggregateResponse { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseCalendarBootstrapDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: CalendarBootstrapDTO; } /** * Success response (SuccessResponseCollectionRelation). */ export interface SuccessResponseCollectionRelation { 'message'?: string; 'data'?: Array; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseCompanyDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: CompanyDTO; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseFeedDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: FeedDTO; } /** * Success response (SuccessResponseFlow). */ export interface SuccessResponseFlow { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (SuccessResponseListAggregateResponse). */ export interface SuccessResponseListAggregateResponse { 'message'?: string; 'data'?: Array; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseListAppExternalOAuthProviderDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseListAppInboundRouteDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseListAppScheduleDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseListCalendarRecordDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseListCalendarTeamOptionDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Success response (SuccessResponseListCaraerObjectDTO). */ export interface SuccessResponseListCaraerObjectDTO { 'message'?: string; 'data'?: Array; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseListDeveloperSandboxDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseListFileListItemDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseListMapStringObject { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array<{ [key: string]: any | null; }>; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseListProjectBuildDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseListProjectDeployDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Success response (SuccessResponseListPropertyDTO). */ export interface SuccessResponseListPropertyDTO { 'message'?: string; 'data'?: Array; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseListString { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: Array; } /** * Success response (SuccessResponseMapStringInteger). */ export interface SuccessResponseMapStringInteger { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (SuccessResponseMapStringObject). */ export interface SuccessResponseMapStringObject { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (SuccessResponseObject). */ export interface SuccessResponseObject { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseString { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: string; } /** * Success response (SuccessResponseSuggestAnalyticsWidgetsResponse). */ export interface SuccessResponseSuggestAnalyticsWidgetsResponse { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Success response (SuccessResponseTable). */ export interface SuccessResponseTable { 'message'?: string; 'data'?: { [key: string]: any; }; } /** * Represents a standard successful response with a message and optional data. */ export interface SuccessResponseVoid { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: any; } export interface SuggestAnalyticsWidgetsRequest { 'objectName'?: string; 'goal'?: string; 'existingWidgets'?: Array; } export interface SyncDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; 'mappings'?: Array; } export interface Tag extends PropertyFormat { } export interface Team { 'name': string; 'label'?: string; 'createdAt'?: number; 'updatedAt'?: number; 'deletedAt'?: number; 'createdByUuid'?: string; 'updatedByUuid'?: string; 'deletedByUuid'?: string; 'index'?: number; 'description'?: string; 'scopes'?: Array; 'filtersString'?: string; 'filters'?: { [key: string]: Filter; }; 'memberCount'?: number; 'complete'?: boolean; 'deleted'?: boolean; 'uuid': string; } export interface TeamDTO { 'description'?: string; 'memberCount'?: number; 'scopes'?: Array; 'members'?: Array; 'filters'?: { [key: string]: Filter; }; /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; } /** * DTO for Template Webpage */ export interface TemplateWebpageDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * The environment of the webpage. */ 'environment'?: string; /** * The title of the webpage. */ 'title'?: string; /** * Short summary or excerpt displayed for the webpage. */ 'excerpt'?: string; /** * URL-friendly identifier for the webpage. */ 'slug'?: string; /** * URL or identifier of the image associated with the webpage. */ 'image'?: string; /** * Custom CSS for the webpage. */ 'customCss'?: string; /** * Custom JS for the webpage. */ 'customJsHead'?: string; /** * Custom JS for the webpage. */ 'customJsBody'?: string; /** * Content of the webpage */ 'content'?: PageContentDTO; /** * Preview of the sidebar */ 'sidebar'?: PreviewDTO; /** * Relation of the sidebar */ 'sidebarRelation'?: RelationDTO; /** * Object of the sidebar */ 'sidebarObject'?: CaraerObjectDTO; /** * UUID of the CMS module rendered as a floating action bar on this page. Null or empty disables the bar. */ 'floatingActionBarModuleUuid'?: string; /** * Custom options and configurations specific to the webpage. */ 'options'?: WebpageOptionsDTO; /** * Map of additional metadata and attributes for the webpage. */ 'metaData'?: { [key: string]: any | null; }; /** * Represents the associated Caraer object */ 'object'?: CaraerObjectDTO; } /** * Request body for testing a serverless function with a specific record and event type. */ export interface TestServerlessFunctionRequest { /** * UUID of the record to base the event on. */ 'recordUuid'?: string; /** * Event type to simulate (created, updated, deleted, etc.). */ 'eventType'?: string; /** * If true, forces re-provisioning of the serverless function before invocation. */ 'forceProvision'?: boolean; } /** * Webhook configuration and test parameters */ export interface TestWebhookRequest { /** * Webhook configuration to test (not saved). */ 'webhook': SubscribeWebhookDTO; /** * UUID of the record to base the event on. Omit to auto-resolve from webhook topic. */ 'recordUuid'?: string; /** * Event type to simulate (created, updated, deleted, etc.). */ 'eventType'?: string; /** * Property name when simulating property_changed. */ 'propertyName'?: string; } export interface TrackingEventRequest { 'visitorId'?: string; 'sessionId'?: string; 'type'?: string; 'ts'?: number; 'pageUrl'?: string; 'pageTitle'?: string; 'webpageUuid'?: string; 'recordUuid'?: string; 'formUuid'?: string; 'formName'?: string; 'utm'?: { [key: string]: string; }; 'referrer'?: string; 'scrollPct'?: number; 'timeOnPage'?: number; 'activeTime'?: number; 'ctaId'?: string; 'ctaLabel'?: string; 'stepIndex'?: number; 'stepTitle'?: string; 'progressPct'?: number; 'completedFieldsCount'?: number; 'consentChoice'?: string; 'requestedRoute'?: string; 'userAgent'?: string; 'clientIp'?: string; 'country'?: string; 'region'?: string; } export interface TrackingSessionUpsertRequest { 'visitorId'?: string; 'sessionId'?: string; } export interface Tuple2LongLong { 't1'?: number; 't2'?: number; } /** * Request body for enabling lifecycle tracking on object properties */ export interface UpdateLifecyclePropertiesDTO { /** * UUIDs of properties to track in lifecycle history */ 'propertyUuids'?: Array; } /** * Represents the response returned after a successful update operation. */ export interface UpdateResponse { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: any; } /** * Represents the response returned after a successful update operation. */ export interface UpdateResponseFeedDTO { /** * A message detailing the result of the operation. */ 'message'?: string; /** * The data payload of the response, if any. */ 'data'?: FeedDTO; } export interface Url extends PropertyFormat { } export interface UsedInResult { 'recordUuids'?: Array; 'count'?: number; } /** * Record response for user API endpoints, including linked user data. */ export interface UserRecordResponseDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * Whether the record is soft-deleted. */ 'deleted'?: boolean; /** * Record properties for display. */ 'properties'?: Array; /** * Primary and extended object metadata for this record. */ 'objects'?: { [key: string]: any | null; }; /** * The user linked to this record when the user trait is enabled. */ 'user'?: PublicUserDTO; } /** * User with cursor location */ export interface UserWithCursorLocationDTO { 'uuid'?: string; 'email'?: string; 'firstname'?: string; 'lastname'?: string; 'cursorLocation'?: CursorLocation; 'reference'?: string; 'sessionId'?: string; } export interface ValidationError { 'cause'?: NotFoundErrorCause; 'stackTrace'?: Array; 'suppressed'?: Array; 'localizedMessage'?: string; /** * The type of error. */ 'type': ValidationErrorTypeEnum; 'field'?: string; /** * The error message providing details about the failure. */ 'message': string; /** * A suggestion on how to correct the error. */ 'correctionSuggestion': string; 'class'?: string; } export declare const ValidationErrorTypeEnum: { readonly Validation: "VALIDATION"; readonly NotFound: "NOT_FOUND"; readonly Test: "TEST"; readonly RelationNotAllowed: "RELATION_NOT_ALLOWED"; readonly InvalidValue: "INVALID_VALUE"; readonly General: "GENERAL"; readonly InvalidFileType: "INVALID_FILE_TYPE"; readonly InternalServerError: "INTERNAL_SERVER_ERROR"; readonly CaraerError: "CARAER_ERROR"; readonly InvalidEmail: "INVALID_EMAIL"; readonly InvalidDate: "INVALID_DATE"; }; export type ValidationErrorTypeEnum = typeof ValidationErrorTypeEnum[keyof typeof ValidationErrorTypeEnum]; export interface ViewDTO { /** * Unique identifier for the entity */ 'uuid': string; 'name'?: string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; 'favorite'?: boolean; 'team'?: boolean; 'shared'?: boolean; 'personal'?: boolean; 'trait'?: string; 'filters'?: Filter; 'shows'?: Array; 'sorts'?: Array; 'limit'?: number; 'showIcons'?: boolean; 'rowHeight'?: string; 'query'?: string; 'icon'?: string; 'flowProperty'?: string; 'flowPreview'?: string; 'taskProgressProperty'?: string; 'taskGroupProperty'?: string; 'taskExpandSubtasks'?: boolean; 'taskCollapsedGroupKeys'?: Array; 'taskExpandedTaskUuids'?: Array; 'calendarOverlay'?: string; 'visibleCalendarUuids'?: Array; 'selectedCalendarUuid'?: string; 'calendarColorBy'?: string; 'defaultView'?: boolean; 'isInternallyPublic'?: boolean; 'analytics'?: AnalyticsDashboardConfig; } export interface ViewShareRequest { 'users'?: Array; 'teams'?: Array; 'isInternallyPublic'?: boolean; } /** * Data transfer object representing the structure of a web menu */ export interface WebMenuDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; /** * The title of the web menu */ 'title'?: string; /** * Indicates whether the web menu is active */ 'active'?: boolean; /** * The environments of the web menu */ 'environments'?: Array; /** * The location of the web menu in the UI, e.g., \'footer_block_1\' or \'header\' */ 'location'?: string; 'urls'?: Array<{ [key: string]: string; }>; 'items'?: Array; /** * The text of the web menu */ 'text'?: string; } export interface WebMenuItem { 'label'?: string; 'url'?: string; 'icon'?: string; 'image'?: string; } /** * Signed URL access grant for a protected webpage */ export interface WebpageAccessGrantDTO { /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; 'recordUuid'?: string; 'expiresAt'?: number; 'revokedAt'?: number; 'active'?: boolean; 'tokenHash'?: string; 'token'?: string; } /** * Data transfer object representing a webpage with its various states, properties, and associated form/versions */ export interface WebpageDTO { /** * The environment of the webpage. */ 'environment'?: string; /** * The UUID of the webpage. */ 'uuid'?: string; /** * The title of the webpage. */ 'title'?: string; /** * Short summary or excerpt displayed for the webpage. */ 'excerpt'?: string; /** * URL-friendly identifier for the webpage. */ 'slug'?: string; /** * URL or identifier of the image associated with the webpage. */ 'image'?: string; /** * Custom CSS for the webpage. */ 'customCss'?: string; /** * Custom JS for the webpage. */ 'customJsHead'?: string; /** * Custom JS for the webpage. */ 'customJsBody'?: string; /** * Content of the webpage */ 'content'?: PageContentDTO; /** * Preview of the sidebar */ 'sidebar'?: PreviewDTO; /** * Relation of the sidebar */ 'sidebarRelation'?: RelationDTO; /** * Object of the sidebar */ 'sidebarObject'?: CaraerObjectDTO; /** * UUID of the CMS module rendered as a floating action bar on this page. Null or empty disables the bar. */ 'floatingActionBarModuleUuid'?: string; /** * Hydrated module tree for the floating action bar. Set only on public page responses. */ 'floatingActionBar'?: PageContentDTO; /** * The Object object associated with the webpage, representing application data. */ 'object'?: CaraerObjectDTO; /** * Webpage-public backing record values (internal + parsed). Set only on public page responses. */ 'record'?: WebpagePublicRecordDTO; /** * Custom options and configurations specific to the webpage. */ 'options'?: WebpageOptionsDTO; /** * Map of additional metadata and attributes for the webpage. */ 'metaData'?: { [key: string]: any | null; }; /** * Identifier of the user or process that published the webpage */ 'publishedBy'?: string; /** * Timestamp representing when the webpage was published */ 'publishedAt'?: number; /** * Identifier of the user or process that unpublished the webpage */ 'unpublishedBy'?: string; /** * Timestamp representing when the webpage was unpublished */ 'unpublishedAt'?: number; /** * Scheduled timestamp for when the webpage will be published */ 'publishAt'?: number; /** * Scheduled timestamp for when the webpage will be unpublished */ 'unpublishAt'?: number; /** * Flag indicating whether the webpage is currently published */ 'isPublished'?: boolean; /** * Fully qualified public URL of the webpage, including the page trait root slug. */ 'liveUrl'?: string; } /** * Whether a webpage is currently being edited by another user */ export interface WebpageEditingStatusDTO { /** * True when another user is actively editing this webpage */ 'locked'?: boolean; /** * The user currently editing, when locked is true */ 'editor'?: UserWithCursorLocationDTO; /** * Human-readable message for the client UI */ 'message'?: string; } /** * Resolved public map markers for a webpage map block */ export interface WebpageMapLocationsDTO { /** * Concrete markers after applying public filters */ 'mapLocations'?: Array; } /** * Data Transfer Object representing options for a webpage. */ export interface WebpageOptionsDTO { /** * Indicates if the webpage is related to a template. */ 'relatedToTemplate'?: boolean; /** * Page-level protection override: inherit, none, password, signedUrl, caraerAuth */ 'protectionOverride'?: string; /** * Bcrypt hash for per-page password (never returned in public APIs) */ 'passwordHash'?: string; /** * Recoverable per-page password value for CMS display only */ 'password'?: string; /** * Stored recoverable per-page password value for CMS display only */ 'passwordValue'?: string; /** * Whether the per-page password value should be resolved as smart content */ 'passwordSmartContent'?: boolean; /** * Whether a per-page password is configured */ 'hasPassword'?: boolean; /** * Recoverable inherited shared password value for CMS display only */ 'inheritedPassword'?: string; /** * Stored recoverable inherited shared password value for CMS display only */ 'inheritedPasswordValue'?: string; /** * Whether the inherited shared password value should be resolved as smart content */ 'inheritedPasswordSmartContent'?: boolean; /** * Whether an inherited shared password is configured */ 'inheritedHasPassword'?: boolean; } /** * Public protection metadata for a webpage (no content) */ export interface WebpageProtectionInfoDTO { 'protectionRequired'?: boolean; 'type'?: string; 'title'?: string; 'uuid'?: string; } /** * Webpage-public record values with internal and parsed property maps */ export interface WebpagePublicRecordDTO { /** * UUID of the webpage backing record */ 'uuid'?: string; /** * Internal/plain property values keyed by property name */ 'properties'?: { [key: string]: any | null; }; /** * Parsed/display property values keyed by property name */ 'parsedProperties'?: { [key: string]: any | null; }; } export interface WebpageUnlockRequest { 'password'?: string; } /** * The website settings of the company. */ export interface WebsiteSettingsDTO { 'subdomain'?: string; 'customDomain'?: string; 'recordType'?: string; 'recordValue'?: string; 'favicon'?: string; 'logo'?: string; 'logoDark'?: string; 'logoLight'?: string; 'logoUrl'?: string; 'logoWidth'?: number; 'logoHeight'?: number; 'headerLayout'?: string; 'headerminHeight'?: number; 'headerMaxHeight'?: number; 'headerMinWidth'?: number; 'headerMaxWidth'?: number; 'headerMarginTop'?: number; 'headerMarginBottom'?: number; 'headerMarginLeft'?: number; 'headerMarginRight'?: number; 'headerTop'?: number; 'headerBottom'?: number; 'headerLeft'?: number; 'headerRight'?: number; 'headerPaddingTop'?: number; 'headerPaddingBottom'?: number; 'headerPaddingLeft'?: number; 'headerPaddingRight'?: number; 'headerBorderRadiusTopLeft'?: number; 'headerBorderRadiusTopRight'?: number; 'headerBorderRadiusBottomLeft'?: number; 'headerBorderRadiusBottomRight'?: number; 'headerBorderWidthTop'?: number; 'headerBorderWidthBottom'?: number; 'headerBorderWidthLeft'?: number; 'headerBorderWidthRight'?: number; 'headerBorderColorTop'?: string; 'headerBorderColorBottom'?: string; 'headerBorderColorLeft'?: string; 'headerBorderColorRight'?: string; 'headerBorderStyleTop'?: string; 'headerBorderStyleBottom'?: string; 'headerBorderStyleLeft'?: string; 'headerBorderStyleRight'?: string; 'headerBehavior'?: string; 'headerBehaviorOnMobile'?: string; 'headerItemSpacing'?: number; 'defaultLightHeader'?: boolean; 'headerRevealOffset'?: number; 'headerRevealSpeed'?: number; 'mobileMenuAlwaysVisible'?: boolean; 'mobileMenuDisplay'?: string; 'mobileMenuText'?: string; 'mobileMenuNextToHeader'?: boolean; 'mobileMenuBehaviour'?: string; 'mobileMenuBehaviourOnMobile'?: string; 'headerBackgroundColor'?: string; 'headerForegroundColor'?: string; 'headerItemHoverBackgroundColor'?: string; 'headerItemHoverForegroundColor'?: string; 'headerBlur'?: boolean; 'headerBlurAmount'?: number; 'headerOpacity'?: number; 'headerShadow'?: boolean; 'headerButtonStyle'?: string; 'headerButtonText'?: string; 'headerButtonTextColor'?: string; 'headerButtonLink'?: string; 'headerButtonIcon'?: string; 'headerButtonIconPosition'?: string; 'headerButtonIconColor'?: string; 'headerSecondaryButtonStyle'?: string; 'headerSecondaryButtonText'?: string; 'headerSecondaryButtonTextColor'?: string; 'headerSecondaryButtonLink'?: string; 'headerSecondaryButtonIcon'?: string; 'headerSecondaryButtonIconPosition'?: string; 'headerSecondaryButtonIconColor'?: string; 'headerTertiaryButtonStyle'?: string; 'headerTertiaryButtonText'?: string; 'headerTertiaryButtonTextColor'?: string; 'headerTertiaryButtonLink'?: string; 'headerTertiaryButtonIcon'?: string; 'headerTertiaryButtonIconPosition'?: string; 'headerTertiaryButtonIconColor'?: string; 'cookieText'?: string; 'cookieAgreementText'?: string; 'cookieBannerEnabled'?: boolean; 'cookieBannerModuleUuid'?: string; 'cssStyles'?: string; 'headJsScript'?: string; 'bodyJsScript'?: string; 'trackingBodyJsScript'?: string; 'footerImage'?: string; 'footerImagePosition'?: string; 'footerImageSize'?: string; 'footerImageRepeat'?: string; 'footerImageOpacity'?: number; 'footerImageWidth'?: number; 'footerImageHeight'?: number; 'footerCopyrightText'?: string; 'footerCompanyName'?: string; 'footerCompanyLink'?: string; 'footerCompanyText'?: string; 'customFooterEnabled'?: boolean; 'customFooterModuleUuid'?: string; 'cmsHeaderModule'?: string; 'cmsFooterModule'?: string; 'cmsCookieBannerModule'?: string; 'cmsModuleDefaults'?: string; 'footerBackgroundColor'?: string; 'footerForegroundColor'?: string; 'footerShowSocialButtons'?: boolean; 'footerShowTermsAndConditions'?: boolean; 'footerShowPrivacyPolicy'?: boolean; 'custom404WebpageUuid'?: string; 'backToTopButton'?: boolean; 'backToTopButtonPosition'?: string; 'backToTopButtonIcon'?: string; 'backToTopButtonIconPosition'?: string; 'backToTopButtonText'?: string; 'backToTopButtonColor'?: string; 'backToTopButtonBackgroundColor'?: string; 'backToTopButtonBorderColor'?: string; 'backToTopButtonOnMobile'?: boolean; 'animatedAnchorLinks'?: boolean; 'maxWebsiteContainerWidth'?: number; 'disableAnimationsOnMobile'?: boolean; 'customFonts'?: Array; 'mainStyling'?: PageContentStylingDTO; 'mainElementStyling'?: PageContentStylingDTO; 'rowStyling'?: PageContentStylingDTO; 'columnStyling'?: PageContentStylingDTO; 'sectionStyling'?: PageContentStylingDTO; 'textStyling'?: PageContentStylingDTO; 'primaryButtonStyling'?: PageContentStylingDTO; 'secondaryButtonStyling'?: PageContentStylingDTO; 'tertiaryButtonStyling'?: PageContentStylingDTO; 'imageStyling'?: PageContentStylingDTO; 'videoStyling'?: PageContentStylingDTO; 'mapStyling'?: PageContentStylingDTO; 'formStyling'?: PageContentStylingDTO; 'sliderStyling'?: PageContentStylingDTO; 'accordionStyling'?: PageContentStylingDTO; 'previewStyling'?: PageContentStylingDTO; 'iconStyling'?: PageContentStylingDTO; 'codeStyling'?: PageContentStylingDTO; 'shareStyling'?: PageContentStylingDTO; /** * Unique identifier for the entity */ 'uuid': string; /** * The name of the entity */ 'name': string; /** * Display label for the entity, can be different from name */ 'label'?: string; /** * Unix timestamp when the entity was created */ 'createdAt'?: number; /** * Identifier of the user who created the entity */ 'createdBy'?: ModelRecord; /** * Unix timestamp when the entity was last updated */ 'updatedAt'?: number; /** * Identifier of the user who last updated the entity */ 'updatedBy'?: ModelRecord; /** * Unix timestamp when the entity was deleted (null if not deleted) */ 'deletedAt'?: number; /** * Identifier of the user who deleted the entity */ 'deletedBy'?: ModelRecord; /** * Index number for ordering entities */ 'index'?: number; } /** * AppBarIframeSessionsApi - axios parameter creator */ export declare const AppBarIframeSessionsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Issues a short-lived opaque token for an iframe-based app bar. The token can be validated by the embedded app to confirm user, company, view, and filter context. * @summary Create an iframe session token * @param {string} appBarUuid UUID of the iframe app bar * @param {AppBarIframeSessionRequest} [appBarIframeSessionRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIframeSession: (appBarUuid: string, appBarIframeSessionRequest?: AppBarIframeSessionRequest, options?: RawAxiosRequestConfig) => Promise; /** * Public endpoint for embedded apps to validate a caraer_iframe_token and receive safe context. * @summary Validate an iframe session token * @param {AppBarIframeSessionValidateRequest} appBarIframeSessionValidateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateIframeSession: (appBarIframeSessionValidateRequest: AppBarIframeSessionValidateRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * AppBarIframeSessionsApi - functional programming interface */ export declare const AppBarIframeSessionsApiFp: (configuration?: Configuration) => { /** * Issues a short-lived opaque token for an iframe-based app bar. The token can be validated by the embedded app to confirm user, company, view, and filter context. * @summary Create an iframe session token * @param {string} appBarUuid UUID of the iframe app bar * @param {AppBarIframeSessionRequest} [appBarIframeSessionRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIframeSession(appBarUuid: string, appBarIframeSessionRequest?: AppBarIframeSessionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Public endpoint for embedded apps to validate a caraer_iframe_token and receive safe context. * @summary Validate an iframe session token * @param {AppBarIframeSessionValidateRequest} appBarIframeSessionValidateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateIframeSession(appBarIframeSessionValidateRequest: AppBarIframeSessionValidateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AppBarIframeSessionsApi - factory interface */ export declare const AppBarIframeSessionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Issues a short-lived opaque token for an iframe-based app bar. The token can be validated by the embedded app to confirm user, company, view, and filter context. * @summary Create an iframe session token * @param {string} appBarUuid UUID of the iframe app bar * @param {AppBarIframeSessionRequest} [appBarIframeSessionRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIframeSession(appBarUuid: string, appBarIframeSessionRequest?: AppBarIframeSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Public endpoint for embedded apps to validate a caraer_iframe_token and receive safe context. * @summary Validate an iframe session token * @param {AppBarIframeSessionValidateRequest} appBarIframeSessionValidateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateIframeSession(appBarIframeSessionValidateRequest: AppBarIframeSessionValidateRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * AppBarIframeSessionsApi - object-oriented interface */ export declare class AppBarIframeSessionsApi extends BaseAPI { /** * Issues a short-lived opaque token for an iframe-based app bar. The token can be validated by the embedded app to confirm user, company, view, and filter context. * @summary Create an iframe session token * @param {string} appBarUuid UUID of the iframe app bar * @param {AppBarIframeSessionRequest} [appBarIframeSessionRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIframeSession(appBarUuid: string, appBarIframeSessionRequest?: AppBarIframeSessionRequest, options?: RawAxiosRequestConfig): Promise>; /** * Public endpoint for embedded apps to validate a caraer_iframe_token and receive safe context. * @summary Validate an iframe session token * @param {AppBarIframeSessionValidateRequest} appBarIframeSessionValidateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateIframeSession(appBarIframeSessionValidateRequest: AppBarIframeSessionValidateRequest, options?: RawAxiosRequestConfig): Promise>; } /** * AppBarsApi - axios parameter creator */ export declare const AppBarsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns all app bars from installed apps for the authenticated user\'s company at the given location. * @summary List installed app bars for a location * @param {ListAppBarsLocationEnum} location App bar location * @param {string} [object] Object name in context * @param {string} [recordUuid] Record UUID in context * @param {string} [viewId] View ID in context * @param {string} [trait] Trait name in context * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAppBars: (location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options?: RawAxiosRequestConfig) => Promise; /** * Fires the app bar webhook with optional settings values and record/view context. * @summary Trigger an action-based app bar * @param {string} appBarUuid UUID of the app bar to trigger * @param {AppBarTriggerRequest} [appBarTriggerRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ triggerAppBar: (appBarUuid: string, appBarTriggerRequest?: AppBarTriggerRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * AppBarsApi - functional programming interface */ export declare const AppBarsApiFp: (configuration?: Configuration) => { /** * Returns all app bars from installed apps for the authenticated user\'s company at the given location. * @summary List installed app bars for a location * @param {ListAppBarsLocationEnum} location App bar location * @param {string} [object] Object name in context * @param {string} [recordUuid] Record UUID in context * @param {string} [viewId] View ID in context * @param {string} [trait] Trait name in context * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fires the app bar webhook with optional settings values and record/view context. * @summary Trigger an action-based app bar * @param {string} appBarUuid UUID of the app bar to trigger * @param {AppBarTriggerRequest} [appBarTriggerRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ triggerAppBar(appBarUuid: string, appBarTriggerRequest?: AppBarTriggerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AppBarsApi - factory interface */ export declare const AppBarsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns all app bars from installed apps for the authenticated user\'s company at the given location. * @summary List installed app bars for a location * @param {ListAppBarsLocationEnum} location App bar location * @param {string} [object] Object name in context * @param {string} [recordUuid] Record UUID in context * @param {string} [viewId] View ID in context * @param {string} [trait] Trait name in context * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fires the app bar webhook with optional settings values and record/view context. * @summary Trigger an action-based app bar * @param {string} appBarUuid UUID of the app bar to trigger * @param {AppBarTriggerRequest} [appBarTriggerRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ triggerAppBar(appBarUuid: string, appBarTriggerRequest?: AppBarTriggerRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * AppBarsApi - object-oriented interface */ export declare class AppBarsApi extends BaseAPI { /** * Returns all app bars from installed apps for the authenticated user\'s company at the given location. * @summary List installed app bars for a location * @param {ListAppBarsLocationEnum} location App bar location * @param {string} [object] Object name in context * @param {string} [recordUuid] Record UUID in context * @param {string} [viewId] View ID in context * @param {string} [trait] Trait name in context * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options?: RawAxiosRequestConfig): Promise>; /** * Fires the app bar webhook with optional settings values and record/view context. * @summary Trigger an action-based app bar * @param {string} appBarUuid UUID of the app bar to trigger * @param {AppBarTriggerRequest} [appBarTriggerRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ triggerAppBar(appBarUuid: string, appBarTriggerRequest?: AppBarTriggerRequest, options?: RawAxiosRequestConfig): Promise>; } export declare const ListAppBarsLocationEnum: { readonly RecordPreview: "RECORD_PREVIEW"; readonly RecordOverview: "RECORD_OVERVIEW"; readonly RecordDetail: "RECORD_DETAIL"; readonly ToolBar: "TOOL_BAR"; readonly TraitBar: "TRAIT_BAR"; readonly RecordTrait: "RECORD_TRAIT"; }; export type ListAppBarsLocationEnum = typeof ListAppBarsLocationEnum[keyof typeof ListAppBarsLocationEnum]; /** * AppInstallationRuntimeApi - axios parameter creator */ export declare const AppInstallationRuntimeApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Delete an encrypted secret * @param {string} appUuid * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSecret: (appUuid: string, name: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Delete a state key * @param {string} appUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteStateKey: (appUuid: string, key: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Enqueue an async serverless function job * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ enqueueJob: (appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get async job status * @param {string} appUuid * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getJob: (appUuid: string, jobId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get installation state map * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getState: (appUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get a single state key * @param {string} appUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStateKey: (appUuid: string, key: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary List external OAuth connection status * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConnections: (appUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary List secret names (no values) * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSecrets: (appUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Merge COMPANY-scoped installation settings from the app runtime * @param {string} appUuid * @param {Array} appSettingFieldSchema * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeCompanySettings: (appUuid: string, appSettingFieldSchema: Array, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Set an encrypted secret * @param {string} appUuid * @param {string} name * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ putSecret: (appUuid: string, name: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Replace/merge installation state (shallow merge) * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ putState: (appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Put a single state key * @param {string} appUuid * @param {string} key * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ putStateKey: (appUuid: string, key: string, body: object, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Revoke external OAuth connection tokens by connection id or provider name * @param {string} appUuid * @param {string} providerOrConnectionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeConnection: (appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Save USER-scoped installation settings for the current user * @param {string} appUuid * @param {Array} appSettingFieldSchema * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveUserSettings: (appUuid: string, appSettingFieldSchema: Array, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Start external OAuth authorize (returns provider authorize URL) * @param {string} appUuid * @param {string} provider * @param {string} [redirectUri] * @param {*} [options] Override http request option. * @throws {RequiredError} */ startOAuth: (appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Trigger an ACTION setting without saving settings * @param {string} appUuid * @param {string} fieldName * @param {*} [options] Override http request option. * @throws {RequiredError} */ triggerSettingAction: (appUuid: string, fieldName: string, options?: RawAxiosRequestConfig) => Promise; }; /** * AppInstallationRuntimeApi - functional programming interface */ export declare const AppInstallationRuntimeApiFp: (configuration?: Configuration) => { /** * * @summary Delete an encrypted secret * @param {string} appUuid * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSecret(appUuid: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Delete a state key * @param {string} appUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteStateKey(appUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Enqueue an async serverless function job * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ enqueueJob(appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get async job status * @param {string} appUuid * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getJob(appUuid: string, jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get installation state map * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getState(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get a single state key * @param {string} appUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStateKey(appUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List external OAuth connection status * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConnections(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List secret names (no values) * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSecrets(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Merge COMPANY-scoped installation settings from the app runtime * @param {string} appUuid * @param {Array} appSettingFieldSchema * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Set an encrypted secret * @param {string} appUuid * @param {string} name * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ putSecret(appUuid: string, name: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Replace/merge installation state (shallow merge) * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ putState(appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Put a single state key * @param {string} appUuid * @param {string} key * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ putStateKey(appUuid: string, key: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Revoke external OAuth connection tokens by connection id or provider name * @param {string} appUuid * @param {string} providerOrConnectionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeConnection(appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Save USER-scoped installation settings for the current user * @param {string} appUuid * @param {Array} appSettingFieldSchema * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveUserSettings(appUuid: string, appSettingFieldSchema: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Start external OAuth authorize (returns provider authorize URL) * @param {string} appUuid * @param {string} provider * @param {string} [redirectUri] * @param {*} [options] Override http request option. * @throws {RequiredError} */ startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Trigger an ACTION setting without saving settings * @param {string} appUuid * @param {string} fieldName * @param {*} [options] Override http request option. * @throws {RequiredError} */ triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AppInstallationRuntimeApi - factory interface */ export declare const AppInstallationRuntimeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Delete an encrypted secret * @param {string} appUuid * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSecret(appUuid: string, name: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Delete a state key * @param {string} appUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteStateKey(appUuid: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Enqueue an async serverless function job * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ enqueueJob(appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get async job status * @param {string} appUuid * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getJob(appUuid: string, jobId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get installation state map * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getState(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get a single state key * @param {string} appUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStateKey(appUuid: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary List external OAuth connection status * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConnections(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary List secret names (no values) * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSecrets(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Merge COMPANY-scoped installation settings from the app runtime * @param {string} appUuid * @param {Array} appSettingFieldSchema * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Set an encrypted secret * @param {string} appUuid * @param {string} name * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ putSecret(appUuid: string, name: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Replace/merge installation state (shallow merge) * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ putState(appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Put a single state key * @param {string} appUuid * @param {string} key * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ putStateKey(appUuid: string, key: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Revoke external OAuth connection tokens by connection id or provider name * @param {string} appUuid * @param {string} providerOrConnectionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeConnection(appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Save USER-scoped installation settings for the current user * @param {string} appUuid * @param {Array} appSettingFieldSchema * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveUserSettings(appUuid: string, appSettingFieldSchema: Array, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Start external OAuth authorize (returns provider authorize URL) * @param {string} appUuid * @param {string} provider * @param {string} [redirectUri] * @param {*} [options] Override http request option. * @throws {RequiredError} */ startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Trigger an ACTION setting without saving settings * @param {string} appUuid * @param {string} fieldName * @param {*} [options] Override http request option. * @throws {RequiredError} */ triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * AppInstallationRuntimeApi - object-oriented interface */ export declare class AppInstallationRuntimeApi extends BaseAPI { /** * * @summary Delete an encrypted secret * @param {string} appUuid * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSecret(appUuid: string, name: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Delete a state key * @param {string} appUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteStateKey(appUuid: string, key: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Enqueue an async serverless function job * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ enqueueJob(appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get async job status * @param {string} appUuid * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getJob(appUuid: string, jobId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get installation state map * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getState(appUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get a single state key * @param {string} appUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStateKey(appUuid: string, key: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary List external OAuth connection status * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConnections(appUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary List secret names (no values) * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSecrets(appUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Merge COMPANY-scoped installation settings from the app runtime * @param {string} appUuid * @param {Array} appSettingFieldSchema * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Set an encrypted secret * @param {string} appUuid * @param {string} name * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ putSecret(appUuid: string, name: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Replace/merge installation state (shallow merge) * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ putState(appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Put a single state key * @param {string} appUuid * @param {string} key * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ putStateKey(appUuid: string, key: string, body: object, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Revoke external OAuth connection tokens by connection id or provider name * @param {string} appUuid * @param {string} providerOrConnectionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeConnection(appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Save USER-scoped installation settings for the current user * @param {string} appUuid * @param {Array} appSettingFieldSchema * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveUserSettings(appUuid: string, appSettingFieldSchema: Array, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Start external OAuth authorize (returns provider authorize URL) * @param {string} appUuid * @param {string} provider * @param {string} [redirectUri] * @param {*} [options] Override http request option. * @throws {RequiredError} */ startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Trigger an ACTION setting without saving settings * @param {string} appUuid * @param {string} fieldName * @param {*} [options] Override http request option. * @throws {RequiredError} */ triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise>; } /** * ApplicationsApi - axios parameter creator */ export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new webhook for the specified app using normal bearer authentication. The app must be installed for the authenticated user\'s selected company. This endpoint is an app-scoped equivalent of the generic webhook creation endpoint. * @summary Create a webhook for an app (app-scoped path) * @param {string} appUuid UUID of the app to create the webhook for * @param {SubscribeWebhookDTO} subscribeWebhookDTO Webhook details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAppWebhookForApp: (appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig) => Promise; /** * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO. * @summary Create a private app * @param {CreatePrivateAppRequest} createPrivateAppRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPrivateApp: (createPrivateAppRequest: CreatePrivateAppRequest, options?: RawAxiosRequestConfig) => Promise; /** * Creates a new public app with the provided label and optional description. Public apps are automatically published for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO. * @summary Create a public app * @param {AppDTO} appDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPublicApp: (appDTO: AppDTO, options?: RawAxiosRequestConfig) => Promise; /** * Deletes a webhook that belongs to the specified app and the authenticated user\'s selected company. * @summary Delete a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAppWebhook: (appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO. * @summary Retrieve application details by UUID * @param {string} uuid UUID of the application to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApp: (uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Fetches a single webhook that belongs to the specified app. * @summary Get a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAppWebhook: (appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Fetches a paginated and optionally filtered list of webhooks associated with the specified app and the authenticated user\'s selected company. * @summary Retrieve a paginated list of webhooks for an app * @param {string} appUuid UUID of the application for which to retrieve webhooks * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAppWebhooks: (appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects. * @summary Retrieve a paginated list of applications * @param {PaginationRequest} paginationRequest * @param {string} [type] * @param {boolean} [installedOnly] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApps: (paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company. * @summary Get current user\'s company information * @param {string} appUuid UUID of the app to get the company information for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompanyInformation: (appUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Fetches a paginated and optionally filtered list of apps where the selected company is the creator. Returns a PaginationResponse containing AppDTO objects. * @summary Retrieve apps created by the logged-in user\'s selected company * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyCreatedApps: (paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Gets the full app for the creator, including appPublish, appBars, details, and pricing. Returns AppCreatorDTO with everything under App. * @summary Get a public app (creator view) * @param {string} uuid UUID of the public app to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicApp: (uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Queries Cloud Logging for the shared V2 app container (app-{uuid}) without filtering to a single function. * @summary Get app runtime logs * @param {string} appUuid UUID of the app * @param {string} [since] Lookback window, e.g. 15m, 1h, 24h * @param {number} [limit] Maximum number of log entries to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRuntimeLogs: (appUuid: string, since?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Returns all supported record webhook events with their details. * @summary Get available webhook record events * @param {string} appUuid UUID of the app to get the webhook events for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookEvents: (appUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns all supported webhook payload formats with their details. * @summary Get available webhook formats * @param {string} appUuid UUID of the app to get the webhook formats for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookFormats: (appUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns property names on an object that can be used in 4-part property_changed webhook topics. * @summary Get webhook property topic options * @param {string} appUuid UUID of the app * @param {string} object Object name (e.g. contact) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookPropertyTopics: (appUuid: string, object: string, options?: RawAxiosRequestConfig) => Promise; /** * Installs the application specified by its UUID with optional initial configuration settings. Returns the updated application details as a ShowResponse wrapping an AppDTO. * @summary Install an application * @param {string} uuid UUID of the application to install * @param {InstallAppRequest} [installAppRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ installApp: (uuid: string, installAppRequest?: InstallAppRequest, options?: RawAxiosRequestConfig) => Promise; /** * Returns the allowed category keys and labels for public app marketplace listings. * @summary List predefined marketplace app categories * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAppCategories: (options?: RawAxiosRequestConfig) => Promise; /** * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader. * @summary Load dynamic options for a setting select field * @param {string} uuid UUID of the application * @param {LoadAppSettingOptionsRequest} loadAppSettingOptionsRequest Field name, optional query, and draft settings schema * @param {*} [options] Override http request option. * @throws {RequiredError} */ loadSettingOptions: (uuid: string, loadAppSettingOptionsRequest: LoadAppSettingOptionsRequest, options?: RawAxiosRequestConfig) => Promise; /** * Opt-in in-place migration to the shared container runtime. Validates a single runtime, sets platformVersion=2, schedules an async rebuild, and keeps invoking via legacy gcpReference until runtimeStatus is READY. * @summary Migrate an app from platform V1 to V2 * @param {string} uuid UUID of the app to migrate * @param {MigrateAppToV2Request} [migrateAppToV2Request] * @param {*} [options] Override http request option. * @throws {RequiredError} */ migrateToV2: (uuid: string, migrateAppToV2Request?: MigrateAppToV2Request, options?: RawAxiosRequestConfig) => Promise; /** * Sets review outcome (approve/reject/changes requested), feedback, and optional reviewer notes. Returns the updated app details as a ShowResponse wrapping an AppDTO. * @summary Review a public app * @param {string} uuid UUID of the public app to review * @param {ReviewRequest} reviewRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ reviewPublicApp: (uuid: string, reviewRequest: ReviewRequest, options?: RawAxiosRequestConfig) => Promise; /** * Rotates the configuration or settings for the specified application by UUID. On success, returns the updated application details as a ShowResponse wrapping an AppDTO. * @summary Rotate application configurations * @param {string} uuid UUID of the application to rotate configurations * @param {*} [options] Override http request option. * @throws {RequiredError} */ rotateApp: (uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Server-Sent Events stream of Cloud Logging entries for the shared V2 app container. Polls every ~2.5s and stops after 5 minutes or client disconnect. * @summary Stream app runtime logs (SSE) * @param {string} appUuid UUID of the app * @param {*} [options] Override http request option. * @throws {RequiredError} */ streamRuntimeLogs: (appUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Submits a public app specified by its UUID for review. Returns the submitted app details as a ShowResponse wrapping an AppDTO. * @summary Submit a public app for review * @param {string} uuid UUID of the public app to submit for review * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitPublicApp: (uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Generates a test webhook payload for a specific record and event type. Uses the same payload generation logic as live webhook delivery. * @summary Test a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to test * @param {string} recordUuid UUID of the record to include in the webhook payload * @param {string} eventType Type of event to simulate. Supported values are the entries returned by /webhooks/events, or property_changed for property webhooks. * @param {string} [propertyName] Property name when simulating property_changed * @param {*} [options] Override http request option. * @throws {RequiredError} */ testAppWebhook: (appUuid: string, webhookUuid: string, recordUuid: string, eventType: string, propertyName?: string, options?: RawAxiosRequestConfig) => Promise; /** * Generates a test webhook payload using the latest matching record for the topic object. Form-submission topics prefer a record that submitted that form; includeRelations prefer a record that has as many of those related objects as possible. If no record exists, a simulated record is used. Missing includeRelations and simulated samples are explained in context.testNote and the X-Webhook-Test-Note header. Uses the event type from the webhook topic (updated when the topic action is all). * @summary Test a webhook for an app (auto-resolve) * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to test * @param {*} [options] Override http request option. * @throws {RequiredError} */ testAppWebhookAuto: (appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Generates a test webhook payload from webhook configuration supplied in the request body without persisting the webhook. When recordUuid is omitted, auto-resolves the latest matching record, prefers records that submitted the topic form and that have as many includeRelations as possible, and uses the event from the webhook topic. If no record exists, a simulated record is used and context.testNote (also X-Webhook-Test-Note) explains that plus any missing includeRelations. * @summary Test an unsaved webhook for an app * @param {string} appUuid UUID of the app the webhook belongs to * @param {TestWebhookRequest} testWebhookRequest Webhook configuration and optional test event parameters * @param {*} [options] Override http request option. * @throws {RequiredError} */ testAppWebhookUnsaved: (appUuid: string, testWebhookRequest: TestWebhookRequest, options?: RawAxiosRequestConfig) => Promise; /** * Removes the installed application specified by its UUID using the provided settings. The request body should contain an AppRequest with the uninstallation settings. Returns the updated application details as a ShowResponse wrapping an AppDTO. * @summary Uninstall an application * @param {string} uuid UUID of the application to uninstall * @param {AppRequest} appRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ uninstallApp: (uuid: string, appRequest: AppRequest, options?: RawAxiosRequestConfig) => Promise; /** * Updates an existing webhook that belongs to the specified app and the authenticated user\'s selected company. * @summary Update a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to update * @param {SubscribeWebhookDTO} subscribeWebhookDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAppWebhookForApp: (appUuid: string, webhookUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig) => Promise; /** * Updates a public app with the full creator payload (label, description, details, pricing, settingsSchema, appBars). Send the entire AppCreatorDTO as returned by GET. Returns the updated app as AppCreatorDTO. * @summary Update a public app (creator edit) * @param {string} uuid UUID of the public app to update * @param {AppDTO} appDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePublicApp: (uuid: string, appDTO: AppDTO, options?: RawAxiosRequestConfig) => Promise; }; /** * ApplicationsApi - functional programming interface */ export declare const ApplicationsApiFp: (configuration?: Configuration) => { /** * Creates a new webhook for the specified app using normal bearer authentication. The app must be installed for the authenticated user\'s selected company. This endpoint is an app-scoped equivalent of the generic webhook creation endpoint. * @summary Create a webhook for an app (app-scoped path) * @param {string} appUuid UUID of the app to create the webhook for * @param {SubscribeWebhookDTO} subscribeWebhookDTO Webhook details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAppWebhookForApp(appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO. * @summary Create a private app * @param {CreatePrivateAppRequest} createPrivateAppRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPrivateApp(createPrivateAppRequest: CreatePrivateAppRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new public app with the provided label and optional description. Public apps are automatically published for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO. * @summary Create a public app * @param {AppDTO} appDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPublicApp(appDTO: AppDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a webhook that belongs to the specified app and the authenticated user\'s selected company. * @summary Delete a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO. * @summary Retrieve application details by UUID * @param {string} uuid UUID of the application to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApp(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches a single webhook that belongs to the specified app. * @summary Get a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches a paginated and optionally filtered list of webhooks associated with the specified app and the authenticated user\'s selected company. * @summary Retrieve a paginated list of webhooks for an app * @param {string} appUuid UUID of the application for which to retrieve webhooks * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAppWebhooks(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects. * @summary Retrieve a paginated list of applications * @param {PaginationRequest} paginationRequest * @param {string} [type] * @param {boolean} [installedOnly] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company. * @summary Get current user\'s company information * @param {string} appUuid UUID of the app to get the company information for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompanyInformation(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches a paginated and optionally filtered list of apps where the selected company is the creator. Returns a PaginationResponse containing AppDTO objects. * @summary Retrieve apps created by the logged-in user\'s selected company * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyCreatedApps(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets the full app for the creator, including appPublish, appBars, details, and pricing. Returns AppCreatorDTO with everything under App. * @summary Get a public app (creator view) * @param {string} uuid UUID of the public app to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicApp(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Queries Cloud Logging for the shared V2 app container (app-{uuid}) without filtering to a single function. * @summary Get app runtime logs * @param {string} appUuid UUID of the app * @param {string} [since] Lookback window, e.g. 15m, 1h, 24h * @param {number} [limit] Maximum number of log entries to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRuntimeLogs(appUuid: string, since?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns all supported record webhook events with their details. * @summary Get available webhook record events * @param {string} appUuid UUID of the app to get the webhook events for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookEvents(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns all supported webhook payload formats with their details. * @summary Get available webhook formats * @param {string} appUuid UUID of the app to get the webhook formats for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookFormats(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns property names on an object that can be used in 4-part property_changed webhook topics. * @summary Get webhook property topic options * @param {string} appUuid UUID of the app * @param {string} object Object name (e.g. contact) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookPropertyTopics(appUuid: string, object: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Installs the application specified by its UUID with optional initial configuration settings. Returns the updated application details as a ShowResponse wrapping an AppDTO. * @summary Install an application * @param {string} uuid UUID of the application to install * @param {InstallAppRequest} [installAppRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ installApp(uuid: string, installAppRequest?: InstallAppRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the allowed category keys and labels for public app marketplace listings. * @summary List predefined marketplace app categories * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAppCategories(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader. * @summary Load dynamic options for a setting select field * @param {string} uuid UUID of the application * @param {LoadAppSettingOptionsRequest} loadAppSettingOptionsRequest Field name, optional query, and draft settings schema * @param {*} [options] Override http request option. * @throws {RequiredError} */ loadSettingOptions(uuid: string, loadAppSettingOptionsRequest: LoadAppSettingOptionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Opt-in in-place migration to the shared container runtime. Validates a single runtime, sets platformVersion=2, schedules an async rebuild, and keeps invoking via legacy gcpReference until runtimeStatus is READY. * @summary Migrate an app from platform V1 to V2 * @param {string} uuid UUID of the app to migrate * @param {MigrateAppToV2Request} [migrateAppToV2Request] * @param {*} [options] Override http request option. * @throws {RequiredError} */ migrateToV2(uuid: string, migrateAppToV2Request?: MigrateAppToV2Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sets review outcome (approve/reject/changes requested), feedback, and optional reviewer notes. Returns the updated app details as a ShowResponse wrapping an AppDTO. * @summary Review a public app * @param {string} uuid UUID of the public app to review * @param {ReviewRequest} reviewRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ reviewPublicApp(uuid: string, reviewRequest: ReviewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Rotates the configuration or settings for the specified application by UUID. On success, returns the updated application details as a ShowResponse wrapping an AppDTO. * @summary Rotate application configurations * @param {string} uuid UUID of the application to rotate configurations * @param {*} [options] Override http request option. * @throws {RequiredError} */ rotateApp(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Server-Sent Events stream of Cloud Logging entries for the shared V2 app container. Polls every ~2.5s and stops after 5 minutes or client disconnect. * @summary Stream app runtime logs (SSE) * @param {string} appUuid UUID of the app * @param {*} [options] Override http request option. * @throws {RequiredError} */ streamRuntimeLogs(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Submits a public app specified by its UUID for review. Returns the submitted app details as a ShowResponse wrapping an AppDTO. * @summary Submit a public app for review * @param {string} uuid UUID of the public app to submit for review * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitPublicApp(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generates a test webhook payload for a specific record and event type. Uses the same payload generation logic as live webhook delivery. * @summary Test a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to test * @param {string} recordUuid UUID of the record to include in the webhook payload * @param {string} eventType Type of event to simulate. Supported values are the entries returned by /webhooks/events, or property_changed for property webhooks. * @param {string} [propertyName] Property name when simulating property_changed * @param {*} [options] Override http request option. * @throws {RequiredError} */ testAppWebhook(appUuid: string, webhookUuid: string, recordUuid: string, eventType: string, propertyName?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generates a test webhook payload using the latest matching record for the topic object. Form-submission topics prefer a record that submitted that form; includeRelations prefer a record that has as many of those related objects as possible. If no record exists, a simulated record is used. Missing includeRelations and simulated samples are explained in context.testNote and the X-Webhook-Test-Note header. Uses the event type from the webhook topic (updated when the topic action is all). * @summary Test a webhook for an app (auto-resolve) * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to test * @param {*} [options] Override http request option. * @throws {RequiredError} */ testAppWebhookAuto(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generates a test webhook payload from webhook configuration supplied in the request body without persisting the webhook. When recordUuid is omitted, auto-resolves the latest matching record, prefers records that submitted the topic form and that have as many includeRelations as possible, and uses the event from the webhook topic. If no record exists, a simulated record is used and context.testNote (also X-Webhook-Test-Note) explains that plus any missing includeRelations. * @summary Test an unsaved webhook for an app * @param {string} appUuid UUID of the app the webhook belongs to * @param {TestWebhookRequest} testWebhookRequest Webhook configuration and optional test event parameters * @param {*} [options] Override http request option. * @throws {RequiredError} */ testAppWebhookUnsaved(appUuid: string, testWebhookRequest: TestWebhookRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Removes the installed application specified by its UUID using the provided settings. The request body should contain an AppRequest with the uninstallation settings. Returns the updated application details as a ShowResponse wrapping an AppDTO. * @summary Uninstall an application * @param {string} uuid UUID of the application to uninstall * @param {AppRequest} appRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ uninstallApp(uuid: string, appRequest: AppRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates an existing webhook that belongs to the specified app and the authenticated user\'s selected company. * @summary Update a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to update * @param {SubscribeWebhookDTO} subscribeWebhookDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAppWebhookForApp(appUuid: string, webhookUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates a public app with the full creator payload (label, description, details, pricing, settingsSchema, appBars). Send the entire AppCreatorDTO as returned by GET. Returns the updated app as AppCreatorDTO. * @summary Update a public app (creator edit) * @param {string} uuid UUID of the public app to update * @param {AppDTO} appDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePublicApp(uuid: string, appDTO: AppDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ApplicationsApi - factory interface */ export declare const ApplicationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new webhook for the specified app using normal bearer authentication. The app must be installed for the authenticated user\'s selected company. This endpoint is an app-scoped equivalent of the generic webhook creation endpoint. * @summary Create a webhook for an app (app-scoped path) * @param {string} appUuid UUID of the app to create the webhook for * @param {SubscribeWebhookDTO} subscribeWebhookDTO Webhook details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAppWebhookForApp(appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO. * @summary Create a private app * @param {CreatePrivateAppRequest} createPrivateAppRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPrivateApp(createPrivateAppRequest: CreatePrivateAppRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a new public app with the provided label and optional description. Public apps are automatically published for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO. * @summary Create a public app * @param {AppDTO} appDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPublicApp(appDTO: AppDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes a webhook that belongs to the specified app and the authenticated user\'s selected company. * @summary Delete a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO. * @summary Retrieve application details by UUID * @param {string} uuid UUID of the application to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApp(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a single webhook that belongs to the specified app. * @summary Get a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a paginated and optionally filtered list of webhooks associated with the specified app and the authenticated user\'s selected company. * @summary Retrieve a paginated list of webhooks for an app * @param {string} appUuid UUID of the application for which to retrieve webhooks * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAppWebhooks(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects. * @summary Retrieve a paginated list of applications * @param {PaginationRequest} paginationRequest * @param {string} [type] * @param {boolean} [installedOnly] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company. * @summary Get current user\'s company information * @param {string} appUuid UUID of the app to get the company information for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompanyInformation(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a paginated and optionally filtered list of apps where the selected company is the creator. Returns a PaginationResponse containing AppDTO objects. * @summary Retrieve apps created by the logged-in user\'s selected company * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyCreatedApps(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Gets the full app for the creator, including appPublish, appBars, details, and pricing. Returns AppCreatorDTO with everything under App. * @summary Get a public app (creator view) * @param {string} uuid UUID of the public app to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicApp(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Queries Cloud Logging for the shared V2 app container (app-{uuid}) without filtering to a single function. * @summary Get app runtime logs * @param {string} appUuid UUID of the app * @param {string} [since] Lookback window, e.g. 15m, 1h, 24h * @param {number} [limit] Maximum number of log entries to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRuntimeLogs(appUuid: string, since?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns all supported record webhook events with their details. * @summary Get available webhook record events * @param {string} appUuid UUID of the app to get the webhook events for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookEvents(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns all supported webhook payload formats with their details. * @summary Get available webhook formats * @param {string} appUuid UUID of the app to get the webhook formats for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookFormats(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns property names on an object that can be used in 4-part property_changed webhook topics. * @summary Get webhook property topic options * @param {string} appUuid UUID of the app * @param {string} object Object name (e.g. contact) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookPropertyTopics(appUuid: string, object: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Installs the application specified by its UUID with optional initial configuration settings. Returns the updated application details as a ShowResponse wrapping an AppDTO. * @summary Install an application * @param {string} uuid UUID of the application to install * @param {InstallAppRequest} [installAppRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ installApp(uuid: string, installAppRequest?: InstallAppRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the allowed category keys and labels for public app marketplace listings. * @summary List predefined marketplace app categories * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAppCategories(options?: RawAxiosRequestConfig): AxiosPromise>; /** * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader. * @summary Load dynamic options for a setting select field * @param {string} uuid UUID of the application * @param {LoadAppSettingOptionsRequest} loadAppSettingOptionsRequest Field name, optional query, and draft settings schema * @param {*} [options] Override http request option. * @throws {RequiredError} */ loadSettingOptions(uuid: string, loadAppSettingOptionsRequest: LoadAppSettingOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Opt-in in-place migration to the shared container runtime. Validates a single runtime, sets platformVersion=2, schedules an async rebuild, and keeps invoking via legacy gcpReference until runtimeStatus is READY. * @summary Migrate an app from platform V1 to V2 * @param {string} uuid UUID of the app to migrate * @param {MigrateAppToV2Request} [migrateAppToV2Request] * @param {*} [options] Override http request option. * @throws {RequiredError} */ migrateToV2(uuid: string, migrateAppToV2Request?: MigrateAppToV2Request, options?: RawAxiosRequestConfig): AxiosPromise; /** * Sets review outcome (approve/reject/changes requested), feedback, and optional reviewer notes. Returns the updated app details as a ShowResponse wrapping an AppDTO. * @summary Review a public app * @param {string} uuid UUID of the public app to review * @param {ReviewRequest} reviewRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ reviewPublicApp(uuid: string, reviewRequest: ReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Rotates the configuration or settings for the specified application by UUID. On success, returns the updated application details as a ShowResponse wrapping an AppDTO. * @summary Rotate application configurations * @param {string} uuid UUID of the application to rotate configurations * @param {*} [options] Override http request option. * @throws {RequiredError} */ rotateApp(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Server-Sent Events stream of Cloud Logging entries for the shared V2 app container. Polls every ~2.5s and stops after 5 minutes or client disconnect. * @summary Stream app runtime logs (SSE) * @param {string} appUuid UUID of the app * @param {*} [options] Override http request option. * @throws {RequiredError} */ streamRuntimeLogs(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Submits a public app specified by its UUID for review. Returns the submitted app details as a ShowResponse wrapping an AppDTO. * @summary Submit a public app for review * @param {string} uuid UUID of the public app to submit for review * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitPublicApp(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Generates a test webhook payload for a specific record and event type. Uses the same payload generation logic as live webhook delivery. * @summary Test a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to test * @param {string} recordUuid UUID of the record to include in the webhook payload * @param {string} eventType Type of event to simulate. Supported values are the entries returned by /webhooks/events, or property_changed for property webhooks. * @param {string} [propertyName] Property name when simulating property_changed * @param {*} [options] Override http request option. * @throws {RequiredError} */ testAppWebhook(appUuid: string, webhookUuid: string, recordUuid: string, eventType: string, propertyName?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Generates a test webhook payload using the latest matching record for the topic object. Form-submission topics prefer a record that submitted that form; includeRelations prefer a record that has as many of those related objects as possible. If no record exists, a simulated record is used. Missing includeRelations and simulated samples are explained in context.testNote and the X-Webhook-Test-Note header. Uses the event type from the webhook topic (updated when the topic action is all). * @summary Test a webhook for an app (auto-resolve) * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to test * @param {*} [options] Override http request option. * @throws {RequiredError} */ testAppWebhookAuto(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Generates a test webhook payload from webhook configuration supplied in the request body without persisting the webhook. When recordUuid is omitted, auto-resolves the latest matching record, prefers records that submitted the topic form and that have as many includeRelations as possible, and uses the event from the webhook topic. If no record exists, a simulated record is used and context.testNote (also X-Webhook-Test-Note) explains that plus any missing includeRelations. * @summary Test an unsaved webhook for an app * @param {string} appUuid UUID of the app the webhook belongs to * @param {TestWebhookRequest} testWebhookRequest Webhook configuration and optional test event parameters * @param {*} [options] Override http request option. * @throws {RequiredError} */ testAppWebhookUnsaved(appUuid: string, testWebhookRequest: TestWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Removes the installed application specified by its UUID using the provided settings. The request body should contain an AppRequest with the uninstallation settings. Returns the updated application details as a ShowResponse wrapping an AppDTO. * @summary Uninstall an application * @param {string} uuid UUID of the application to uninstall * @param {AppRequest} appRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ uninstallApp(uuid: string, appRequest: AppRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates an existing webhook that belongs to the specified app and the authenticated user\'s selected company. * @summary Update a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to update * @param {SubscribeWebhookDTO} subscribeWebhookDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAppWebhookForApp(appUuid: string, webhookUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates a public app with the full creator payload (label, description, details, pricing, settingsSchema, appBars). Send the entire AppCreatorDTO as returned by GET. Returns the updated app as AppCreatorDTO. * @summary Update a public app (creator edit) * @param {string} uuid UUID of the public app to update * @param {AppDTO} appDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePublicApp(uuid: string, appDTO: AppDTO, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ApplicationsApi - object-oriented interface */ export declare class ApplicationsApi extends BaseAPI { /** * Creates a new webhook for the specified app using normal bearer authentication. The app must be installed for the authenticated user\'s selected company. This endpoint is an app-scoped equivalent of the generic webhook creation endpoint. * @summary Create a webhook for an app (app-scoped path) * @param {string} appUuid UUID of the app to create the webhook for * @param {SubscribeWebhookDTO} subscribeWebhookDTO Webhook details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAppWebhookForApp(appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): Promise>; /** * Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO. * @summary Create a private app * @param {CreatePrivateAppRequest} createPrivateAppRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPrivateApp(createPrivateAppRequest: CreatePrivateAppRequest, options?: RawAxiosRequestConfig): Promise>; /** * Creates a new public app with the provided label and optional description. Public apps are automatically published for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO. * @summary Create a public app * @param {AppDTO} appDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPublicApp(appDTO: AppDTO, options?: RawAxiosRequestConfig): Promise>; /** * Deletes a webhook that belongs to the specified app and the authenticated user\'s selected company. * @summary Delete a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO. * @summary Retrieve application details by UUID * @param {string} uuid UUID of the application to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApp(uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Fetches a single webhook that belongs to the specified app. * @summary Get a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Fetches a paginated and optionally filtered list of webhooks associated with the specified app and the authenticated user\'s selected company. * @summary Retrieve a paginated list of webhooks for an app * @param {string} appUuid UUID of the application for which to retrieve webhooks * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAppWebhooks(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects. * @summary Retrieve a paginated list of applications * @param {PaginationRequest} paginationRequest * @param {string} [type] * @param {boolean} [installedOnly] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company. * @summary Get current user\'s company information * @param {string} appUuid UUID of the app to get the company information for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompanyInformation(appUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Fetches a paginated and optionally filtered list of apps where the selected company is the creator. Returns a PaginationResponse containing AppDTO objects. * @summary Retrieve apps created by the logged-in user\'s selected company * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyCreatedApps(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Gets the full app for the creator, including appPublish, appBars, details, and pricing. Returns AppCreatorDTO with everything under App. * @summary Get a public app (creator view) * @param {string} uuid UUID of the public app to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicApp(uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Queries Cloud Logging for the shared V2 app container (app-{uuid}) without filtering to a single function. * @summary Get app runtime logs * @param {string} appUuid UUID of the app * @param {string} [since] Lookback window, e.g. 15m, 1h, 24h * @param {number} [limit] Maximum number of log entries to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRuntimeLogs(appUuid: string, since?: string, limit?: number, options?: RawAxiosRequestConfig): Promise>; /** * Returns all supported record webhook events with their details. * @summary Get available webhook record events * @param {string} appUuid UUID of the app to get the webhook events for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookEvents(appUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns all supported webhook payload formats with their details. * @summary Get available webhook formats * @param {string} appUuid UUID of the app to get the webhook formats for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookFormats(appUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns property names on an object that can be used in 4-part property_changed webhook topics. * @summary Get webhook property topic options * @param {string} appUuid UUID of the app * @param {string} object Object name (e.g. contact) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookPropertyTopics(appUuid: string, object: string, options?: RawAxiosRequestConfig): Promise>; /** * Installs the application specified by its UUID with optional initial configuration settings. Returns the updated application details as a ShowResponse wrapping an AppDTO. * @summary Install an application * @param {string} uuid UUID of the application to install * @param {InstallAppRequest} [installAppRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ installApp(uuid: string, installAppRequest?: InstallAppRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the allowed category keys and labels for public app marketplace listings. * @summary List predefined marketplace app categories * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAppCategories(options?: RawAxiosRequestConfig): Promise>; /** * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader. * @summary Load dynamic options for a setting select field * @param {string} uuid UUID of the application * @param {LoadAppSettingOptionsRequest} loadAppSettingOptionsRequest Field name, optional query, and draft settings schema * @param {*} [options] Override http request option. * @throws {RequiredError} */ loadSettingOptions(uuid: string, loadAppSettingOptionsRequest: LoadAppSettingOptionsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Opt-in in-place migration to the shared container runtime. Validates a single runtime, sets platformVersion=2, schedules an async rebuild, and keeps invoking via legacy gcpReference until runtimeStatus is READY. * @summary Migrate an app from platform V1 to V2 * @param {string} uuid UUID of the app to migrate * @param {MigrateAppToV2Request} [migrateAppToV2Request] * @param {*} [options] Override http request option. * @throws {RequiredError} */ migrateToV2(uuid: string, migrateAppToV2Request?: MigrateAppToV2Request, options?: RawAxiosRequestConfig): Promise>; /** * Sets review outcome (approve/reject/changes requested), feedback, and optional reviewer notes. Returns the updated app details as a ShowResponse wrapping an AppDTO. * @summary Review a public app * @param {string} uuid UUID of the public app to review * @param {ReviewRequest} reviewRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ reviewPublicApp(uuid: string, reviewRequest: ReviewRequest, options?: RawAxiosRequestConfig): Promise>; /** * Rotates the configuration or settings for the specified application by UUID. On success, returns the updated application details as a ShowResponse wrapping an AppDTO. * @summary Rotate application configurations * @param {string} uuid UUID of the application to rotate configurations * @param {*} [options] Override http request option. * @throws {RequiredError} */ rotateApp(uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Server-Sent Events stream of Cloud Logging entries for the shared V2 app container. Polls every ~2.5s and stops after 5 minutes or client disconnect. * @summary Stream app runtime logs (SSE) * @param {string} appUuid UUID of the app * @param {*} [options] Override http request option. * @throws {RequiredError} */ streamRuntimeLogs(appUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Submits a public app specified by its UUID for review. Returns the submitted app details as a ShowResponse wrapping an AppDTO. * @summary Submit a public app for review * @param {string} uuid UUID of the public app to submit for review * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitPublicApp(uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Generates a test webhook payload for a specific record and event type. Uses the same payload generation logic as live webhook delivery. * @summary Test a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to test * @param {string} recordUuid UUID of the record to include in the webhook payload * @param {string} eventType Type of event to simulate. Supported values are the entries returned by /webhooks/events, or property_changed for property webhooks. * @param {string} [propertyName] Property name when simulating property_changed * @param {*} [options] Override http request option. * @throws {RequiredError} */ testAppWebhook(appUuid: string, webhookUuid: string, recordUuid: string, eventType: string, propertyName?: string, options?: RawAxiosRequestConfig): Promise>; /** * Generates a test webhook payload using the latest matching record for the topic object. Form-submission topics prefer a record that submitted that form; includeRelations prefer a record that has as many of those related objects as possible. If no record exists, a simulated record is used. Missing includeRelations and simulated samples are explained in context.testNote and the X-Webhook-Test-Note header. Uses the event type from the webhook topic (updated when the topic action is all). * @summary Test a webhook for an app (auto-resolve) * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to test * @param {*} [options] Override http request option. * @throws {RequiredError} */ testAppWebhookAuto(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Generates a test webhook payload from webhook configuration supplied in the request body without persisting the webhook. When recordUuid is omitted, auto-resolves the latest matching record, prefers records that submitted the topic form and that have as many includeRelations as possible, and uses the event from the webhook topic. If no record exists, a simulated record is used and context.testNote (also X-Webhook-Test-Note) explains that plus any missing includeRelations. * @summary Test an unsaved webhook for an app * @param {string} appUuid UUID of the app the webhook belongs to * @param {TestWebhookRequest} testWebhookRequest Webhook configuration and optional test event parameters * @param {*} [options] Override http request option. * @throws {RequiredError} */ testAppWebhookUnsaved(appUuid: string, testWebhookRequest: TestWebhookRequest, options?: RawAxiosRequestConfig): Promise>; /** * Removes the installed application specified by its UUID using the provided settings. The request body should contain an AppRequest with the uninstallation settings. Returns the updated application details as a ShowResponse wrapping an AppDTO. * @summary Uninstall an application * @param {string} uuid UUID of the application to uninstall * @param {AppRequest} appRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ uninstallApp(uuid: string, appRequest: AppRequest, options?: RawAxiosRequestConfig): Promise>; /** * Updates an existing webhook that belongs to the specified app and the authenticated user\'s selected company. * @summary Update a webhook for an app * @param {string} appUuid UUID of the app that owns the webhook * @param {string} webhookUuid UUID of the webhook to update * @param {SubscribeWebhookDTO} subscribeWebhookDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAppWebhookForApp(appUuid: string, webhookUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): Promise>; /** * Updates a public app with the full creator payload (label, description, details, pricing, settingsSchema, appBars). Send the entire AppCreatorDTO as returned by GET. Returns the updated app as AppCreatorDTO. * @summary Update a public app (creator edit) * @param {string} uuid UUID of the public app to update * @param {AppDTO} appDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePublicApp(uuid: string, appDTO: AppDTO, options?: RawAxiosRequestConfig): Promise>; } /** * AutomationsApi - axios parameter creator */ export declare const AutomationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Generates a short-lived Latenode JWT token for the authenticated user, to be used with the Latenode embedded SDK. * @summary Get Latenode JWT token for current user * @param {*} [options] Override http request option. * @throws {RequiredError} */ getToken: (options?: RawAxiosRequestConfig) => Promise; }; /** * AutomationsApi - functional programming interface */ export declare const AutomationsApiFp: (configuration?: Configuration) => { /** * Generates a short-lived Latenode JWT token for the authenticated user, to be used with the Latenode embedded SDK. * @summary Get Latenode JWT token for current user * @param {*} [options] Override http request option. * @throws {RequiredError} */ getToken(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AutomationsApi - factory interface */ export declare const AutomationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Generates a short-lived Latenode JWT token for the authenticated user, to be used with the Latenode embedded SDK. * @summary Get Latenode JWT token for current user * @param {*} [options] Override http request option. * @throws {RequiredError} */ getToken(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * AutomationsApi - object-oriented interface */ export declare class AutomationsApi extends BaseAPI { /** * Generates a short-lived Latenode JWT token for the authenticated user, to be used with the Latenode embedded SDK. * @summary Get Latenode JWT token for current user * @param {*} [options] Override http request option. * @throws {RequiredError} */ getToken(options?: RawAxiosRequestConfig): Promise>; } /** * BillingApi - axios parameter creator */ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns whether the selected company should see no UI, a billing banner, or a non-dismissible lockout, based on Caraer BV CRM billing fields. * @summary Get billing enforcement status * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStatus: (options?: RawAxiosRequestConfig) => Promise; /** * Triggers Jortt to email the linked customer a direct-debit authorization payment link. * @summary Send billing setup email * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendSetupEmail: (options?: RawAxiosRequestConfig) => Promise; }; /** * BillingApi - functional programming interface */ export declare const BillingApiFp: (configuration?: Configuration) => { /** * Returns whether the selected company should see no UI, a billing banner, or a non-dismissible lockout, based on Caraer BV CRM billing fields. * @summary Get billing enforcement status * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Triggers Jortt to email the linked customer a direct-debit authorization payment link. * @summary Send billing setup email * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendSetupEmail(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * BillingApi - factory interface */ export declare const BillingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns whether the selected company should see no UI, a billing banner, or a non-dismissible lockout, based on Caraer BV CRM billing fields. * @summary Get billing enforcement status * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStatus(options?: RawAxiosRequestConfig): AxiosPromise; /** * Triggers Jortt to email the linked customer a direct-debit authorization payment link. * @summary Send billing setup email * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendSetupEmail(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * BillingApi - object-oriented interface */ export declare class BillingApi extends BaseAPI { /** * Returns whether the selected company should see no UI, a billing banner, or a non-dismissible lockout, based on Caraer BV CRM billing fields. * @summary Get billing enforcement status * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStatus(options?: RawAxiosRequestConfig): Promise>; /** * Triggers Jortt to email the linked customer a direct-debit authorization payment link. * @summary Send billing setup email * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendSetupEmail(options?: RawAxiosRequestConfig): Promise>; } /** * CMSModulesApi - axios parameter creator */ export declare const CMSModulesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Includes retired modules, so a developer can see what a push removed. * @summary List an app\'s CMS modules * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ list: (appUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Accepts a staged npm tarball (base64) and module manifests. Publishes to the platform registry with the host token, then replaces the catalog. * @summary Publish an app\'s CMS module package * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishPackage: (appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig) => Promise; /** * Registers the modules shipped by a published package version. Modules missing from the payload are retired rather than deleted, because pages may still reference them. * @summary Replace an app\'s CMS module catalog * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ upsert: (appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig) => Promise; }; /** * CMSModulesApi - functional programming interface */ export declare const CMSModulesApiFp: (configuration?: Configuration) => { /** * Includes retired modules, so a developer can see what a push removed. * @summary List an app\'s CMS modules * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ list(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Accepts a staged npm tarball (base64) and module manifests. Publishes to the platform registry with the host token, then replaces the catalog. * @summary Publish an app\'s CMS module package * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishPackage(appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Registers the modules shipped by a published package version. Modules missing from the payload are retired rather than deleted, because pages may still reference them. * @summary Replace an app\'s CMS module catalog * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ upsert(appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CMSModulesApi - factory interface */ export declare const CMSModulesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Includes retired modules, so a developer can see what a push removed. * @summary List an app\'s CMS modules * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ list(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Accepts a staged npm tarball (base64) and module manifests. Publishes to the platform registry with the host token, then replaces the catalog. * @summary Publish an app\'s CMS module package * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishPackage(appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): AxiosPromise; /** * Registers the modules shipped by a published package version. Modules missing from the payload are retired rather than deleted, because pages may still reference them. * @summary Replace an app\'s CMS module catalog * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ upsert(appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * CMSModulesApi - object-oriented interface */ export declare class CMSModulesApi extends BaseAPI { /** * Includes retired modules, so a developer can see what a push removed. * @summary List an app\'s CMS modules * @param {string} appUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ list(appUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Accepts a staged npm tarball (base64) and module manifests. Publishes to the platform registry with the host token, then replaces the catalog. * @summary Publish an app\'s CMS module package * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishPackage(appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise>; /** * Registers the modules shipped by a published package version. Modules missing from the payload are retired rather than deleted, because pages may still reference them. * @summary Replace an app\'s CMS module catalog * @param {string} appUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ upsert(appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise>; } /** * CMSV2EnvironmentsApi - axios parameter creator */ export declare const CMSV2EnvironmentsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Create an environment * @param {CmsEnvironmentDTO} cmsEnvironmentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ create3: (cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Delete an environment except main * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete1: (key: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Translation group for a record * @param {string} recordUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ group: (recordUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Link two records as translations * @param {string} fromUuid * @param {string} toUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ link: (fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary List company environments * @param {*} [options] Override http request option. * @throws {RequiredError} */ list2: (options?: RawAxiosRequestConfig) => Promise; /** * * @summary Unlink a translation edge * @param {string} fromUuid * @param {string} toUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlink: (fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Update routing, auth or htmlLang. Keys are immutable. * @param {string} key * @param {CmsEnvironmentDTO} cmsEnvironmentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ update1: (key: string, cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig) => Promise; }; /** * CMSV2EnvironmentsApi - functional programming interface */ export declare const CMSV2EnvironmentsApiFp: (configuration?: Configuration) => { /** * * @summary Create an environment * @param {CmsEnvironmentDTO} cmsEnvironmentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ create3(cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Delete an environment except main * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete1(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Translation group for a record * @param {string} recordUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ group(recordUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Link two records as translations * @param {string} fromUuid * @param {string} toUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ link(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List company environments * @param {*} [options] Override http request option. * @throws {RequiredError} */ list2(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Unlink a translation edge * @param {string} fromUuid * @param {string} toUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlink(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update routing, auth or htmlLang. Keys are immutable. * @param {string} key * @param {CmsEnvironmentDTO} cmsEnvironmentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ update1(key: string, cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CMSV2EnvironmentsApi - factory interface */ export declare const CMSV2EnvironmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Create an environment * @param {CmsEnvironmentDTO} cmsEnvironmentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ create3(cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Delete an environment except main * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete1(key: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Translation group for a record * @param {string} recordUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ group(recordUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Link two records as translations * @param {string} fromUuid * @param {string} toUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ link(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary List company environments * @param {*} [options] Override http request option. * @throws {RequiredError} */ list2(options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Unlink a translation edge * @param {string} fromUuid * @param {string} toUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlink(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Update routing, auth or htmlLang. Keys are immutable. * @param {string} key * @param {CmsEnvironmentDTO} cmsEnvironmentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ update1(key: string, cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * CMSV2EnvironmentsApi - object-oriented interface */ export declare class CMSV2EnvironmentsApi extends BaseAPI { /** * * @summary Create an environment * @param {CmsEnvironmentDTO} cmsEnvironmentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ create3(cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Delete an environment except main * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete1(key: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Translation group for a record * @param {string} recordUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ group(recordUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Link two records as translations * @param {string} fromUuid * @param {string} toUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ link(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary List company environments * @param {*} [options] Override http request option. * @throws {RequiredError} */ list2(options?: RawAxiosRequestConfig): Promise>; /** * * @summary Unlink a translation edge * @param {string} fromUuid * @param {string} toUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlink(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Update routing, auth or htmlLang. Keys are immutable. * @param {string} key * @param {CmsEnvironmentDTO} cmsEnvironmentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ update1(key: string, cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise>; } /** * CMSV2PagesApi - axios parameter creator */ export declare const CMSV2PagesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns patches the editor applies through the same revision channel as a manual edit, so the change is undoable. Page scope may add, remove and reorder modules. A module\'s code lives in a shared npm package, so the AI rewrites field values and composition, never the component itself. * @summary Rewrite a page or a module from a prompt * @param {string} recordUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ aiRewrite: (recordUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Create a translated sibling page for an environment * @param {string} recordUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTranslation: (recordUuid: string, key: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Discard a Modify-this-module playground session * @param {string} recordUuid * @param {string} sessionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ discardModuleFork: (recordUuid: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise; /** * Finds the page at /404 on the root Webpage object, or creates an empty draft there, and stores it as the company custom 404 page. * @summary Create or reuse the custom 404 page * @param {*} [options] Override http request option. * @throws {RequiredError} */ ensureNotFound: (options?: RawAxiosRequestConfig) => Promise; /** * * @summary Environment coverage for the builder dropdown * @param {string} recordUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ environmentCoverage: (recordUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Load a page for the builder * @param {string} recordUuid * @param {string} [locale] * @param {string} [state] * @param {*} [options] Override http request option. * @throws {RequiredError} */ get: (recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary CMS v2 object template document * @param {string} objectUuid * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTemplate: (objectUuid: string, locale?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Draft snapshots for one locale * @param {string} recordUuid * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ history: (recordUuid: string, locale?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Host this page on another environment * @param {string} recordUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ hostOnEnvironment: (recordUuid: string, key: string, options?: RawAxiosRequestConfig) => Promise; /** * Backs the builder\'s library picker. Only modules from installed apps, and never retired ones, because a new page must be able to render them. * @summary Modules available to this company * @param {*} [options] Override http request option. * @throws {RequiredError} */ library: (options?: RawAxiosRequestConfig) => Promise; /** * Rejected with 409 when expectedRevision does not match, so a stale client cannot overwrite another editor\'s work. * @summary Apply patches to a page draft * @param {string} recordUuid * @param {CmsPagePatchRequest} cmsPagePatchRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patch: (recordUuid: string, cmsPagePatchRequest: CmsPagePatchRequest, options?: RawAxiosRequestConfig) => Promise; /** * The iframe renders the draft document, which the public API will not serve. The signature covers the page and an expiry so a leaked link cannot be retargeted or replayed. * @summary Signed preview URL for the builder iframe * @param {string} recordUuid * @param {string} [locale] * @param {string} [state] * @param {*} [options] Override http request option. * @throws {RequiredError} */ previewLink: (recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Rewrite forked module source from a prompt * @param {string} recordUuid * @param {string} sessionId * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ promptModuleFork: (recordUuid: string, sessionId: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig) => Promise; /** * Copies the draft over the published document. Publishing is per locale so a translated page can ship without republishing the others. * @summary Publish one locale, or all of them * @param {string} recordUuid * @param {string} [locale] * @param {boolean} [allLocales] * @param {*} [options] Override http request option. * @throws {RequiredError} */ publish: (recordUuid: string, locale?: string, allLocales?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Restore a draft snapshot * @param {string} recordUuid * @param {number} index * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreHistory: (recordUuid: string, index: number, locale?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Replace a page draft * @param {string} recordUuid * @param {CmsPageDocument} cmsPageDocument * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ save: (recordUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Update slug, title, excerpt, SEO and page scripts * @param {string} recordUuid * @param {{ [key: string]: any | null; }} requestBody * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveMeta: (recordUuid: string, requestBody: { [key: string]: any | null; }, locale?: string, options?: RawAxiosRequestConfig) => Promise; /** * Merges the new module into the whole npm package so sibling modules are not retired, then swaps this placement with set_module. * @summary Publish the forked module into a private app * @param {string} recordUuid * @param {string} sessionId * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveModuleFork: (recordUuid: string, sessionId: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Replace a CMS v2 object template * @param {string} objectUuid * @param {CmsPageDocument} cmsPageDocument * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveTemplate: (objectUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig) => Promise; /** * CMS v2 companies and pages only. Copies the installed module\'s published source into a playground session. Live code edits stay off the company site until save publishes a platform v2 private-app package and a rebuild compiles it. * @summary Start a Modify-this-module playground session * @param {string} recordUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ startModuleFork: (recordUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Take one locale offline * @param {string} recordUuid * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unpublish: (recordUuid: string, locale?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Remove an environment from this page only * @param {string} recordUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ unselectEnvironment: (recordUuid: string, key: string, options?: RawAxiosRequestConfig) => Promise; /** * Writes test values into the playground session without changing the live page. * @summary Preview field values on the forked module * @param {string} recordUuid * @param {string} sessionId * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateModuleForkFields: (recordUuid: string, sessionId: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig) => Promise; }; /** * CMSV2PagesApi - functional programming interface */ export declare const CMSV2PagesApiFp: (configuration?: Configuration) => { /** * Returns patches the editor applies through the same revision channel as a manual edit, so the change is undoable. Page scope may add, remove and reorder modules. A module\'s code lives in a shared npm package, so the AI rewrites field values and composition, never the component itself. * @summary Rewrite a page or a module from a prompt * @param {string} recordUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ aiRewrite(recordUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Create a translated sibling page for an environment * @param {string} recordUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTranslation(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Discard a Modify-this-module playground session * @param {string} recordUuid * @param {string} sessionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ discardModuleFork(recordUuid: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Finds the page at /404 on the root Webpage object, or creates an empty draft there, and stores it as the company custom 404 page. * @summary Create or reuse the custom 404 page * @param {*} [options] Override http request option. * @throws {RequiredError} */ ensureNotFound(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Environment coverage for the builder dropdown * @param {string} recordUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ environmentCoverage(recordUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Load a page for the builder * @param {string} recordUuid * @param {string} [locale] * @param {string} [state] * @param {*} [options] Override http request option. * @throws {RequiredError} */ get(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary CMS v2 object template document * @param {string} objectUuid * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTemplate(objectUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Draft snapshots for one locale * @param {string} recordUuid * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ history(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Host this page on another environment * @param {string} recordUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ hostOnEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Backs the builder\'s library picker. Only modules from installed apps, and never retired ones, because a new page must be able to render them. * @summary Modules available to this company * @param {*} [options] Override http request option. * @throws {RequiredError} */ library(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Rejected with 409 when expectedRevision does not match, so a stale client cannot overwrite another editor\'s work. * @summary Apply patches to a page draft * @param {string} recordUuid * @param {CmsPagePatchRequest} cmsPagePatchRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patch(recordUuid: string, cmsPagePatchRequest: CmsPagePatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * The iframe renders the draft document, which the public API will not serve. The signature covers the page and an expiry so a leaked link cannot be retargeted or replayed. * @summary Signed preview URL for the builder iframe * @param {string} recordUuid * @param {string} [locale] * @param {string} [state] * @param {*} [options] Override http request option. * @throws {RequiredError} */ previewLink(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Rewrite forked module source from a prompt * @param {string} recordUuid * @param {string} sessionId * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ promptModuleFork(recordUuid: string, sessionId: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Copies the draft over the published document. Publishing is per locale so a translated page can ship without republishing the others. * @summary Publish one locale, or all of them * @param {string} recordUuid * @param {string} [locale] * @param {boolean} [allLocales] * @param {*} [options] Override http request option. * @throws {RequiredError} */ publish(recordUuid: string, locale?: string, allLocales?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Restore a draft snapshot * @param {string} recordUuid * @param {number} index * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreHistory(recordUuid: string, index: number, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Replace a page draft * @param {string} recordUuid * @param {CmsPageDocument} cmsPageDocument * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ save(recordUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update slug, title, excerpt, SEO and page scripts * @param {string} recordUuid * @param {{ [key: string]: any | null; }} requestBody * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveMeta(recordUuid: string, requestBody: { [key: string]: any | null; }, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Merges the new module into the whole npm package so sibling modules are not retired, then swaps this placement with set_module. * @summary Publish the forked module into a private app * @param {string} recordUuid * @param {string} sessionId * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveModuleFork(recordUuid: string, sessionId: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Replace a CMS v2 object template * @param {string} objectUuid * @param {CmsPageDocument} cmsPageDocument * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveTemplate(objectUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * CMS v2 companies and pages only. Copies the installed module\'s published source into a playground session. Live code edits stay off the company site until save publishes a platform v2 private-app package and a rebuild compiles it. * @summary Start a Modify-this-module playground session * @param {string} recordUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ startModuleFork(recordUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Take one locale offline * @param {string} recordUuid * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unpublish(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Remove an environment from this page only * @param {string} recordUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ unselectEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Writes test values into the playground session without changing the live page. * @summary Preview field values on the forked module * @param {string} recordUuid * @param {string} sessionId * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateModuleForkFields(recordUuid: string, sessionId: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CMSV2PagesApi - factory interface */ export declare const CMSV2PagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns patches the editor applies through the same revision channel as a manual edit, so the change is undoable. Page scope may add, remove and reorder modules. A module\'s code lives in a shared npm package, so the AI rewrites field values and composition, never the component itself. * @summary Rewrite a page or a module from a prompt * @param {string} recordUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ aiRewrite(recordUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Create a translated sibling page for an environment * @param {string} recordUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTranslation(recordUuid: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Discard a Modify-this-module playground session * @param {string} recordUuid * @param {string} sessionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ discardModuleFork(recordUuid: string, sessionId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Finds the page at /404 on the root Webpage object, or creates an empty draft there, and stores it as the company custom 404 page. * @summary Create or reuse the custom 404 page * @param {*} [options] Override http request option. * @throws {RequiredError} */ ensureNotFound(options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Environment coverage for the builder dropdown * @param {string} recordUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ environmentCoverage(recordUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Load a page for the builder * @param {string} recordUuid * @param {string} [locale] * @param {string} [state] * @param {*} [options] Override http request option. * @throws {RequiredError} */ get(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary CMS v2 object template document * @param {string} objectUuid * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTemplate(objectUuid: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Draft snapshots for one locale * @param {string} recordUuid * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ history(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Host this page on another environment * @param {string} recordUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ hostOnEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Backs the builder\'s library picker. Only modules from installed apps, and never retired ones, because a new page must be able to render them. * @summary Modules available to this company * @param {*} [options] Override http request option. * @throws {RequiredError} */ library(options?: RawAxiosRequestConfig): AxiosPromise; /** * Rejected with 409 when expectedRevision does not match, so a stale client cannot overwrite another editor\'s work. * @summary Apply patches to a page draft * @param {string} recordUuid * @param {CmsPagePatchRequest} cmsPagePatchRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patch(recordUuid: string, cmsPagePatchRequest: CmsPagePatchRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * The iframe renders the draft document, which the public API will not serve. The signature covers the page and an expiry so a leaked link cannot be retargeted or replayed. * @summary Signed preview URL for the builder iframe * @param {string} recordUuid * @param {string} [locale] * @param {string} [state] * @param {*} [options] Override http request option. * @throws {RequiredError} */ previewLink(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Rewrite forked module source from a prompt * @param {string} recordUuid * @param {string} sessionId * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ promptModuleFork(recordUuid: string, sessionId: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): AxiosPromise; /** * Copies the draft over the published document. Publishing is per locale so a translated page can ship without republishing the others. * @summary Publish one locale, or all of them * @param {string} recordUuid * @param {string} [locale] * @param {boolean} [allLocales] * @param {*} [options] Override http request option. * @throws {RequiredError} */ publish(recordUuid: string, locale?: string, allLocales?: boolean, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Restore a draft snapshot * @param {string} recordUuid * @param {number} index * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreHistory(recordUuid: string, index: number, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Replace a page draft * @param {string} recordUuid * @param {CmsPageDocument} cmsPageDocument * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ save(recordUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Update slug, title, excerpt, SEO and page scripts * @param {string} recordUuid * @param {{ [key: string]: any | null; }} requestBody * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveMeta(recordUuid: string, requestBody: { [key: string]: any | null; }, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Merges the new module into the whole npm package so sibling modules are not retired, then swaps this placement with set_module. * @summary Publish the forked module into a private app * @param {string} recordUuid * @param {string} sessionId * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveModuleFork(recordUuid: string, sessionId: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Replace a CMS v2 object template * @param {string} objectUuid * @param {CmsPageDocument} cmsPageDocument * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveTemplate(objectUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * CMS v2 companies and pages only. Copies the installed module\'s published source into a playground session. Live code edits stay off the company site until save publishes a platform v2 private-app package and a rebuild compiles it. * @summary Start a Modify-this-module playground session * @param {string} recordUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ startModuleFork(recordUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Take one locale offline * @param {string} recordUuid * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unpublish(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Remove an environment from this page only * @param {string} recordUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ unselectEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Writes test values into the playground session without changing the live page. * @summary Preview field values on the forked module * @param {string} recordUuid * @param {string} sessionId * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateModuleForkFields(recordUuid: string, sessionId: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * CMSV2PagesApi - object-oriented interface */ export declare class CMSV2PagesApi extends BaseAPI { /** * Returns patches the editor applies through the same revision channel as a manual edit, so the change is undoable. Page scope may add, remove and reorder modules. A module\'s code lives in a shared npm package, so the AI rewrites field values and composition, never the component itself. * @summary Rewrite a page or a module from a prompt * @param {string} recordUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ aiRewrite(recordUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Create a translated sibling page for an environment * @param {string} recordUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTranslation(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Discard a Modify-this-module playground session * @param {string} recordUuid * @param {string} sessionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ discardModuleFork(recordUuid: string, sessionId: string, options?: RawAxiosRequestConfig): Promise>; /** * Finds the page at /404 on the root Webpage object, or creates an empty draft there, and stores it as the company custom 404 page. * @summary Create or reuse the custom 404 page * @param {*} [options] Override http request option. * @throws {RequiredError} */ ensureNotFound(options?: RawAxiosRequestConfig): Promise>; /** * * @summary Environment coverage for the builder dropdown * @param {string} recordUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ environmentCoverage(recordUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Load a page for the builder * @param {string} recordUuid * @param {string} [locale] * @param {string} [state] * @param {*} [options] Override http request option. * @throws {RequiredError} */ get(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary CMS v2 object template document * @param {string} objectUuid * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTemplate(objectUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Draft snapshots for one locale * @param {string} recordUuid * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ history(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Host this page on another environment * @param {string} recordUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ hostOnEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise>; /** * Backs the builder\'s library picker. Only modules from installed apps, and never retired ones, because a new page must be able to render them. * @summary Modules available to this company * @param {*} [options] Override http request option. * @throws {RequiredError} */ library(options?: RawAxiosRequestConfig): Promise>; /** * Rejected with 409 when expectedRevision does not match, so a stale client cannot overwrite another editor\'s work. * @summary Apply patches to a page draft * @param {string} recordUuid * @param {CmsPagePatchRequest} cmsPagePatchRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patch(recordUuid: string, cmsPagePatchRequest: CmsPagePatchRequest, options?: RawAxiosRequestConfig): Promise>; /** * The iframe renders the draft document, which the public API will not serve. The signature covers the page and an expiry so a leaked link cannot be retargeted or replayed. * @summary Signed preview URL for the builder iframe * @param {string} recordUuid * @param {string} [locale] * @param {string} [state] * @param {*} [options] Override http request option. * @throws {RequiredError} */ previewLink(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Rewrite forked module source from a prompt * @param {string} recordUuid * @param {string} sessionId * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ promptModuleFork(recordUuid: string, sessionId: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise>; /** * Copies the draft over the published document. Publishing is per locale so a translated page can ship without republishing the others. * @summary Publish one locale, or all of them * @param {string} recordUuid * @param {string} [locale] * @param {boolean} [allLocales] * @param {*} [options] Override http request option. * @throws {RequiredError} */ publish(recordUuid: string, locale?: string, allLocales?: boolean, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Restore a draft snapshot * @param {string} recordUuid * @param {number} index * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreHistory(recordUuid: string, index: number, locale?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Replace a page draft * @param {string} recordUuid * @param {CmsPageDocument} cmsPageDocument * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ save(recordUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Update slug, title, excerpt, SEO and page scripts * @param {string} recordUuid * @param {{ [key: string]: any | null; }} requestBody * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveMeta(recordUuid: string, requestBody: { [key: string]: any | null; }, locale?: string, options?: RawAxiosRequestConfig): Promise>; /** * Merges the new module into the whole npm package so sibling modules are not retired, then swaps this placement with set_module. * @summary Publish the forked module into a private app * @param {string} recordUuid * @param {string} sessionId * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveModuleFork(recordUuid: string, sessionId: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Replace a CMS v2 object template * @param {string} objectUuid * @param {CmsPageDocument} cmsPageDocument * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveTemplate(objectUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): Promise>; /** * CMS v2 companies and pages only. Copies the installed module\'s published source into a playground session. Live code edits stay off the company site until save publishes a platform v2 private-app package and a rebuild compiles it. * @summary Start a Modify-this-module playground session * @param {string} recordUuid * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ startModuleFork(recordUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Take one locale offline * @param {string} recordUuid * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unpublish(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Remove an environment from this page only * @param {string} recordUuid * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ unselectEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise>; /** * Writes test values into the playground session without changing the live page. * @summary Preview field values on the forked module * @param {string} recordUuid * @param {string} sessionId * @param {{ [key: string]: any | null; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateModuleForkFields(recordUuid: string, sessionId: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise>; } /** * CMSV2PublicApi - axios parameter creator */ export declare const CMSV2PublicApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Installed app settings with SECRET fields removed * @param {string} xCaraerSubdomain * @param {string} appName * @param {*} [options] Override http request option. * @throws {RequiredError} */ appSettings: (xCaraerSubdomain: string, appName: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Redirect to a company file for the website runtime * @param {string} xCaraerSubdomain * @param {string} key * @param {string} [pageUuid] * @param {string} [environment] * @param {string} [locale] * @param {string} [access] * @param {string} [token] * @param {string} [caraerExpires] * @param {string} [caraerSig] * @param {string} [xCaraerWebpageAccess] * @param {string} [authorization] * @param {*} [options] Override http request option. * @throws {RequiredError} */ asset: (xCaraerSubdomain: string, key: string, pageUuid?: string, environment?: string, locale?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, xCaraerWebpageAccess?: string, authorization?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Installed apps and modules for a company\'s website build * @param {string} xCaraerSubdomain * @param {*} [options] Override http request option. * @throws {RequiredError} */ buildManifest: (xCaraerSubdomain: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Navigation menus for the header and footer * @param {string} xCaraerSubdomain * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ menus: (xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary A published page by URL path * @param {string} xCaraerSubdomain * @param {string} path * @param {string} [xCaraerWebpageAccess] * @param {string} [authorization] * @param {string} [environment] * @param {string} [locale] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pageByPath: (xCaraerSubdomain: string, path: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, access?: string, token?: string, options?: RawAxiosRequestConfig) => Promise; /** * Used by the builder preview, which addresses a page by uuid because a draft may not have a slug yet. * @summary A page by record uuid * @param {string} xCaraerSubdomain * @param {string} uuid * @param {string} [xCaraerWebpageAccess] * @param {string} [authorization] * @param {string} [environment] * @param {string} [locale] * @param {string} [state] * @param {string} [access] * @param {string} [token] * @param {string} [caraerExpires] * @param {string} [caraerSig] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pageByUuid: (xCaraerSubdomain: string, uuid: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, state?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Protection info for a path, without the page document * @param {string} xCaraerSubdomain * @param {string} path * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pageGate: (xCaraerSubdomain: string, path: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Published paths per environment, for sitemaps and cache warming * @param {string} xCaraerSubdomain * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ paths: (xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Public records visible in an environment * @param {string} xCaraerSubdomain * @param {{ [key: string]: any | null; }} requestBody * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ records: (xCaraerSubdomain: string, requestBody: { [key: string]: any | null; }, environment?: string, locale?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Company settings, branding and locales * @param {string} xCaraerSubdomain * @param {*} [options] Override http request option. * @throws {RequiredError} */ settings: (xCaraerSubdomain: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Unlock a password-protected CMS v2 page * @param {string} xCaraerSubdomain * @param {string} uuid * @param {{ [key: string]: string; }} requestBody * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlock: (xCaraerSubdomain: string, uuid: string, requestBody: { [key: string]: string; }, environment?: string, locale?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * CMSV2PublicApi - functional programming interface */ export declare const CMSV2PublicApiFp: (configuration?: Configuration) => { /** * * @summary Installed app settings with SECRET fields removed * @param {string} xCaraerSubdomain * @param {string} appName * @param {*} [options] Override http request option. * @throws {RequiredError} */ appSettings(xCaraerSubdomain: string, appName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Redirect to a company file for the website runtime * @param {string} xCaraerSubdomain * @param {string} key * @param {string} [pageUuid] * @param {string} [environment] * @param {string} [locale] * @param {string} [access] * @param {string} [token] * @param {string} [caraerExpires] * @param {string} [caraerSig] * @param {string} [xCaraerWebpageAccess] * @param {string} [authorization] * @param {*} [options] Override http request option. * @throws {RequiredError} */ asset(xCaraerSubdomain: string, key: string, pageUuid?: string, environment?: string, locale?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, xCaraerWebpageAccess?: string, authorization?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Installed apps and modules for a company\'s website build * @param {string} xCaraerSubdomain * @param {*} [options] Override http request option. * @throws {RequiredError} */ buildManifest(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Navigation menus for the header and footer * @param {string} xCaraerSubdomain * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ menus(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary A published page by URL path * @param {string} xCaraerSubdomain * @param {string} path * @param {string} [xCaraerWebpageAccess] * @param {string} [authorization] * @param {string} [environment] * @param {string} [locale] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pageByPath(xCaraerSubdomain: string, path: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Used by the builder preview, which addresses a page by uuid because a draft may not have a slug yet. * @summary A page by record uuid * @param {string} xCaraerSubdomain * @param {string} uuid * @param {string} [xCaraerWebpageAccess] * @param {string} [authorization] * @param {string} [environment] * @param {string} [locale] * @param {string} [state] * @param {string} [access] * @param {string} [token] * @param {string} [caraerExpires] * @param {string} [caraerSig] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pageByUuid(xCaraerSubdomain: string, uuid: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, state?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Protection info for a path, without the page document * @param {string} xCaraerSubdomain * @param {string} path * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pageGate(xCaraerSubdomain: string, path: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Published paths per environment, for sitemaps and cache warming * @param {string} xCaraerSubdomain * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ paths(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Public records visible in an environment * @param {string} xCaraerSubdomain * @param {{ [key: string]: any | null; }} requestBody * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ records(xCaraerSubdomain: string, requestBody: { [key: string]: any | null; }, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Company settings, branding and locales * @param {string} xCaraerSubdomain * @param {*} [options] Override http request option. * @throws {RequiredError} */ settings(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Unlock a password-protected CMS v2 page * @param {string} xCaraerSubdomain * @param {string} uuid * @param {{ [key: string]: string; }} requestBody * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlock(xCaraerSubdomain: string, uuid: string, requestBody: { [key: string]: string; }, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CMSV2PublicApi - factory interface */ export declare const CMSV2PublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Installed app settings with SECRET fields removed * @param {string} xCaraerSubdomain * @param {string} appName * @param {*} [options] Override http request option. * @throws {RequiredError} */ appSettings(xCaraerSubdomain: string, appName: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Redirect to a company file for the website runtime * @param {string} xCaraerSubdomain * @param {string} key * @param {string} [pageUuid] * @param {string} [environment] * @param {string} [locale] * @param {string} [access] * @param {string} [token] * @param {string} [caraerExpires] * @param {string} [caraerSig] * @param {string} [xCaraerWebpageAccess] * @param {string} [authorization] * @param {*} [options] Override http request option. * @throws {RequiredError} */ asset(xCaraerSubdomain: string, key: string, pageUuid?: string, environment?: string, locale?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, xCaraerWebpageAccess?: string, authorization?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Installed apps and modules for a company\'s website build * @param {string} xCaraerSubdomain * @param {*} [options] Override http request option. * @throws {RequiredError} */ buildManifest(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Navigation menus for the header and footer * @param {string} xCaraerSubdomain * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ menus(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary A published page by URL path * @param {string} xCaraerSubdomain * @param {string} path * @param {string} [xCaraerWebpageAccess] * @param {string} [authorization] * @param {string} [environment] * @param {string} [locale] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pageByPath(xCaraerSubdomain: string, path: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Used by the builder preview, which addresses a page by uuid because a draft may not have a slug yet. * @summary A page by record uuid * @param {string} xCaraerSubdomain * @param {string} uuid * @param {string} [xCaraerWebpageAccess] * @param {string} [authorization] * @param {string} [environment] * @param {string} [locale] * @param {string} [state] * @param {string} [access] * @param {string} [token] * @param {string} [caraerExpires] * @param {string} [caraerSig] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pageByUuid(xCaraerSubdomain: string, uuid: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, state?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Protection info for a path, without the page document * @param {string} xCaraerSubdomain * @param {string} path * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pageGate(xCaraerSubdomain: string, path: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Published paths per environment, for sitemaps and cache warming * @param {string} xCaraerSubdomain * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ paths(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Public records visible in an environment * @param {string} xCaraerSubdomain * @param {{ [key: string]: any | null; }} requestBody * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ records(xCaraerSubdomain: string, requestBody: { [key: string]: any | null; }, environment?: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Company settings, branding and locales * @param {string} xCaraerSubdomain * @param {*} [options] Override http request option. * @throws {RequiredError} */ settings(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Unlock a password-protected CMS v2 page * @param {string} xCaraerSubdomain * @param {string} uuid * @param {{ [key: string]: string; }} requestBody * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlock(xCaraerSubdomain: string, uuid: string, requestBody: { [key: string]: string; }, environment?: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * CMSV2PublicApi - object-oriented interface */ export declare class CMSV2PublicApi extends BaseAPI { /** * * @summary Installed app settings with SECRET fields removed * @param {string} xCaraerSubdomain * @param {string} appName * @param {*} [options] Override http request option. * @throws {RequiredError} */ appSettings(xCaraerSubdomain: string, appName: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Redirect to a company file for the website runtime * @param {string} xCaraerSubdomain * @param {string} key * @param {string} [pageUuid] * @param {string} [environment] * @param {string} [locale] * @param {string} [access] * @param {string} [token] * @param {string} [caraerExpires] * @param {string} [caraerSig] * @param {string} [xCaraerWebpageAccess] * @param {string} [authorization] * @param {*} [options] Override http request option. * @throws {RequiredError} */ asset(xCaraerSubdomain: string, key: string, pageUuid?: string, environment?: string, locale?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, xCaraerWebpageAccess?: string, authorization?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Installed apps and modules for a company\'s website build * @param {string} xCaraerSubdomain * @param {*} [options] Override http request option. * @throws {RequiredError} */ buildManifest(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Navigation menus for the header and footer * @param {string} xCaraerSubdomain * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ menus(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary A published page by URL path * @param {string} xCaraerSubdomain * @param {string} path * @param {string} [xCaraerWebpageAccess] * @param {string} [authorization] * @param {string} [environment] * @param {string} [locale] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pageByPath(xCaraerSubdomain: string, path: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise>; /** * Used by the builder preview, which addresses a page by uuid because a draft may not have a slug yet. * @summary A page by record uuid * @param {string} xCaraerSubdomain * @param {string} uuid * @param {string} [xCaraerWebpageAccess] * @param {string} [authorization] * @param {string} [environment] * @param {string} [locale] * @param {string} [state] * @param {string} [access] * @param {string} [token] * @param {string} [caraerExpires] * @param {string} [caraerSig] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pageByUuid(xCaraerSubdomain: string, uuid: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, state?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Protection info for a path, without the page document * @param {string} xCaraerSubdomain * @param {string} path * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pageGate(xCaraerSubdomain: string, path: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Published paths per environment, for sitemaps and cache warming * @param {string} xCaraerSubdomain * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ paths(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Public records visible in an environment * @param {string} xCaraerSubdomain * @param {{ [key: string]: any | null; }} requestBody * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ records(xCaraerSubdomain: string, requestBody: { [key: string]: any | null; }, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Company settings, branding and locales * @param {string} xCaraerSubdomain * @param {*} [options] Override http request option. * @throws {RequiredError} */ settings(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Unlock a password-protected CMS v2 page * @param {string} xCaraerSubdomain * @param {string} uuid * @param {{ [key: string]: string; }} requestBody * @param {string} [environment] * @param {string} [locale] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlock(xCaraerSubdomain: string, uuid: string, requestBody: { [key: string]: string; }, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise>; } /** * CMSV2TransferApi - axios parameter creator */ export declare const CMSV2TransferApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Attach a manually created caraer-web project * @param {string} companyUuid * @param {{ [key: string]: string; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ attach: (companyUuid: string, requestBody: { [key: string]: string; }, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Switch the live site to CMS v2: schema, caraer-web repo, and hostname * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ cutover: (companyUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Restore the live hostname to the stored v1 project * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ rollback: (companyUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Transfer status for one company * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ status: (companyUuid: string, options?: RawAxiosRequestConfig) => Promise; }; /** * CMSV2TransferApi - functional programming interface */ export declare const CMSV2TransferApiFp: (configuration?: Configuration) => { /** * * @summary Attach a manually created caraer-web project * @param {string} companyUuid * @param {{ [key: string]: string; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ attach(companyUuid: string, requestBody: { [key: string]: string; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Switch the live site to CMS v2: schema, caraer-web repo, and hostname * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ cutover(companyUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Restore the live hostname to the stored v1 project * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ rollback(companyUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Transfer status for one company * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ status(companyUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CMSV2TransferApi - factory interface */ export declare const CMSV2TransferApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Attach a manually created caraer-web project * @param {string} companyUuid * @param {{ [key: string]: string; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ attach(companyUuid: string, requestBody: { [key: string]: string; }, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Switch the live site to CMS v2: schema, caraer-web repo, and hostname * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ cutover(companyUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Restore the live hostname to the stored v1 project * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ rollback(companyUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Transfer status for one company * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ status(companyUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * CMSV2TransferApi - object-oriented interface */ export declare class CMSV2TransferApi extends BaseAPI { /** * * @summary Attach a manually created caraer-web project * @param {string} companyUuid * @param {{ [key: string]: string; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ attach(companyUuid: string, requestBody: { [key: string]: string; }, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Switch the live site to CMS v2: schema, caraer-web repo, and hostname * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ cutover(companyUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Restore the live hostname to the stored v1 project * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ rollback(companyUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Transfer status for one company * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ status(companyUuid: string, options?: RawAxiosRequestConfig): Promise>; } /** * CalendarsApi - axios parameter creator */ export declare const CalendarsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Ensure calendar schema, default calendar, and event backfill * @param {*} [options] Override http request option. * @throws {RequiredError} */ bootstrap: (options?: RawAxiosRequestConfig) => Promise; /** * * @summary Create a calendar owned by the current user * @param {CalendarCreateRequest} calendarCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create4: (calendarCreateRequest: CalendarCreateRequest, options?: RawAxiosRequestConfig) => Promise; /** * * @summary List calendars visible to the current company * @param {*} [options] Override http request option. * @throws {RequiredError} */ list3: (options?: RawAxiosRequestConfig) => Promise; /** * * @summary List teams that can be linked to a calendar * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTeams: (options?: RawAxiosRequestConfig) => Promise; }; /** * CalendarsApi - functional programming interface */ export declare const CalendarsApiFp: (configuration?: Configuration) => { /** * * @summary Ensure calendar schema, default calendar, and event backfill * @param {*} [options] Override http request option. * @throws {RequiredError} */ bootstrap(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Create a calendar owned by the current user * @param {CalendarCreateRequest} calendarCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create4(calendarCreateRequest: CalendarCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List calendars visible to the current company * @param {*} [options] Override http request option. * @throws {RequiredError} */ list3(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List teams that can be linked to a calendar * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTeams(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CalendarsApi - factory interface */ export declare const CalendarsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Ensure calendar schema, default calendar, and event backfill * @param {*} [options] Override http request option. * @throws {RequiredError} */ bootstrap(options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Create a calendar owned by the current user * @param {CalendarCreateRequest} calendarCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create4(calendarCreateRequest: CalendarCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary List calendars visible to the current company * @param {*} [options] Override http request option. * @throws {RequiredError} */ list3(options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary List teams that can be linked to a calendar * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTeams(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * CalendarsApi - object-oriented interface */ export declare class CalendarsApi extends BaseAPI { /** * * @summary Ensure calendar schema, default calendar, and event backfill * @param {*} [options] Override http request option. * @throws {RequiredError} */ bootstrap(options?: RawAxiosRequestConfig): Promise>; /** * * @summary Create a calendar owned by the current user * @param {CalendarCreateRequest} calendarCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create4(calendarCreateRequest: CalendarCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * * @summary List calendars visible to the current company * @param {*} [options] Override http request option. * @throws {RequiredError} */ list3(options?: RawAxiosRequestConfig): Promise>; /** * * @summary List teams that can be linked to a calendar * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTeams(options?: RawAxiosRequestConfig): Promise>; } /** * CompanyApi - axios parameter creator */ export declare const CompanyApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new company based on the provided request data. * @summary Create a new company * @param {CreateCompanyRequest} createCompanyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCompany: (createCompanyRequest: CreateCompanyRequest, options?: RawAxiosRequestConfig) => Promise; /** * Returns the company currently selected by the logged-in user. Requires TOOLS_COMPANY_SETTINGS_READ scope. * @summary Get current company * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompany: (options?: RawAxiosRequestConfig) => Promise; /** * Returns a company by its UUID. Requires TOOLS_COMPANY_SETTINGS_READ scope. * @summary Get company by UUID * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompanyByUuid: (uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the digital identity (branding) for the company currently selected by the logged-in user. * @summary Get digital identity * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDigitalIdentity: (options?: RawAxiosRequestConfig) => Promise; /** * Returns the home analytics dashboard for a suite. Empty dashboard when none is saved. * @summary Get suite dashboard * @param {string} suiteName * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSuiteDashboard: (suiteName: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns all home analytics dashboards keyed by suite name for the selected company. * @summary List suite dashboards * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSuiteDashboards: (options?: RawAxiosRequestConfig) => Promise; /** * Returns the website settings for the company currently selected by the logged-in user. * @summary Get website settings * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebsiteSettings: (options?: RawAxiosRequestConfig) => Promise; /** * Clears the per-company webhook circuit breaker so outbound deliveries resume immediately. * @summary Resume webhook dispatch * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ resumeWebhookDispatch: (companyUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates a company by UUID. Request body should contain the company fields to update. * @summary Update company * @param {string} uuid * @param {CompanyDTO} companyDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCompany: (uuid: string, companyDTO: CompanyDTO, options?: RawAxiosRequestConfig) => Promise; /** * Updates the digital identity (branding) for the company currently selected by the logged-in user. * @summary Update digital identity * @param {DigitalIdentityDTO} digitalIdentityDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDigitalIdentity: (digitalIdentityDTO: DigitalIdentityDTO, options?: RawAxiosRequestConfig) => Promise; /** * Creates or replaces the home analytics dashboard for a suite. * @summary Update suite dashboard * @param {string} suiteName * @param {AnalyticsDashboardConfig} analyticsDashboardConfig * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSuiteDashboard: (suiteName: string, analyticsDashboardConfig: AnalyticsDashboardConfig, options?: RawAxiosRequestConfig) => Promise; /** * Updates the website settings for the company currently selected by the logged-in user. * @summary Update website settings * @param {WebsiteSettingsDTO} websiteSettingsDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebsiteSettings: (websiteSettingsDTO: WebsiteSettingsDTO, options?: RawAxiosRequestConfig) => Promise; /** * Uploads a font file to S3 storage and returns the public URL. * @summary Upload a font file * @param {File} file * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFont: (file: File, options?: RawAxiosRequestConfig) => Promise; }; /** * CompanyApi - functional programming interface */ export declare const CompanyApiFp: (configuration?: Configuration) => { /** * Creates a new company based on the provided request data. * @summary Create a new company * @param {CreateCompanyRequest} createCompanyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCompany(createCompanyRequest: CreateCompanyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the company currently selected by the logged-in user. Requires TOOLS_COMPANY_SETTINGS_READ scope. * @summary Get current company * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompany(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a company by its UUID. Requires TOOLS_COMPANY_SETTINGS_READ scope. * @summary Get company by UUID * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompanyByUuid(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the digital identity (branding) for the company currently selected by the logged-in user. * @summary Get digital identity * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDigitalIdentity(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the home analytics dashboard for a suite. Empty dashboard when none is saved. * @summary Get suite dashboard * @param {string} suiteName * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSuiteDashboard(suiteName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns all home analytics dashboards keyed by suite name for the selected company. * @summary List suite dashboards * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSuiteDashboards(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the website settings for the company currently selected by the logged-in user. * @summary Get website settings * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebsiteSettings(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Clears the per-company webhook circuit breaker so outbound deliveries resume immediately. * @summary Resume webhook dispatch * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ resumeWebhookDispatch(companyUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates a company by UUID. Request body should contain the company fields to update. * @summary Update company * @param {string} uuid * @param {CompanyDTO} companyDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCompany(uuid: string, companyDTO: CompanyDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the digital identity (branding) for the company currently selected by the logged-in user. * @summary Update digital identity * @param {DigitalIdentityDTO} digitalIdentityDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDigitalIdentity(digitalIdentityDTO: DigitalIdentityDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates or replaces the home analytics dashboard for a suite. * @summary Update suite dashboard * @param {string} suiteName * @param {AnalyticsDashboardConfig} analyticsDashboardConfig * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSuiteDashboard(suiteName: string, analyticsDashboardConfig: AnalyticsDashboardConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the website settings for the company currently selected by the logged-in user. * @summary Update website settings * @param {WebsiteSettingsDTO} websiteSettingsDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebsiteSettings(websiteSettingsDTO: WebsiteSettingsDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Uploads a font file to S3 storage and returns the public URL. * @summary Upload a font file * @param {File} file * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFont(file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CompanyApi - factory interface */ export declare const CompanyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new company based on the provided request data. * @summary Create a new company * @param {CreateCompanyRequest} createCompanyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCompany(createCompanyRequest: CreateCompanyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the company currently selected by the logged-in user. Requires TOOLS_COMPANY_SETTINGS_READ scope. * @summary Get current company * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompany(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a company by its UUID. Requires TOOLS_COMPANY_SETTINGS_READ scope. * @summary Get company by UUID * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompanyByUuid(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the digital identity (branding) for the company currently selected by the logged-in user. * @summary Get digital identity * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDigitalIdentity(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the home analytics dashboard for a suite. Empty dashboard when none is saved. * @summary Get suite dashboard * @param {string} suiteName * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSuiteDashboard(suiteName: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns all home analytics dashboards keyed by suite name for the selected company. * @summary List suite dashboards * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSuiteDashboards(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the website settings for the company currently selected by the logged-in user. * @summary Get website settings * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebsiteSettings(options?: RawAxiosRequestConfig): AxiosPromise; /** * Clears the per-company webhook circuit breaker so outbound deliveries resume immediately. * @summary Resume webhook dispatch * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ resumeWebhookDispatch(companyUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates a company by UUID. Request body should contain the company fields to update. * @summary Update company * @param {string} uuid * @param {CompanyDTO} companyDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCompany(uuid: string, companyDTO: CompanyDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the digital identity (branding) for the company currently selected by the logged-in user. * @summary Update digital identity * @param {DigitalIdentityDTO} digitalIdentityDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDigitalIdentity(digitalIdentityDTO: DigitalIdentityDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates or replaces the home analytics dashboard for a suite. * @summary Update suite dashboard * @param {string} suiteName * @param {AnalyticsDashboardConfig} analyticsDashboardConfig * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSuiteDashboard(suiteName: string, analyticsDashboardConfig: AnalyticsDashboardConfig, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the website settings for the company currently selected by the logged-in user. * @summary Update website settings * @param {WebsiteSettingsDTO} websiteSettingsDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebsiteSettings(websiteSettingsDTO: WebsiteSettingsDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Uploads a font file to S3 storage and returns the public URL. * @summary Upload a font file * @param {File} file * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFont(file: File, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * CompanyApi - object-oriented interface */ export declare class CompanyApi extends BaseAPI { /** * Creates a new company based on the provided request data. * @summary Create a new company * @param {CreateCompanyRequest} createCompanyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCompany(createCompanyRequest: CreateCompanyRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the company currently selected by the logged-in user. Requires TOOLS_COMPANY_SETTINGS_READ scope. * @summary Get current company * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompany(options?: RawAxiosRequestConfig): Promise>; /** * Returns a company by its UUID. Requires TOOLS_COMPANY_SETTINGS_READ scope. * @summary Get company by UUID * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompanyByUuid(uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns the digital identity (branding) for the company currently selected by the logged-in user. * @summary Get digital identity * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDigitalIdentity(options?: RawAxiosRequestConfig): Promise>; /** * Returns the home analytics dashboard for a suite. Empty dashboard when none is saved. * @summary Get suite dashboard * @param {string} suiteName * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSuiteDashboard(suiteName: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns all home analytics dashboards keyed by suite name for the selected company. * @summary List suite dashboards * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSuiteDashboards(options?: RawAxiosRequestConfig): Promise>; /** * Returns the website settings for the company currently selected by the logged-in user. * @summary Get website settings * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebsiteSettings(options?: RawAxiosRequestConfig): Promise>; /** * Clears the per-company webhook circuit breaker so outbound deliveries resume immediately. * @summary Resume webhook dispatch * @param {string} companyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ resumeWebhookDispatch(companyUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Updates a company by UUID. Request body should contain the company fields to update. * @summary Update company * @param {string} uuid * @param {CompanyDTO} companyDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCompany(uuid: string, companyDTO: CompanyDTO, options?: RawAxiosRequestConfig): Promise>; /** * Updates the digital identity (branding) for the company currently selected by the logged-in user. * @summary Update digital identity * @param {DigitalIdentityDTO} digitalIdentityDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDigitalIdentity(digitalIdentityDTO: DigitalIdentityDTO, options?: RawAxiosRequestConfig): Promise>; /** * Creates or replaces the home analytics dashboard for a suite. * @summary Update suite dashboard * @param {string} suiteName * @param {AnalyticsDashboardConfig} analyticsDashboardConfig * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSuiteDashboard(suiteName: string, analyticsDashboardConfig: AnalyticsDashboardConfig, options?: RawAxiosRequestConfig): Promise>; /** * Updates the website settings for the company currently selected by the logged-in user. * @summary Update website settings * @param {WebsiteSettingsDTO} websiteSettingsDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebsiteSettings(websiteSettingsDTO: WebsiteSettingsDTO, options?: RawAxiosRequestConfig): Promise>; /** * Uploads a font file to S3 storage and returns the public URL. * @summary Upload a font file * @param {File} file * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFont(file: File, options?: RawAxiosRequestConfig): Promise>; } /** * DeveloperProjectsApi - axios parameter creator */ export declare const DeveloperProjectsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a developer project linked to the given app, or returns the existing one if already linked. Creator company only. * @summary Create or fetch a developer project * @param {CreateDeveloperProjectRequest} createDeveloperProjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create2: (createDeveloperProjectRequest: CreateDeveloperProjectRequest, options?: RawAxiosRequestConfig) => Promise; /** * Decodes a base64-encoded project archive, parses its manifest, uploads it to Cloud Storage, and records an immutable build. * @summary Upload a project build * @param {string} projectUuid UUID of the developer project * @param {CreateProjectBuildRequest} createProjectBuildRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBuild: (projectUuid: string, createProjectBuildRequest: CreateProjectBuildRequest, options?: RawAxiosRequestConfig) => Promise; /** * Reconciles the build\'s manifest (app details, serverless functions, webhooks, schedules, inbound routes, external OAuth providers) against the linked app. Set prune=true to soft-delete remote resources absent from the archive. * @summary Deploy a project build * @param {string} projectUuid UUID of the developer project * @param {string} buildUuid UUID of the build to deploy * @param {DeployBuildRequest} [deployBuildRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deploy: (projectUuid: string, buildUuid: string, deployBuildRequest?: DeployBuildRequest, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get a project build * @param {string} projectUuid UUID of the developer project * @param {string} buildUuid UUID of the build * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBuild: (projectUuid: string, buildUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary List project builds * @param {string} projectUuid UUID of the developer project * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBuilds: (projectUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary List project deploys * @param {string} projectUuid UUID of the developer project * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeploys: (projectUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get a developer project * @param {string} uuid UUID of the developer project * @param {*} [options] Override http request option. * @throws {RequiredError} */ show3: (uuid: string, options?: RawAxiosRequestConfig) => Promise; }; /** * DeveloperProjectsApi - functional programming interface */ export declare const DeveloperProjectsApiFp: (configuration?: Configuration) => { /** * Creates a developer project linked to the given app, or returns the existing one if already linked. Creator company only. * @summary Create or fetch a developer project * @param {CreateDeveloperProjectRequest} createDeveloperProjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create2(createDeveloperProjectRequest: CreateDeveloperProjectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Decodes a base64-encoded project archive, parses its manifest, uploads it to Cloud Storage, and records an immutable build. * @summary Upload a project build * @param {string} projectUuid UUID of the developer project * @param {CreateProjectBuildRequest} createProjectBuildRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBuild(projectUuid: string, createProjectBuildRequest: CreateProjectBuildRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Reconciles the build\'s manifest (app details, serverless functions, webhooks, schedules, inbound routes, external OAuth providers) against the linked app. Set prune=true to soft-delete remote resources absent from the archive. * @summary Deploy a project build * @param {string} projectUuid UUID of the developer project * @param {string} buildUuid UUID of the build to deploy * @param {DeployBuildRequest} [deployBuildRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deploy(projectUuid: string, buildUuid: string, deployBuildRequest?: DeployBuildRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get a project build * @param {string} projectUuid UUID of the developer project * @param {string} buildUuid UUID of the build * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBuild(projectUuid: string, buildUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List project builds * @param {string} projectUuid UUID of the developer project * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBuilds(projectUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List project deploys * @param {string} projectUuid UUID of the developer project * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeploys(projectUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get a developer project * @param {string} uuid UUID of the developer project * @param {*} [options] Override http request option. * @throws {RequiredError} */ show3(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DeveloperProjectsApi - factory interface */ export declare const DeveloperProjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a developer project linked to the given app, or returns the existing one if already linked. Creator company only. * @summary Create or fetch a developer project * @param {CreateDeveloperProjectRequest} createDeveloperProjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create2(createDeveloperProjectRequest: CreateDeveloperProjectRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Decodes a base64-encoded project archive, parses its manifest, uploads it to Cloud Storage, and records an immutable build. * @summary Upload a project build * @param {string} projectUuid UUID of the developer project * @param {CreateProjectBuildRequest} createProjectBuildRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBuild(projectUuid: string, createProjectBuildRequest: CreateProjectBuildRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Reconciles the build\'s manifest (app details, serverless functions, webhooks, schedules, inbound routes, external OAuth providers) against the linked app. Set prune=true to soft-delete remote resources absent from the archive. * @summary Deploy a project build * @param {string} projectUuid UUID of the developer project * @param {string} buildUuid UUID of the build to deploy * @param {DeployBuildRequest} [deployBuildRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deploy(projectUuid: string, buildUuid: string, deployBuildRequest?: DeployBuildRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get a project build * @param {string} projectUuid UUID of the developer project * @param {string} buildUuid UUID of the build * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBuild(projectUuid: string, buildUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary List project builds * @param {string} projectUuid UUID of the developer project * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBuilds(projectUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary List project deploys * @param {string} projectUuid UUID of the developer project * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeploys(projectUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get a developer project * @param {string} uuid UUID of the developer project * @param {*} [options] Override http request option. * @throws {RequiredError} */ show3(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * DeveloperProjectsApi - object-oriented interface */ export declare class DeveloperProjectsApi extends BaseAPI { /** * Creates a developer project linked to the given app, or returns the existing one if already linked. Creator company only. * @summary Create or fetch a developer project * @param {CreateDeveloperProjectRequest} createDeveloperProjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create2(createDeveloperProjectRequest: CreateDeveloperProjectRequest, options?: RawAxiosRequestConfig): Promise>; /** * Decodes a base64-encoded project archive, parses its manifest, uploads it to Cloud Storage, and records an immutable build. * @summary Upload a project build * @param {string} projectUuid UUID of the developer project * @param {CreateProjectBuildRequest} createProjectBuildRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBuild(projectUuid: string, createProjectBuildRequest: CreateProjectBuildRequest, options?: RawAxiosRequestConfig): Promise>; /** * Reconciles the build\'s manifest (app details, serverless functions, webhooks, schedules, inbound routes, external OAuth providers) against the linked app. Set prune=true to soft-delete remote resources absent from the archive. * @summary Deploy a project build * @param {string} projectUuid UUID of the developer project * @param {string} buildUuid UUID of the build to deploy * @param {DeployBuildRequest} [deployBuildRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deploy(projectUuid: string, buildUuid: string, deployBuildRequest?: DeployBuildRequest, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get a project build * @param {string} projectUuid UUID of the developer project * @param {string} buildUuid UUID of the build * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBuild(projectUuid: string, buildUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary List project builds * @param {string} projectUuid UUID of the developer project * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBuilds(projectUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary List project deploys * @param {string} projectUuid UUID of the developer project * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeploys(projectUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get a developer project * @param {string} uuid UUID of the developer project * @param {*} [options] Override http request option. * @throws {RequiredError} */ show3(uuid: string, options?: RawAxiosRequestConfig): Promise>; } /** * DeveloperSandboxesApi - axios parameter creator */ export declare const DeveloperSandboxesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Clones the selected company\'s Neo4j database (no new Company node). Activate with X-Caraer-Sandbox-Uuid; company identity stays the owner. * @summary Create a developer sandbox * @param {CreateDeveloperSandboxRequest} createDeveloperSandboxRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create1: (createDeveloperSandboxRequest: CreateDeveloperSandboxRequest, options?: RawAxiosRequestConfig) => Promise; /** * Lists sandboxes owned by the caller\'s selected company. * @summary List developer sandboxes * @param {*} [options] Override http request option. * @throws {RequiredError} */ list1: (options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get a developer sandbox * @param {string} uuid UUID of the sandbox * @param {*} [options] Override http request option. * @throws {RequiredError} */ show2: (uuid: string, options?: RawAxiosRequestConfig) => Promise; }; /** * DeveloperSandboxesApi - functional programming interface */ export declare const DeveloperSandboxesApiFp: (configuration?: Configuration) => { /** * Clones the selected company\'s Neo4j database (no new Company node). Activate with X-Caraer-Sandbox-Uuid; company identity stays the owner. * @summary Create a developer sandbox * @param {CreateDeveloperSandboxRequest} createDeveloperSandboxRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create1(createDeveloperSandboxRequest: CreateDeveloperSandboxRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists sandboxes owned by the caller\'s selected company. * @summary List developer sandboxes * @param {*} [options] Override http request option. * @throws {RequiredError} */ list1(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get a developer sandbox * @param {string} uuid UUID of the sandbox * @param {*} [options] Override http request option. * @throws {RequiredError} */ show2(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DeveloperSandboxesApi - factory interface */ export declare const DeveloperSandboxesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Clones the selected company\'s Neo4j database (no new Company node). Activate with X-Caraer-Sandbox-Uuid; company identity stays the owner. * @summary Create a developer sandbox * @param {CreateDeveloperSandboxRequest} createDeveloperSandboxRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create1(createDeveloperSandboxRequest: CreateDeveloperSandboxRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists sandboxes owned by the caller\'s selected company. * @summary List developer sandboxes * @param {*} [options] Override http request option. * @throws {RequiredError} */ list1(options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get a developer sandbox * @param {string} uuid UUID of the sandbox * @param {*} [options] Override http request option. * @throws {RequiredError} */ show2(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * DeveloperSandboxesApi - object-oriented interface */ export declare class DeveloperSandboxesApi extends BaseAPI { /** * Clones the selected company\'s Neo4j database (no new Company node). Activate with X-Caraer-Sandbox-Uuid; company identity stays the owner. * @summary Create a developer sandbox * @param {CreateDeveloperSandboxRequest} createDeveloperSandboxRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create1(createDeveloperSandboxRequest: CreateDeveloperSandboxRequest, options?: RawAxiosRequestConfig): Promise>; /** * Lists sandboxes owned by the caller\'s selected company. * @summary List developer sandboxes * @param {*} [options] Override http request option. * @throws {RequiredError} */ list1(options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get a developer sandbox * @param {string} uuid UUID of the sandbox * @param {*} [options] Override http request option. * @throws {RequiredError} */ show2(uuid: string, options?: RawAxiosRequestConfig): Promise>; } /** * FeedsApi - axios parameter creator */ export declare const FeedsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary List feeds * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ index1: (paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * FeedsApi - functional programming interface */ export declare const FeedsApiFp: (configuration?: Configuration) => { /** * * @summary List feeds * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ index1(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FeedsApi - factory interface */ export declare const FeedsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary List feeds * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ index1(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * FeedsApi - object-oriented interface */ export declare class FeedsApi extends BaseAPI { /** * * @summary List feeds * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ index1(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; } /** * FileManagementApi - axios parameter creator */ export declare const FileManagementApiAxiosParamCreator: (configuration?: Configuration) => { /** * Deletes a file from the S3-compatible storage identified by its unique key. * @summary Delete file * @param {string} key The key of the file to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFile: (key: string, options?: RawAxiosRequestConfig) => Promise; /** * Generates a pre-signed URL to download a file stored in S3-compatible storage. The URL expiry time and download behavior can be specified using the query parameters. * @summary Download file * @param {string} key The key of the file to download. * @param {number} [expireAfter] The URL expiry period in seconds. * @param {boolean} [download] Whether to download the file in the browser. * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadFile: (key: string, expireAfter?: number, download?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Lists all files stored in the system or, if a record UUID is provided, lists the files related to that record. * @summary List files * @param {string} [recordUuid] An optional record UUID to filter files. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFiles: (recordUuid?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary List company files with metadata for the media library * @param {string} [recordUuid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLibrary: (recordUuid?: string, options?: RawAxiosRequestConfig) => Promise; /** * Uploads multiple files to an S3-compatible storage and returns their unique keys. The request must contain one or more files in multipart/form-data format. * @summary Upload files * @param {string} [recordUuid] Optional record UUID to directly link uploaded files as attachments. * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFile2: (recordUuid?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * FileManagementApi - functional programming interface */ export declare const FileManagementApiFp: (configuration?: Configuration) => { /** * Deletes a file from the S3-compatible storage identified by its unique key. * @summary Delete file * @param {string} key The key of the file to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFile(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generates a pre-signed URL to download a file stored in S3-compatible storage. The URL expiry time and download behavior can be specified using the query parameters. * @summary Download file * @param {string} key The key of the file to download. * @param {number} [expireAfter] The URL expiry period in seconds. * @param {boolean} [download] Whether to download the file in the browser. * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadFile(key: string, expireAfter?: number, download?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists all files stored in the system or, if a record UUID is provided, lists the files related to that record. * @summary List files * @param {string} [recordUuid] An optional record UUID to filter files. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFiles(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List company files with metadata for the media library * @param {string} [recordUuid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLibrary(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Uploads multiple files to an S3-compatible storage and returns their unique keys. The request must contain one or more files in multipart/form-data format. * @summary Upload files * @param {string} [recordUuid] Optional record UUID to directly link uploaded files as attachments. * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFile2(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FileManagementApi - factory interface */ export declare const FileManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Deletes a file from the S3-compatible storage identified by its unique key. * @summary Delete file * @param {string} key The key of the file to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFile(key: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Generates a pre-signed URL to download a file stored in S3-compatible storage. The URL expiry time and download behavior can be specified using the query parameters. * @summary Download file * @param {string} key The key of the file to download. * @param {number} [expireAfter] The URL expiry period in seconds. * @param {boolean} [download] Whether to download the file in the browser. * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadFile(key: string, expireAfter?: number, download?: boolean, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists all files stored in the system or, if a record UUID is provided, lists the files related to that record. * @summary List files * @param {string} [recordUuid] An optional record UUID to filter files. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFiles(recordUuid?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary List company files with metadata for the media library * @param {string} [recordUuid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLibrary(recordUuid?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Uploads multiple files to an S3-compatible storage and returns their unique keys. The request must contain one or more files in multipart/form-data format. * @summary Upload files * @param {string} [recordUuid] Optional record UUID to directly link uploaded files as attachments. * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFile2(recordUuid?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * FileManagementApi - object-oriented interface */ export declare class FileManagementApi extends BaseAPI { /** * Deletes a file from the S3-compatible storage identified by its unique key. * @summary Delete file * @param {string} key The key of the file to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFile(key: string, options?: RawAxiosRequestConfig): Promise>; /** * Generates a pre-signed URL to download a file stored in S3-compatible storage. The URL expiry time and download behavior can be specified using the query parameters. * @summary Download file * @param {string} key The key of the file to download. * @param {number} [expireAfter] The URL expiry period in seconds. * @param {boolean} [download] Whether to download the file in the browser. * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadFile(key: string, expireAfter?: number, download?: boolean, options?: RawAxiosRequestConfig): Promise>; /** * Lists all files stored in the system or, if a record UUID is provided, lists the files related to that record. * @summary List files * @param {string} [recordUuid] An optional record UUID to filter files. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFiles(recordUuid?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary List company files with metadata for the media library * @param {string} [recordUuid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLibrary(recordUuid?: string, options?: RawAxiosRequestConfig): Promise>; /** * Uploads multiple files to an S3-compatible storage and returns their unique keys. The request must contain one or more files in multipart/form-data format. * @summary Upload files * @param {string} [recordUuid] Optional record UUID to directly link uploaded files as attachments. * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFile2(recordUuid?: string, options?: RawAxiosRequestConfig): Promise>; } /** * FilterApi - axios parameter creator */ export declare const FilterApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new saved filter with the provided configuration. * @summary Create a new saved filter * @param {SavedFilterDTO} savedFilterDTO Saved filter details for creation * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFilter: (savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig) => Promise; /** * Soft deletes a saved filter identified by its UUID. * @summary Delete a saved filter * @param {string} filterUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFilter: (filterUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves details of a saved filter by its UUID. * @summary Fetch a specific saved filter * @param {string} filterUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFilter: (filterUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Fetches a paginated list of saved filters. The request body should contain pagination details such as limit, page, filters, and sort. * @summary Fetch paginated saved filters * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination request details * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFilters: (objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Updates an existing saved filter identified by its UUID. * @summary Update an existing saved filter * @param {string} filterUuid * @param {SavedFilterDTO} savedFilterDTO Updated saved filter details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFilter: (filterUuid: string, savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig) => Promise; }; /** * FilterApi - functional programming interface */ export declare const FilterApiFp: (configuration?: Configuration) => { /** * Creates a new saved filter with the provided configuration. * @summary Create a new saved filter * @param {SavedFilterDTO} savedFilterDTO Saved filter details for creation * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFilter(savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Soft deletes a saved filter identified by its UUID. * @summary Delete a saved filter * @param {string} filterUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFilter(filterUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves details of a saved filter by its UUID. * @summary Fetch a specific saved filter * @param {string} filterUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFilter(filterUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches a paginated list of saved filters. The request body should contain pagination details such as limit, page, filters, and sort. * @summary Fetch paginated saved filters * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination request details * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFilters(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates an existing saved filter identified by its UUID. * @summary Update an existing saved filter * @param {string} filterUuid * @param {SavedFilterDTO} savedFilterDTO Updated saved filter details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFilter(filterUuid: string, savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FilterApi - factory interface */ export declare const FilterApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new saved filter with the provided configuration. * @summary Create a new saved filter * @param {SavedFilterDTO} savedFilterDTO Saved filter details for creation * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFilter(savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Soft deletes a saved filter identified by its UUID. * @summary Delete a saved filter * @param {string} filterUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFilter(filterUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves details of a saved filter by its UUID. * @summary Fetch a specific saved filter * @param {string} filterUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFilter(filterUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a paginated list of saved filters. The request body should contain pagination details such as limit, page, filters, and sort. * @summary Fetch paginated saved filters * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination request details * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFilters(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates an existing saved filter identified by its UUID. * @summary Update an existing saved filter * @param {string} filterUuid * @param {SavedFilterDTO} savedFilterDTO Updated saved filter details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFilter(filterUuid: string, savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * FilterApi - object-oriented interface */ export declare class FilterApi extends BaseAPI { /** * Creates a new saved filter with the provided configuration. * @summary Create a new saved filter * @param {SavedFilterDTO} savedFilterDTO Saved filter details for creation * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFilter(savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig): Promise>; /** * Soft deletes a saved filter identified by its UUID. * @summary Delete a saved filter * @param {string} filterUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFilter(filterUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves details of a saved filter by its UUID. * @summary Fetch a specific saved filter * @param {string} filterUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFilter(filterUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Fetches a paginated list of saved filters. The request body should contain pagination details such as limit, page, filters, and sort. * @summary Fetch paginated saved filters * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination request details * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFilters(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Updates an existing saved filter identified by its UUID. * @summary Update an existing saved filter * @param {string} filterUuid * @param {SavedFilterDTO} savedFilterDTO Updated saved filter details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFilter(filterUuid: string, savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig): Promise>; } /** * FormsApi - axios parameter creator */ export declare const FormsApiAxiosParamCreator: (configuration?: Configuration) => { /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary AI form field (public) * @param {string} companyUuid * @param {string} fieldUuid * @param {string} prompt * @param {FormWithAiPromptDTO} formWithAiPromptDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ chatField: (companyUuid: string, fieldUuid: string, prompt: string, formWithAiPromptDTO: FormWithAiPromptDTO, options?: RawAxiosRequestConfig) => Promise; /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary AI form step (public) * @param {string} companyUuid * @param {string} stepTitle * @param {string} prompt * @param {FormWithAiPromptDTO} formWithAiPromptDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ chatStep: (companyUuid: string, stepTitle: string, prompt: string, formWithAiPromptDTO: FormWithAiPromptDTO, options?: RawAxiosRequestConfig) => Promise; /** * Creates a new form with the provided data. The request body should contain a valid FormDTO object. On success, returns the created form as a FormDTO wrapped in a CreateResponse. Validation: Form fields are validated according to the Form validation rules. Required fields and format constraints are enforced. * @summary Create a new form * @param {FormDTO} formDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createForm: (formDTO: FormDTO, options?: RawAxiosRequestConfig) => Promise; /** * Deletes a form identified by its UUID. On success, returns the deleted form\'s data wrapped in a DeleteResponse. * @summary Delete a form * @param {string} formUuid UUID of the form to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteForm: (formUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a specific form by its UUID. Returns the details of the form in a FormDTO object wrapped in a ShowResponse. * @summary Get form by UUID * @param {string} formUuid UUID of the form to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForm: (formUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a specific form by its UUID. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Get form by UUID * @param {string} companyUuid * @param {string} formUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormPublic: (companyUuid: string, formUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a paginated list of forms based on the provided filters, sorting, and search query. This endpoint returns a list of FormDTO objects wrapped in a PaginationResponse containing the current page, limit, total count, and the forms data. * @summary Get paginated list of forms * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForms: (paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a paginated list of forms associated with a specific object UUID. The endpoint uses a custom Cypher query to match forms linked to the object. * @summary Get forms by object UUID * @param {string} objectUuid UUID of the object to get forms for * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormsByObject: (objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Get all forms for a company * @param {string} companyUuid * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormsPublic: (companyUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Returns distinct custom objects that have at least one non-deleted form, ordered by object index. * @summary List objects that have forms * @param {*} [options] Override http request option. * @throws {RequiredError} */ getObjectsWithForms: (options?: RawAxiosRequestConfig) => Promise; /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Property options (public) * @param {string} propertyUuid * @param {string} companyUuid * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptions: (propertyUuid: string, companyUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Restores a previously deleted form identified by its UUID. Returns the restored form wrapped in a RestoreResponse. * @summary Restore a deleted form * @param {string} formUuid UUID of the form to restore * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreForm: (formUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Submits a form with the provided data. Returns a SuccessResponse upon successful submission. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Submit a form * @param {string} companyUuid * @param {string} formUuid * @param {FormDTO} formDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ submit: (companyUuid: string, formUuid: string, formDTO: FormDTO, options?: RawAxiosRequestConfig) => Promise; /** * Updates an existing form identified by its UUID with the provided data. The request body should include the updated fields in a FormDTO. Returns the updated form wrapped in an UpdateResponse. Validation: Form fields are validated according to the Form validation rules. Required fields and format constraints are enforced. * @summary Update an existing form * @param {string} formUuid UUID of the form to update * @param {FormDTO} formDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateForm: (formUuid: string, formDTO: FormDTO, options?: RawAxiosRequestConfig) => Promise; /** * Submits a file with the provided data. Returns a SuccessResponse upon successful submission. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Submit a file * @param {string} companyUuid * @param {string} formUuid * @param {Array} files * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFiles: (companyUuid: string, formUuid: string, files: Array, options?: RawAxiosRequestConfig) => Promise; }; /** * FormsApi - functional programming interface */ export declare const FormsApiFp: (configuration?: Configuration) => { /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary AI form field (public) * @param {string} companyUuid * @param {string} fieldUuid * @param {string} prompt * @param {FormWithAiPromptDTO} formWithAiPromptDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ chatField(companyUuid: string, fieldUuid: string, prompt: string, formWithAiPromptDTO: FormWithAiPromptDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary AI form step (public) * @param {string} companyUuid * @param {string} stepTitle * @param {string} prompt * @param {FormWithAiPromptDTO} formWithAiPromptDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ chatStep(companyUuid: string, stepTitle: string, prompt: string, formWithAiPromptDTO: FormWithAiPromptDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new form with the provided data. The request body should contain a valid FormDTO object. On success, returns the created form as a FormDTO wrapped in a CreateResponse. Validation: Form fields are validated according to the Form validation rules. Required fields and format constraints are enforced. * @summary Create a new form * @param {FormDTO} formDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createForm(formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a form identified by its UUID. On success, returns the deleted form\'s data wrapped in a DeleteResponse. * @summary Delete a form * @param {string} formUuid UUID of the form to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteForm(formUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a specific form by its UUID. Returns the details of the form in a FormDTO object wrapped in a ShowResponse. * @summary Get form by UUID * @param {string} formUuid UUID of the form to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForm(formUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a specific form by its UUID. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Get form by UUID * @param {string} companyUuid * @param {string} formUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormPublic(companyUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a paginated list of forms based on the provided filters, sorting, and search query. This endpoint returns a list of FormDTO objects wrapped in a PaginationResponse containing the current page, limit, total count, and the forms data. * @summary Get paginated list of forms * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForms(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a paginated list of forms associated with a specific object UUID. The endpoint uses a custom Cypher query to match forms linked to the object. * @summary Get forms by object UUID * @param {string} objectUuid UUID of the object to get forms for * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormsByObject(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Get all forms for a company * @param {string} companyUuid * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormsPublic(companyUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns distinct custom objects that have at least one non-deleted form, ordered by object index. * @summary List objects that have forms * @param {*} [options] Override http request option. * @throws {RequiredError} */ getObjectsWithForms(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Property options (public) * @param {string} propertyUuid * @param {string} companyUuid * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptions(propertyUuid: string, companyUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Restores a previously deleted form identified by its UUID. Returns the restored form wrapped in a RestoreResponse. * @summary Restore a deleted form * @param {string} formUuid UUID of the form to restore * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreForm(formUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Submits a form with the provided data. Returns a SuccessResponse upon successful submission. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Submit a form * @param {string} companyUuid * @param {string} formUuid * @param {FormDTO} formDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ submit(companyUuid: string, formUuid: string, formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates an existing form identified by its UUID with the provided data. The request body should include the updated fields in a FormDTO. Returns the updated form wrapped in an UpdateResponse. Validation: Form fields are validated according to the Form validation rules. Required fields and format constraints are enforced. * @summary Update an existing form * @param {string} formUuid UUID of the form to update * @param {FormDTO} formDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateForm(formUuid: string, formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Submits a file with the provided data. Returns a SuccessResponse upon successful submission. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Submit a file * @param {string} companyUuid * @param {string} formUuid * @param {Array} files * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFiles(companyUuid: string, formUuid: string, files: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FormsApi - factory interface */ export declare const FormsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary AI form field (public) * @param {string} companyUuid * @param {string} fieldUuid * @param {string} prompt * @param {FormWithAiPromptDTO} formWithAiPromptDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ chatField(companyUuid: string, fieldUuid: string, prompt: string, formWithAiPromptDTO: FormWithAiPromptDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary AI form step (public) * @param {string} companyUuid * @param {string} stepTitle * @param {string} prompt * @param {FormWithAiPromptDTO} formWithAiPromptDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ chatStep(companyUuid: string, stepTitle: string, prompt: string, formWithAiPromptDTO: FormWithAiPromptDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a new form with the provided data. The request body should contain a valid FormDTO object. On success, returns the created form as a FormDTO wrapped in a CreateResponse. Validation: Form fields are validated according to the Form validation rules. Required fields and format constraints are enforced. * @summary Create a new form * @param {FormDTO} formDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createForm(formDTO: FormDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes a form identified by its UUID. On success, returns the deleted form\'s data wrapped in a DeleteResponse. * @summary Delete a form * @param {string} formUuid UUID of the form to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteForm(formUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a specific form by its UUID. Returns the details of the form in a FormDTO object wrapped in a ShowResponse. * @summary Get form by UUID * @param {string} formUuid UUID of the form to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForm(formUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a specific form by its UUID. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Get form by UUID * @param {string} companyUuid * @param {string} formUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormPublic(companyUuid: string, formUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a paginated list of forms based on the provided filters, sorting, and search query. This endpoint returns a list of FormDTO objects wrapped in a PaginationResponse containing the current page, limit, total count, and the forms data. * @summary Get paginated list of forms * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForms(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a paginated list of forms associated with a specific object UUID. The endpoint uses a custom Cypher query to match forms linked to the object. * @summary Get forms by object UUID * @param {string} objectUuid UUID of the object to get forms for * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormsByObject(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Get all forms for a company * @param {string} companyUuid * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormsPublic(companyUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns distinct custom objects that have at least one non-deleted form, ordered by object index. * @summary List objects that have forms * @param {*} [options] Override http request option. * @throws {RequiredError} */ getObjectsWithForms(options?: RawAxiosRequestConfig): AxiosPromise; /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Property options (public) * @param {string} propertyUuid * @param {string} companyUuid * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptions(propertyUuid: string, companyUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Restores a previously deleted form identified by its UUID. Returns the restored form wrapped in a RestoreResponse. * @summary Restore a deleted form * @param {string} formUuid UUID of the form to restore * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreForm(formUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Submits a form with the provided data. Returns a SuccessResponse upon successful submission. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Submit a form * @param {string} companyUuid * @param {string} formUuid * @param {FormDTO} formDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ submit(companyUuid: string, formUuid: string, formDTO: FormDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates an existing form identified by its UUID with the provided data. The request body should include the updated fields in a FormDTO. Returns the updated form wrapped in an UpdateResponse. Validation: Form fields are validated according to the Form validation rules. Required fields and format constraints are enforced. * @summary Update an existing form * @param {string} formUuid UUID of the form to update * @param {FormDTO} formDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateForm(formUuid: string, formDTO: FormDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Submits a file with the provided data. Returns a SuccessResponse upon successful submission. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Submit a file * @param {string} companyUuid * @param {string} formUuid * @param {Array} files * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFiles(companyUuid: string, formUuid: string, files: Array, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * FormsApi - object-oriented interface */ export declare class FormsApi extends BaseAPI { /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary AI form field (public) * @param {string} companyUuid * @param {string} fieldUuid * @param {string} prompt * @param {FormWithAiPromptDTO} formWithAiPromptDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ chatField(companyUuid: string, fieldUuid: string, prompt: string, formWithAiPromptDTO: FormWithAiPromptDTO, options?: RawAxiosRequestConfig): Promise>; /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary AI form step (public) * @param {string} companyUuid * @param {string} stepTitle * @param {string} prompt * @param {FormWithAiPromptDTO} formWithAiPromptDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ chatStep(companyUuid: string, stepTitle: string, prompt: string, formWithAiPromptDTO: FormWithAiPromptDTO, options?: RawAxiosRequestConfig): Promise>; /** * Creates a new form with the provided data. The request body should contain a valid FormDTO object. On success, returns the created form as a FormDTO wrapped in a CreateResponse. Validation: Form fields are validated according to the Form validation rules. Required fields and format constraints are enforced. * @summary Create a new form * @param {FormDTO} formDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createForm(formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise>; /** * Deletes a form identified by its UUID. On success, returns the deleted form\'s data wrapped in a DeleteResponse. * @summary Delete a form * @param {string} formUuid UUID of the form to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteForm(formUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a specific form by its UUID. Returns the details of the form in a FormDTO object wrapped in a ShowResponse. * @summary Get form by UUID * @param {string} formUuid UUID of the form to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForm(formUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a specific form by its UUID. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Get form by UUID * @param {string} companyUuid * @param {string} formUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormPublic(companyUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a paginated list of forms based on the provided filters, sorting, and search query. This endpoint returns a list of FormDTO objects wrapped in a PaginationResponse containing the current page, limit, total count, and the forms data. * @summary Get paginated list of forms * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForms(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a paginated list of forms associated with a specific object UUID. The endpoint uses a custom Cypher query to match forms linked to the object. * @summary Get forms by object UUID * @param {string} objectUuid UUID of the object to get forms for * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormsByObject(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Get all forms for a company * @param {string} companyUuid * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormsPublic(companyUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns distinct custom objects that have at least one non-deleted form, ordered by object index. * @summary List objects that have forms * @param {*} [options] Override http request option. * @throws {RequiredError} */ getObjectsWithForms(options?: RawAxiosRequestConfig): Promise>; /** * When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Property options (public) * @param {string} propertyUuid * @param {string} companyUuid * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptions(propertyUuid: string, companyUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Restores a previously deleted form identified by its UUID. Returns the restored form wrapped in a RestoreResponse. * @summary Restore a deleted form * @param {string} formUuid UUID of the form to restore * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreForm(formUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Submits a form with the provided data. Returns a SuccessResponse upon successful submission. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Submit a form * @param {string} companyUuid * @param {string} formUuid * @param {FormDTO} formDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ submit(companyUuid: string, formUuid: string, formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise>; /** * Updates an existing form identified by its UUID with the provided data. The request body should include the updated fields in a FormDTO. Returns the updated form wrapped in an UpdateResponse. Validation: Form fields are validated according to the Form validation rules. Required fields and format constraints are enforced. * @summary Update an existing form * @param {string} formUuid UUID of the form to update * @param {FormDTO} formDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateForm(formUuid: string, formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise>; /** * Submits a file with the provided data. Returns a SuccessResponse upon successful submission. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment. * @summary Submit a file * @param {string} companyUuid * @param {string} formUuid * @param {Array} files * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFiles(companyUuid: string, formUuid: string, files: Array, options?: RawAxiosRequestConfig): Promise>; } /** * ModuleApi - axios parameter creator */ export declare const ModuleApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new module. * @summary Create a new module * @param {PageContentDTO} pageContentDTO Module details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createModule: (pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig) => Promise; /** * Creates a module in the user\'s personal library. * @summary Create a personal module * @param {PageContentDTO} pageContentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPersonalModule: (pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig) => Promise; /** * Deletes a module by its UUID. * @summary Delete a module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteModule: (moduleId: string, options?: RawAxiosRequestConfig) => Promise; /** * Deletes a personal module for the logged-in user. * @summary Delete a personal module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePersonalModule: (moduleId: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves details of a module by its UUID. * @summary Fetch a specific module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getModule: (moduleId: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a paginated list of modules. * @summary Fetch paginated modules * @param {PaginationRequest} paginationRequest Pagination details * @param {*} [options] Override http request option. * @throws {RequiredError} */ getModules: (paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a personal module by UUID for the logged-in user. * @summary Fetch a personal module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPersonalModule: (moduleId: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves personal modules for the logged-in user. * @summary Fetch paginated personal modules * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPersonalModules: (paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Updates the details of an existing module. * @summary Update an existing module * @param {string} moduleId * @param {PageContentDTO} pageContentDTO Updated module details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateModule: (moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig) => Promise; /** * Updates a personal module for the logged-in user. * @summary Update a personal module * @param {string} moduleId * @param {PageContentDTO} pageContentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePersonalModule: (moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig) => Promise; }; /** * ModuleApi - functional programming interface */ export declare const ModuleApiFp: (configuration?: Configuration) => { /** * Creates a new module. * @summary Create a new module * @param {PageContentDTO} pageContentDTO Module details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createModule(pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a module in the user\'s personal library. * @summary Create a personal module * @param {PageContentDTO} pageContentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPersonalModule(pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a module by its UUID. * @summary Delete a module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a personal module for the logged-in user. * @summary Delete a personal module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePersonalModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves details of a module by its UUID. * @summary Fetch a specific module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a paginated list of modules. * @summary Fetch paginated modules * @param {PaginationRequest} paginationRequest Pagination details * @param {*} [options] Override http request option. * @throws {RequiredError} */ getModules(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a personal module by UUID for the logged-in user. * @summary Fetch a personal module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPersonalModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves personal modules for the logged-in user. * @summary Fetch paginated personal modules * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPersonalModules(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the details of an existing module. * @summary Update an existing module * @param {string} moduleId * @param {PageContentDTO} pageContentDTO Updated module details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates a personal module for the logged-in user. * @summary Update a personal module * @param {string} moduleId * @param {PageContentDTO} pageContentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePersonalModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ModuleApi - factory interface */ export declare const ModuleApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new module. * @summary Create a new module * @param {PageContentDTO} pageContentDTO Module details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createModule(pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a module in the user\'s personal library. * @summary Create a personal module * @param {PageContentDTO} pageContentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPersonalModule(pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes a module by its UUID. * @summary Delete a module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteModule(moduleId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes a personal module for the logged-in user. * @summary Delete a personal module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePersonalModule(moduleId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves details of a module by its UUID. * @summary Fetch a specific module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getModule(moduleId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a paginated list of modules. * @summary Fetch paginated modules * @param {PaginationRequest} paginationRequest Pagination details * @param {*} [options] Override http request option. * @throws {RequiredError} */ getModules(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a personal module by UUID for the logged-in user. * @summary Fetch a personal module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPersonalModule(moduleId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves personal modules for the logged-in user. * @summary Fetch paginated personal modules * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPersonalModules(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the details of an existing module. * @summary Update an existing module * @param {string} moduleId * @param {PageContentDTO} pageContentDTO Updated module details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates a personal module for the logged-in user. * @summary Update a personal module * @param {string} moduleId * @param {PageContentDTO} pageContentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePersonalModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ModuleApi - object-oriented interface */ export declare class ModuleApi extends BaseAPI { /** * Creates a new module. * @summary Create a new module * @param {PageContentDTO} pageContentDTO Module details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createModule(pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise>; /** * Creates a module in the user\'s personal library. * @summary Create a personal module * @param {PageContentDTO} pageContentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPersonalModule(pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise>; /** * Deletes a module by its UUID. * @summary Delete a module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteModule(moduleId: string, options?: RawAxiosRequestConfig): Promise>; /** * Deletes a personal module for the logged-in user. * @summary Delete a personal module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePersonalModule(moduleId: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves details of a module by its UUID. * @summary Fetch a specific module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getModule(moduleId: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a paginated list of modules. * @summary Fetch paginated modules * @param {PaginationRequest} paginationRequest Pagination details * @param {*} [options] Override http request option. * @throws {RequiredError} */ getModules(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a personal module by UUID for the logged-in user. * @summary Fetch a personal module * @param {string} moduleId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPersonalModule(moduleId: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves personal modules for the logged-in user. * @summary Fetch paginated personal modules * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPersonalModules(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Updates the details of an existing module. * @summary Update an existing module * @param {string} moduleId * @param {PageContentDTO} pageContentDTO Updated module details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise>; /** * Updates a personal module for the logged-in user. * @summary Update a personal module * @param {string} moduleId * @param {PageContentDTO} pageContentDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePersonalModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise>; } /** * NotificationsApi - axios parameter creator */ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Dismiss a notification * @param {string} notificationId Firestore notification document ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ dismissNotification: (notificationId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Mint a Firebase custom token so the app can listen to its inbox * @param {*} [options] Override http request option. * @throws {RequiredError} */ firebaseToken: (options?: RawAxiosRequestConfig) => Promise; /** * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included. * @summary List in-app notifications for the logged-in user * @param {string} [company] * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNotifications: (company?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Mark all notifications as read * @param {*} [options] Override http request option. * @throws {RequiredError} */ markAllAsRead: (options?: RawAxiosRequestConfig) => Promise; /** * * @summary Mark a notification as read * @param {string} notificationId Firestore notification document ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ markAsRead: (notificationId: string, options?: RawAxiosRequestConfig) => Promise; /** * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member. * @summary Send a notification (app token) * @param {SendNotificationRequest} sendNotificationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendNotification: (sendNotificationRequest: SendNotificationRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * NotificationsApi - functional programming interface */ export declare const NotificationsApiFp: (configuration?: Configuration) => { /** * * @summary Dismiss a notification * @param {string} notificationId Firestore notification document ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Mint a Firebase custom token so the app can listen to its inbox * @param {*} [options] Override http request option. * @throws {RequiredError} */ firebaseToken(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included. * @summary List in-app notifications for the logged-in user * @param {string} [company] * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Mark all notifications as read * @param {*} [options] Override http request option. * @throws {RequiredError} */ markAllAsRead(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Mark a notification as read * @param {string} notificationId Firestore notification document ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ markAsRead(notificationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member. * @summary Send a notification (app token) * @param {SendNotificationRequest} sendNotificationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendNotification(sendNotificationRequest: SendNotificationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * NotificationsApi - factory interface */ export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Dismiss a notification * @param {string} notificationId Firestore notification document ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Mint a Firebase custom token so the app can listen to its inbox * @param {*} [options] Override http request option. * @throws {RequiredError} */ firebaseToken(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included. * @summary List in-app notifications for the logged-in user * @param {string} [company] * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Mark all notifications as read * @param {*} [options] Override http request option. * @throws {RequiredError} */ markAllAsRead(options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Mark a notification as read * @param {string} notificationId Firestore notification document ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ markAsRead(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member. * @summary Send a notification (app token) * @param {SendNotificationRequest} sendNotificationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendNotification(sendNotificationRequest: SendNotificationRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * NotificationsApi - object-oriented interface */ export declare class NotificationsApi extends BaseAPI { /** * * @summary Dismiss a notification * @param {string} notificationId Firestore notification document ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Mint a Firebase custom token so the app can listen to its inbox * @param {*} [options] Override http request option. * @throws {RequiredError} */ firebaseToken(options?: RawAxiosRequestConfig): Promise>; /** * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included. * @summary List in-app notifications for the logged-in user * @param {string} [company] * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Mark all notifications as read * @param {*} [options] Override http request option. * @throws {RequiredError} */ markAllAsRead(options?: RawAxiosRequestConfig): Promise>; /** * * @summary Mark a notification as read * @param {string} notificationId Firestore notification document ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ markAsRead(notificationId: string, options?: RawAxiosRequestConfig): Promise>; /** * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member. * @summary Send a notification (app token) * @param {SendNotificationRequest} sendNotificationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendNotification(sendNotificationRequest: SendNotificationRequest, options?: RawAxiosRequestConfig): Promise>; } /** * ObjectsApi - axios parameter creator */ export declare const ObjectsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new Caraer object using the provided details. Optional request parameters specify whether to include views, properties, and relations in the response. Validation rules: label (required, must be a string, maximum 32 characters), plural (required, must be a string, maximum 32 characters), name (required, must be a string, must be lowercase, must be unique, must match name pattern (lowercase letters, numbers, underscores)), description (optional, maximum 255 characters), groups (required, must be an array of string, no duplicate values allowed). * @summary Create new object * @param {CaraerObjectDTO} caraerObjectDTO Details of the object to create * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createObject: (caraerObjectDTO: CaraerObjectDTO, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig) => Promise; /** * Deletes a specific object identified by its UUID. * @summary Delete object by UUID * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteObject: (uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns all company users, teams, and installed apps that can receive record access on an object. * @summary List access grant candidates * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccessGrantCandidates: (options?: RawAxiosRequestConfig) => Promise; /** * Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response. * @summary Get object by UUID * @param {string} uuid * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getObject: (uuid: string, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig) => Promise; /** * Fetches a paginated list of objects, optionally including views, properties, and/or relations. The request body should contain pagination details such as limit, page, filters, sort, and query. * @summary Fetch paginated objects * @param {PaginationRequest} paginationRequest Pagination request details * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getObjects: (paginationRequest: PaginationRequest, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig) => Promise; /** * Fetches a preview for an object by the object\'s UUID and the preview name. Returns the preview data wrapped in a ShowResponse. * @summary Get specific preview by name * @param {string} uuid * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreview: (uuid: string, name: string, options?: RawAxiosRequestConfig) => Promise; /** * Fetches all previews over all objects. Returns a PaginationResponse containing a list of preview DTOs. * @summary Get all previews over all objects * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviews: (paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Fetches all previews associated with a specific object. Returns a PaginationResponse containing a list of preview DTOs. * @summary Get all previews of an object * @param {string} uuid * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviews1: (uuid: string, search?: string, options?: RawAxiosRequestConfig) => Promise; /** * Accepts a request to grant record-level scopes on the object to selected users, teams, and installed apps. Validation runs synchronously; grants are applied asynchronously. Returns 202 Accepted on success. * @summary Grant object record access * @param {string} objectUuid * @param {ObjectAccessGrantRequestDTO} objectAccessGrantRequestDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ grantObjectAccess: (objectUuid: string, objectAccessGrantRequestDTO: ObjectAccessGrantRequestDTO, options?: RawAxiosRequestConfig) => Promise; /** * Hard-deletes a soft-deleted object. Only objects with deletedAt set can be removed. * @summary Permanently delete archived object * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ permanentlyDeleteArchivedObject: (uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Creates or updates a preview for a specific object. The preview type is determined by the \'name\' path variable. Depending on the preview type (e.g., \'detail\', \'flow\', \'pill\', or \'page\'), the request body will be mapped to the corresponding PreviewDTO and converted to the appropriate Preview model. * @summary Save object preview * @param {string} uuid * @param {string} name * @param {PreviewDTO} previewDTO Preview data * @param {*} [options] Override http request option. * @throws {RequiredError} */ savePreview: (uuid: string, name: string, previewDTO: PreviewDTO, options?: RawAxiosRequestConfig) => Promise; /** * Synchronizes existing records for an object after extended configuration changes. The object path variable accepts UUID or object name. Leftover nodes with a unique object label and no primary_object are stamped first. Records that reference the object as primary object, extended object, or label are re-extended. * @summary Sync extended objects for existing records * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ syncExtendedObjects: (uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates indices of objects based on the provided mapping. The request body should contain a mapping of object UUIDs to index values. Optional request parameters determine if views, properties, and relations should be included in the response. * @summary Update object indices * @param {{ [key: string]: number; }} requestBody Mapping of object indices * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices3: (requestBody: { [key: string]: number; }, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig) => Promise; /** * Sets which properties on this object should generate lifecycle history records when their values change. * @summary Configure lifecycle property tracking * @param {string} objectUuid * @param {UpdateLifecyclePropertiesDTO} updateLifecyclePropertiesDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateLifecycleProperties: (objectUuid: string, updateLifecyclePropertiesDTO: UpdateLifecyclePropertiesDTO, options?: RawAxiosRequestConfig) => Promise; /** * Updates an existing object identified by its UUID with new details. Optional parameters determine if views, properties, and relations should be included in the response. Validation rules: label (required, must be a string, maximum 32 characters), plural (required, must be a string, maximum 32 characters), name (required, must be a string, must be lowercase, must be unique, must match name pattern (lowercase letters, numbers, underscores), cannot be changed after creation), description (optional, maximum 255 characters), groups (required, must be an array of string, no duplicate values allowed). * @summary Update object by UUID * @param {string} uuid * @param {CaraerObjectDTO} caraerObjectDTO Updated details of the object * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateObject: (uuid: string, caraerObjectDTO: CaraerObjectDTO, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ObjectsApi - functional programming interface */ export declare const ObjectsApiFp: (configuration?: Configuration) => { /** * Creates a new Caraer object using the provided details. Optional request parameters specify whether to include views, properties, and relations in the response. Validation rules: label (required, must be a string, maximum 32 characters), plural (required, must be a string, maximum 32 characters), name (required, must be a string, must be lowercase, must be unique, must match name pattern (lowercase letters, numbers, underscores)), description (optional, maximum 255 characters), groups (required, must be an array of string, no duplicate values allowed). * @summary Create new object * @param {CaraerObjectDTO} caraerObjectDTO Details of the object to create * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createObject(caraerObjectDTO: CaraerObjectDTO, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a specific object identified by its UUID. * @summary Delete object by UUID * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteObject(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns all company users, teams, and installed apps that can receive record access on an object. * @summary List access grant candidates * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccessGrantCandidates(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response. * @summary Get object by UUID * @param {string} uuid * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getObject(uuid: string, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches a paginated list of objects, optionally including views, properties, and/or relations. The request body should contain pagination details such as limit, page, filters, sort, and query. * @summary Fetch paginated objects * @param {PaginationRequest} paginationRequest Pagination request details * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getObjects(paginationRequest: PaginationRequest, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches a preview for an object by the object\'s UUID and the preview name. Returns the preview data wrapped in a ShowResponse. * @summary Get specific preview by name * @param {string} uuid * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreview(uuid: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches all previews over all objects. Returns a PaginationResponse containing a list of preview DTOs. * @summary Get all previews over all objects * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviews(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches all previews associated with a specific object. Returns a PaginationResponse containing a list of preview DTOs. * @summary Get all previews of an object * @param {string} uuid * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviews1(uuid: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Accepts a request to grant record-level scopes on the object to selected users, teams, and installed apps. Validation runs synchronously; grants are applied asynchronously. Returns 202 Accepted on success. * @summary Grant object record access * @param {string} objectUuid * @param {ObjectAccessGrantRequestDTO} objectAccessGrantRequestDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ grantObjectAccess(objectUuid: string, objectAccessGrantRequestDTO: ObjectAccessGrantRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Hard-deletes a soft-deleted object. Only objects with deletedAt set can be removed. * @summary Permanently delete archived object * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ permanentlyDeleteArchivedObject(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates or updates a preview for a specific object. The preview type is determined by the \'name\' path variable. Depending on the preview type (e.g., \'detail\', \'flow\', \'pill\', or \'page\'), the request body will be mapped to the corresponding PreviewDTO and converted to the appropriate Preview model. * @summary Save object preview * @param {string} uuid * @param {string} name * @param {PreviewDTO} previewDTO Preview data * @param {*} [options] Override http request option. * @throws {RequiredError} */ savePreview(uuid: string, name: string, previewDTO: PreviewDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Synchronizes existing records for an object after extended configuration changes. The object path variable accepts UUID or object name. Leftover nodes with a unique object label and no primary_object are stamped first. Records that reference the object as primary object, extended object, or label are re-extended. * @summary Sync extended objects for existing records * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ syncExtendedObjects(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates indices of objects based on the provided mapping. The request body should contain a mapping of object UUIDs to index values. Optional request parameters determine if views, properties, and relations should be included in the response. * @summary Update object indices * @param {{ [key: string]: number; }} requestBody Mapping of object indices * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices3(requestBody: { [key: string]: number; }, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sets which properties on this object should generate lifecycle history records when their values change. * @summary Configure lifecycle property tracking * @param {string} objectUuid * @param {UpdateLifecyclePropertiesDTO} updateLifecyclePropertiesDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateLifecycleProperties(objectUuid: string, updateLifecyclePropertiesDTO: UpdateLifecyclePropertiesDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates an existing object identified by its UUID with new details. Optional parameters determine if views, properties, and relations should be included in the response. Validation rules: label (required, must be a string, maximum 32 characters), plural (required, must be a string, maximum 32 characters), name (required, must be a string, must be lowercase, must be unique, must match name pattern (lowercase letters, numbers, underscores), cannot be changed after creation), description (optional, maximum 255 characters), groups (required, must be an array of string, no duplicate values allowed). * @summary Update object by UUID * @param {string} uuid * @param {CaraerObjectDTO} caraerObjectDTO Updated details of the object * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateObject(uuid: string, caraerObjectDTO: CaraerObjectDTO, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ObjectsApi - factory interface */ export declare const ObjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new Caraer object using the provided details. Optional request parameters specify whether to include views, properties, and relations in the response. Validation rules: label (required, must be a string, maximum 32 characters), plural (required, must be a string, maximum 32 characters), name (required, must be a string, must be lowercase, must be unique, must match name pattern (lowercase letters, numbers, underscores)), description (optional, maximum 255 characters), groups (required, must be an array of string, no duplicate values allowed). * @summary Create new object * @param {CaraerObjectDTO} caraerObjectDTO Details of the object to create * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createObject(caraerObjectDTO: CaraerObjectDTO, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes a specific object identified by its UUID. * @summary Delete object by UUID * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteObject(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns all company users, teams, and installed apps that can receive record access on an object. * @summary List access grant candidates * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccessGrantCandidates(options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response. * @summary Get object by UUID * @param {string} uuid * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getObject(uuid: string, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a paginated list of objects, optionally including views, properties, and/or relations. The request body should contain pagination details such as limit, page, filters, sort, and query. * @summary Fetch paginated objects * @param {PaginationRequest} paginationRequest Pagination request details * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getObjects(paginationRequest: PaginationRequest, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a preview for an object by the object\'s UUID and the preview name. Returns the preview data wrapped in a ShowResponse. * @summary Get specific preview by name * @param {string} uuid * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreview(uuid: string, name: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches all previews over all objects. Returns a PaginationResponse containing a list of preview DTOs. * @summary Get all previews over all objects * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviews(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches all previews associated with a specific object. Returns a PaginationResponse containing a list of preview DTOs. * @summary Get all previews of an object * @param {string} uuid * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviews1(uuid: string, search?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Accepts a request to grant record-level scopes on the object to selected users, teams, and installed apps. Validation runs synchronously; grants are applied asynchronously. Returns 202 Accepted on success. * @summary Grant object record access * @param {string} objectUuid * @param {ObjectAccessGrantRequestDTO} objectAccessGrantRequestDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ grantObjectAccess(objectUuid: string, objectAccessGrantRequestDTO: ObjectAccessGrantRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Hard-deletes a soft-deleted object. Only objects with deletedAt set can be removed. * @summary Permanently delete archived object * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ permanentlyDeleteArchivedObject(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates or updates a preview for a specific object. The preview type is determined by the \'name\' path variable. Depending on the preview type (e.g., \'detail\', \'flow\', \'pill\', or \'page\'), the request body will be mapped to the corresponding PreviewDTO and converted to the appropriate Preview model. * @summary Save object preview * @param {string} uuid * @param {string} name * @param {PreviewDTO} previewDTO Preview data * @param {*} [options] Override http request option. * @throws {RequiredError} */ savePreview(uuid: string, name: string, previewDTO: PreviewDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Synchronizes existing records for an object after extended configuration changes. The object path variable accepts UUID or object name. Leftover nodes with a unique object label and no primary_object are stamped first. Records that reference the object as primary object, extended object, or label are re-extended. * @summary Sync extended objects for existing records * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ syncExtendedObjects(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates indices of objects based on the provided mapping. The request body should contain a mapping of object UUIDs to index values. Optional request parameters determine if views, properties, and relations should be included in the response. * @summary Update object indices * @param {{ [key: string]: number; }} requestBody Mapping of object indices * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices3(requestBody: { [key: string]: number; }, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Sets which properties on this object should generate lifecycle history records when their values change. * @summary Configure lifecycle property tracking * @param {string} objectUuid * @param {UpdateLifecyclePropertiesDTO} updateLifecyclePropertiesDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateLifecycleProperties(objectUuid: string, updateLifecyclePropertiesDTO: UpdateLifecyclePropertiesDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates an existing object identified by its UUID with new details. Optional parameters determine if views, properties, and relations should be included in the response. Validation rules: label (required, must be a string, maximum 32 characters), plural (required, must be a string, maximum 32 characters), name (required, must be a string, must be lowercase, must be unique, must match name pattern (lowercase letters, numbers, underscores), cannot be changed after creation), description (optional, maximum 255 characters), groups (required, must be an array of string, no duplicate values allowed). * @summary Update object by UUID * @param {string} uuid * @param {CaraerObjectDTO} caraerObjectDTO Updated details of the object * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateObject(uuid: string, caraerObjectDTO: CaraerObjectDTO, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ObjectsApi - object-oriented interface */ export declare class ObjectsApi extends BaseAPI { /** * Creates a new Caraer object using the provided details. Optional request parameters specify whether to include views, properties, and relations in the response. Validation rules: label (required, must be a string, maximum 32 characters), plural (required, must be a string, maximum 32 characters), name (required, must be a string, must be lowercase, must be unique, must match name pattern (lowercase letters, numbers, underscores)), description (optional, maximum 255 characters), groups (required, must be an array of string, no duplicate values allowed). * @summary Create new object * @param {CaraerObjectDTO} caraerObjectDTO Details of the object to create * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createObject(caraerObjectDTO: CaraerObjectDTO, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise>; /** * Deletes a specific object identified by its UUID. * @summary Delete object by UUID * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteObject(uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns all company users, teams, and installed apps that can receive record access on an object. * @summary List access grant candidates * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccessGrantCandidates(options?: RawAxiosRequestConfig): Promise>; /** * Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response. * @summary Get object by UUID * @param {string} uuid * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getObject(uuid: string, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise>; /** * Fetches a paginated list of objects, optionally including views, properties, and/or relations. The request body should contain pagination details such as limit, page, filters, sort, and query. * @summary Fetch paginated objects * @param {PaginationRequest} paginationRequest Pagination request details * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getObjects(paginationRequest: PaginationRequest, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise>; /** * Fetches a preview for an object by the object\'s UUID and the preview name. Returns the preview data wrapped in a ShowResponse. * @summary Get specific preview by name * @param {string} uuid * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreview(uuid: string, name: string, options?: RawAxiosRequestConfig): Promise>; /** * Fetches all previews over all objects. Returns a PaginationResponse containing a list of preview DTOs. * @summary Get all previews over all objects * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviews(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Fetches all previews associated with a specific object. Returns a PaginationResponse containing a list of preview DTOs. * @summary Get all previews of an object * @param {string} uuid * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviews1(uuid: string, search?: string, options?: RawAxiosRequestConfig): Promise>; /** * Accepts a request to grant record-level scopes on the object to selected users, teams, and installed apps. Validation runs synchronously; grants are applied asynchronously. Returns 202 Accepted on success. * @summary Grant object record access * @param {string} objectUuid * @param {ObjectAccessGrantRequestDTO} objectAccessGrantRequestDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ grantObjectAccess(objectUuid: string, objectAccessGrantRequestDTO: ObjectAccessGrantRequestDTO, options?: RawAxiosRequestConfig): Promise>; /** * Hard-deletes a soft-deleted object. Only objects with deletedAt set can be removed. * @summary Permanently delete archived object * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ permanentlyDeleteArchivedObject(uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Creates or updates a preview for a specific object. The preview type is determined by the \'name\' path variable. Depending on the preview type (e.g., \'detail\', \'flow\', \'pill\', or \'page\'), the request body will be mapped to the corresponding PreviewDTO and converted to the appropriate Preview model. * @summary Save object preview * @param {string} uuid * @param {string} name * @param {PreviewDTO} previewDTO Preview data * @param {*} [options] Override http request option. * @throws {RequiredError} */ savePreview(uuid: string, name: string, previewDTO: PreviewDTO, options?: RawAxiosRequestConfig): Promise>; /** * Synchronizes existing records for an object after extended configuration changes. The object path variable accepts UUID or object name. Leftover nodes with a unique object label and no primary_object are stamped first. Records that reference the object as primary object, extended object, or label are re-extended. * @summary Sync extended objects for existing records * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ syncExtendedObjects(uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Updates indices of objects based on the provided mapping. The request body should contain a mapping of object UUIDs to index values. Optional request parameters determine if views, properties, and relations should be included in the response. * @summary Update object indices * @param {{ [key: string]: number; }} requestBody Mapping of object indices * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices3(requestBody: { [key: string]: number; }, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise>; /** * Sets which properties on this object should generate lifecycle history records when their values change. * @summary Configure lifecycle property tracking * @param {string} objectUuid * @param {UpdateLifecyclePropertiesDTO} updateLifecyclePropertiesDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateLifecycleProperties(objectUuid: string, updateLifecyclePropertiesDTO: UpdateLifecyclePropertiesDTO, options?: RawAxiosRequestConfig): Promise>; /** * Updates an existing object identified by its UUID with new details. Optional parameters determine if views, properties, and relations should be included in the response. Validation rules: label (required, must be a string, maximum 32 characters), plural (required, must be a string, maximum 32 characters), name (required, must be a string, must be lowercase, must be unique, must match name pattern (lowercase letters, numbers, underscores), cannot be changed after creation), description (optional, maximum 255 characters), groups (required, must be an array of string, no duplicate values allowed). * @summary Update object by UUID * @param {string} uuid * @param {CaraerObjectDTO} caraerObjectDTO Updated details of the object * @param {string} [views] * @param {string} [properties] * @param {string} [relations] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateObject(uuid: string, caraerObjectDTO: CaraerObjectDTO, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise>; } /** * PropertyApi - axios parameter creator */ export declare const PropertyApiAxiosParamCreator: (configuration?: Configuration) => { /** * Attaches existing properties from other objects to the target object in a single request. Archived links on the target object are restored. Properties already active on the target are rejected. * @summary Copy properties to object * @param {string} objectUuid * @param {CopyPropertiesToObjectRequest} copyPropertiesToObjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyPropertiesToObject: (objectUuid: string, copyPropertiesToObjectRequest: CopyPropertiesToObjectRequest, options?: RawAxiosRequestConfig) => Promise; /** * Creates a new property for a specific object using the provided property details. The SavePropertyDTO must include necessary details, and the object association is determined by the objectUuid path variable. Returns a CreateResponse containing the newly created property as a PropertyDTO. Validation rules: name (required, must be unique, must be lowercase, must match name pattern (lowercase letters, numbers, underscores)), label (required), description (maximum 255 characters), type (required, must be one of valid PropertyTypes, cannot be changed after creation), format (required, must be one of valid PropertyFormats, cannot be changed after creation), rules (required, must be an array of string). * @summary Create a new property * @param {string} objectUuid * @param {SavePropertyDTO} savePropertyDTO Property details for creation * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProperty: (objectUuid: string, savePropertyDTO: SavePropertyDTO, options?: RawAxiosRequestConfig) => Promise; /** * Deletes a property from the specified object, identified by the property UUID. Returns a DeleteResponse containing the deleted property\'s details. * @summary Delete a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProperty: (objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the calculation functions available for each property type (for example min/max on numbers). * @summary Retrieve allowed calculation types per property type * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCalculationTypes: (objectUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Fetches a sorted list of available property formats. The formats are retrieved from the PropertyFormats enum and converted to PropertyFormat instances. * @summary Retrieve property formats * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormats: (objectUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a paginated list of properties for a given object. Depending on the object UUID format, a Cypher query is constructed to filter properties belonging to that object. Returns a PaginationResponse containing PropertyDTO objects. * @summary Fetch paginated properties * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination details (limit, page, filters, sort, query) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProperties: (objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves details of a property by its UUID and associates it with its parent object. Returns a ShowResponse containing a PropertyDTO object with complete property details. * @summary Fetch a specific property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProperty: (objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns calculation functions supported for the property\'s type. * @summary Retrieve allowed calculation types for a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPropertyCalculationTypes: (objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Deletes the soft-deleted HAS_PROPERTY link to this object. If the property is not linked to any other object, the property node is hard-deleted. * @summary Permanently remove archived property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ permanentlyDeleteArchivedProperty: (objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Pins the specified property for the logged-in user. Pinned properties appear at the top of record create and update forms. * @summary Pin a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ pinProperty: (objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Restores a previously deleted property by propertyUuid for the specified objectUuid. Returns a RestoreResponse containing the restored property details. * @summary Restore a soft-deleted property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreProperty: (objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Removes the pin for the specified property for the logged-in user. * @summary Unpin a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ unpinProperty: (objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates the indices for properties of a specific object. The request body should contain a mapping between property UUIDs and their new index values. Returns a SuccessResponse containing a list of updated PropertyDTO objects. * @summary Update property indices * @param {string} objectUuid * @param {{ [key: string]: number; }} requestBody Mapping of property UUIDs to new index values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices2: (objectUuid: string, requestBody: { [key: string]: number; }, options?: RawAxiosRequestConfig) => Promise; /** * Updates the details of an existing property for a specific object. The property details are provided via SavePropertyDTO, and the property is identified by its UUID. Returns an UpdateResponse containing the updated property as a PropertyDTO. Validation rules: name (required, must be unique, must be lowercase, must match name pattern (lowercase letters, numbers, underscores), cannot be changed after creation), label (required), description (maximum 255 characters), type (required, must be one of valid PropertyTypes, cannot be changed after creation), format (required, must be one of valid PropertyFormats, cannot be changed after creation), rules (required, must be an array of string). * @summary Update an existing property * @param {string} objectUuid * @param {string} propertyUuid * @param {SavePropertyDTO} savePropertyDTO Updated property details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateProperty: (objectUuid: string, propertyUuid: string, savePropertyDTO: SavePropertyDTO, options?: RawAxiosRequestConfig) => Promise; }; /** * PropertyApi - functional programming interface */ export declare const PropertyApiFp: (configuration?: Configuration) => { /** * Attaches existing properties from other objects to the target object in a single request. Archived links on the target object are restored. Properties already active on the target are rejected. * @summary Copy properties to object * @param {string} objectUuid * @param {CopyPropertiesToObjectRequest} copyPropertiesToObjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyPropertiesToObject(objectUuid: string, copyPropertiesToObjectRequest: CopyPropertiesToObjectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new property for a specific object using the provided property details. The SavePropertyDTO must include necessary details, and the object association is determined by the objectUuid path variable. Returns a CreateResponse containing the newly created property as a PropertyDTO. Validation rules: name (required, must be unique, must be lowercase, must match name pattern (lowercase letters, numbers, underscores)), label (required), description (maximum 255 characters), type (required, must be one of valid PropertyTypes, cannot be changed after creation), format (required, must be one of valid PropertyFormats, cannot be changed after creation), rules (required, must be an array of string). * @summary Create a new property * @param {string} objectUuid * @param {SavePropertyDTO} savePropertyDTO Property details for creation * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProperty(objectUuid: string, savePropertyDTO: SavePropertyDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a property from the specified object, identified by the property UUID. Returns a DeleteResponse containing the deleted property\'s details. * @summary Delete a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the calculation functions available for each property type (for example min/max on numbers). * @summary Retrieve allowed calculation types per property type * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCalculationTypes(objectUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches a sorted list of available property formats. The formats are retrieved from the PropertyFormats enum and converted to PropertyFormat instances. * @summary Retrieve property formats * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormats(objectUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a paginated list of properties for a given object. Depending on the object UUID format, a Cypher query is constructed to filter properties belonging to that object. Returns a PaginationResponse containing PropertyDTO objects. * @summary Fetch paginated properties * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination details (limit, page, filters, sort, query) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProperties(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves details of a property by its UUID and associates it with its parent object. Returns a ShowResponse containing a PropertyDTO object with complete property details. * @summary Fetch a specific property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns calculation functions supported for the property\'s type. * @summary Retrieve allowed calculation types for a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPropertyCalculationTypes(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the soft-deleted HAS_PROPERTY link to this object. If the property is not linked to any other object, the property node is hard-deleted. * @summary Permanently remove archived property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ permanentlyDeleteArchivedProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Pins the specified property for the logged-in user. Pinned properties appear at the top of record create and update forms. * @summary Pin a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ pinProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Restores a previously deleted property by propertyUuid for the specified objectUuid. Returns a RestoreResponse containing the restored property details. * @summary Restore a soft-deleted property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Removes the pin for the specified property for the logged-in user. * @summary Unpin a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ unpinProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the indices for properties of a specific object. The request body should contain a mapping between property UUIDs and their new index values. Returns a SuccessResponse containing a list of updated PropertyDTO objects. * @summary Update property indices * @param {string} objectUuid * @param {{ [key: string]: number; }} requestBody Mapping of property UUIDs to new index values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices2(objectUuid: string, requestBody: { [key: string]: number; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the details of an existing property for a specific object. The property details are provided via SavePropertyDTO, and the property is identified by its UUID. Returns an UpdateResponse containing the updated property as a PropertyDTO. Validation rules: name (required, must be unique, must be lowercase, must match name pattern (lowercase letters, numbers, underscores), cannot be changed after creation), label (required), description (maximum 255 characters), type (required, must be one of valid PropertyTypes, cannot be changed after creation), format (required, must be one of valid PropertyFormats, cannot be changed after creation), rules (required, must be an array of string). * @summary Update an existing property * @param {string} objectUuid * @param {string} propertyUuid * @param {SavePropertyDTO} savePropertyDTO Updated property details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateProperty(objectUuid: string, propertyUuid: string, savePropertyDTO: SavePropertyDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PropertyApi - factory interface */ export declare const PropertyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Attaches existing properties from other objects to the target object in a single request. Archived links on the target object are restored. Properties already active on the target are rejected. * @summary Copy properties to object * @param {string} objectUuid * @param {CopyPropertiesToObjectRequest} copyPropertiesToObjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyPropertiesToObject(objectUuid: string, copyPropertiesToObjectRequest: CopyPropertiesToObjectRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a new property for a specific object using the provided property details. The SavePropertyDTO must include necessary details, and the object association is determined by the objectUuid path variable. Returns a CreateResponse containing the newly created property as a PropertyDTO. Validation rules: name (required, must be unique, must be lowercase, must match name pattern (lowercase letters, numbers, underscores)), label (required), description (maximum 255 characters), type (required, must be one of valid PropertyTypes, cannot be changed after creation), format (required, must be one of valid PropertyFormats, cannot be changed after creation), rules (required, must be an array of string). * @summary Create a new property * @param {string} objectUuid * @param {SavePropertyDTO} savePropertyDTO Property details for creation * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProperty(objectUuid: string, savePropertyDTO: SavePropertyDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes a property from the specified object, identified by the property UUID. Returns a DeleteResponse containing the deleted property\'s details. * @summary Delete a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the calculation functions available for each property type (for example min/max on numbers). * @summary Retrieve allowed calculation types per property type * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCalculationTypes(objectUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a sorted list of available property formats. The formats are retrieved from the PropertyFormats enum and converted to PropertyFormat instances. * @summary Retrieve property formats * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormats(objectUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a paginated list of properties for a given object. Depending on the object UUID format, a Cypher query is constructed to filter properties belonging to that object. Returns a PaginationResponse containing PropertyDTO objects. * @summary Fetch paginated properties * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination details (limit, page, filters, sort, query) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProperties(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves details of a property by its UUID and associates it with its parent object. Returns a ShowResponse containing a PropertyDTO object with complete property details. * @summary Fetch a specific property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns calculation functions supported for the property\'s type. * @summary Retrieve allowed calculation types for a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPropertyCalculationTypes(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes the soft-deleted HAS_PROPERTY link to this object. If the property is not linked to any other object, the property node is hard-deleted. * @summary Permanently remove archived property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ permanentlyDeleteArchivedProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Pins the specified property for the logged-in user. Pinned properties appear at the top of record create and update forms. * @summary Pin a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ pinProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Restores a previously deleted property by propertyUuid for the specified objectUuid. Returns a RestoreResponse containing the restored property details. * @summary Restore a soft-deleted property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Removes the pin for the specified property for the logged-in user. * @summary Unpin a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ unpinProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the indices for properties of a specific object. The request body should contain a mapping between property UUIDs and their new index values. Returns a SuccessResponse containing a list of updated PropertyDTO objects. * @summary Update property indices * @param {string} objectUuid * @param {{ [key: string]: number; }} requestBody Mapping of property UUIDs to new index values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices2(objectUuid: string, requestBody: { [key: string]: number; }, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the details of an existing property for a specific object. The property details are provided via SavePropertyDTO, and the property is identified by its UUID. Returns an UpdateResponse containing the updated property as a PropertyDTO. Validation rules: name (required, must be unique, must be lowercase, must match name pattern (lowercase letters, numbers, underscores), cannot be changed after creation), label (required), description (maximum 255 characters), type (required, must be one of valid PropertyTypes, cannot be changed after creation), format (required, must be one of valid PropertyFormats, cannot be changed after creation), rules (required, must be an array of string). * @summary Update an existing property * @param {string} objectUuid * @param {string} propertyUuid * @param {SavePropertyDTO} savePropertyDTO Updated property details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateProperty(objectUuid: string, propertyUuid: string, savePropertyDTO: SavePropertyDTO, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * PropertyApi - object-oriented interface */ export declare class PropertyApi extends BaseAPI { /** * Attaches existing properties from other objects to the target object in a single request. Archived links on the target object are restored. Properties already active on the target are rejected. * @summary Copy properties to object * @param {string} objectUuid * @param {CopyPropertiesToObjectRequest} copyPropertiesToObjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyPropertiesToObject(objectUuid: string, copyPropertiesToObjectRequest: CopyPropertiesToObjectRequest, options?: RawAxiosRequestConfig): Promise>; /** * Creates a new property for a specific object using the provided property details. The SavePropertyDTO must include necessary details, and the object association is determined by the objectUuid path variable. Returns a CreateResponse containing the newly created property as a PropertyDTO. Validation rules: name (required, must be unique, must be lowercase, must match name pattern (lowercase letters, numbers, underscores)), label (required), description (maximum 255 characters), type (required, must be one of valid PropertyTypes, cannot be changed after creation), format (required, must be one of valid PropertyFormats, cannot be changed after creation), rules (required, must be an array of string). * @summary Create a new property * @param {string} objectUuid * @param {SavePropertyDTO} savePropertyDTO Property details for creation * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProperty(objectUuid: string, savePropertyDTO: SavePropertyDTO, options?: RawAxiosRequestConfig): Promise>; /** * Deletes a property from the specified object, identified by the property UUID. Returns a DeleteResponse containing the deleted property\'s details. * @summary Delete a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns the calculation functions available for each property type (for example min/max on numbers). * @summary Retrieve allowed calculation types per property type * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCalculationTypes(objectUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Fetches a sorted list of available property formats. The formats are retrieved from the PropertyFormats enum and converted to PropertyFormat instances. * @summary Retrieve property formats * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFormats(objectUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a paginated list of properties for a given object. Depending on the object UUID format, a Cypher query is constructed to filter properties belonging to that object. Returns a PaginationResponse containing PropertyDTO objects. * @summary Fetch paginated properties * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination details (limit, page, filters, sort, query) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProperties(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves details of a property by its UUID and associates it with its parent object. Returns a ShowResponse containing a PropertyDTO object with complete property details. * @summary Fetch a specific property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns calculation functions supported for the property\'s type. * @summary Retrieve allowed calculation types for a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPropertyCalculationTypes(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Deletes the soft-deleted HAS_PROPERTY link to this object. If the property is not linked to any other object, the property node is hard-deleted. * @summary Permanently remove archived property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ permanentlyDeleteArchivedProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Pins the specified property for the logged-in user. Pinned properties appear at the top of record create and update forms. * @summary Pin a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ pinProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Restores a previously deleted property by propertyUuid for the specified objectUuid. Returns a RestoreResponse containing the restored property details. * @summary Restore a soft-deleted property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Removes the pin for the specified property for the logged-in user. * @summary Unpin a property * @param {string} objectUuid * @param {string} propertyUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ unpinProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Updates the indices for properties of a specific object. The request body should contain a mapping between property UUIDs and their new index values. Returns a SuccessResponse containing a list of updated PropertyDTO objects. * @summary Update property indices * @param {string} objectUuid * @param {{ [key: string]: number; }} requestBody Mapping of property UUIDs to new index values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices2(objectUuid: string, requestBody: { [key: string]: number; }, options?: RawAxiosRequestConfig): Promise>; /** * Updates the details of an existing property for a specific object. The property details are provided via SavePropertyDTO, and the property is identified by its UUID. Returns an UpdateResponse containing the updated property as a PropertyDTO. Validation rules: name (required, must be unique, must be lowercase, must match name pattern (lowercase letters, numbers, underscores), cannot be changed after creation), label (required), description (maximum 255 characters), type (required, must be one of valid PropertyTypes, cannot be changed after creation), format (required, must be one of valid PropertyFormats, cannot be changed after creation), rules (required, must be an array of string). * @summary Update an existing property * @param {string} objectUuid * @param {string} propertyUuid * @param {SavePropertyDTO} savePropertyDTO Updated property details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateProperty(objectUuid: string, propertyUuid: string, savePropertyDTO: SavePropertyDTO, options?: RawAxiosRequestConfig): Promise>; } /** * RecordsApi - axios parameter creator */ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Deletes a record specified by its UUID. * @summary Delete a record * @param {string} uuid * @param {string} [mode] Controls how the record is removed. Allowed values: \'archive\' (soft delete, keep all data), \'anonymize\' (remove data but keep relationships), \'delete\' (hard delete). Defaults to \'archive\'. * @param {*} [options] Override http request option. * @throws {RequiredError} */ _delete: (uuid: string, mode?: string, options?: RawAxiosRequestConfig) => Promise; /** * Groups Neo4j records by property or time bucket and returns series points with optional drilldown filters. * @summary Aggregate records for analytics charts * @param {AggregateRequest} aggregateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ aggregate: (aggregateRequest: AggregateRequest, options?: RawAxiosRequestConfig) => Promise; /** * Runs multiple aggregation requests for dashboard widgets. * @summary Batch aggregate records for analytics dashboards * @param {AggregateBatchRequest} aggregateBatchRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ aggregateBatch: (aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig) => Promise; /** * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids. * @summary Bulk delete records * @param {string} objectName * @param {BulkDeleteRecordsRequest} bulkDeleteRecordsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ bulkDelete: (objectName: string, bulkDeleteRecordsRequest: BulkDeleteRecordsRequest, options?: RawAxiosRequestConfig) => Promise; /** * Creates or updates multiple records in one request. Returns HTTP 201 when every item succeeds (no per-record errors). Returns HTTP 200 when one or more items fail validation; successful items are still persisted and listed in data.records, with failures in errors. * @summary Bulk create or update records * @param {string} objectName * @param {BulkEditRecordsRequest} bulkEditRecordsRequest * @param {boolean} [ignoreErrors] If \'true\', allows each save to proceed while ignoring certain non-critical validation errors, when supported. * @param {*} [options] Override http request option. * @throws {RequiredError} */ bulkEdit: (objectName: string, bulkEditRecordsRequest: BulkEditRecordsRequest, ignoreErrors?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc. * @summary Create a new record * @param {string} objectName * @param {RecordDTO} recordDTO Record data to create * @param {CreateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported. * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ create: (objectName: string, recordDTO: RecordDTO, parse?: CreateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: CreateRecordReturnFormatEnum, options?: RawAxiosRequestConfig) => Promise; /** * Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc. * @summary Create or update a record * @param {string} objectName * @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists. * @param {CreateOrUpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrUpdate: (objectName: string, recordDTO: RecordDTO, parse?: CreateOrUpdateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: CreateOrUpdateRecordReturnFormatEnum, options?: RawAxiosRequestConfig) => Promise; /** * Creates a relation between two records identified by their UUIDs using the provided relation name. * @summary Create a relation between records * @param {string} fromUuid * @param {string} relationName * @param {string} toUuid * @param {object} [primary] When \'true\', marks the created relation as primary. Defaults to \'false\'. * @param {RelationEdgeRequestDTO} [relationEdgeRequestDTO] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createRelation: (fromUuid: string, relationName: string, toUuid: string, primary?: object, relationEdgeRequestDTO?: RelationEdgeRequestDTO, options?: RawAxiosRequestConfig) => Promise; /** * Deletes a relation between two records identified by their UUIDs and the relation name. * @summary Delete a relation between records * @param {string} fromUuid * @param {string} relationName * @param {string} toUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRelation: (fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Extends a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it\'ll be visible in the new object.Returns a SuccessResponse confirming that the record has been extended. * @summary Extend a record * @param {string} uuid * @param {ExtendRecordRequest} extendRecordRequest * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {ExtendParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ extend: (uuid: string, extendRecordRequest: ExtendRecordRequest, recordReturnFormat?: ExtendRecordReturnFormatEnum, parse?: ExtendParseEnum, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a paginated list of records. If a preview type is specified in the request, returns records formatted for preview; otherwise, returns full record details. * @summary Fetch paginated records * @param {RecordPaginationRequest} recordPaginationRequest Pagination request for records * @param {IndexParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'. * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ index: (recordPaginationRequest: RecordPaginationRequest, parse?: IndexParseEnum, archived?: boolean, relatedRecordUuid?: string, recordReturnFormat?: IndexRecordReturnFormatEnum, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a list of records formatted for flow view based on a specific property. If the property is not provided in the request, defaults to the \'status\' property of the main object. Returns a SuccessResponse containing the flow records. * @summary Fetch records for flow view * @param {FlowPaginationRequest} flowPaginationRequest Pagination request for flow view * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {IndexFlowParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexFlow: (flowPaginationRequest: FlowPaginationRequest, relatedRecordUuid?: string, parse?: IndexFlowParseEnum, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a paginated list of webpages for page view. The search query is temporarily removed from the pagination request and passed separately. Returns a PaginationResponse containing WebpageDTO objects. * @summary Fetch records for page view * @param {RecordPaginationRequest} recordPaginationRequest Pagination request for page view * @param {string} [environment] Target environment for resolving webpages (for example \'staging\' or \'production\'). Defaults to \'staging\'. * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {string} [fields] Comma-separated WebpageDTO fields to return (for example: uuid,title). When omitted, the full WebpageDTO is returned. * @param {boolean} [publishedOnly] When true, only returns pages published in the selected environment. * @param {boolean} [excludeTemplateRelated] When true, excludes pages whose options mark them as related to a template. * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexPage: (recordPaginationRequest: RecordPaginationRequest, environment?: string, relatedRecordUuid?: string, fields?: string, publishedOnly?: boolean, excludeTemplateRelated?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves records formatted for table display. Returns a PaginationResponse containing records formatted for table view. * @summary Fetch records for table view * @param {RecordPaginationRequest} recordPaginationRequest Pagination request for table view * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexTable: (recordPaginationRequest: RecordPaginationRequest, relatedRecordUuid?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a preview for a record specified by its UUID and preview name. Returns a ShowResponse containing the preview data. * @summary Get record preview * @param {string} uuid * @param {string} name * @param {string} [object] Optional object name used to resolve the record before building the preview. * @param {PreviewParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ preview: (uuid: string, name: string, object?: string, parse?: PreviewParseEnum, options?: RawAxiosRequestConfig) => Promise; /** * Executes a two-pass GraphRAG query using natural language or a declarative plan. Returns records with scores and graph evidence. * @summary Advanced graph-aware record query * @param {AdvancedRecordQueryRequest} advancedRecordQueryRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ query: (advancedRecordQueryRequest: AdvancedRecordQueryRequest, options?: RawAxiosRequestConfig) => Promise; /** * Restores a soft-deleted record identified by its UUID. Returns a SuccessResponse confirming that the record has been restored. * @summary Restore a deleted record * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restore: (uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Performs a search for records based on the specified criteria in the request body. Returns a PaginationResponse containing matching records. * @summary Search records * @param {SearchRequest} searchRequest Search criteria * @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results. * @param {SearchParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ search: (searchRequest: SearchRequest, archived?: boolean, parse?: SearchParseEnum, recordReturnFormat?: SearchRecordReturnFormatEnum, options?: RawAxiosRequestConfig) => Promise; /** * Searches records across multiple object types in one request. Use fromObjectUuid + relationName to limit to relation target objects (e.g. event attendees), or objectUuids for an explicit list, or omit both to search all company objects (capped). Returns preview-shaped results suitable for relation pickers. * @summary Search records across objects * @param {CrossObjectRecordSearchRequest} crossObjectRecordSearchRequest * @param {boolean} [archived] When true, includes archived records. * @param {SearchCrossObjectParseEnum} [parse] Parse property values for display. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchCrossObject: (crossObjectRecordSearchRequest: CrossObjectRecordSearchRequest, archived?: boolean, parse?: SearchCrossObjectParseEnum, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves detailed information about a record by its UUID. Returns a ShowResponse containing the record details. Prefer GET /{objectName}/{uuid} when the object context is known. * @summary Get record details * @param {string} uuid * @param {string} [object] Optional object name to resolve the record in a specific object context. * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {ShowParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ show: (uuid: string, object?: string, recordReturnFormat?: ShowRecordReturnFormatEnum, parse?: ShowParseEnum, fields?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a record by object name and UUID. Same response as GET /{uuid}?object={objectName}. * @summary Get record details by object * @param {string} objectName * @param {string} uuid * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {ShowByObjectParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ showByObject: (objectName: string, uuid: string, recordReturnFormat?: ShowByObjectRecordReturnFormatEnum, parse?: ShowByObjectParseEnum, options?: RawAxiosRequestConfig) => Promise; /** * Uses structured OpenAI output plus schema validation to propose dashboard charts for an object. Returns an empty list when AI is unavailable. * @summary Suggest analytics widgets with AI * @param {SuggestAnalyticsWidgetsRequest} suggestAnalyticsWidgetsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ suggestAnalyticsWidgets: (suggestAnalyticsWidgetsRequest: SuggestAnalyticsWidgetsRequest, options?: RawAxiosRequestConfig) => Promise; /** * Updates a record\'s details identified by its UUID. The record data is provided as a RecordDTO. Returns an UpdateResponse with the updated record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc. * @summary Update a record * @param {string} uuid * @param {string} objectName * @param {RecordDTO} recordDTO Record data to update * @param {UpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported. * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ update: (uuid: string, objectName: string, recordDTO: RecordDTO, parse?: UpdateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: UpdateRecordReturnFormatEnum, options?: RawAxiosRequestConfig) => Promise; /** * Updates a record identified by UUID. Optional object query param resolves the object context (same as GET /{uuid}?object=...). When omitted, the record\'s current/primary object is used. Prefer PUT /{objectName}/{uuid} when the object context is known. * @summary Update a record by UUID * @param {string} uuid * @param {RecordDTO} recordDTO * @param {string} [object] Optional object name to resolve the record in a specific object context. * @param {UpdateByUuidParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported. * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateByUuid: (uuid: string, recordDTO: RecordDTO, object?: string, parse?: UpdateByUuidParseEnum, ignoreErrors?: boolean, recordReturnFormat?: UpdateByUuidRecordReturnFormatEnum, options?: RawAxiosRequestConfig) => Promise; /** * Patches values stored on an existing relation edge. Only keys present in edgeProperties are written; a null value clears a key. * @summary Update relation edge properties * @param {string} fromUuid * @param {string} relationName * @param {string} toUuid * @param {RelationEdgeRequestDTO} relationEdgeRequestDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateRelationEdge: (fromUuid: string, relationName: string, toUuid: string, relationEdgeRequestDTO: RelationEdgeRequestDTO, options?: RawAxiosRequestConfig) => Promise; }; /** * RecordsApi - functional programming interface */ export declare const RecordsApiFp: (configuration?: Configuration) => { /** * Deletes a record specified by its UUID. * @summary Delete a record * @param {string} uuid * @param {string} [mode] Controls how the record is removed. Allowed values: \'archive\' (soft delete, keep all data), \'anonymize\' (remove data but keep relationships), \'delete\' (hard delete). Defaults to \'archive\'. * @param {*} [options] Override http request option. * @throws {RequiredError} */ _delete(uuid: string, mode?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Groups Neo4j records by property or time bucket and returns series points with optional drilldown filters. * @summary Aggregate records for analytics charts * @param {AggregateRequest} aggregateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ aggregate(aggregateRequest: AggregateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Runs multiple aggregation requests for dashboard widgets. * @summary Batch aggregate records for analytics dashboards * @param {AggregateBatchRequest} aggregateBatchRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids. * @summary Bulk delete records * @param {string} objectName * @param {BulkDeleteRecordsRequest} bulkDeleteRecordsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ bulkDelete(objectName: string, bulkDeleteRecordsRequest: BulkDeleteRecordsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates or updates multiple records in one request. Returns HTTP 201 when every item succeeds (no per-record errors). Returns HTTP 200 when one or more items fail validation; successful items are still persisted and listed in data.records, with failures in errors. * @summary Bulk create or update records * @param {string} objectName * @param {BulkEditRecordsRequest} bulkEditRecordsRequest * @param {boolean} [ignoreErrors] If \'true\', allows each save to proceed while ignoring certain non-critical validation errors, when supported. * @param {*} [options] Override http request option. * @throws {RequiredError} */ bulkEdit(objectName: string, bulkEditRecordsRequest: BulkEditRecordsRequest, ignoreErrors?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc. * @summary Create a new record * @param {string} objectName * @param {RecordDTO} recordDTO Record data to create * @param {CreateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported. * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ create(objectName: string, recordDTO: RecordDTO, parse?: CreateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: CreateRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc. * @summary Create or update a record * @param {string} objectName * @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists. * @param {CreateOrUpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrUpdate(objectName: string, recordDTO: RecordDTO, parse?: CreateOrUpdateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: CreateOrUpdateRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a relation between two records identified by their UUIDs using the provided relation name. * @summary Create a relation between records * @param {string} fromUuid * @param {string} relationName * @param {string} toUuid * @param {object} [primary] When \'true\', marks the created relation as primary. Defaults to \'false\'. * @param {RelationEdgeRequestDTO} [relationEdgeRequestDTO] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createRelation(fromUuid: string, relationName: string, toUuid: string, primary?: object, relationEdgeRequestDTO?: RelationEdgeRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a relation between two records identified by their UUIDs and the relation name. * @summary Delete a relation between records * @param {string} fromUuid * @param {string} relationName * @param {string} toUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRelation(fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Extends a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it\'ll be visible in the new object.Returns a SuccessResponse confirming that the record has been extended. * @summary Extend a record * @param {string} uuid * @param {ExtendRecordRequest} extendRecordRequest * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {ExtendParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ extend(uuid: string, extendRecordRequest: ExtendRecordRequest, recordReturnFormat?: ExtendRecordReturnFormatEnum, parse?: ExtendParseEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a paginated list of records. If a preview type is specified in the request, returns records formatted for preview; otherwise, returns full record details. * @summary Fetch paginated records * @param {RecordPaginationRequest} recordPaginationRequest Pagination request for records * @param {IndexParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'. * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ index(recordPaginationRequest: RecordPaginationRequest, parse?: IndexParseEnum, archived?: boolean, relatedRecordUuid?: string, recordReturnFormat?: IndexRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a list of records formatted for flow view based on a specific property. If the property is not provided in the request, defaults to the \'status\' property of the main object. Returns a SuccessResponse containing the flow records. * @summary Fetch records for flow view * @param {FlowPaginationRequest} flowPaginationRequest Pagination request for flow view * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {IndexFlowParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexFlow(flowPaginationRequest: FlowPaginationRequest, relatedRecordUuid?: string, parse?: IndexFlowParseEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a paginated list of webpages for page view. The search query is temporarily removed from the pagination request and passed separately. Returns a PaginationResponse containing WebpageDTO objects. * @summary Fetch records for page view * @param {RecordPaginationRequest} recordPaginationRequest Pagination request for page view * @param {string} [environment] Target environment for resolving webpages (for example \'staging\' or \'production\'). Defaults to \'staging\'. * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {string} [fields] Comma-separated WebpageDTO fields to return (for example: uuid,title). When omitted, the full WebpageDTO is returned. * @param {boolean} [publishedOnly] When true, only returns pages published in the selected environment. * @param {boolean} [excludeTemplateRelated] When true, excludes pages whose options mark them as related to a template. * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexPage(recordPaginationRequest: RecordPaginationRequest, environment?: string, relatedRecordUuid?: string, fields?: string, publishedOnly?: boolean, excludeTemplateRelated?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves records formatted for table display. Returns a PaginationResponse containing records formatted for table view. * @summary Fetch records for table view * @param {RecordPaginationRequest} recordPaginationRequest Pagination request for table view * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexTable(recordPaginationRequest: RecordPaginationRequest, relatedRecordUuid?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a preview for a record specified by its UUID and preview name. Returns a ShowResponse containing the preview data. * @summary Get record preview * @param {string} uuid * @param {string} name * @param {string} [object] Optional object name used to resolve the record before building the preview. * @param {PreviewParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ preview(uuid: string, name: string, object?: string, parse?: PreviewParseEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Executes a two-pass GraphRAG query using natural language or a declarative plan. Returns records with scores and graph evidence. * @summary Advanced graph-aware record query * @param {AdvancedRecordQueryRequest} advancedRecordQueryRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ query(advancedRecordQueryRequest: AdvancedRecordQueryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Restores a soft-deleted record identified by its UUID. Returns a SuccessResponse confirming that the record has been restored. * @summary Restore a deleted record * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restore(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Performs a search for records based on the specified criteria in the request body. Returns a PaginationResponse containing matching records. * @summary Search records * @param {SearchRequest} searchRequest Search criteria * @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results. * @param {SearchParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ search(searchRequest: SearchRequest, archived?: boolean, parse?: SearchParseEnum, recordReturnFormat?: SearchRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Searches records across multiple object types in one request. Use fromObjectUuid + relationName to limit to relation target objects (e.g. event attendees), or objectUuids for an explicit list, or omit both to search all company objects (capped). Returns preview-shaped results suitable for relation pickers. * @summary Search records across objects * @param {CrossObjectRecordSearchRequest} crossObjectRecordSearchRequest * @param {boolean} [archived] When true, includes archived records. * @param {SearchCrossObjectParseEnum} [parse] Parse property values for display. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchCrossObject(crossObjectRecordSearchRequest: CrossObjectRecordSearchRequest, archived?: boolean, parse?: SearchCrossObjectParseEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves detailed information about a record by its UUID. Returns a ShowResponse containing the record details. Prefer GET /{objectName}/{uuid} when the object context is known. * @summary Get record details * @param {string} uuid * @param {string} [object] Optional object name to resolve the record in a specific object context. * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {ShowParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ show(uuid: string, object?: string, recordReturnFormat?: ShowRecordReturnFormatEnum, parse?: ShowParseEnum, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a record by object name and UUID. Same response as GET /{uuid}?object={objectName}. * @summary Get record details by object * @param {string} objectName * @param {string} uuid * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {ShowByObjectParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ showByObject(objectName: string, uuid: string, recordReturnFormat?: ShowByObjectRecordReturnFormatEnum, parse?: ShowByObjectParseEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Uses structured OpenAI output plus schema validation to propose dashboard charts for an object. Returns an empty list when AI is unavailable. * @summary Suggest analytics widgets with AI * @param {SuggestAnalyticsWidgetsRequest} suggestAnalyticsWidgetsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ suggestAnalyticsWidgets(suggestAnalyticsWidgetsRequest: SuggestAnalyticsWidgetsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates a record\'s details identified by its UUID. The record data is provided as a RecordDTO. Returns an UpdateResponse with the updated record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc. * @summary Update a record * @param {string} uuid * @param {string} objectName * @param {RecordDTO} recordDTO Record data to update * @param {UpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported. * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ update(uuid: string, objectName: string, recordDTO: RecordDTO, parse?: UpdateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: UpdateRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates a record identified by UUID. Optional object query param resolves the object context (same as GET /{uuid}?object=...). When omitted, the record\'s current/primary object is used. Prefer PUT /{objectName}/{uuid} when the object context is known. * @summary Update a record by UUID * @param {string} uuid * @param {RecordDTO} recordDTO * @param {string} [object] Optional object name to resolve the record in a specific object context. * @param {UpdateByUuidParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported. * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateByUuid(uuid: string, recordDTO: RecordDTO, object?: string, parse?: UpdateByUuidParseEnum, ignoreErrors?: boolean, recordReturnFormat?: UpdateByUuidRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Patches values stored on an existing relation edge. Only keys present in edgeProperties are written; a null value clears a key. * @summary Update relation edge properties * @param {string} fromUuid * @param {string} relationName * @param {string} toUuid * @param {RelationEdgeRequestDTO} relationEdgeRequestDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateRelationEdge(fromUuid: string, relationName: string, toUuid: string, relationEdgeRequestDTO: RelationEdgeRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RecordsApi - factory interface */ export declare const RecordsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Deletes a record specified by its UUID. * @summary Delete a record * @param {string} uuid * @param {string} [mode] Controls how the record is removed. Allowed values: \'archive\' (soft delete, keep all data), \'anonymize\' (remove data but keep relationships), \'delete\' (hard delete). Defaults to \'archive\'. * @param {*} [options] Override http request option. * @throws {RequiredError} */ _delete(uuid: string, mode?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Groups Neo4j records by property or time bucket and returns series points with optional drilldown filters. * @summary Aggregate records for analytics charts * @param {AggregateRequest} aggregateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ aggregate(aggregateRequest: AggregateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Runs multiple aggregation requests for dashboard widgets. * @summary Batch aggregate records for analytics dashboards * @param {AggregateBatchRequest} aggregateBatchRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids. * @summary Bulk delete records * @param {string} objectName * @param {BulkDeleteRecordsRequest} bulkDeleteRecordsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ bulkDelete(objectName: string, bulkDeleteRecordsRequest: BulkDeleteRecordsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates or updates multiple records in one request. Returns HTTP 201 when every item succeeds (no per-record errors). Returns HTTP 200 when one or more items fail validation; successful items are still persisted and listed in data.records, with failures in errors. * @summary Bulk create or update records * @param {string} objectName * @param {BulkEditRecordsRequest} bulkEditRecordsRequest * @param {boolean} [ignoreErrors] If \'true\', allows each save to proceed while ignoring certain non-critical validation errors, when supported. * @param {*} [options] Override http request option. * @throws {RequiredError} */ bulkEdit(objectName: string, bulkEditRecordsRequest: BulkEditRecordsRequest, ignoreErrors?: boolean, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc. * @summary Create a new record * @param {string} objectName * @param {RecordDTO} recordDTO Record data to create * @param {CreateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported. * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ create(objectName: string, recordDTO: RecordDTO, parse?: CreateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: CreateRecordReturnFormatEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc. * @summary Create or update a record * @param {string} objectName * @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists. * @param {CreateOrUpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrUpdate(objectName: string, recordDTO: RecordDTO, parse?: CreateOrUpdateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: CreateOrUpdateRecordReturnFormatEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a relation between two records identified by their UUIDs using the provided relation name. * @summary Create a relation between records * @param {string} fromUuid * @param {string} relationName * @param {string} toUuid * @param {object} [primary] When \'true\', marks the created relation as primary. Defaults to \'false\'. * @param {RelationEdgeRequestDTO} [relationEdgeRequestDTO] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createRelation(fromUuid: string, relationName: string, toUuid: string, primary?: object, relationEdgeRequestDTO?: RelationEdgeRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes a relation between two records identified by their UUIDs and the relation name. * @summary Delete a relation between records * @param {string} fromUuid * @param {string} relationName * @param {string} toUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRelation(fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Extends a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it\'ll be visible in the new object.Returns a SuccessResponse confirming that the record has been extended. * @summary Extend a record * @param {string} uuid * @param {ExtendRecordRequest} extendRecordRequest * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {ExtendParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ extend(uuid: string, extendRecordRequest: ExtendRecordRequest, recordReturnFormat?: ExtendRecordReturnFormatEnum, parse?: ExtendParseEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a paginated list of records. If a preview type is specified in the request, returns records formatted for preview; otherwise, returns full record details. * @summary Fetch paginated records * @param {RecordPaginationRequest} recordPaginationRequest Pagination request for records * @param {IndexParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'. * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ index(recordPaginationRequest: RecordPaginationRequest, parse?: IndexParseEnum, archived?: boolean, relatedRecordUuid?: string, recordReturnFormat?: IndexRecordReturnFormatEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a list of records formatted for flow view based on a specific property. If the property is not provided in the request, defaults to the \'status\' property of the main object. Returns a SuccessResponse containing the flow records. * @summary Fetch records for flow view * @param {FlowPaginationRequest} flowPaginationRequest Pagination request for flow view * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {IndexFlowParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexFlow(flowPaginationRequest: FlowPaginationRequest, relatedRecordUuid?: string, parse?: IndexFlowParseEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a paginated list of webpages for page view. The search query is temporarily removed from the pagination request and passed separately. Returns a PaginationResponse containing WebpageDTO objects. * @summary Fetch records for page view * @param {RecordPaginationRequest} recordPaginationRequest Pagination request for page view * @param {string} [environment] Target environment for resolving webpages (for example \'staging\' or \'production\'). Defaults to \'staging\'. * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {string} [fields] Comma-separated WebpageDTO fields to return (for example: uuid,title). When omitted, the full WebpageDTO is returned. * @param {boolean} [publishedOnly] When true, only returns pages published in the selected environment. * @param {boolean} [excludeTemplateRelated] When true, excludes pages whose options mark them as related to a template. * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexPage(recordPaginationRequest: RecordPaginationRequest, environment?: string, relatedRecordUuid?: string, fields?: string, publishedOnly?: boolean, excludeTemplateRelated?: boolean, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves records formatted for table display. Returns a PaginationResponse containing records formatted for table view. * @summary Fetch records for table view * @param {RecordPaginationRequest} recordPaginationRequest Pagination request for table view * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexTable(recordPaginationRequest: RecordPaginationRequest, relatedRecordUuid?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a preview for a record specified by its UUID and preview name. Returns a ShowResponse containing the preview data. * @summary Get record preview * @param {string} uuid * @param {string} name * @param {string} [object] Optional object name used to resolve the record before building the preview. * @param {PreviewParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ preview(uuid: string, name: string, object?: string, parse?: PreviewParseEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Executes a two-pass GraphRAG query using natural language or a declarative plan. Returns records with scores and graph evidence. * @summary Advanced graph-aware record query * @param {AdvancedRecordQueryRequest} advancedRecordQueryRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ query(advancedRecordQueryRequest: AdvancedRecordQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Restores a soft-deleted record identified by its UUID. Returns a SuccessResponse confirming that the record has been restored. * @summary Restore a deleted record * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restore(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Performs a search for records based on the specified criteria in the request body. Returns a PaginationResponse containing matching records. * @summary Search records * @param {SearchRequest} searchRequest Search criteria * @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results. * @param {SearchParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ search(searchRequest: SearchRequest, archived?: boolean, parse?: SearchParseEnum, recordReturnFormat?: SearchRecordReturnFormatEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Searches records across multiple object types in one request. Use fromObjectUuid + relationName to limit to relation target objects (e.g. event attendees), or objectUuids for an explicit list, or omit both to search all company objects (capped). Returns preview-shaped results suitable for relation pickers. * @summary Search records across objects * @param {CrossObjectRecordSearchRequest} crossObjectRecordSearchRequest * @param {boolean} [archived] When true, includes archived records. * @param {SearchCrossObjectParseEnum} [parse] Parse property values for display. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchCrossObject(crossObjectRecordSearchRequest: CrossObjectRecordSearchRequest, archived?: boolean, parse?: SearchCrossObjectParseEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves detailed information about a record by its UUID. Returns a ShowResponse containing the record details. Prefer GET /{objectName}/{uuid} when the object context is known. * @summary Get record details * @param {string} uuid * @param {string} [object] Optional object name to resolve the record in a specific object context. * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {ShowParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ show(uuid: string, object?: string, recordReturnFormat?: ShowRecordReturnFormatEnum, parse?: ShowParseEnum, fields?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a record by object name and UUID. Same response as GET /{uuid}?object={objectName}. * @summary Get record details by object * @param {string} objectName * @param {string} uuid * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {ShowByObjectParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ showByObject(objectName: string, uuid: string, recordReturnFormat?: ShowByObjectRecordReturnFormatEnum, parse?: ShowByObjectParseEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Uses structured OpenAI output plus schema validation to propose dashboard charts for an object. Returns an empty list when AI is unavailable. * @summary Suggest analytics widgets with AI * @param {SuggestAnalyticsWidgetsRequest} suggestAnalyticsWidgetsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ suggestAnalyticsWidgets(suggestAnalyticsWidgetsRequest: SuggestAnalyticsWidgetsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates a record\'s details identified by its UUID. The record data is provided as a RecordDTO. Returns an UpdateResponse with the updated record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc. * @summary Update a record * @param {string} uuid * @param {string} objectName * @param {RecordDTO} recordDTO Record data to update * @param {UpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported. * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ update(uuid: string, objectName: string, recordDTO: RecordDTO, parse?: UpdateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: UpdateRecordReturnFormatEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates a record identified by UUID. Optional object query param resolves the object context (same as GET /{uuid}?object=...). When omitted, the record\'s current/primary object is used. Prefer PUT /{objectName}/{uuid} when the object context is known. * @summary Update a record by UUID * @param {string} uuid * @param {RecordDTO} recordDTO * @param {string} [object] Optional object name to resolve the record in a specific object context. * @param {UpdateByUuidParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported. * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateByUuid(uuid: string, recordDTO: RecordDTO, object?: string, parse?: UpdateByUuidParseEnum, ignoreErrors?: boolean, recordReturnFormat?: UpdateByUuidRecordReturnFormatEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Patches values stored on an existing relation edge. Only keys present in edgeProperties are written; a null value clears a key. * @summary Update relation edge properties * @param {string} fromUuid * @param {string} relationName * @param {string} toUuid * @param {RelationEdgeRequestDTO} relationEdgeRequestDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateRelationEdge(fromUuid: string, relationName: string, toUuid: string, relationEdgeRequestDTO: RelationEdgeRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * RecordsApi - object-oriented interface */ export declare class RecordsApi extends BaseAPI { /** * Deletes a record specified by its UUID. * @summary Delete a record * @param {string} uuid * @param {string} [mode] Controls how the record is removed. Allowed values: \'archive\' (soft delete, keep all data), \'anonymize\' (remove data but keep relationships), \'delete\' (hard delete). Defaults to \'archive\'. * @param {*} [options] Override http request option. * @throws {RequiredError} */ _delete(uuid: string, mode?: string, options?: RawAxiosRequestConfig): Promise>; /** * Groups Neo4j records by property or time bucket and returns series points with optional drilldown filters. * @summary Aggregate records for analytics charts * @param {AggregateRequest} aggregateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ aggregate(aggregateRequest: AggregateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Runs multiple aggregation requests for dashboard widgets. * @summary Batch aggregate records for analytics dashboards * @param {AggregateBatchRequest} aggregateBatchRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): Promise>; /** * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids. * @summary Bulk delete records * @param {string} objectName * @param {BulkDeleteRecordsRequest} bulkDeleteRecordsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ bulkDelete(objectName: string, bulkDeleteRecordsRequest: BulkDeleteRecordsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Creates or updates multiple records in one request. Returns HTTP 201 when every item succeeds (no per-record errors). Returns HTTP 200 when one or more items fail validation; successful items are still persisted and listed in data.records, with failures in errors. * @summary Bulk create or update records * @param {string} objectName * @param {BulkEditRecordsRequest} bulkEditRecordsRequest * @param {boolean} [ignoreErrors] If \'true\', allows each save to proceed while ignoring certain non-critical validation errors, when supported. * @param {*} [options] Override http request option. * @throws {RequiredError} */ bulkEdit(objectName: string, bulkEditRecordsRequest: BulkEditRecordsRequest, ignoreErrors?: boolean, options?: RawAxiosRequestConfig): Promise>; /** * Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc. * @summary Create a new record * @param {string} objectName * @param {RecordDTO} recordDTO Record data to create * @param {CreateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported. * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ create(objectName: string, recordDTO: RecordDTO, parse?: CreateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: CreateRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise>; /** * Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc. * @summary Create or update a record * @param {string} objectName * @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists. * @param {CreateOrUpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrUpdate(objectName: string, recordDTO: RecordDTO, parse?: CreateOrUpdateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: CreateOrUpdateRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise>; /** * Creates a relation between two records identified by their UUIDs using the provided relation name. * @summary Create a relation between records * @param {string} fromUuid * @param {string} relationName * @param {string} toUuid * @param {object} [primary] When \'true\', marks the created relation as primary. Defaults to \'false\'. * @param {RelationEdgeRequestDTO} [relationEdgeRequestDTO] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createRelation(fromUuid: string, relationName: string, toUuid: string, primary?: object, relationEdgeRequestDTO?: RelationEdgeRequestDTO, options?: RawAxiosRequestConfig): Promise>; /** * Deletes a relation between two records identified by their UUIDs and the relation name. * @summary Delete a relation between records * @param {string} fromUuid * @param {string} relationName * @param {string} toUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRelation(fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Extends a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it\'ll be visible in the new object.Returns a SuccessResponse confirming that the record has been extended. * @summary Extend a record * @param {string} uuid * @param {ExtendRecordRequest} extendRecordRequest * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {ExtendParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ extend(uuid: string, extendRecordRequest: ExtendRecordRequest, recordReturnFormat?: ExtendRecordReturnFormatEnum, parse?: ExtendParseEnum, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a paginated list of records. If a preview type is specified in the request, returns records formatted for preview; otherwise, returns full record details. * @summary Fetch paginated records * @param {RecordPaginationRequest} recordPaginationRequest Pagination request for records * @param {IndexParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'. * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ index(recordPaginationRequest: RecordPaginationRequest, parse?: IndexParseEnum, archived?: boolean, relatedRecordUuid?: string, recordReturnFormat?: IndexRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a list of records formatted for flow view based on a specific property. If the property is not provided in the request, defaults to the \'status\' property of the main object. Returns a SuccessResponse containing the flow records. * @summary Fetch records for flow view * @param {FlowPaginationRequest} flowPaginationRequest Pagination request for flow view * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {IndexFlowParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexFlow(flowPaginationRequest: FlowPaginationRequest, relatedRecordUuid?: string, parse?: IndexFlowParseEnum, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a paginated list of webpages for page view. The search query is temporarily removed from the pagination request and passed separately. Returns a PaginationResponse containing WebpageDTO objects. * @summary Fetch records for page view * @param {RecordPaginationRequest} recordPaginationRequest Pagination request for page view * @param {string} [environment] Target environment for resolving webpages (for example \'staging\' or \'production\'). Defaults to \'staging\'. * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {string} [fields] Comma-separated WebpageDTO fields to return (for example: uuid,title). When omitted, the full WebpageDTO is returned. * @param {boolean} [publishedOnly] When true, only returns pages published in the selected environment. * @param {boolean} [excludeTemplateRelated] When true, excludes pages whose options mark them as related to a template. * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexPage(recordPaginationRequest: RecordPaginationRequest, environment?: string, relatedRecordUuid?: string, fields?: string, publishedOnly?: boolean, excludeTemplateRelated?: boolean, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves records formatted for table display. Returns a PaginationResponse containing records formatted for table view. * @summary Fetch records for table view * @param {RecordPaginationRequest} recordPaginationRequest Pagination request for table view * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexTable(recordPaginationRequest: RecordPaginationRequest, relatedRecordUuid?: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a preview for a record specified by its UUID and preview name. Returns a ShowResponse containing the preview data. * @summary Get record preview * @param {string} uuid * @param {string} name * @param {string} [object] Optional object name used to resolve the record before building the preview. * @param {PreviewParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ preview(uuid: string, name: string, object?: string, parse?: PreviewParseEnum, options?: RawAxiosRequestConfig): Promise>; /** * Executes a two-pass GraphRAG query using natural language or a declarative plan. Returns records with scores and graph evidence. * @summary Advanced graph-aware record query * @param {AdvancedRecordQueryRequest} advancedRecordQueryRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ query(advancedRecordQueryRequest: AdvancedRecordQueryRequest, options?: RawAxiosRequestConfig): Promise>; /** * Restores a soft-deleted record identified by its UUID. Returns a SuccessResponse confirming that the record has been restored. * @summary Restore a deleted record * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restore(uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Performs a search for records based on the specified criteria in the request body. Returns a PaginationResponse containing matching records. * @summary Search records * @param {SearchRequest} searchRequest Search criteria * @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results. * @param {SearchParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ search(searchRequest: SearchRequest, archived?: boolean, parse?: SearchParseEnum, recordReturnFormat?: SearchRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise>; /** * Searches records across multiple object types in one request. Use fromObjectUuid + relationName to limit to relation target objects (e.g. event attendees), or objectUuids for an explicit list, or omit both to search all company objects (capped). Returns preview-shaped results suitable for relation pickers. * @summary Search records across objects * @param {CrossObjectRecordSearchRequest} crossObjectRecordSearchRequest * @param {boolean} [archived] When true, includes archived records. * @param {SearchCrossObjectParseEnum} [parse] Parse property values for display. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchCrossObject(crossObjectRecordSearchRequest: CrossObjectRecordSearchRequest, archived?: boolean, parse?: SearchCrossObjectParseEnum, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves detailed information about a record by its UUID. Returns a ShowResponse containing the record details. Prefer GET /{objectName}/{uuid} when the object context is known. * @summary Get record details * @param {string} uuid * @param {string} [object] Optional object name to resolve the record in a specific object context. * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {ShowParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ show(uuid: string, object?: string, recordReturnFormat?: ShowRecordReturnFormatEnum, parse?: ShowParseEnum, fields?: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a record by object name and UUID. Same response as GET /{uuid}?object={objectName}. * @summary Get record details by object * @param {string} objectName * @param {string} uuid * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {ShowByObjectParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {*} [options] Override http request option. * @throws {RequiredError} */ showByObject(objectName: string, uuid: string, recordReturnFormat?: ShowByObjectRecordReturnFormatEnum, parse?: ShowByObjectParseEnum, options?: RawAxiosRequestConfig): Promise>; /** * Uses structured OpenAI output plus schema validation to propose dashboard charts for an object. Returns an empty list when AI is unavailable. * @summary Suggest analytics widgets with AI * @param {SuggestAnalyticsWidgetsRequest} suggestAnalyticsWidgetsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ suggestAnalyticsWidgets(suggestAnalyticsWidgetsRequest: SuggestAnalyticsWidgetsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Updates a record\'s details identified by its UUID. The record data is provided as a RecordDTO. Returns an UpdateResponse with the updated record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc. * @summary Update a record * @param {string} uuid * @param {string} objectName * @param {RecordDTO} recordDTO Record data to update * @param {UpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported. * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ update(uuid: string, objectName: string, recordDTO: RecordDTO, parse?: UpdateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: UpdateRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise>; /** * Updates a record identified by UUID. Optional object query param resolves the object context (same as GET /{uuid}?object=...). When omitted, the record\'s current/primary object is used. Prefer PUT /{objectName}/{uuid} when the object context is known. * @summary Update a record by UUID * @param {string} uuid * @param {RecordDTO} recordDTO * @param {string} [object] Optional object name to resolve the record in a specific object context. * @param {UpdateByUuidParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported. * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateByUuid(uuid: string, recordDTO: RecordDTO, object?: string, parse?: UpdateByUuidParseEnum, ignoreErrors?: boolean, recordReturnFormat?: UpdateByUuidRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise>; /** * Patches values stored on an existing relation edge. Only keys present in edgeProperties are written; a null value clears a key. * @summary Update relation edge properties * @param {string} fromUuid * @param {string} relationName * @param {string} toUuid * @param {RelationEdgeRequestDTO} relationEdgeRequestDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateRelationEdge(fromUuid: string, relationName: string, toUuid: string, relationEdgeRequestDTO: RelationEdgeRequestDTO, options?: RawAxiosRequestConfig): Promise>; } export declare const CreateParseEnum: { readonly Db: "DB"; readonly HumanReadable: "HUMAN_READABLE"; readonly Structured: "STRUCTURED"; }; export type CreateParseEnum = typeof CreateParseEnum[keyof typeof CreateParseEnum]; export declare const CreateRecordReturnFormatEnum: { readonly Legacy: "LEGACY"; readonly UserFriendly: "USER_FRIENDLY"; readonly Expanded: "EXPANDED"; }; export type CreateRecordReturnFormatEnum = typeof CreateRecordReturnFormatEnum[keyof typeof CreateRecordReturnFormatEnum]; export declare const CreateOrUpdateParseEnum: { readonly Db: "DB"; readonly HumanReadable: "HUMAN_READABLE"; readonly Structured: "STRUCTURED"; }; export type CreateOrUpdateParseEnum = typeof CreateOrUpdateParseEnum[keyof typeof CreateOrUpdateParseEnum]; export declare const CreateOrUpdateRecordReturnFormatEnum: { readonly Legacy: "LEGACY"; readonly UserFriendly: "USER_FRIENDLY"; readonly Expanded: "EXPANDED"; }; export type CreateOrUpdateRecordReturnFormatEnum = typeof CreateOrUpdateRecordReturnFormatEnum[keyof typeof CreateOrUpdateRecordReturnFormatEnum]; export declare const ExtendRecordReturnFormatEnum: { readonly Legacy: "LEGACY"; readonly UserFriendly: "USER_FRIENDLY"; readonly Expanded: "EXPANDED"; }; export type ExtendRecordReturnFormatEnum = typeof ExtendRecordReturnFormatEnum[keyof typeof ExtendRecordReturnFormatEnum]; export declare const ExtendParseEnum: { readonly Db: "DB"; readonly HumanReadable: "HUMAN_READABLE"; readonly Structured: "STRUCTURED"; }; export type ExtendParseEnum = typeof ExtendParseEnum[keyof typeof ExtendParseEnum]; export declare const IndexParseEnum: { readonly Db: "DB"; readonly HumanReadable: "HUMAN_READABLE"; readonly Structured: "STRUCTURED"; }; export type IndexParseEnum = typeof IndexParseEnum[keyof typeof IndexParseEnum]; export declare const IndexRecordReturnFormatEnum: { readonly Legacy: "LEGACY"; readonly UserFriendly: "USER_FRIENDLY"; readonly Expanded: "EXPANDED"; }; export type IndexRecordReturnFormatEnum = typeof IndexRecordReturnFormatEnum[keyof typeof IndexRecordReturnFormatEnum]; export declare const IndexFlowParseEnum: { readonly Db: "DB"; readonly HumanReadable: "HUMAN_READABLE"; readonly Structured: "STRUCTURED"; }; export type IndexFlowParseEnum = typeof IndexFlowParseEnum[keyof typeof IndexFlowParseEnum]; export declare const PreviewParseEnum: { readonly Db: "DB"; readonly HumanReadable: "HUMAN_READABLE"; readonly Structured: "STRUCTURED"; }; export type PreviewParseEnum = typeof PreviewParseEnum[keyof typeof PreviewParseEnum]; export declare const SearchParseEnum: { readonly Db: "DB"; readonly HumanReadable: "HUMAN_READABLE"; readonly Structured: "STRUCTURED"; }; export type SearchParseEnum = typeof SearchParseEnum[keyof typeof SearchParseEnum]; export declare const SearchRecordReturnFormatEnum: { readonly Legacy: "LEGACY"; readonly UserFriendly: "USER_FRIENDLY"; readonly Expanded: "EXPANDED"; }; export type SearchRecordReturnFormatEnum = typeof SearchRecordReturnFormatEnum[keyof typeof SearchRecordReturnFormatEnum]; export declare const SearchCrossObjectParseEnum: { readonly Db: "DB"; readonly HumanReadable: "HUMAN_READABLE"; readonly Structured: "STRUCTURED"; }; export type SearchCrossObjectParseEnum = typeof SearchCrossObjectParseEnum[keyof typeof SearchCrossObjectParseEnum]; export declare const ShowRecordReturnFormatEnum: { readonly Legacy: "LEGACY"; readonly UserFriendly: "USER_FRIENDLY"; readonly Expanded: "EXPANDED"; }; export type ShowRecordReturnFormatEnum = typeof ShowRecordReturnFormatEnum[keyof typeof ShowRecordReturnFormatEnum]; export declare const ShowParseEnum: { readonly Db: "DB"; readonly HumanReadable: "HUMAN_READABLE"; readonly Structured: "STRUCTURED"; }; export type ShowParseEnum = typeof ShowParseEnum[keyof typeof ShowParseEnum]; export declare const ShowByObjectRecordReturnFormatEnum: { readonly Legacy: "LEGACY"; readonly UserFriendly: "USER_FRIENDLY"; readonly Expanded: "EXPANDED"; }; export type ShowByObjectRecordReturnFormatEnum = typeof ShowByObjectRecordReturnFormatEnum[keyof typeof ShowByObjectRecordReturnFormatEnum]; export declare const ShowByObjectParseEnum: { readonly Db: "DB"; readonly HumanReadable: "HUMAN_READABLE"; readonly Structured: "STRUCTURED"; }; export type ShowByObjectParseEnum = typeof ShowByObjectParseEnum[keyof typeof ShowByObjectParseEnum]; export declare const UpdateParseEnum: { readonly Db: "DB"; readonly HumanReadable: "HUMAN_READABLE"; readonly Structured: "STRUCTURED"; }; export type UpdateParseEnum = typeof UpdateParseEnum[keyof typeof UpdateParseEnum]; export declare const UpdateRecordReturnFormatEnum: { readonly Legacy: "LEGACY"; readonly UserFriendly: "USER_FRIENDLY"; readonly Expanded: "EXPANDED"; }; export type UpdateRecordReturnFormatEnum = typeof UpdateRecordReturnFormatEnum[keyof typeof UpdateRecordReturnFormatEnum]; export declare const UpdateByUuidParseEnum: { readonly Db: "DB"; readonly HumanReadable: "HUMAN_READABLE"; readonly Structured: "STRUCTURED"; }; export type UpdateByUuidParseEnum = typeof UpdateByUuidParseEnum[keyof typeof UpdateByUuidParseEnum]; export declare const UpdateByUuidRecordReturnFormatEnum: { readonly Legacy: "LEGACY"; readonly UserFriendly: "USER_FRIENDLY"; readonly Expanded: "EXPANDED"; }; export type UpdateByUuidRecordReturnFormatEnum = typeof UpdateByUuidRecordReturnFormatEnum[keyof typeof UpdateByUuidRecordReturnFormatEnum]; /** * RelationsApi - axios parameter creator */ export declare const RelationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a connection between two objects for a given relation. The \'from\' and \'to\' UUIDs identify the objects to connect. * @summary Add a connection to a relation * @param {string} relationUuid * @param {string} from * @param {string} to * @param {*} [options] Override http request option. * @throws {RequiredError} */ addConnection: (relationUuid: string, from: string, to: string, options?: RawAxiosRequestConfig) => Promise; /** * Creates a new relation or updates an existing one for the specified object. If a relation with the same name exists, it is updated; otherwise, a new relation is created. Returns an UpdateResponse if updated or a CreateResponse if created. * @summary Create or update a relation * @param {string} objectUuid * @param {RelationDTO} relationDTO Relation data * @param {*} [options] Override http request option. * @throws {RequiredError} */ createRelationOrUpdate: (objectUuid: string, relationDTO: RelationDTO, options?: RawAxiosRequestConfig) => Promise; /** * Deletes a connection between two objects for a given relation using the specified UUIDs. * @summary Delete a connection from a relation * @param {string} relationUuid * @param {string} from * @param {string} to * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteConnection: (relationUuid: string, from: string, to: string, options?: RawAxiosRequestConfig) => Promise; /** * Deletes a relation specified by its UUID. Returns a DeleteResponse with the deleted relation details. * @summary Delete a relation * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRelation1: (relationUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the details of a relation by its UUID. Returns a ShowResponse containing a RelationDTO. * @summary Get relation details * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelation: (relationUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a relation by its UUID and associates it with the specified object, returning a RelationDTO that includes details from the related object. * @summary Get relation details for a specific object * @param {string} relationUuid * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelationForObject: (relationUuid: string, objectUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a paginated list of relations. Returns a PaginationResponse containing RelationDTO objects based on the provided pagination criteria. * @summary Fetch paginated relations * @param {PaginationRequest} paginationRequest Pagination request for relations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelations: (paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves all relations between two objects based on the provided object UUIDs. * @summary Get all relations between two objects * @param {string} fromObjectUuid * @param {string} toObjectUuid * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelationsBetweenObjects: (fromObjectUuid: string, toObjectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Returns relation definitions where this object participates in the **schema** graph for that relation name: either as origin `(thisObject)-[:relationName]->(:Object)` or as target `(:Object)-[:relationName]->(thisObject)`. Unrelated relations (same name elsewhere, or no typed edge touching this object) are excluded. Uses the object’s `name` to filter; request path uses object UUID. * @summary Fetch relations for a specific object * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination request for relations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelationsByObject: (objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed. * @summary Permanently delete archived relation * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ permanentlyDeleteArchivedRelation: (relationUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details. * @summary Restore a deleted relation * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreRelation: (relationUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates the indices for relations. The request body should contain a mapping of relation UUIDs to their new index values. Returns a SuccessResponse containing the updated relation objects. * @summary Update relation indices * @param {{ [key: string]: number; }} requestBody Mapping of relation UUIDs to new index values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices: (requestBody: { [key: string]: number; }, options?: RawAxiosRequestConfig) => Promise; }; /** * RelationsApi - functional programming interface */ export declare const RelationsApiFp: (configuration?: Configuration) => { /** * Creates a connection between two objects for a given relation. The \'from\' and \'to\' UUIDs identify the objects to connect. * @summary Add a connection to a relation * @param {string} relationUuid * @param {string} from * @param {string} to * @param {*} [options] Override http request option. * @throws {RequiredError} */ addConnection(relationUuid: string, from: string, to: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new relation or updates an existing one for the specified object. If a relation with the same name exists, it is updated; otherwise, a new relation is created. Returns an UpdateResponse if updated or a CreateResponse if created. * @summary Create or update a relation * @param {string} objectUuid * @param {RelationDTO} relationDTO Relation data * @param {*} [options] Override http request option. * @throws {RequiredError} */ createRelationOrUpdate(objectUuid: string, relationDTO: RelationDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a connection between two objects for a given relation using the specified UUIDs. * @summary Delete a connection from a relation * @param {string} relationUuid * @param {string} from * @param {string} to * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteConnection(relationUuid: string, from: string, to: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a relation specified by its UUID. Returns a DeleteResponse with the deleted relation details. * @summary Delete a relation * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRelation1(relationUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the details of a relation by its UUID. Returns a ShowResponse containing a RelationDTO. * @summary Get relation details * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a relation by its UUID and associates it with the specified object, returning a RelationDTO that includes details from the related object. * @summary Get relation details for a specific object * @param {string} relationUuid * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelationForObject(relationUuid: string, objectUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a paginated list of relations. Returns a PaginationResponse containing RelationDTO objects based on the provided pagination criteria. * @summary Fetch paginated relations * @param {PaginationRequest} paginationRequest Pagination request for relations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelations(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves all relations between two objects based on the provided object UUIDs. * @summary Get all relations between two objects * @param {string} fromObjectUuid * @param {string} toObjectUuid * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelationsBetweenObjects(fromObjectUuid: string, toObjectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns relation definitions where this object participates in the **schema** graph for that relation name: either as origin `(thisObject)-[:relationName]->(:Object)` or as target `(:Object)-[:relationName]->(thisObject)`. Unrelated relations (same name elsewhere, or no typed edge touching this object) are excluded. Uses the object’s `name` to filter; request path uses object UUID. * @summary Fetch relations for a specific object * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination request for relations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelationsByObject(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed. * @summary Permanently delete archived relation * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details. * @summary Restore a deleted relation * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the indices for relations. The request body should contain a mapping of relation UUIDs to their new index values. Returns a SuccessResponse containing the updated relation objects. * @summary Update relation indices * @param {{ [key: string]: number; }} requestBody Mapping of relation UUIDs to new index values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices(requestBody: { [key: string]: number; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RelationsApi - factory interface */ export declare const RelationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a connection between two objects for a given relation. The \'from\' and \'to\' UUIDs identify the objects to connect. * @summary Add a connection to a relation * @param {string} relationUuid * @param {string} from * @param {string} to * @param {*} [options] Override http request option. * @throws {RequiredError} */ addConnection(relationUuid: string, from: string, to: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a new relation or updates an existing one for the specified object. If a relation with the same name exists, it is updated; otherwise, a new relation is created. Returns an UpdateResponse if updated or a CreateResponse if created. * @summary Create or update a relation * @param {string} objectUuid * @param {RelationDTO} relationDTO Relation data * @param {*} [options] Override http request option. * @throws {RequiredError} */ createRelationOrUpdate(objectUuid: string, relationDTO: RelationDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes a connection between two objects for a given relation using the specified UUIDs. * @summary Delete a connection from a relation * @param {string} relationUuid * @param {string} from * @param {string} to * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteConnection(relationUuid: string, from: string, to: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes a relation specified by its UUID. Returns a DeleteResponse with the deleted relation details. * @summary Delete a relation * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRelation1(relationUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the details of a relation by its UUID. Returns a ShowResponse containing a RelationDTO. * @summary Get relation details * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelation(relationUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a relation by its UUID and associates it with the specified object, returning a RelationDTO that includes details from the related object. * @summary Get relation details for a specific object * @param {string} relationUuid * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelationForObject(relationUuid: string, objectUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a paginated list of relations. Returns a PaginationResponse containing RelationDTO objects based on the provided pagination criteria. * @summary Fetch paginated relations * @param {PaginationRequest} paginationRequest Pagination request for relations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelations(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves all relations between two objects based on the provided object UUIDs. * @summary Get all relations between two objects * @param {string} fromObjectUuid * @param {string} toObjectUuid * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelationsBetweenObjects(fromObjectUuid: string, toObjectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns relation definitions where this object participates in the **schema** graph for that relation name: either as origin `(thisObject)-[:relationName]->(:Object)` or as target `(:Object)-[:relationName]->(thisObject)`. Unrelated relations (same name elsewhere, or no typed edge touching this object) are excluded. Uses the object’s `name` to filter; request path uses object UUID. * @summary Fetch relations for a specific object * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination request for relations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelationsByObject(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed. * @summary Permanently delete archived relation * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details. * @summary Restore a deleted relation * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreRelation(relationUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the indices for relations. The request body should contain a mapping of relation UUIDs to their new index values. Returns a SuccessResponse containing the updated relation objects. * @summary Update relation indices * @param {{ [key: string]: number; }} requestBody Mapping of relation UUIDs to new index values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices(requestBody: { [key: string]: number; }, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * RelationsApi - object-oriented interface */ export declare class RelationsApi extends BaseAPI { /** * Creates a connection between two objects for a given relation. The \'from\' and \'to\' UUIDs identify the objects to connect. * @summary Add a connection to a relation * @param {string} relationUuid * @param {string} from * @param {string} to * @param {*} [options] Override http request option. * @throws {RequiredError} */ addConnection(relationUuid: string, from: string, to: string, options?: RawAxiosRequestConfig): Promise>; /** * Creates a new relation or updates an existing one for the specified object. If a relation with the same name exists, it is updated; otherwise, a new relation is created. Returns an UpdateResponse if updated or a CreateResponse if created. * @summary Create or update a relation * @param {string} objectUuid * @param {RelationDTO} relationDTO Relation data * @param {*} [options] Override http request option. * @throws {RequiredError} */ createRelationOrUpdate(objectUuid: string, relationDTO: RelationDTO, options?: RawAxiosRequestConfig): Promise>; /** * Deletes a connection between two objects for a given relation using the specified UUIDs. * @summary Delete a connection from a relation * @param {string} relationUuid * @param {string} from * @param {string} to * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteConnection(relationUuid: string, from: string, to: string, options?: RawAxiosRequestConfig): Promise>; /** * Deletes a relation specified by its UUID. Returns a DeleteResponse with the deleted relation details. * @summary Delete a relation * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRelation1(relationUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the details of a relation by its UUID. Returns a ShowResponse containing a RelationDTO. * @summary Get relation details * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a relation by its UUID and associates it with the specified object, returning a RelationDTO that includes details from the related object. * @summary Get relation details for a specific object * @param {string} relationUuid * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelationForObject(relationUuid: string, objectUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a paginated list of relations. Returns a PaginationResponse containing RelationDTO objects based on the provided pagination criteria. * @summary Fetch paginated relations * @param {PaginationRequest} paginationRequest Pagination request for relations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelations(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves all relations between two objects based on the provided object UUIDs. * @summary Get all relations between two objects * @param {string} fromObjectUuid * @param {string} toObjectUuid * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelationsBetweenObjects(fromObjectUuid: string, toObjectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns relation definitions where this object participates in the **schema** graph for that relation name: either as origin `(thisObject)-[:relationName]->(:Object)` or as target `(:Object)-[:relationName]->(thisObject)`. Unrelated relations (same name elsewhere, or no typed edge touching this object) are excluded. Uses the object’s `name` to filter; request path uses object UUID. * @summary Fetch relations for a specific object * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination request for relations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelationsByObject(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed. * @summary Permanently delete archived relation * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details. * @summary Restore a deleted relation * @param {string} relationUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Updates the indices for relations. The request body should contain a mapping of relation UUIDs to their new index values. Returns a SuccessResponse containing the updated relation objects. * @summary Update relation indices * @param {{ [key: string]: number; }} requestBody Mapping of relation UUIDs to new index values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices(requestBody: { [key: string]: number; }, options?: RawAxiosRequestConfig): Promise>; } /** * ServerlessFunctionsApi - axios parameter creator */ export declare const ServerlessFunctionsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new serverless function attached to the specified app. * @summary Create a serverless function * @param {string} appUuid UUID of the app to attach the serverless function to * @param {ServerlessFunctionDTO} serverlessFunctionDTO Serverless function payload (runtime and code) * @param {*} [options] Override http request option. * @throws {RequiredError} */ create5: (appUuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig) => Promise; /** * Tears down the GCP Cloud Function (if provisioned) and deletes the serverless function entity. * @summary Delete a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete2: (appUuid: string, uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a paginated list of serverless functions that belong to the specified app. * @summary List serverless functions for an app * @param {string} appUuid UUID of the app whose serverless functions to list * @param {PaginationRequest} paginationRequest Pagination and filtering options for the request * @param {*} [options] Override http request option. * @throws {RequiredError} */ index2: (appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Queries Cloud Logging for recent log entries emitted by the Cloud Function backing this serverless function. * @summary Get serverless function logs * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function * @param {string} [since] Lookback window, e.g. 15m, 1h, 24h * @param {number} [limit] Maximum number of log entries to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ logs: (appUuid: string, uuid: string, since?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Builds the same payload shape used for serverless invocations and webhook delivery from a record and event type, without invoking anything. * @summary Generate a sample webhook payload * @param {string} appUuid UUID of the app * @param {SamplePayloadRequest} samplePayloadRequest Sample payload request (recordUuid and eventType) * @param {*} [options] Override http request option. * @throws {RequiredError} */ samplePayload: (appUuid: string, samplePayloadRequest: SamplePayloadRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a serverless function by its UUID, ensuring it belongs to the specified app. * @summary Get a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function * @param {*} [options] Override http request option. * @throws {RequiredError} */ show1: (appUuid: string, uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Provisions (if needed) and invokes a serverless function for a given record and event type, using the same payload shape as webhooks. * @summary Test a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function to test * @param {TestServerlessFunctionRequest} testServerlessFunctionRequest Test serverless function payload (recordUuid and eventType) * @param {*} [options] Override http request option. * @throws {RequiredError} */ testServerlessFunction: (appUuid: string, uuid: string, testServerlessFunctionRequest: TestServerlessFunctionRequest, options?: RawAxiosRequestConfig) => Promise; /** * Updates an existing serverless function\'s runtime and code, keeping it attached to the same app. * @summary Update a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function to update * @param {ServerlessFunctionDTO} serverlessFunctionDTO Updated serverless function payload (runtime and code) * @param {*} [options] Override http request option. * @throws {RequiredError} */ update2: (appUuid: string, uuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig) => Promise; }; /** * ServerlessFunctionsApi - functional programming interface */ export declare const ServerlessFunctionsApiFp: (configuration?: Configuration) => { /** * Creates a new serverless function attached to the specified app. * @summary Create a serverless function * @param {string} appUuid UUID of the app to attach the serverless function to * @param {ServerlessFunctionDTO} serverlessFunctionDTO Serverless function payload (runtime and code) * @param {*} [options] Override http request option. * @throws {RequiredError} */ create5(appUuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Tears down the GCP Cloud Function (if provisioned) and deletes the serverless function entity. * @summary Delete a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete2(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a paginated list of serverless functions that belong to the specified app. * @summary List serverless functions for an app * @param {string} appUuid UUID of the app whose serverless functions to list * @param {PaginationRequest} paginationRequest Pagination and filtering options for the request * @param {*} [options] Override http request option. * @throws {RequiredError} */ index2(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Queries Cloud Logging for recent log entries emitted by the Cloud Function backing this serverless function. * @summary Get serverless function logs * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function * @param {string} [since] Lookback window, e.g. 15m, 1h, 24h * @param {number} [limit] Maximum number of log entries to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ logs(appUuid: string, uuid: string, since?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Builds the same payload shape used for serverless invocations and webhook delivery from a record and event type, without invoking anything. * @summary Generate a sample webhook payload * @param {string} appUuid UUID of the app * @param {SamplePayloadRequest} samplePayloadRequest Sample payload request (recordUuid and eventType) * @param {*} [options] Override http request option. * @throws {RequiredError} */ samplePayload(appUuid: string, samplePayloadRequest: SamplePayloadRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a serverless function by its UUID, ensuring it belongs to the specified app. * @summary Get a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function * @param {*} [options] Override http request option. * @throws {RequiredError} */ show1(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Provisions (if needed) and invokes a serverless function for a given record and event type, using the same payload shape as webhooks. * @summary Test a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function to test * @param {TestServerlessFunctionRequest} testServerlessFunctionRequest Test serverless function payload (recordUuid and eventType) * @param {*} [options] Override http request option. * @throws {RequiredError} */ testServerlessFunction(appUuid: string, uuid: string, testServerlessFunctionRequest: TestServerlessFunctionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates an existing serverless function\'s runtime and code, keeping it attached to the same app. * @summary Update a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function to update * @param {ServerlessFunctionDTO} serverlessFunctionDTO Updated serverless function payload (runtime and code) * @param {*} [options] Override http request option. * @throws {RequiredError} */ update2(appUuid: string, uuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ServerlessFunctionsApi - factory interface */ export declare const ServerlessFunctionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new serverless function attached to the specified app. * @summary Create a serverless function * @param {string} appUuid UUID of the app to attach the serverless function to * @param {ServerlessFunctionDTO} serverlessFunctionDTO Serverless function payload (runtime and code) * @param {*} [options] Override http request option. * @throws {RequiredError} */ create5(appUuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Tears down the GCP Cloud Function (if provisioned) and deletes the serverless function entity. * @summary Delete a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete2(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a paginated list of serverless functions that belong to the specified app. * @summary List serverless functions for an app * @param {string} appUuid UUID of the app whose serverless functions to list * @param {PaginationRequest} paginationRequest Pagination and filtering options for the request * @param {*} [options] Override http request option. * @throws {RequiredError} */ index2(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Queries Cloud Logging for recent log entries emitted by the Cloud Function backing this serverless function. * @summary Get serverless function logs * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function * @param {string} [since] Lookback window, e.g. 15m, 1h, 24h * @param {number} [limit] Maximum number of log entries to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ logs(appUuid: string, uuid: string, since?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Builds the same payload shape used for serverless invocations and webhook delivery from a record and event type, without invoking anything. * @summary Generate a sample webhook payload * @param {string} appUuid UUID of the app * @param {SamplePayloadRequest} samplePayloadRequest Sample payload request (recordUuid and eventType) * @param {*} [options] Override http request option. * @throws {RequiredError} */ samplePayload(appUuid: string, samplePayloadRequest: SamplePayloadRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a serverless function by its UUID, ensuring it belongs to the specified app. * @summary Get a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function * @param {*} [options] Override http request option. * @throws {RequiredError} */ show1(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Provisions (if needed) and invokes a serverless function for a given record and event type, using the same payload shape as webhooks. * @summary Test a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function to test * @param {TestServerlessFunctionRequest} testServerlessFunctionRequest Test serverless function payload (recordUuid and eventType) * @param {*} [options] Override http request option. * @throws {RequiredError} */ testServerlessFunction(appUuid: string, uuid: string, testServerlessFunctionRequest: TestServerlessFunctionRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates an existing serverless function\'s runtime and code, keeping it attached to the same app. * @summary Update a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function to update * @param {ServerlessFunctionDTO} serverlessFunctionDTO Updated serverless function payload (runtime and code) * @param {*} [options] Override http request option. * @throws {RequiredError} */ update2(appUuid: string, uuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ServerlessFunctionsApi - object-oriented interface */ export declare class ServerlessFunctionsApi extends BaseAPI { /** * Creates a new serverless function attached to the specified app. * @summary Create a serverless function * @param {string} appUuid UUID of the app to attach the serverless function to * @param {ServerlessFunctionDTO} serverlessFunctionDTO Serverless function payload (runtime and code) * @param {*} [options] Override http request option. * @throws {RequiredError} */ create5(appUuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): Promise>; /** * Tears down the GCP Cloud Function (if provisioned) and deletes the serverless function entity. * @summary Delete a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete2(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a paginated list of serverless functions that belong to the specified app. * @summary List serverless functions for an app * @param {string} appUuid UUID of the app whose serverless functions to list * @param {PaginationRequest} paginationRequest Pagination and filtering options for the request * @param {*} [options] Override http request option. * @throws {RequiredError} */ index2(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Queries Cloud Logging for recent log entries emitted by the Cloud Function backing this serverless function. * @summary Get serverless function logs * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function * @param {string} [since] Lookback window, e.g. 15m, 1h, 24h * @param {number} [limit] Maximum number of log entries to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ logs(appUuid: string, uuid: string, since?: string, limit?: number, options?: RawAxiosRequestConfig): Promise>; /** * Builds the same payload shape used for serverless invocations and webhook delivery from a record and event type, without invoking anything. * @summary Generate a sample webhook payload * @param {string} appUuid UUID of the app * @param {SamplePayloadRequest} samplePayloadRequest Sample payload request (recordUuid and eventType) * @param {*} [options] Override http request option. * @throws {RequiredError} */ samplePayload(appUuid: string, samplePayloadRequest: SamplePayloadRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a serverless function by its UUID, ensuring it belongs to the specified app. * @summary Get a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function * @param {*} [options] Override http request option. * @throws {RequiredError} */ show1(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Provisions (if needed) and invokes a serverless function for a given record and event type, using the same payload shape as webhooks. * @summary Test a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function to test * @param {TestServerlessFunctionRequest} testServerlessFunctionRequest Test serverless function payload (recordUuid and eventType) * @param {*} [options] Override http request option. * @throws {RequiredError} */ testServerlessFunction(appUuid: string, uuid: string, testServerlessFunctionRequest: TestServerlessFunctionRequest, options?: RawAxiosRequestConfig): Promise>; /** * Updates an existing serverless function\'s runtime and code, keeping it attached to the same app. * @summary Update a serverless function * @param {string} appUuid UUID of the app * @param {string} uuid UUID of the serverless function to update * @param {ServerlessFunctionDTO} serverlessFunctionDTO Updated serverless function payload (runtime and code) * @param {*} [options] Override http request option. * @throws {RequiredError} */ update2(appUuid: string, uuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): Promise>; } /** * SyncApi - axios parameter creator */ export declare const SyncApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new sync. Returns a CreateResponse containing the created sync details. * @summary Create a sync * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSync: (syncDTO: SyncDTO, options?: RawAxiosRequestConfig) => Promise; /** * Deletes an existing sync. Returns a DeleteResponse containing the deleted sync details. * @summary Delete a sync * @param {string} uuid * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSync: (uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a sync by its UUID. Returns a SyncDTO containing the sync details. * @summary Get a sync * @param {string} uuid * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSync: (uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a paginated list of syncs. Returns a PaginationResponse containing SyncDTO objects based on the provided pagination criteria. * @summary Fetch paginated syncs * @param {PaginationRequest} paginationRequest Pagination request for syncs * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSyncs: (paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Restores a previously deleted sync by its UUID. Returns a RestoreResponse containing the restored sync details. * @summary Restore a deleted sync * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreSync: (uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates an existing sync. Returns a UpdateResponse containing the updated sync details. * @summary Update a sync * @param {string} uuid * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSync: (uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig) => Promise; }; /** * SyncApi - functional programming interface */ export declare const SyncApiFp: (configuration?: Configuration) => { /** * Creates a new sync. Returns a CreateResponse containing the created sync details. * @summary Create a sync * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSync(syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes an existing sync. Returns a DeleteResponse containing the deleted sync details. * @summary Delete a sync * @param {string} uuid * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a sync by its UUID. Returns a SyncDTO containing the sync details. * @summary Get a sync * @param {string} uuid * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a paginated list of syncs. Returns a PaginationResponse containing SyncDTO objects based on the provided pagination criteria. * @summary Fetch paginated syncs * @param {PaginationRequest} paginationRequest Pagination request for syncs * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSyncs(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Restores a previously deleted sync by its UUID. Returns a RestoreResponse containing the restored sync details. * @summary Restore a deleted sync * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreSync(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates an existing sync. Returns a UpdateResponse containing the updated sync details. * @summary Update a sync * @param {string} uuid * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SyncApi - factory interface */ export declare const SyncApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new sync. Returns a CreateResponse containing the created sync details. * @summary Create a sync * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSync(syncDTO: SyncDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes an existing sync. Returns a DeleteResponse containing the deleted sync details. * @summary Delete a sync * @param {string} uuid * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a sync by its UUID. Returns a SyncDTO containing the sync details. * @summary Get a sync * @param {string} uuid * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a paginated list of syncs. Returns a PaginationResponse containing SyncDTO objects based on the provided pagination criteria. * @summary Fetch paginated syncs * @param {PaginationRequest} paginationRequest Pagination request for syncs * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSyncs(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Restores a previously deleted sync by its UUID. Returns a RestoreResponse containing the restored sync details. * @summary Restore a deleted sync * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreSync(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates an existing sync. Returns a UpdateResponse containing the updated sync details. * @summary Update a sync * @param {string} uuid * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * SyncApi - object-oriented interface */ export declare class SyncApi extends BaseAPI { /** * Creates a new sync. Returns a CreateResponse containing the created sync details. * @summary Create a sync * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSync(syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise>; /** * Deletes an existing sync. Returns a DeleteResponse containing the deleted sync details. * @summary Delete a sync * @param {string} uuid * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a sync by its UUID. Returns a SyncDTO containing the sync details. * @summary Get a sync * @param {string} uuid * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a paginated list of syncs. Returns a PaginationResponse containing SyncDTO objects based on the provided pagination criteria. * @summary Fetch paginated syncs * @param {PaginationRequest} paginationRequest Pagination request for syncs * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSyncs(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Restores a previously deleted sync by its UUID. Returns a RestoreResponse containing the restored sync details. * @summary Restore a deleted sync * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreSync(uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Updates an existing sync. Returns a UpdateResponse containing the updated sync details. * @summary Update a sync * @param {string} uuid * @param {SyncDTO} syncDTO Sync data * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise>; } /** * TraitsApi - axios parameter creator */ export declare const TraitsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new trait or updates an existing trait for the specified object. The trait name is provided in the URL, and trait details are supplied in the request body as a JSON map. If a trait with the specified name exists, it will be updated; otherwise, a new trait is created. Returns a CreateResponse containing the TraitDTO of the created or updated trait. * @summary Create or update a trait for an object * @param {string} objectUuid * @param {string} traitName * @param {object} body Trait details as a JSON map * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTrait: (objectUuid: string, traitName: string, body: object, options?: RawAxiosRequestConfig) => Promise; /** * Removes a trait identified by its name from the specified object. Returns a DeleteResponse confirming that the trait has been removed. * @summary Delete a trait from an object * @param {string} objectUuid * @param {string} traitName * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTrait: (objectUuid: string, traitName: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves details of a specific trait associated with the specified object, identified by the trait name. Returns a ShowResponse containing the TraitDTO. If the trait is not found, a NotFoundError is thrown. * @summary Fetch a specific trait for an object * @param {string} objectUuid * @param {string} traitName * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTrait: (objectUuid: string, traitName: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a list of traits associated with the specified object. Returns a paginated response containing TraitDTO objects. The page is set to 0 by default, with a maximum limit of 100. * @summary Fetch all traits for an object * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTraits: (objectUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Public browser RSVP. Without partstat shows a choice page; with partstat applies after login when the attendee has a user trait. Non-user-trait attendees need no login. * @summary Respond to an event invitation (email link) * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {string} [partstat] * @param {string} [scope] * @param {string} [switchAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpBrowserGet: (companyUuid: string, eventUuid: string, attendeeUuid: string, partstat?: string, scope?: string, switchAccount?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Email/password login for RSVP * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {string} email * @param {string} password * @param {string} [partstat] * @param {string} [scope] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpBrowserLogin: (companyUuid: string, eventUuid: string, attendeeUuid: string, email: string, password: string, partstat?: string, scope?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Start social login for RSVP * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {string} provider * @param {string} [partstat] * @param {string} [scope] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpBrowserSocial: (companyUuid: string, eventUuid: string, attendeeUuid: string, provider: string, partstat?: string, scope?: string, options?: RawAxiosRequestConfig) => Promise; /** * Patches partstat on the attendees edge. No tools @AccessControl — auth is bearer/session + self-only / partner login rules. * @summary Update event RSVP (JSON) * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {EventRsvpRequest} eventRsvpRequest RSVP payload * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpJson: (companyUuid: string, eventUuid: string, attendeeUuid: string, eventRsvpRequest: EventRsvpRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * TraitsApi - functional programming interface */ export declare const TraitsApiFp: (configuration?: Configuration) => { /** * Creates a new trait or updates an existing trait for the specified object. The trait name is provided in the URL, and trait details are supplied in the request body as a JSON map. If a trait with the specified name exists, it will be updated; otherwise, a new trait is created. Returns a CreateResponse containing the TraitDTO of the created or updated trait. * @summary Create or update a trait for an object * @param {string} objectUuid * @param {string} traitName * @param {object} body Trait details as a JSON map * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTrait(objectUuid: string, traitName: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Removes a trait identified by its name from the specified object. Returns a DeleteResponse confirming that the trait has been removed. * @summary Delete a trait from an object * @param {string} objectUuid * @param {string} traitName * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTrait(objectUuid: string, traitName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves details of a specific trait associated with the specified object, identified by the trait name. Returns a ShowResponse containing the TraitDTO. If the trait is not found, a NotFoundError is thrown. * @summary Fetch a specific trait for an object * @param {string} objectUuid * @param {string} traitName * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTrait(objectUuid: string, traitName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a list of traits associated with the specified object. Returns a paginated response containing TraitDTO objects. The page is set to 0 by default, with a maximum limit of 100. * @summary Fetch all traits for an object * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTraits(objectUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Public browser RSVP. Without partstat shows a choice page; with partstat applies after login when the attendee has a user trait. Non-user-trait attendees need no login. * @summary Respond to an event invitation (email link) * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {string} [partstat] * @param {string} [scope] * @param {string} [switchAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpBrowserGet(companyUuid: string, eventUuid: string, attendeeUuid: string, partstat?: string, scope?: string, switchAccount?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Email/password login for RSVP * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {string} email * @param {string} password * @param {string} [partstat] * @param {string} [scope] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpBrowserLogin(companyUuid: string, eventUuid: string, attendeeUuid: string, email: string, password: string, partstat?: string, scope?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Start social login for RSVP * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {string} provider * @param {string} [partstat] * @param {string} [scope] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpBrowserSocial(companyUuid: string, eventUuid: string, attendeeUuid: string, provider: string, partstat?: string, scope?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Patches partstat on the attendees edge. No tools @AccessControl — auth is bearer/session + self-only / partner login rules. * @summary Update event RSVP (JSON) * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {EventRsvpRequest} eventRsvpRequest RSVP payload * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpJson(companyUuid: string, eventUuid: string, attendeeUuid: string, eventRsvpRequest: EventRsvpRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TraitsApi - factory interface */ export declare const TraitsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new trait or updates an existing trait for the specified object. The trait name is provided in the URL, and trait details are supplied in the request body as a JSON map. If a trait with the specified name exists, it will be updated; otherwise, a new trait is created. Returns a CreateResponse containing the TraitDTO of the created or updated trait. * @summary Create or update a trait for an object * @param {string} objectUuid * @param {string} traitName * @param {object} body Trait details as a JSON map * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTrait(objectUuid: string, traitName: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise; /** * Removes a trait identified by its name from the specified object. Returns a DeleteResponse confirming that the trait has been removed. * @summary Delete a trait from an object * @param {string} objectUuid * @param {string} traitName * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTrait(objectUuid: string, traitName: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves details of a specific trait associated with the specified object, identified by the trait name. Returns a ShowResponse containing the TraitDTO. If the trait is not found, a NotFoundError is thrown. * @summary Fetch a specific trait for an object * @param {string} objectUuid * @param {string} traitName * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTrait(objectUuid: string, traitName: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a list of traits associated with the specified object. Returns a paginated response containing TraitDTO objects. The page is set to 0 by default, with a maximum limit of 100. * @summary Fetch all traits for an object * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTraits(objectUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Public browser RSVP. Without partstat shows a choice page; with partstat applies after login when the attendee has a user trait. Non-user-trait attendees need no login. * @summary Respond to an event invitation (email link) * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {string} [partstat] * @param {string} [scope] * @param {string} [switchAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpBrowserGet(companyUuid: string, eventUuid: string, attendeeUuid: string, partstat?: string, scope?: string, switchAccount?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Email/password login for RSVP * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {string} email * @param {string} password * @param {string} [partstat] * @param {string} [scope] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpBrowserLogin(companyUuid: string, eventUuid: string, attendeeUuid: string, email: string, password: string, partstat?: string, scope?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Start social login for RSVP * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {string} provider * @param {string} [partstat] * @param {string} [scope] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpBrowserSocial(companyUuid: string, eventUuid: string, attendeeUuid: string, provider: string, partstat?: string, scope?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Patches partstat on the attendees edge. No tools @AccessControl — auth is bearer/session + self-only / partner login rules. * @summary Update event RSVP (JSON) * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {EventRsvpRequest} eventRsvpRequest RSVP payload * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpJson(companyUuid: string, eventUuid: string, attendeeUuid: string, eventRsvpRequest: EventRsvpRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * TraitsApi - object-oriented interface */ export declare class TraitsApi extends BaseAPI { /** * Creates a new trait or updates an existing trait for the specified object. The trait name is provided in the URL, and trait details are supplied in the request body as a JSON map. If a trait with the specified name exists, it will be updated; otherwise, a new trait is created. Returns a CreateResponse containing the TraitDTO of the created or updated trait. * @summary Create or update a trait for an object * @param {string} objectUuid * @param {string} traitName * @param {object} body Trait details as a JSON map * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTrait(objectUuid: string, traitName: string, body: object, options?: RawAxiosRequestConfig): Promise>; /** * Removes a trait identified by its name from the specified object. Returns a DeleteResponse confirming that the trait has been removed. * @summary Delete a trait from an object * @param {string} objectUuid * @param {string} traitName * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTrait(objectUuid: string, traitName: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves details of a specific trait associated with the specified object, identified by the trait name. Returns a ShowResponse containing the TraitDTO. If the trait is not found, a NotFoundError is thrown. * @summary Fetch a specific trait for an object * @param {string} objectUuid * @param {string} traitName * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTrait(objectUuid: string, traitName: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a list of traits associated with the specified object. Returns a paginated response containing TraitDTO objects. The page is set to 0 by default, with a maximum limit of 100. * @summary Fetch all traits for an object * @param {string} objectUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTraits(objectUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Public browser RSVP. Without partstat shows a choice page; with partstat applies after login when the attendee has a user trait. Non-user-trait attendees need no login. * @summary Respond to an event invitation (email link) * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {string} [partstat] * @param {string} [scope] * @param {string} [switchAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpBrowserGet(companyUuid: string, eventUuid: string, attendeeUuid: string, partstat?: string, scope?: string, switchAccount?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Email/password login for RSVP * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {string} email * @param {string} password * @param {string} [partstat] * @param {string} [scope] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpBrowserLogin(companyUuid: string, eventUuid: string, attendeeUuid: string, email: string, password: string, partstat?: string, scope?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Start social login for RSVP * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {string} provider * @param {string} [partstat] * @param {string} [scope] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpBrowserSocial(companyUuid: string, eventUuid: string, attendeeUuid: string, provider: string, partstat?: string, scope?: string, options?: RawAxiosRequestConfig): Promise>; /** * Patches partstat on the attendees edge. No tools @AccessControl — auth is bearer/session + self-only / partner login rules. * @summary Update event RSVP (JSON) * @param {string} companyUuid * @param {string} eventUuid * @param {string} attendeeUuid * @param {EventRsvpRequest} eventRsvpRequest RSVP payload * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvpJson(companyUuid: string, eventUuid: string, attendeeUuid: string, eventRsvpRequest: EventRsvpRequest, options?: RawAxiosRequestConfig): Promise>; } /** * ViewsApi - axios parameter creator */ export declare const ViewsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new view for the specified object. The request body must contain the view details as a ViewDTO. Returns a CreateResponse containing the newly created view as a ViewDTO. * @summary Create a new view * @param {string} objectUuid * @param {ViewDTO} viewDTO View details to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createView: (objectUuid: string, viewDTO: ViewDTO, options?: RawAxiosRequestConfig) => Promise; /** * Deletes the view identified by its UUID from the specified object. Returns a DeleteResponse confirming the deletion. * @summary Delete a view * @param {string} objectUuid * @param {string} viewUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteView: (objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Toggles the favorite status of the specified view. Returns an UpdateResponse containing the updated view details. * @summary Toggle view favorite status * @param {string} objectUuid * @param {string} viewUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ favoriteView: (objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves detailed information for a view identified by its UUID for the specified object. Returns a ShowResponse containing the ViewDTO. * @summary Get view details * @param {string} objectUuid * @param {string} viewUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getView: (objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a paginated list of views for the specified object. A custom Cypher query is used to filter views based on the object\'s UUID. Returns a PaginationResponse containing ViewDTO objects. * @summary Fetch paginated views for an object * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination request details (limit, page, filters, sort, query) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getViews: (objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Updates the indices for views associated with the specified object. The request body must include a mapping of view UUIDs to their new index values. Returns a SuccessResponse with the updated view DTOs. * @summary Update view indices * @param {string} objectUuid * @param {{ [key: string]: number; }} requestBody Mapping of view UUIDs to new index values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices1: (objectUuid: string, requestBody: { [key: string]: number; }, options?: RawAxiosRequestConfig) => Promise; /** * Updates the details of an existing view identified by its UUID for the specified object. The request body must contain the updated view details as a ViewDTO. Returns an UpdateResponse with the updated view data. * @summary Update an existing view * @param {string} objectUuid * @param {string} viewUuid * @param {ViewDTO} viewDTO Updated view details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateView: (objectUuid: string, viewUuid: string, viewDTO: ViewDTO, options?: RawAxiosRequestConfig) => Promise; }; /** * ViewsApi - functional programming interface */ export declare const ViewsApiFp: (configuration?: Configuration) => { /** * Creates a new view for the specified object. The request body must contain the view details as a ViewDTO. Returns a CreateResponse containing the newly created view as a ViewDTO. * @summary Create a new view * @param {string} objectUuid * @param {ViewDTO} viewDTO View details to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createView(objectUuid: string, viewDTO: ViewDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the view identified by its UUID from the specified object. Returns a DeleteResponse confirming the deletion. * @summary Delete a view * @param {string} objectUuid * @param {string} viewUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Toggles the favorite status of the specified view. Returns an UpdateResponse containing the updated view details. * @summary Toggle view favorite status * @param {string} objectUuid * @param {string} viewUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ favoriteView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves detailed information for a view identified by its UUID for the specified object. Returns a ShowResponse containing the ViewDTO. * @summary Get view details * @param {string} objectUuid * @param {string} viewUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a paginated list of views for the specified object. A custom Cypher query is used to filter views based on the object\'s UUID. Returns a PaginationResponse containing ViewDTO objects. * @summary Fetch paginated views for an object * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination request details (limit, page, filters, sort, query) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getViews(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the indices for views associated with the specified object. The request body must include a mapping of view UUIDs to their new index values. Returns a SuccessResponse with the updated view DTOs. * @summary Update view indices * @param {string} objectUuid * @param {{ [key: string]: number; }} requestBody Mapping of view UUIDs to new index values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices1(objectUuid: string, requestBody: { [key: string]: number; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the details of an existing view identified by its UUID for the specified object. The request body must contain the updated view details as a ViewDTO. Returns an UpdateResponse with the updated view data. * @summary Update an existing view * @param {string} objectUuid * @param {string} viewUuid * @param {ViewDTO} viewDTO Updated view details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateView(objectUuid: string, viewUuid: string, viewDTO: ViewDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ViewsApi - factory interface */ export declare const ViewsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new view for the specified object. The request body must contain the view details as a ViewDTO. Returns a CreateResponse containing the newly created view as a ViewDTO. * @summary Create a new view * @param {string} objectUuid * @param {ViewDTO} viewDTO View details to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createView(objectUuid: string, viewDTO: ViewDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes the view identified by its UUID from the specified object. Returns a DeleteResponse confirming the deletion. * @summary Delete a view * @param {string} objectUuid * @param {string} viewUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Toggles the favorite status of the specified view. Returns an UpdateResponse containing the updated view details. * @summary Toggle view favorite status * @param {string} objectUuid * @param {string} viewUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ favoriteView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves detailed information for a view identified by its UUID for the specified object. Returns a ShowResponse containing the ViewDTO. * @summary Get view details * @param {string} objectUuid * @param {string} viewUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a paginated list of views for the specified object. A custom Cypher query is used to filter views based on the object\'s UUID. Returns a PaginationResponse containing ViewDTO objects. * @summary Fetch paginated views for an object * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination request details (limit, page, filters, sort, query) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getViews(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the indices for views associated with the specified object. The request body must include a mapping of view UUIDs to their new index values. Returns a SuccessResponse with the updated view DTOs. * @summary Update view indices * @param {string} objectUuid * @param {{ [key: string]: number; }} requestBody Mapping of view UUIDs to new index values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices1(objectUuid: string, requestBody: { [key: string]: number; }, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the details of an existing view identified by its UUID for the specified object. The request body must contain the updated view details as a ViewDTO. Returns an UpdateResponse with the updated view data. * @summary Update an existing view * @param {string} objectUuid * @param {string} viewUuid * @param {ViewDTO} viewDTO Updated view details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateView(objectUuid: string, viewUuid: string, viewDTO: ViewDTO, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ViewsApi - object-oriented interface */ export declare class ViewsApi extends BaseAPI { /** * Creates a new view for the specified object. The request body must contain the view details as a ViewDTO. Returns a CreateResponse containing the newly created view as a ViewDTO. * @summary Create a new view * @param {string} objectUuid * @param {ViewDTO} viewDTO View details to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createView(objectUuid: string, viewDTO: ViewDTO, options?: RawAxiosRequestConfig): Promise>; /** * Deletes the view identified by its UUID from the specified object. Returns a DeleteResponse confirming the deletion. * @summary Delete a view * @param {string} objectUuid * @param {string} viewUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Toggles the favorite status of the specified view. Returns an UpdateResponse containing the updated view details. * @summary Toggle view favorite status * @param {string} objectUuid * @param {string} viewUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ favoriteView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves detailed information for a view identified by its UUID for the specified object. Returns a ShowResponse containing the ViewDTO. * @summary Get view details * @param {string} objectUuid * @param {string} viewUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a paginated list of views for the specified object. A custom Cypher query is used to filter views based on the object\'s UUID. Returns a PaginationResponse containing ViewDTO objects. * @summary Fetch paginated views for an object * @param {string} objectUuid * @param {PaginationRequest} paginationRequest Pagination request details (limit, page, filters, sort, query) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getViews(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Updates the indices for views associated with the specified object. The request body must include a mapping of view UUIDs to their new index values. Returns a SuccessResponse with the updated view DTOs. * @summary Update view indices * @param {string} objectUuid * @param {{ [key: string]: number; }} requestBody Mapping of view UUIDs to new index values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIndices1(objectUuid: string, requestBody: { [key: string]: number; }, options?: RawAxiosRequestConfig): Promise>; /** * Updates the details of an existing view identified by its UUID for the specified object. The request body must contain the updated view details as a ViewDTO. Returns an UpdateResponse with the updated view data. * @summary Update an existing view * @param {string} objectUuid * @param {string} viewUuid * @param {ViewDTO} viewDTO Updated view details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateView(objectUuid: string, viewUuid: string, viewDTO: ViewDTO, options?: RawAxiosRequestConfig): Promise>; } /** * WebMenusApi - axios parameter creator */ export declare const WebMenusApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create web menu * @summary Create web menu * @param {WebMenuDTO} webMenuDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebMenu: (webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig) => Promise; /** * Delete web menu * @summary Delete web menu * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebMenu: (uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Show web menu * @summary Show web menu * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebMenu: (uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Index web menus * @summary Index web menus * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexWebMenus: (paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Restore a deleted web menu by its UUID * @summary Restore deleted web menu * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreWebMenu: (uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Update web menu * @summary Update web menu * @param {string} uuid * @param {WebMenuDTO} webMenuDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebMenu: (uuid: string, webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig) => Promise; }; /** * WebMenusApi - functional programming interface */ export declare const WebMenusApiFp: (configuration?: Configuration) => { /** * Create web menu * @summary Create web menu * @param {WebMenuDTO} webMenuDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebMenu(webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete web menu * @summary Delete web menu * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Show web menu * @summary Show web menu * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Index web menus * @summary Index web menus * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexWebMenus(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Restore a deleted web menu by its UUID * @summary Restore deleted web menu * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update web menu * @summary Update web menu * @param {string} uuid * @param {WebMenuDTO} webMenuDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebMenu(uuid: string, webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WebMenusApi - factory interface */ export declare const WebMenusApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create web menu * @summary Create web menu * @param {WebMenuDTO} webMenuDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebMenu(webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete web menu * @summary Delete web menu * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebMenu(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Show web menu * @summary Show web menu * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebMenu(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Index web menus * @summary Index web menus * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexWebMenus(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Restore a deleted web menu by its UUID * @summary Restore deleted web menu * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreWebMenu(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update web menu * @summary Update web menu * @param {string} uuid * @param {WebMenuDTO} webMenuDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebMenu(uuid: string, webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * WebMenusApi - object-oriented interface */ export declare class WebMenusApi extends BaseAPI { /** * Create web menu * @summary Create web menu * @param {WebMenuDTO} webMenuDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebMenu(webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig): Promise>; /** * Delete web menu * @summary Delete web menu * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Show web menu * @summary Show web menu * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Index web menus * @summary Index web menus * @param {PaginationRequest} paginationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ indexWebMenus(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Restore a deleted web menu by its UUID * @summary Restore deleted web menu * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Update web menu * @summary Update web menu * @param {string} uuid * @param {WebMenuDTO} webMenuDTO * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebMenu(uuid: string, webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig): Promise>; } /** * WebpagesApi - axios parameter creator */ export declare const WebpagesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Registers the current user as editing the template webpage so other users are blocked from opening the builder. * @summary Claim a template webpage editing session * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimTemplateWebpageEditingSession: (objectName: string, environment: string, options?: RawAxiosRequestConfig) => Promise; /** * Registers the current user as editing this webpage so other users are blocked from opening the builder. * @summary Claim a webpage editing session * @param {string} uuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimWebpageEditingSession: (uuid: string, environment?: string, options?: RawAxiosRequestConfig) => Promise; /** * Copies selected properties for the chosen environments (e.g. production_title → german_production_title). * @summary Copy properties to environments * @param {CopyPropertyToEnvironmentsRequest} copyPropertyToEnvironmentsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyPropertyToEnvironments: (copyPropertyToEnvironmentsRequest: CopyPropertyToEnvironmentsRequest, options?: RawAxiosRequestConfig) => Promise; /** * Copies a template webpage by object name from one environment to another. Returns a CreateResponse containing the copied template webpage as a TemplateWebpageDTO. * @summary Copy a template webpage from one environment to another * @param {string} objectName * @param {string} fromEnvironment * @param {string} toEnvironment * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyTemplateWebpage: (objectName: string, fromEnvironment: string, toEnvironment: string, options?: RawAxiosRequestConfig) => Promise; /** * Copies a webpage by its UUID from one environment to another. Returns a CreateResponse containing the copied webpage as a WebpageDTO. * @summary Copy a webpage from one environment to another * @param {string} uuid * @param {string} fromEnvironment * @param {string} toEnvironment * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyWebpage: (uuid: string, fromEnvironment: string, toEnvironment: string, options?: RawAxiosRequestConfig) => Promise; /** * Creates an environment. * @summary Create an environment * @param {CreateOrUpdateEnvironmentRequest} createOrUpdateEnvironmentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEnvironments: (createOrUpdateEnvironmentRequest: CreateOrUpdateEnvironmentRequest, options?: RawAxiosRequestConfig) => Promise; /** * Creates a new or updates an existing template webpage for the specified object. An event is published after the template is changed. Returns an UpdateResponse or CreateResponse with the template webpage details. * @summary Create or update template webpage * @param {string} objectName * @param {string} environment * @param {TemplateWebpageDTO} templateWebpageDTO Template webpage details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrUpdateTemplateWebpage: (objectName: string, environment: string, templateWebpageDTO: TemplateWebpageDTO, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Generate signed URL for protected webpage * @param {string} uuid * @param {string} [environment] * @param {CreateSignedUrlRequest} [createSignedUrlRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSignedUrl: (uuid: string, environment?: string, createSignedUrlRequest?: CreateSignedUrlRequest, options?: RawAxiosRequestConfig) => Promise; /** * Creates a new webpage using the provided webpage details. Returns a CreateResponse containing the newly created webpage as a WebpageDTO. Validation: Webpage fields are validated according to the Webpage validation rules. Required fields and format constraints are enforced. * @summary Create a new webpage * @param {WebpageDTO} webpageDTO Webpage details * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebpage: (webpageDTO: WebpageDTO, environment?: string, options?: RawAxiosRequestConfig) => Promise; /** * Soft deletes an environment. * @summary Delete an environment * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEnvironment: (environment: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a list of all webpage slugs for the public site. Returns a PaginationResponse containing WebpageMapItemDTO objects. * @summary Get all public webpage slugs * @param {string} xCaraerSubdomain * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllSlugs: (xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the public company configuration for the given subdomain. Returns a ShowResponse containing PublicCompanyDTO details. * @summary Fetch public company settings * @param {string} xCaraerSubdomain * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompanySettings: (xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a list of all environments. * @summary Get all environments * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEnvironments: (options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a list of web menus for the public site. Returns a PaginationResponse containing WebMenuDTO objects. * @summary Fetch public web menus * @param {string} xCaraerSubdomain * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMenus: (xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig) => Promise; /** * Resolves map markers for a public map component. Object-bound sources are filtered in Cypher before the 500-marker cap. * @summary Get filtered map markers for a public webpage * @param {string} xCaraerSubdomain * @param {string} pageUuid * @param {string} componentUuid * @param {RecordPaginationRequest} recordPaginationRequest * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicMapLocations: (xCaraerSubdomain: string, pageUuid: string, componentUuid: string, recordPaginationRequest: RecordPaginationRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig) => Promise; /** * Hydrates the hover preview selected on a bound map location for a published record. * @summary Get a hydrated preview for one public map marker * @param {string} xCaraerSubdomain * @param {string} pageUuid * @param {string} componentUuid * @param {MapMarkerPreviewRequest} mapMarkerPreviewRequest * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicMapMarkerPreview: (xCaraerSubdomain: string, pageUuid: string, componentUuid: string, mapMarkerPreviewRequest: MapMarkerPreviewRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects. * @summary Get previews for a public webpage * @param {string} xCaraerSubdomain * @param {string} pageUuid * @param {string} componentUuid * @param {string} layout * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicPreviews: (xCaraerSubdomain: string, pageUuid: string, componentUuid: string, layout: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a published webpage based on the provided root slug and slug. Returns a ShowResponse containing WebpageDTO data. * @summary Get a public webpage by slug * @param {string} xCaraerSubdomain * @param {string} rootSlug * @param {string} slug * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebpage: (xCaraerSubdomain: string, rootSlug: string, slug: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a published webpage based on its UUID. Returns a ShowResponse containing WebpageDTO data. * @summary Get a public webpage by UUID * @param {string} xCaraerSubdomain * @param {string} uuid * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebpageByUuid: (xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns protection requirements without page content. * @summary Get webpage protection metadata * @param {string} xCaraerSubdomain * @param {string} uuid * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebpageProtection: (xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible. * @summary Fetch public website module * @param {string} xCaraerSubdomain * @param {string} moduleUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebsiteModule: (xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data. * @summary Get template webpage * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTemplateWebpage: (objectName: string, environment: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns whether another user is actively editing the template webpage for the given object and environment. * @summary Check if a template webpage is being edited * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTemplateWebpageEditingStatus: (objectName: string, environment: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves detailed information for a webpage identified by its UUID. Optionally, the webpage title is \'smartened\' if the smartened parameter is true. * @summary Get webpage details * @param {string} uuid * @param {boolean} [smartened] * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebpage: (uuid: string, smartened?: boolean, environment?: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns whether another user is actively editing this webpage (via an open builder session or collaborative WebSocket connection). * @summary Check if a webpage is being edited * @param {string} uuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebpageEditingStatus: (uuid: string, environment?: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns uuid and title for all webpage records across objects with a Page trait. Supports optional filters for published pages and excluding template-related pages. * @summary List webpages for picker dropdowns * @param {string} [environment] Environment to resolve webpage properties from (e.g. \'production\' or \'staging\'). * @param {boolean} [publishedOnly] When true, only returns pages that are published in the given environment. * @param {boolean} [excludeTemplateRelated] When true, excludes pages whose options mark them as related to a template. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebpagePickerPages: (environment?: string, publishedOnly?: boolean, excludeTemplateRelated?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * * @summary List signed URL grants for a webpage * @param {string} uuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProtectionGrants: (uuid: string, environment?: string, options?: RawAxiosRequestConfig) => Promise; /** * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage. * @summary Public URL for a library file * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishFile: (key: string, options?: RawAxiosRequestConfig) => Promise; /** * Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details. * @summary Publish a webpage * @param {string} uuid * @param {string} [publishAt] * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishWebpage: (uuid: string, publishAt?: string, environment?: string, options?: RawAxiosRequestConfig) => Promise; /** * Releases the editing session held by the current user for this template webpage. * @summary Release a template webpage editing session * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ releaseTemplateWebpageEditingSession: (objectName: string, environment: string, options?: RawAxiosRequestConfig) => Promise; /** * Releases the editing session held by the current user for this webpage. * @summary Release a webpage editing session * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ releaseWebpageEditingSession: (uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Revoke a signed URL grant * @param {string} uuid * @param {string} grantUuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeProtectionGrant: (uuid: string, grantUuid: string, environment?: string, options?: RawAxiosRequestConfig) => Promise; /** * Validates password and returns a short-lived access token. * @summary Unlock password-protected webpage * @param {string} xCaraerSubdomain * @param {string} uuid * @param {WebpageUnlockRequest} webpageUnlockRequest * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlockPublicWebpage: (xCaraerSubdomain: string, uuid: string, webpageUnlockRequest: WebpageUnlockRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig) => Promise; /** * Unpublishes a webpage by its UUID. Optionally, an unpublishAt timestamp (in seconds) may be provided. Returns an UpdateResponse containing the unpublished webpage details. * @summary Unpublish a webpage * @param {string} uuid * @param {string} [unpublishAt] * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unpublishWebpage: (uuid: string, unpublishAt?: string, environment?: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates an existing webpage identified by its UUID using the provided webpage details. Returns an UpdateResponse containing the updated webpage as a WebpageDTO. Validation: Webpage fields are validated according to the Webpage validation rules. Required fields and format constraints are enforced. * @summary Update a webpage * @param {string} uuid * @param {WebpageDTO} webpageDTO Webpage details * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebpage: (uuid: string, webpageDTO: WebpageDTO, environment?: string, options?: RawAxiosRequestConfig) => Promise; /** * Uploads a file to S3 storage under the specified webpage\'s attachments folder, sets the file\'s ACL to public, and returns the public URL for the file in a SuccessResponse. * @summary Upload a file for a webpage * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFile: (uuid: string, options?: RawAxiosRequestConfig) => Promise; /** * Uploads a file to S3 storage and returns the public URL for the file in a SuccessResponse. * @summary Upload a file * @param {File} file * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFile1: (file: File, options?: RawAxiosRequestConfig) => Promise; }; /** * WebpagesApi - functional programming interface */ export declare const WebpagesApiFp: (configuration?: Configuration) => { /** * Registers the current user as editing the template webpage so other users are blocked from opening the builder. * @summary Claim a template webpage editing session * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimTemplateWebpageEditingSession(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Registers the current user as editing this webpage so other users are blocked from opening the builder. * @summary Claim a webpage editing session * @param {string} uuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimWebpageEditingSession(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Copies selected properties for the chosen environments (e.g. production_title → german_production_title). * @summary Copy properties to environments * @param {CopyPropertyToEnvironmentsRequest} copyPropertyToEnvironmentsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyPropertyToEnvironments(copyPropertyToEnvironmentsRequest: CopyPropertyToEnvironmentsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Copies a template webpage by object name from one environment to another. Returns a CreateResponse containing the copied template webpage as a TemplateWebpageDTO. * @summary Copy a template webpage from one environment to another * @param {string} objectName * @param {string} fromEnvironment * @param {string} toEnvironment * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyTemplateWebpage(objectName: string, fromEnvironment: string, toEnvironment: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Copies a webpage by its UUID from one environment to another. Returns a CreateResponse containing the copied webpage as a WebpageDTO. * @summary Copy a webpage from one environment to another * @param {string} uuid * @param {string} fromEnvironment * @param {string} toEnvironment * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyWebpage(uuid: string, fromEnvironment: string, toEnvironment: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates an environment. * @summary Create an environment * @param {CreateOrUpdateEnvironmentRequest} createOrUpdateEnvironmentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEnvironments(createOrUpdateEnvironmentRequest: CreateOrUpdateEnvironmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new or updates an existing template webpage for the specified object. An event is published after the template is changed. Returns an UpdateResponse or CreateResponse with the template webpage details. * @summary Create or update template webpage * @param {string} objectName * @param {string} environment * @param {TemplateWebpageDTO} templateWebpageDTO Template webpage details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrUpdateTemplateWebpage(objectName: string, environment: string, templateWebpageDTO: TemplateWebpageDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Generate signed URL for protected webpage * @param {string} uuid * @param {string} [environment] * @param {CreateSignedUrlRequest} [createSignedUrlRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSignedUrl(uuid: string, environment?: string, createSignedUrlRequest?: CreateSignedUrlRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new webpage using the provided webpage details. Returns a CreateResponse containing the newly created webpage as a WebpageDTO. Validation: Webpage fields are validated according to the Webpage validation rules. Required fields and format constraints are enforced. * @summary Create a new webpage * @param {WebpageDTO} webpageDTO Webpage details * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebpage(webpageDTO: WebpageDTO, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Soft deletes an environment. * @summary Delete an environment * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEnvironment(environment: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a list of all webpage slugs for the public site. Returns a PaginationResponse containing WebpageMapItemDTO objects. * @summary Get all public webpage slugs * @param {string} xCaraerSubdomain * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllSlugs(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the public company configuration for the given subdomain. Returns a ShowResponse containing PublicCompanyDTO details. * @summary Fetch public company settings * @param {string} xCaraerSubdomain * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompanySettings(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a list of all environments. * @summary Get all environments * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEnvironments(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a list of web menus for the public site. Returns a PaginationResponse containing WebMenuDTO objects. * @summary Fetch public web menus * @param {string} xCaraerSubdomain * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMenus(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Resolves map markers for a public map component. Object-bound sources are filtered in Cypher before the 500-marker cap. * @summary Get filtered map markers for a public webpage * @param {string} xCaraerSubdomain * @param {string} pageUuid * @param {string} componentUuid * @param {RecordPaginationRequest} recordPaginationRequest * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicMapLocations(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, recordPaginationRequest: RecordPaginationRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Hydrates the hover preview selected on a bound map location for a published record. * @summary Get a hydrated preview for one public map marker * @param {string} xCaraerSubdomain * @param {string} pageUuid * @param {string} componentUuid * @param {MapMarkerPreviewRequest} mapMarkerPreviewRequest * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicMapMarkerPreview(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, mapMarkerPreviewRequest: MapMarkerPreviewRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects. * @summary Get previews for a public webpage * @param {string} xCaraerSubdomain * @param {string} pageUuid * @param {string} componentUuid * @param {string} layout * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicPreviews(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, layout: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a published webpage based on the provided root slug and slug. Returns a ShowResponse containing WebpageDTO data. * @summary Get a public webpage by slug * @param {string} xCaraerSubdomain * @param {string} rootSlug * @param {string} slug * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebpage(xCaraerSubdomain: string, rootSlug: string, slug: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a published webpage based on its UUID. Returns a ShowResponse containing WebpageDTO data. * @summary Get a public webpage by UUID * @param {string} xCaraerSubdomain * @param {string} uuid * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebpageByUuid(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns protection requirements without page content. * @summary Get webpage protection metadata * @param {string} xCaraerSubdomain * @param {string} uuid * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebpageProtection(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible. * @summary Fetch public website module * @param {string} xCaraerSubdomain * @param {string} moduleUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data. * @summary Get template webpage * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTemplateWebpage(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns whether another user is actively editing the template webpage for the given object and environment. * @summary Check if a template webpage is being edited * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTemplateWebpageEditingStatus(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves detailed information for a webpage identified by its UUID. Optionally, the webpage title is \'smartened\' if the smartened parameter is true. * @summary Get webpage details * @param {string} uuid * @param {boolean} [smartened] * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebpage(uuid: string, smartened?: boolean, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns whether another user is actively editing this webpage (via an open builder session or collaborative WebSocket connection). * @summary Check if a webpage is being edited * @param {string} uuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebpageEditingStatus(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns uuid and title for all webpage records across objects with a Page trait. Supports optional filters for published pages and excluding template-related pages. * @summary List webpages for picker dropdowns * @param {string} [environment] Environment to resolve webpage properties from (e.g. \'production\' or \'staging\'). * @param {boolean} [publishedOnly] When true, only returns pages that are published in the given environment. * @param {boolean} [excludeTemplateRelated] When true, excludes pages whose options mark them as related to a template. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebpagePickerPages(environment?: string, publishedOnly?: boolean, excludeTemplateRelated?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List signed URL grants for a webpage * @param {string} uuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage. * @summary Public URL for a library file * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishFile(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details. * @summary Publish a webpage * @param {string} uuid * @param {string} [publishAt] * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishWebpage(uuid: string, publishAt?: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Releases the editing session held by the current user for this template webpage. * @summary Release a template webpage editing session * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ releaseTemplateWebpageEditingSession(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Releases the editing session held by the current user for this webpage. * @summary Release a webpage editing session * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ releaseWebpageEditingSession(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Revoke a signed URL grant * @param {string} uuid * @param {string} grantUuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeProtectionGrant(uuid: string, grantUuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Validates password and returns a short-lived access token. * @summary Unlock password-protected webpage * @param {string} xCaraerSubdomain * @param {string} uuid * @param {WebpageUnlockRequest} webpageUnlockRequest * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlockPublicWebpage(xCaraerSubdomain: string, uuid: string, webpageUnlockRequest: WebpageUnlockRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Unpublishes a webpage by its UUID. Optionally, an unpublishAt timestamp (in seconds) may be provided. Returns an UpdateResponse containing the unpublished webpage details. * @summary Unpublish a webpage * @param {string} uuid * @param {string} [unpublishAt] * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unpublishWebpage(uuid: string, unpublishAt?: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates an existing webpage identified by its UUID using the provided webpage details. Returns an UpdateResponse containing the updated webpage as a WebpageDTO. Validation: Webpage fields are validated according to the Webpage validation rules. Required fields and format constraints are enforced. * @summary Update a webpage * @param {string} uuid * @param {WebpageDTO} webpageDTO Webpage details * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebpage(uuid: string, webpageDTO: WebpageDTO, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Uploads a file to S3 storage under the specified webpage\'s attachments folder, sets the file\'s ACL to public, and returns the public URL for the file in a SuccessResponse. * @summary Upload a file for a webpage * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFile(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Uploads a file to S3 storage and returns the public URL for the file in a SuccessResponse. * @summary Upload a file * @param {File} file * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFile1(file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WebpagesApi - factory interface */ export declare const WebpagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Registers the current user as editing the template webpage so other users are blocked from opening the builder. * @summary Claim a template webpage editing session * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimTemplateWebpageEditingSession(objectName: string, environment: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Registers the current user as editing this webpage so other users are blocked from opening the builder. * @summary Claim a webpage editing session * @param {string} uuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimWebpageEditingSession(uuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Copies selected properties for the chosen environments (e.g. production_title → german_production_title). * @summary Copy properties to environments * @param {CopyPropertyToEnvironmentsRequest} copyPropertyToEnvironmentsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyPropertyToEnvironments(copyPropertyToEnvironmentsRequest: CopyPropertyToEnvironmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Copies a template webpage by object name from one environment to another. Returns a CreateResponse containing the copied template webpage as a TemplateWebpageDTO. * @summary Copy a template webpage from one environment to another * @param {string} objectName * @param {string} fromEnvironment * @param {string} toEnvironment * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyTemplateWebpage(objectName: string, fromEnvironment: string, toEnvironment: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Copies a webpage by its UUID from one environment to another. Returns a CreateResponse containing the copied webpage as a WebpageDTO. * @summary Copy a webpage from one environment to another * @param {string} uuid * @param {string} fromEnvironment * @param {string} toEnvironment * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyWebpage(uuid: string, fromEnvironment: string, toEnvironment: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates an environment. * @summary Create an environment * @param {CreateOrUpdateEnvironmentRequest} createOrUpdateEnvironmentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEnvironments(createOrUpdateEnvironmentRequest: CreateOrUpdateEnvironmentRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a new or updates an existing template webpage for the specified object. An event is published after the template is changed. Returns an UpdateResponse or CreateResponse with the template webpage details. * @summary Create or update template webpage * @param {string} objectName * @param {string} environment * @param {TemplateWebpageDTO} templateWebpageDTO Template webpage details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrUpdateTemplateWebpage(objectName: string, environment: string, templateWebpageDTO: TemplateWebpageDTO, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Generate signed URL for protected webpage * @param {string} uuid * @param {string} [environment] * @param {CreateSignedUrlRequest} [createSignedUrlRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSignedUrl(uuid: string, environment?: string, createSignedUrlRequest?: CreateSignedUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a new webpage using the provided webpage details. Returns a CreateResponse containing the newly created webpage as a WebpageDTO. Validation: Webpage fields are validated according to the Webpage validation rules. Required fields and format constraints are enforced. * @summary Create a new webpage * @param {WebpageDTO} webpageDTO Webpage details * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebpage(webpageDTO: WebpageDTO, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Soft deletes an environment. * @summary Delete an environment * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEnvironment(environment: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a list of all webpage slugs for the public site. Returns a PaginationResponse containing WebpageMapItemDTO objects. * @summary Get all public webpage slugs * @param {string} xCaraerSubdomain * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllSlugs(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the public company configuration for the given subdomain. Returns a ShowResponse containing PublicCompanyDTO details. * @summary Fetch public company settings * @param {string} xCaraerSubdomain * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompanySettings(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a list of all environments. * @summary Get all environments * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEnvironments(options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a list of web menus for the public site. Returns a PaginationResponse containing WebMenuDTO objects. * @summary Fetch public web menus * @param {string} xCaraerSubdomain * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMenus(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Resolves map markers for a public map component. Object-bound sources are filtered in Cypher before the 500-marker cap. * @summary Get filtered map markers for a public webpage * @param {string} xCaraerSubdomain * @param {string} pageUuid * @param {string} componentUuid * @param {RecordPaginationRequest} recordPaginationRequest * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicMapLocations(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, recordPaginationRequest: RecordPaginationRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Hydrates the hover preview selected on a bound map location for a published record. * @summary Get a hydrated preview for one public map marker * @param {string} xCaraerSubdomain * @param {string} pageUuid * @param {string} componentUuid * @param {MapMarkerPreviewRequest} mapMarkerPreviewRequest * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicMapMarkerPreview(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, mapMarkerPreviewRequest: MapMarkerPreviewRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects. * @summary Get previews for a public webpage * @param {string} xCaraerSubdomain * @param {string} pageUuid * @param {string} componentUuid * @param {string} layout * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicPreviews(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, layout: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a published webpage based on the provided root slug and slug. Returns a ShowResponse containing WebpageDTO data. * @summary Get a public webpage by slug * @param {string} xCaraerSubdomain * @param {string} rootSlug * @param {string} slug * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebpage(xCaraerSubdomain: string, rootSlug: string, slug: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a published webpage based on its UUID. Returns a ShowResponse containing WebpageDTO data. * @summary Get a public webpage by UUID * @param {string} xCaraerSubdomain * @param {string} uuid * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebpageByUuid(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns protection requirements without page content. * @summary Get webpage protection metadata * @param {string} xCaraerSubdomain * @param {string} uuid * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebpageProtection(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible. * @summary Fetch public website module * @param {string} xCaraerSubdomain * @param {string} moduleUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data. * @summary Get template webpage * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTemplateWebpage(objectName: string, environment: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns whether another user is actively editing the template webpage for the given object and environment. * @summary Check if a template webpage is being edited * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTemplateWebpageEditingStatus(objectName: string, environment: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves detailed information for a webpage identified by its UUID. Optionally, the webpage title is \'smartened\' if the smartened parameter is true. * @summary Get webpage details * @param {string} uuid * @param {boolean} [smartened] * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebpage(uuid: string, smartened?: boolean, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns whether another user is actively editing this webpage (via an open builder session or collaborative WebSocket connection). * @summary Check if a webpage is being edited * @param {string} uuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebpageEditingStatus(uuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns uuid and title for all webpage records across objects with a Page trait. Supports optional filters for published pages and excluding template-related pages. * @summary List webpages for picker dropdowns * @param {string} [environment] Environment to resolve webpage properties from (e.g. \'production\' or \'staging\'). * @param {boolean} [publishedOnly] When true, only returns pages that are published in the given environment. * @param {boolean} [excludeTemplateRelated] When true, excludes pages whose options mark them as related to a template. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebpagePickerPages(environment?: string, publishedOnly?: boolean, excludeTemplateRelated?: boolean, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary List signed URL grants for a webpage * @param {string} uuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage. * @summary Public URL for a library file * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishFile(key: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details. * @summary Publish a webpage * @param {string} uuid * @param {string} [publishAt] * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishWebpage(uuid: string, publishAt?: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Releases the editing session held by the current user for this template webpage. * @summary Release a template webpage editing session * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ releaseTemplateWebpageEditingSession(objectName: string, environment: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Releases the editing session held by the current user for this webpage. * @summary Release a webpage editing session * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ releaseWebpageEditingSession(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Revoke a signed URL grant * @param {string} uuid * @param {string} grantUuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeProtectionGrant(uuid: string, grantUuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Validates password and returns a short-lived access token. * @summary Unlock password-protected webpage * @param {string} xCaraerSubdomain * @param {string} uuid * @param {WebpageUnlockRequest} webpageUnlockRequest * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlockPublicWebpage(xCaraerSubdomain: string, uuid: string, webpageUnlockRequest: WebpageUnlockRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Unpublishes a webpage by its UUID. Optionally, an unpublishAt timestamp (in seconds) may be provided. Returns an UpdateResponse containing the unpublished webpage details. * @summary Unpublish a webpage * @param {string} uuid * @param {string} [unpublishAt] * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unpublishWebpage(uuid: string, unpublishAt?: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates an existing webpage identified by its UUID using the provided webpage details. Returns an UpdateResponse containing the updated webpage as a WebpageDTO. Validation: Webpage fields are validated according to the Webpage validation rules. Required fields and format constraints are enforced. * @summary Update a webpage * @param {string} uuid * @param {WebpageDTO} webpageDTO Webpage details * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebpage(uuid: string, webpageDTO: WebpageDTO, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Uploads a file to S3 storage under the specified webpage\'s attachments folder, sets the file\'s ACL to public, and returns the public URL for the file in a SuccessResponse. * @summary Upload a file for a webpage * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFile(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Uploads a file to S3 storage and returns the public URL for the file in a SuccessResponse. * @summary Upload a file * @param {File} file * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFile1(file: File, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * WebpagesApi - object-oriented interface */ export declare class WebpagesApi extends BaseAPI { /** * Registers the current user as editing the template webpage so other users are blocked from opening the builder. * @summary Claim a template webpage editing session * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimTemplateWebpageEditingSession(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise>; /** * Registers the current user as editing this webpage so other users are blocked from opening the builder. * @summary Claim a webpage editing session * @param {string} uuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimWebpageEditingSession(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise>; /** * Copies selected properties for the chosen environments (e.g. production_title → german_production_title). * @summary Copy properties to environments * @param {CopyPropertyToEnvironmentsRequest} copyPropertyToEnvironmentsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyPropertyToEnvironments(copyPropertyToEnvironmentsRequest: CopyPropertyToEnvironmentsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Copies a template webpage by object name from one environment to another. Returns a CreateResponse containing the copied template webpage as a TemplateWebpageDTO. * @summary Copy a template webpage from one environment to another * @param {string} objectName * @param {string} fromEnvironment * @param {string} toEnvironment * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyTemplateWebpage(objectName: string, fromEnvironment: string, toEnvironment: string, options?: RawAxiosRequestConfig): Promise>; /** * Copies a webpage by its UUID from one environment to another. Returns a CreateResponse containing the copied webpage as a WebpageDTO. * @summary Copy a webpage from one environment to another * @param {string} uuid * @param {string} fromEnvironment * @param {string} toEnvironment * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyWebpage(uuid: string, fromEnvironment: string, toEnvironment: string, options?: RawAxiosRequestConfig): Promise>; /** * Creates an environment. * @summary Create an environment * @param {CreateOrUpdateEnvironmentRequest} createOrUpdateEnvironmentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEnvironments(createOrUpdateEnvironmentRequest: CreateOrUpdateEnvironmentRequest, options?: RawAxiosRequestConfig): Promise>; /** * Creates a new or updates an existing template webpage for the specified object. An event is published after the template is changed. Returns an UpdateResponse or CreateResponse with the template webpage details. * @summary Create or update template webpage * @param {string} objectName * @param {string} environment * @param {TemplateWebpageDTO} templateWebpageDTO Template webpage details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrUpdateTemplateWebpage(objectName: string, environment: string, templateWebpageDTO: TemplateWebpageDTO, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Generate signed URL for protected webpage * @param {string} uuid * @param {string} [environment] * @param {CreateSignedUrlRequest} [createSignedUrlRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSignedUrl(uuid: string, environment?: string, createSignedUrlRequest?: CreateSignedUrlRequest, options?: RawAxiosRequestConfig): Promise>; /** * Creates a new webpage using the provided webpage details. Returns a CreateResponse containing the newly created webpage as a WebpageDTO. Validation: Webpage fields are validated according to the Webpage validation rules. Required fields and format constraints are enforced. * @summary Create a new webpage * @param {WebpageDTO} webpageDTO Webpage details * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebpage(webpageDTO: WebpageDTO, environment?: string, options?: RawAxiosRequestConfig): Promise>; /** * Soft deletes an environment. * @summary Delete an environment * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEnvironment(environment: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a list of all webpage slugs for the public site. Returns a PaginationResponse containing WebpageMapItemDTO objects. * @summary Get all public webpage slugs * @param {string} xCaraerSubdomain * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllSlugs(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the public company configuration for the given subdomain. Returns a ShowResponse containing PublicCompanyDTO details. * @summary Fetch public company settings * @param {string} xCaraerSubdomain * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompanySettings(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a list of all environments. * @summary Get all environments * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEnvironments(options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a list of web menus for the public site. Returns a PaginationResponse containing WebMenuDTO objects. * @summary Fetch public web menus * @param {string} xCaraerSubdomain * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMenus(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise>; /** * Resolves map markers for a public map component. Object-bound sources are filtered in Cypher before the 500-marker cap. * @summary Get filtered map markers for a public webpage * @param {string} xCaraerSubdomain * @param {string} pageUuid * @param {string} componentUuid * @param {RecordPaginationRequest} recordPaginationRequest * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicMapLocations(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, recordPaginationRequest: RecordPaginationRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise>; /** * Hydrates the hover preview selected on a bound map location for a published record. * @summary Get a hydrated preview for one public map marker * @param {string} xCaraerSubdomain * @param {string} pageUuid * @param {string} componentUuid * @param {MapMarkerPreviewRequest} mapMarkerPreviewRequest * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicMapMarkerPreview(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, mapMarkerPreviewRequest: MapMarkerPreviewRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects. * @summary Get previews for a public webpage * @param {string} xCaraerSubdomain * @param {string} pageUuid * @param {string} componentUuid * @param {string} layout * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicPreviews(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, layout: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a published webpage based on the provided root slug and slug. Returns a ShowResponse containing WebpageDTO data. * @summary Get a public webpage by slug * @param {string} xCaraerSubdomain * @param {string} rootSlug * @param {string} slug * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebpage(xCaraerSubdomain: string, rootSlug: string, slug: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a published webpage based on its UUID. Returns a ShowResponse containing WebpageDTO data. * @summary Get a public webpage by UUID * @param {string} xCaraerSubdomain * @param {string} uuid * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {string} [authorization] * @param {string} [xCaraerWebpageAccess] * @param {string} [access] * @param {string} [token] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebpageByUuid(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns protection requirements without page content. * @summary Get webpage protection metadata * @param {string} xCaraerSubdomain * @param {string} uuid * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebpageProtection(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible. * @summary Fetch public website module * @param {string} xCaraerSubdomain * @param {string} moduleUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data. * @summary Get template webpage * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTemplateWebpage(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns whether another user is actively editing the template webpage for the given object and environment. * @summary Check if a template webpage is being edited * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTemplateWebpageEditingStatus(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves detailed information for a webpage identified by its UUID. Optionally, the webpage title is \'smartened\' if the smartened parameter is true. * @summary Get webpage details * @param {string} uuid * @param {boolean} [smartened] * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebpage(uuid: string, smartened?: boolean, environment?: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns whether another user is actively editing this webpage (via an open builder session or collaborative WebSocket connection). * @summary Check if a webpage is being edited * @param {string} uuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebpageEditingStatus(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns uuid and title for all webpage records across objects with a Page trait. Supports optional filters for published pages and excluding template-related pages. * @summary List webpages for picker dropdowns * @param {string} [environment] Environment to resolve webpage properties from (e.g. \'production\' or \'staging\'). * @param {boolean} [publishedOnly] When true, only returns pages that are published in the given environment. * @param {boolean} [excludeTemplateRelated] When true, excludes pages whose options mark them as related to a template. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebpagePickerPages(environment?: string, publishedOnly?: boolean, excludeTemplateRelated?: boolean, options?: RawAxiosRequestConfig): Promise>; /** * * @summary List signed URL grants for a webpage * @param {string} uuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise>; /** * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage. * @summary Public URL for a library file * @param {string} key * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishFile(key: string, options?: RawAxiosRequestConfig): Promise>; /** * Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details. * @summary Publish a webpage * @param {string} uuid * @param {string} [publishAt] * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishWebpage(uuid: string, publishAt?: string, environment?: string, options?: RawAxiosRequestConfig): Promise>; /** * Releases the editing session held by the current user for this template webpage. * @summary Release a template webpage editing session * @param {string} objectName * @param {string} environment * @param {*} [options] Override http request option. * @throws {RequiredError} */ releaseTemplateWebpageEditingSession(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise>; /** * Releases the editing session held by the current user for this webpage. * @summary Release a webpage editing session * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ releaseWebpageEditingSession(uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Revoke a signed URL grant * @param {string} uuid * @param {string} grantUuid * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeProtectionGrant(uuid: string, grantUuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise>; /** * Validates password and returns a short-lived access token. * @summary Unlock password-protected webpage * @param {string} xCaraerSubdomain * @param {string} uuid * @param {WebpageUnlockRequest} webpageUnlockRequest * @param {string} [xCaraerEnvironment] * @param {string} [xCaraerPrimaryEnvironment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlockPublicWebpage(xCaraerSubdomain: string, uuid: string, webpageUnlockRequest: WebpageUnlockRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise>; /** * Unpublishes a webpage by its UUID. Optionally, an unpublishAt timestamp (in seconds) may be provided. Returns an UpdateResponse containing the unpublished webpage details. * @summary Unpublish a webpage * @param {string} uuid * @param {string} [unpublishAt] * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unpublishWebpage(uuid: string, unpublishAt?: string, environment?: string, options?: RawAxiosRequestConfig): Promise>; /** * Updates an existing webpage identified by its UUID using the provided webpage details. Returns an UpdateResponse containing the updated webpage as a WebpageDTO. Validation: Webpage fields are validated according to the Webpage validation rules. Required fields and format constraints are enforced. * @summary Update a webpage * @param {string} uuid * @param {WebpageDTO} webpageDTO Webpage details * @param {string} [environment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebpage(uuid: string, webpageDTO: WebpageDTO, environment?: string, options?: RawAxiosRequestConfig): Promise>; /** * Uploads a file to S3 storage under the specified webpage\'s attachments folder, sets the file\'s ACL to public, and returns the public URL for the file in a SuccessResponse. * @summary Upload a file for a webpage * @param {string} uuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFile(uuid: string, options?: RawAxiosRequestConfig): Promise>; /** * Uploads a file to S3 storage and returns the public URL for the file in a SuccessResponse. * @summary Upload a file * @param {File} file * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFile1(file: File, options?: RawAxiosRequestConfig): Promise>; }