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: { self: Customer.Rels.CustomerPortalSettings }

Type declaration

props

props: { allowed_origins: string[]; date_created: null | string; date_modified: null | string; session_lifespan_in_minutes: number; sign_up?: { enabled: boolean; verification: { site_key: string; type: "hcaptcha" } }; sso: boolean; subscriptions: { allow_frequency_modification: { jsonata_query: string; values: string[] }[]; allow_next_date_modification: boolean | { allowed_days?: { days: number[]; type: "day" } | { days: number[]; type: "month" }; disallowed_dates?: string[]; jsonata_query: string; max?: string; min?: string }[] }; tos_checkbox_settings: { initial_state: "unchecked" | "checked"; is_hidden: boolean; url: string; usage: "none" | "optional" | "required" } }

Type declaration

  • allowed_origins: 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.

  • session_lifespan_in_minutes: number

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

  • Optional sign_up?: { enabled: boolean; verification: { site_key: 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: { site_key: string; type: "hcaptcha" }

      Client verification settings.

      • site_key: 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.

  • subscriptions: { allow_frequency_modification: { jsonata_query: string; values: string[] }[]; allow_next_date_modification: boolean | { allowed_days?: { days: number[]; type: "day" } | { days: number[]; type: "month" }; disallowed_dates?: string[]; jsonata_query: string; max?: string; min?: string }[] }

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

    • allow_frequency_modification: { jsonata_query: string; values: string[] }[]

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

    • allow_next_date_modification: boolean | { allowed_days?: { days: number[]; type: "day" } | { days: number[]; type: "month" }; disallowed_dates?: string[]; jsonata_query: 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.

  • tos_checkbox_settings: { initial_state: "unchecked" | "checked"; is_hidden: boolean; url: string; usage: "none" | "optional" | "required" }

    Determines if a terms of service checkbox is shown on the portal. This value comes from a template config linked to the default template set.

    • initial_state: "unchecked" | "checked"

      Initial state of the checkbox element.

    • is_hidden: boolean

      Hides the checkbox if true.

    • url: string

      Public URL of your terms of service agreement.

    • usage: "none" | "optional" | "required"

      Hides the checkbox if "none". Makes accepting ToS mandatory if "required", and optional otherwise.

Optional Readonly zooms

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

Generated using TypeDoc