Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace OrganisationTypes

Index

Interfaces

Type aliases

Type aliases

AuditRecord

AuditRecord: NewAuditRecord & { createdAt: string; id: number }

AuditRecordType

AuditRecordType: "Organisation" | "OrganisationDeleteRequest" | "OrganisationDataRetention" | "OrganisationMfaRequirement" | "EnableAwsBilling" | "ExtendTrial" | "Key" | "API" | "APIEnvironment" | "APIEnvironmentLogs" | "APIEnvironmentMetrics" | "APIEnvironmentServe" | "APIEnvironmentSchedule" | "APIEnvironmentScheduleInvocation" | "FormsAppEnvironment" | "FormsAppEnvironmentApproverGroup" | "FormElementDynamicOptionSet" | "FormElementLookup" | "Form" | "FormJsonSchema" | "WebApp" | "WebAppEnvironment" | "WebAppEnvironmentCustomDomain" | "WebAppEnvironmentCustomDomainCertificate" | "FormsApp" | "FormsAppStyles" | "FormsAppUser" | "FormsAppKey" | "FormsAppRequestAccess" | "FormsAppHostnameConfiguration" | "FormsAppHostnameConfigurationCertificate" | "Job" | "FormSubmissionMeta" | "FormSubmission" | "FormSubmissionUrl" | "FormSubmissionExtract" | "FormSubmissionStatistics" | "FormWorkflowEventReplay" | "WebhookSubscription" | "Role" | "TeamMember" | "FormsAppDraft" | "FormsAppUserSubscription" | "FormsAppSendingAddress" | "FormsAppSendingAddressResend" | "Integration" | "FormApprovalFlowInstance" | "FormSubmissionApproval" | "FormApprovalWebhook" | "FormRetentionPolicy" | "EmailTemplate" | "EmailAttachment" | "SchedulingBooking" | "SchedulingBookingSession" | "FormSubmissionPayment" | "FormSubmissionAttachment" | "FormSubmissionAttachmentUrl" | "Audit" | "AccountAsset" | "FormsAppSamlIdentityProvider" | "FormStore" | "FormStoreExport" | "FormStoreFormDefinition" | "FormSubmissionApprovalAdditionalNote" | "FormApprovalWebhookEventReplay" | "ScheduledTask" | "CompletedTask" | "ScheduledTaskAction" | "ScheduledTaskGroup" | "ScheduledTaskGroupInstance" | "FormVersion" | "FormSubmissionDraft" | "PDFConversion" | "OrganisationManagedSecret" | "FormKeyAssociation" | "FormsAppMfaRequirement" | "FormsAppEnvironmentSendingAddress" | "FormsAppEnvironmentSendingAddressResend"

FormRetentionPolicy

FormRetentionPolicy: NewFormRetentionPolicy & { createdAt: string; updatedAt: string }

NewAuditRecord

NewAuditRecord: { clientIpAddress?: string; key?: DeveloperKeyReference; operation: "VIEW" | "CREATE" | "UPDATE" | "DELETE" | "SEARCH"; organisationId: string; recordId: Record<string, unknown>; recordLabel?: string; type: AuditRecordType; user?: UserProfile }

Type declaration

  • Optional clientIpAddress?: string
  • Optional key?: DeveloperKeyReference
  • operation: "VIEW" | "CREATE" | "UPDATE" | "DELETE" | "SEARCH"
  • organisationId: string
  • recordId: Record<string, unknown>
  • Optional recordLabel?: string
  • type: AuditRecordType
  • Optional user?: UserProfile

NewOrganisation

NewOrganisation: { apiHostingAwsAccountId: string; assetsS3Bucket: string; attachmentLinkExpiryDaysOverride?: number; awsCustomerId?: string; cdnHostingAwsAccountId: string; draftDataRetentionDays?: number | null; formStoreFormIds?: number[]; name: string; prefillDataRetentionDays?: number | null; requireTeamMemberMfa?: boolean; retainDraftData: boolean; retainPrefillData: boolean; retainSubmissionData: boolean; slug: string; submissionDataRetentionDays?: number | null; tags?: string[] | null; tierId: number; tierOverrides?: Partial<NewTier["tierData"]>; timezone?: string; trialExpiry?: string | null }

Type declaration

  • apiHostingAwsAccountId: string
  • assetsS3Bucket: string
  • Optional attachmentLinkExpiryDaysOverride?: number
  • Optional awsCustomerId?: string
  • cdnHostingAwsAccountId: string
  • Optional draftDataRetentionDays?: number | null
  • Optional formStoreFormIds?: number[]
  • name: string
  • Optional prefillDataRetentionDays?: number | null
  • Optional requireTeamMemberMfa?: boolean
  • retainDraftData: boolean
  • retainPrefillData: boolean
  • retainSubmissionData: boolean
  • slug: string
  • Optional submissionDataRetentionDays?: number | null
  • Optional tags?: string[] | null
  • tierId: number
  • Optional tierOverrides?: Partial<NewTier["tierData"]>
  • Optional timezone?: string
  • Optional trialExpiry?: string | null

NewProductNotification

NewProductNotification: { body: string; expiresAt: string; imageAlt?: string; imageUrl: string; linkText?: string; linkUrl?: string; publishedAt: string; title: string; type: "FEATURE" | "BUG_FIX" | "ANNOUNCEMENT" }

Type declaration

  • body: string
  • expiresAt: string
  • Optional imageAlt?: string
  • imageUrl: string
  • Optional linkText?: string
  • Optional linkUrl?: string
  • publishedAt: string
  • title: string
  • type: "FEATURE" | "BUG_FIX" | "ANNOUNCEMENT"

Organisation

Organisation: NewOrganisation & { createdAt: string; id: string }

ProductNotification

ProductNotification: NewProductNotification & { createdAt: string; id: number; updatedAt: string }

Tier

Tier: NewTier & { createdAt: string; id: number; updatedAt: string }

TierLimitation

TierLimitation: { unlimited: true } | { limit: number; unlimited: false }