Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace IntegrationTypes

Index

Type aliases

Type aliases

DeleteIntegrationValidationResults

DeleteIntegrationValidationResults: { forms: { formId: number; formName: string }[]; formsApps: { formsAppId: number; formsAppName: string }[] }

Type declaration

  • forms: { formId: number; formName: string }[]
  • formsApps: { formsAppId: number; formsAppName: string }[]

Integration

Integration: IntegrationTrim | IntegrationCPPay | IntegrationCPHCMS | IntegrationBPOINT | IntegrationGeoscape | IntegrationPoint | IntegrationRecaptcha | IntegrationWestpacQuickWeb | IntegrationWestpacQuickStream | IntegrationCivica | IntegrationScheduling | IntegrationFreshdesk | IntegrationMailGun | IntegrationNSWGovPay | IntegrationAPINSW

IntegrationAPINSW

IntegrationAPINSW: IntegrationBase & { configuration: { products: { liquor?: { apiKey: string; apiSecret: string } } }; type: "API_NSW" }

IntegrationBPOINT

IntegrationBPOINT: IntegrationBase & { configuration: { environments: IntegrationBPOINTEnvironment[] }; type: "BPOINT" }

IntegrationBPOINTEnvironment

IntegrationBPOINTEnvironment: { baseUrl: string; billerCode?: string; id: string; isTestMode?: boolean; label: string; merchantNumber: string; password: string; shortMerchantName: string; username: string }

Type declaration

  • baseUrl: string
  • Optional billerCode?: string
  • id: string
  • Optional isTestMode?: boolean
  • label: string
  • merchantNumber: string
  • password: string
  • shortMerchantName: string
  • username: string

IntegrationBase

IntegrationBase: { createdAt: Date; organisationId: string; updatedAt: Date }

Type declaration

  • createdAt: Date
  • organisationId: string
  • updatedAt: Date

IntegrationCPHCMS

IntegrationCPHCMS: IntegrationBase & { configuration: { baseUrl: string; clientId: string; clientSecret: string }; type: "CP_HCMS" }

IntegrationCPPay

IntegrationCPPay: IntegrationBase & { configuration: { baseUrl: string; gateways: IntegrationCPPayGateway[] }; type: "CP_PAY" }

IntegrationCPPayGateway

IntegrationCPPayGateway: { clientId: string; clientSecret: string; id: string; label: string; paymentType?: number }

Type declaration

  • clientId: string
  • clientSecret: string
  • id: string
  • label: string
  • Optional paymentType?: number

IntegrationCivica

IntegrationCivica: IntegrationBase & { configuration: { environments: IntegrationCivicaEnvironment[] }; type: "CIVICA" }

IntegrationCivicaEnvironment

IntegrationCivicaEnvironment: { baseUrl: string; id: string; label: string; password: string; username: string }

Type declaration

  • baseUrl: string
  • id: string
  • label: string
  • password: string
  • username: string

IntegrationFreshdesk

IntegrationFreshdesk: IntegrationBase & { configuration: { apiKey: string; baseUrl: string }; type: "FRESHDESK" }

IntegrationGeoscape

IntegrationGeoscape: IntegrationBase & { configuration: { apiKey: string }; type: "GEOSCAPE" }

IntegrationMailGun

IntegrationMailGun: IntegrationBase & { configuration: { apiKey: string; domain: string; userVariables?: ({ key: string } & ({ text: string; type: "TEXT" } | { type: "ENVIRONMENT_NAME" | "FORM_DESCRIPTION" | "FORM_ID" | "SUBMISSION_ID" | "EXTERNAL_ID" }))[] }; type: "MAILGUN" }

IntegrationNSWGovPay

IntegrationNSWGovPay: IntegrationBase & { configuration: { primaryAgencies: IntegrationNSWGovPayPrimaryAgency[] }; type: "NSW_GOV_PAY" }

IntegrationNSWGovPayPrimaryAgency

