Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

ActionCreator

ActionCreator: function

Type declaration

ActiveMilitaryPersonalInfoRequest

ActiveMilitaryPersonalInfoRequest: object
description

The request to submit when verification is on the step "collectActiveMilitaryPersonalInfo"

Type declaration

ActiveMilitaryPersonalInfoResponse

ActiveMilitaryPersonalInfoResponse: object & VerificationResponse
description

Response from REST API indicating that StudentPersonalInfoViewModel is expected to be submitted next.

ActiveMilitaryPersonalInfoViewModel

ActiveMilitaryPersonalInfoViewModel: object & ActiveMilitaryPersonalInfoRequest

BirthDate

BirthDate: string
example

2013-03-06

template

ISO-8601 'YYYY-MM-DD'

BoundAction

BoundAction: function

Type declaration

    • (...args: any): Promise<any>
    • Parameters

      • Rest ...args: any

      Returns Promise<any>

DatabaseId

DatabaseId: string
example

5bbd127d9781852f68e14ddc

template

24 digit hexadecimal

DischargeDate

DischargeDate: string

DocUploadRequest

DocUploadRequest: object
description

The request to submit when verification is on the step "docUpload"

Type declaration

DocUploadResponse

DocUploadResponse: object
description

Response from REST API indicating that DocUploadRequest is expected to be submitted next.

Type declaration

DocUploadViewModel

DocUploadViewModel: DocUploadRequest

Email

Email: string
todo

document constraints here

ErrorId

ErrorId: "internalServerError" | "noProgram" | "noVerification" | "invalidProgram" | "invalidStep" | "invalidOrganization" | "invalidFirstName" | "invalidLastName" | "invalidBirthDate" | "invalidEmail" | "invalidPostalCode" | "invalidDischargeDate" | "invalidStatus" | "underagePerson" | "outsideAgePerson" | "futureBirthDate" | "futureDischargeDate" | "noValidFiles" | "invalidFileSizeMax" | "invalidFileSizeEmpty" | "invalidNumberOfFiles" | "invalidDocUploadToken" | "unsupportedDocMimeType" | "verificationLimitExceeded" | "docReviewLimitExceeded" | "unknownError"

ErrorResponse

ErrorResponse: object
description

Response from REST API. Unrecoverable error. No further requests are expected. Recommend starting over.

Type declaration

FetchOrganizationTypes

FetchOrganizationTypes: "student" | "military" | "teacher"

FieldContent

FieldContent: string | number | FileWithPreview | Organization

FieldId

FieldId: "firstName" | "lastName" | "organization" | "birthDate" | "email" | "postalCode" | "dischargeDate" | "status" | "docUpload"

FieldValidationErrors

FieldValidationErrors: object

Type declaration

FormSelectChoice

FormSelectChoice: object

Type declaration

InactiveMilitaryPersonalInfoRequest

InactiveMilitaryPersonalInfoRequest: object
description

The request to submit when verification is on the step "collectInactiveMilitaryPersonalInfo"

Type declaration

InactiveMilitaryPersonalInfoResponse

InactiveMilitaryPersonalInfoResponse: object & VerificationResponse
description

Response from REST API indicating that StudentPersonalInfoViewModel is expected to be submitted next.

InactiveMilitaryPersonalInfoViewModel

InactiveMilitaryPersonalInfoViewModel: object & InactiveMilitaryPersonalInfoRequest

Intl

Intl: object
description

Internationalization information

Type declaration

Locale

Locale: "en"

LogLevel

LogLevel: "info" | "log" | "warn" | "error"

Metadata

Metadata: object
example

{ 'someKey': 'someValue' }

Type declaration

  • [key: string]: string

MilitaryStatus

MilitaryStatus: "ACTIVE_DUTY" | "VETERAN" | "RESERVIST" | "MILITARY_RETIREE"

MilitaryStatusRequest

MilitaryStatusRequest: object
description

The request to submit when verification is on the step "collectMilitaryStatus"

Type declaration

MilitaryStatusResponse

MilitaryStatusResponse: object & VerificationResponse
description

Response from REST API indicating that StudentPersonalInfoViewModel is expected to be submitted next.

