Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace MiscTypes

Index

Interfaces

Type aliases

Type aliases

ABNRecord

ABNRecord: { ABN: ABNValue | ABNValue[]; ASICNumber: string; businessName: ({ effectiveFrom: string; organisationName: string } | null)[]; entityStatus: { effectiveFrom: string; effectiveTo: string; entityStatusCode: string }; entityType: { entityDescription: string; entityTypeCode: string }; goodsAndServicesTax?: { effectiveFrom: string; effectiveTo: string }; legalName?: { familyName?: string; givenName?: string; otherGivenName?: string }; mainBusinessPhysicalAddress?: { effectiveFrom: string; effectiveTo: string; postcode: string; stateCode: string }; mainName?: { effectiveFrom: string; organisationName: string }; mainTradingName?: { effectiveFrom: string; organisationName: string }; otherTradingName?: { effectiveFrom: string; organisationName: string }; recordLastUpdatedDate: string }

Type declaration

  • ABN: ABNValue | ABNValue[]
  • ASICNumber: string
  • businessName: ({ effectiveFrom: string; organisationName: string } | null)[]
  • entityStatus: { effectiveFrom: string; effectiveTo: string; entityStatusCode: string }
    • effectiveFrom: string
    • effectiveTo: string
    • entityStatusCode: string
  • entityType: { entityDescription: string; entityTypeCode: string }
    • entityDescription: string
    • entityTypeCode: string
  • Optional goodsAndServicesTax?: { effectiveFrom: string; effectiveTo: string }
    • effectiveFrom: string
    • effectiveTo: string
  • Optional legalName?: { familyName?: string; givenName?: string; otherGivenName?: string }
    • Optional familyName?: string
    • Optional givenName?: string
    • Optional otherGivenName?: string
  • Optional mainBusinessPhysicalAddress?: { effectiveFrom: string; effectiveTo: string; postcode: string; stateCode: string }
    • effectiveFrom: string
    • effectiveTo: string
    • postcode: string
    • stateCode: string
  • Optional mainName?: { effectiveFrom: string; organisationName: string }
    • effectiveFrom: string
    • organisationName: string
  • Optional mainTradingName?: { effectiveFrom: string; organisationName: string }
    • effectiveFrom: string
    • organisationName: string
  • Optional otherTradingName?: { effectiveFrom: string; organisationName: string }
    • effectiveFrom: string
    • organisationName: string
  • recordLastUpdatedDate: string

BSBRecord

BSBRecord: { bsb: string; financialInstitutionMnemonic: string; name: string; paymentsFlags?: string; postcode: string; state: string; street: string; suburb: string }

Type declaration

  • bsb: string
  • financialInstitutionMnemonic: string
  • name: string
  • Optional paymentsFlags?: string
  • postcode: string
  • state: string
  • street: string
  • suburb: string

BaseSearchResult

BaseSearchResult: { meta: { limit?: number; nextOffset?: number; offset?: number } }

Type declaration

  • meta: { limit?: number; nextOffset?: number; offset?: number }
    • Optional limit?: number
    • Optional nextOffset?: number
    • Optional offset?: number

CustomerSecret

CustomerSecret: IdResource & NewCustomerSecret

EmailSendingAddressBase

EmailSendingAddressBase: { createdAt: string; emailAddress: string; emailName?: string; updatedAt: string }

Type declaration

  • createdAt: string
  • emailAddress: string
  • Optional emailName?: string
  • updatedAt: string

EmailSendingAddressMailgun

EmailSendingAddressMailgun: { type: "MAILGUN" }

Type declaration

  • type: "MAILGUN"

EmailSendingAddressResponseBase

EmailSendingAddressResponseBase: { integration: EmailSendingAddressSES | EmailSendingAddressMailgun }

Type declaration

EmailSendingAddressSES

EmailSendingAddressSES: { isEmailVerified: boolean; type: "SES" }

Type declaration

  • isEmailVerified: boolean
  • type: "SES"

EndpointConfiguration

EndpointConfiguration: EndpointConfigurationCallback | EndpointConfigurationAPI

EndpointConfigurationAPI

EndpointConfigurationAPI: { configuration: { apiEnvironment: string; apiEnvironmentRoute: string; apiId: string; organisationManagedSecretId?: number }; type: "ONEBLINK_API" }

Examples

 
{
  "type": "ONEBLINK_API",
  "configuration": {
    "apiId": "oneblink-api-id",
    "apiEnvironment": "test",
    "apiEnvironmentRoute": "/my-route"
  }
}

Type declaration

  • configuration: { apiEnvironment: string; apiEnvironmentRoute: string; apiId: string; organisationManagedSecretId?: number }

    The configuration of the OneBlink Hosted API.

    • apiEnvironment: string

      The environment of the specified OneBlink hosted API.

    • apiEnvironmentRoute: string

      The route of the specified API and Environment.

    • apiId: string

      The ID of the OneBlink hosted API that a request is made to.

    • Optional organisationManagedSecretId?: number

      The identifier for the organisation managed secret that is associated with the endpoint. Should represent the secret string used for verifying the authenticity of the request made from the OneBlink system.

  • type: "ONEBLINK_API"

    The type of endpoint.

EndpointConfigurationCallback

EndpointConfigurationCallback: { configuration: { organisationManagedSecretId?: number; url: string }; type: "CALLBACK" }

Examples

 
{
  "type": "CALLBACK",
  "configuration": {
    "url": "https://api.url.com/callback"
  }
}

Type declaration

  • configuration: { organisationManagedSecretId?: number; url: string }

    The configuration of the endpoint.

    • Optional organisationManagedSecretId?: number

      The identifier for the organisation managed secret that is associated with the endpoint. Should represent the secret string used for verifying the authenticity of the request made from the OneBlink system.

    • url: string

      URL that the request is made to.

  • type: "CALLBACK"

    The type of endpoint.

GenericObject

GenericObject: Record<string, unknown>

IdResource

IdResource: { createdAt: string; id: number; updatedAt: string }

Type declaration

  • createdAt: string

    The date and time (in ISO format) the resource was created

  • id: number

    The id the resource

  • updatedAt: string

    The date and time (in ISO format) the resource was last updated

NewCustomerSecret

NewCustomerSecret: { cipherText: string; kmsKeyAliasArn: string; kmsKeyArn: string }

Type declaration

  • cipherText: string

    The encrypted version of the secret

  • kmsKeyAliasArn: string

    The ARN of the KMS key alias that was used to encrypt the secret

  • kmsKeyArn: string

    The ARN of the KMS key that was used to encrypt the secret

NewOrganisationManagedSecret

NewOrganisationManagedSecret: NewCustomerSecret & { label: string; organisationId: string }

OrganisationManagedSecret

OrganisationManagedSecret: IdResource & NewOrganisationManagedSecret

StatesAndTerritories

StatesAndTerritories: "NSW" | "QLD" | "VIC" | "ACT" | "TAS" | "SA" | "NT" | "WA"