IntegrationNSWGovPayPrimaryAgency: { callingSystem: string; clientId: string; clientSecret: string; id: string; isNonProd: boolean; jwtPublicKey: string; label: string; subAgencyCodes?: string[] }

Type declaration

  • callingSystem: string

    The unique identifier that NSW GovPay need to validate primary agency details

  • clientId: string

    The client identifier used for Auth2.0 authentication

  • clientSecret: string

    The client secret used for Auth2.0 authentication

  • id: string

    Identifier used to link to a form payment event

  • isNonProd: boolean

    Set to true to use the non-prod version by changing the domain used for all requests to NSW GovPay.

  • jwtPublicKey: string

    The public key used to verify JSON web token to validate a payment

  • label: string

    Displayed to team members when configuring form payment events

  • Optional subAgencyCodes?: string[]

    Optional codes that will ensure the payment goes to the correct agency within NSW GovPay

IntegrationPoint

IntegrationPoint: IntegrationBase & { configuration: { apiKey: string }; type: "POINT" }

IntegrationRecaptcha

IntegrationRecaptcha: IntegrationBase & { configuration: { domains: IntegrationRecaptchaDomain[] }; type: "RECAPTCHA" }

IntegrationRecaptchaDomain

IntegrationRecaptchaDomain: { id: string; label: string; privateKey: string; publicKey: string }

Type declaration

  • id: string
  • label: string
  • privateKey: string
  • publicKey: string

IntegrationScheduling

IntegrationScheduling: IntegrationBase & { configuration: { providers: IntegrationSchedulingProvider[] }; type: "SCHEDULING" }

IntegrationSchedulingProvider

IntegrationSchedulingProvider: { nylasAccountAccessToken: string; nylasAccountId: string }

Type declaration

  • nylasAccountAccessToken: string
  • nylasAccountId: string

IntegrationTrim

IntegrationTrim: IntegrationBase & { configuration: { environments: IntegrationTrimEnvironment[] }; type: "TRIM" }

IntegrationTrimEnvironment

IntegrationTrimEnvironment: { baseUrl: string; id: string; label: string; password: string; username: string }

Type declaration

  • baseUrl: string
  • id: string
  • label: string
  • password: string
  • username: string

IntegrationType

IntegrationType: "CP_PAY" | "TRIM" | "CIVICA" | "CP_HCMS" | "BPOINT" | "GEOSCAPE" | "POINT" | "RECAPTCHA" | "WESTPAC_QUICK_WEB" | "WESTPAC_QUICK_STREAM" | "SCHEDULING" | "FRESHDESK" | "MAILGUN" | "NSW_GOV_PAY" | "API_NSW"

IntegrationWestpacQuickStream

IntegrationWestpacQuickStream: IntegrationBase & { configuration: { environments: IntegrationWestpacQuickStreamEnvironment[] }; type: "WESTPAC_QUICK_STREAM" }

IntegrationWestpacQuickStreamEnvironment

IntegrationWestpacQuickStreamEnvironment: { id: string; isTestMode: boolean; label: string; publishableApiKey: string; secretApiKey: string; supplierBusinessCode: string }

Type declaration

  • id: string
  • isTestMode: boolean
  • label: string
  • publishableApiKey: string
  • secretApiKey: string
  • supplierBusinessCode: string

IntegrationWestpacQuickWeb

IntegrationWestpacQuickWeb: IntegrationBase & { configuration: { environments: IntegrationWestpacQuickWebEnvironment[] }; type: "WESTPAC_QUICK_WEB" }

IntegrationWestpacQuickWebEnvironment

IntegrationWestpacQuickWebEnvironment: { communityCode: string; id: string; isTestMode: boolean; label: string; password: string; supplierBusinessCode: string; username: string }

Type declaration

  • communityCode: string
  • id: string
  • isTestMode: boolean
  • label: string
  • password: string
  • supplierBusinessCode: string
  • username: string