MockStep

MockStep: VerificationStep | "loading"

NewVerificationRequest

NewVerificationRequest: object

Type declaration

Options

Options: object
description

Configurable options that can be passed when initializing this library.

Type declaration

Private Organization

Organization: object

Type declaration

OrganizationId

OrganizationId: number

OrganizationName

OrganizationName: string

OrganizationResources

OrganizationResources: object

Type declaration

Private OrganizationSearchResp

OrganizationSearchResp: [Organization]

OverrideableComponentName

OverrideableComponentName: "StepStudentPersonalInfoComponent" | "StepSeniorPersonalInfoComponent" | "StepTeacherPersonalInfoComponent" | "StepCollectMilitaryStatusComponent" | "StepActiveMilitaryPersonalInfoComponent" | "StepInactiveMilitaryPersonalInfoComponent" | "StepSuccessComponent" | "StepDocUploadComponent" | "StepPendingComponent" | "StepErrorComponent"

PendingResponse

PendingResponse: object
description

Response from REST API. Poll statusUrl for updates while document is reviewed.

Type declaration

ProgramResources

ProgramResources: object

Type declaration

ProgramTheme

ProgramTheme: object
description

Theme information about the Program that was created at my.sheerid.com

Type declaration

PropertiesOf

PropertiesOf: Pick<T, Exclude<keyof T, Keys>> & { [K in Keys]-?: Required<Pick<T, K>>; }[Keys]

Require only properties of type T Example: type A = { foo: string }

function bar(newObject: PropertiesOf) {...}

bar({ foo: 'baz' }) // valid bar({ otherProp: 'stuff' }) // invalid

ReduxState

ReduxState: object

Type declaration

RestApiOptions

RestApiOptions: object

Type declaration

RestResources

RestResources: object

Type declaration

Segment

Segment: "student" | "military" | "teacher" | "senior"

SeniorPersonalInfoRequest

SeniorPersonalInfoRequest: object
description

The request to submit when verification is on the step "collectSeniorPersonalInfo"

Type declaration

SeniorPersonalInfoResponse

SeniorPersonalInfoResponse: object & VerificationResponse
description

Response from REST API indicating that SeniorPersonalInfoViewModel is expected to be submitted next.

SeniorPersonalInfoViewModel

SeniorPersonalInfoViewModel: SeniorPersonalInfoRequest

StepComponent

StepComponent: FunctionComponent<object>

StringMap

StringMap: object

Type declaration

  • [a: string]: string

StudentPersonalInfoRequest

StudentPersonalInfoRequest: object
description

The request to submit when verification is on the step "collectStudentPersonalInfo"

Type declaration

StudentPersonalInfoResponse

StudentPersonalInfoResponse: object & VerificationResponse
description

Response from REST API indicating that StudentPersonalInfoViewModel is expected to be submitted next.

StudentPersonalInfoViewModel

StudentPersonalInfoViewModel: StudentPersonalInfoRequest

SubSegment

SubSegment: "activeDuty" | "reservist" | "veteran" | "retiree"

SuccessResponse

SuccessResponse: object
description

Response from REST API. No further requests are expected.

Type declaration

TeacherPersonalInfoRequest

TeacherPersonalInfoRequest: object
description

The request to submit when verification is on the step "collectTeacherPersonalInfo"

Type declaration

TeacherPersonalInfoResponse

TeacherPersonalInfoResponse: object & VerificationResponse
description

Response from REST API indicating that TeacherPersonalInfoViewModel is expected to be submitted next.

TeacherPersonalInfoViewModel

TeacherPersonalInfoViewModel: TeacherPersonalInfoRequest

VerificationRequest

VerificationResponse

VerificationResponse: object
description

Base type for all responses

Type declaration

VerificationStep

VerificationStep: "collectStudentPersonalInfo" | "collectTeacherPersonalInfo" | "collectMilitaryStatus" | "collectActiveMilitaryPersonalInfo" | "collectInactiveMilitaryPersonalInfo" | "collectSeniorPersonalInfo" | "docUpload" | "pending" | "docReviewLimitExceeded" | "success" | "error"

ViewModel