Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CustomerPortalSettings

Hierarchy

Index

Properties

Properties

Optional Readonly child

child?: Core.Graph

curie

curie: "fx:customer_portal_settings"

links

links: { fx:store: Backend.Rels.Store; self: Backend.Rels.CustomerPortalSettings }

Type declaration

props

props: { allowedOrigins: string[]; date_created: null | string; date_modified: null | string; jwtPrivateKey?: string; jwtSharedSecret: string; sessionLifespanInMinutes: number; signUp?: { enabled: boolean; verification: { secretKey: string; siteKey: string; type: "hcaptcha" } }; sso: boolean; ssoSecret?: string; subscriptions: { allowFrequencyModification: { jsonataQuery: string; values: string[] }[]; allowNextDateModification: boolean | { allowedDays?: { days: number[]; type: "day" } | { days: number[]; type: "month" }; disallowedDates?: string[]; jsonataQuery: string; max?: string; min?: string }[] } }

Type declaration

  • allowedOrigins: string[]

    An array of domains. No trailing slashes, must be https unless it's localhost. Can accept a port. Allow up to 10 entries.

  • date_created: null | string

    The date this resource was created.

  • date_modified: null | string

    The date this resource was last modified.

  • Optional jwtPrivateKey?: string

    Private key for JWT signing, read-only.

  • jwtSharedSecret: string

    Shared secret key.

  • sessionLifespanInMinutes: number

    Life span of session in minutes. Maximum 40320 (4 weeks).

  • Optional signUp?: { enabled: boolean; verification: { secretKey: string; siteKey: string; type: "hcaptcha" } }

    Self-registration settings. Self-registration is disabled if this field is undefined.

    • enabled: boolean

      If this field is true, then self-registration is enabled.

    • verification: { secretKey: string; siteKey: string; type: "hcaptcha" }

      Client verification settings.

      • secretKey: string

        hCaptcha secret key. If empty, Foxy will use its own hCaptcha secret key.

      • siteKey: string

        hCaptcha site key. If empty, Foxy will use its own hCaptcha site key.

      • type: "hcaptcha"

        Verification type. Currently only hCaptcha is supported.

  • sso: boolean

    If this field is true we get legacy API key or sso key from store and save it in settings. For false value we drop it.

  • Optional ssoSecret?: string

    SSO secret for SSO URLs.

  • subscriptions: { allowFrequencyModification: { jsonataQuery: string; values: string[] }[]; allowNextDateModification: boolean | { allowedDays?: { days: number[]; type: "day" } | { days: number[]; type: "month" }; disallowedDates?: string[]; jsonataQuery: string; max?: string; min?: string }[] }

    Object which contains "allowFrequencyModification" and "allowNextDateModification" fields. Subscription modification data.

    • allowFrequencyModification: { jsonataQuery: string; values: string[] }[]

      An array that contains objects with jsonataQuery and values. Max length 10 (items).

    • allowNextDateModification: boolean | { allowedDays?: { days: number[]; type: "day" } | { days: number[]; type: "month" }; disallowedDates?: string[]; jsonataQuery: string; max?: string; min?: string }[]

      We can forbid modify subscription next date. False disables modification, true lifts all constraints, array of objects defines custom rules.

Optional Readonly zooms

zooms?: Readonly<Record<string, undefined | Core.Graph>>

Generated using TypeDoc