Skip to content

Latest commit

 

History

History
2122 lines (1577 loc) · 84.7 KB

modules.md

File metadata and controls

2122 lines (1577 loc) · 84.7 KB
Raw

@affinda/affinda / Exports

@affinda/affinda

Table of contents

Enumerations

Classes

Interfaces

Type Aliases

Type Aliases

ActivateResthookSubscriptionResponse

Ƭ ActivateResthookSubscriptionResponse: ResthookSubscription

Contains response data for the activateResthookSubscription operation.

AddMappingDataSourceValueResponse

Ƭ AddMappingDataSourceValueResponse: Record<string, unknown>

Contains response data for the addMappingDataSourceValue operation.

AnnotationContentType

Ƭ AnnotationContentType: string

Defines values for AnnotationContentType.
KnownAnnotationContentType can be used interchangeably with AnnotationContentType, this enum contains the known values that the service supports.

Known values supported by the service

text
integer
float
decimal
date
datetime
daterange
boolean
enum
location
phonenumber
json
table
expectedremuneration
jobtitle
language
skill
yearsexperience
group
table_deprecated
url
image

BatchCreateAnnotationsResponse

Ƭ BatchCreateAnnotationsResponse: (Annotation | null)[]

Contains response data for the batchCreateAnnotations operation.

BatchDeleteAnnotationsOperationResponse

Ƭ BatchDeleteAnnotationsOperationResponse: BatchDeleteAnnotationsResponse

Contains response data for the batchDeleteAnnotations operation.

BatchUpdateAnnotationsResponse

Ƭ BatchUpdateAnnotationsResponse: (Annotation | null)[]

Contains response data for the batchUpdateAnnotations operation.

CollectionDateFormatPreference

Ƭ CollectionDateFormatPreference: string

Defines values for CollectionDateFormatPreference.
KnownCollectionDateFormatPreference can be used interchangeably with CollectionDateFormatPreference, this enum contains the known values that the service supports.

Known values supported by the service

DMY
MDY
YMD

CreateAnnotationResponse

Ƭ CreateAnnotationResponse: AnnotationWithValidationResults

Contains response data for the createAnnotation operation.

CreateApiUserResponse

Ƭ CreateApiUserResponse: ApiUserWithKey

Contains response data for the createApiUser operation.

CreateCollectionResponse

Ƭ CreateCollectionResponse: Collection

Contains response data for the createCollection operation.

CreateDataFieldForCollectionResponse

Ƭ CreateDataFieldForCollectionResponse: DataField

Contains response data for the createDataFieldForCollection operation.

CreateDataPointChoiceResponse

Ƭ CreateDataPointChoiceResponse: DataPointChoice

Contains response data for the createDataPointChoice operation.

CreateDataPointResponse

Ƭ CreateDataPointResponse: DataPoint

Contains response data for the createDataPoint operation.

CreateDocumentResponse

Ƭ CreateDocumentResponse: DocumentUnion

Contains response data for the createDocument operation.

CreateExtractorResponse

Ƭ CreateExtractorResponse: Extractor

Contains response data for the createExtractor operation.

CreateIndexDocumentResponse

Ƭ CreateIndexDocumentResponse: PathsFte27NV3IndexNameDocumentsPostResponses201ContentApplicationJsonSchema

Contains response data for the createIndexDocument operation.

CreateIndexResponse

Ƭ CreateIndexResponse: Index

Contains response data for the createIndex operation.

CreateInvitationResponse

Ƭ CreateInvitationResponse: Invitation

Contains response data for the createInvitation operation.

CreateJobDescriptionSearchEmbedUrlResponse

Ƭ CreateJobDescriptionSearchEmbedUrlResponse: JobDescriptionSearchEmbed

Contains response data for the createJobDescriptionSearchEmbedUrl operation.

CreateJobDescriptionSearchResponse

Ƭ CreateJobDescriptionSearchResponse: JobDescriptionSearch

Contains response data for the createJobDescriptionSearch operation.

CreateMappingDataSourceResponse

Ƭ CreateMappingDataSourceResponse: MappingDataSource

Contains response data for the createMappingDataSource operation.

CreateMappingResponse

Ƭ CreateMappingResponse: Mapping

Contains response data for the createMapping operation.

CreateOrganizationResponse

Ƭ CreateOrganizationResponse: Organization

Contains response data for the createOrganization operation.

CreateResthookSubscriptionResponse

Ƭ CreateResthookSubscriptionResponse: ResthookSubscription

Contains response data for the createResthookSubscription operation.

CreateResumeSearchEmbedUrlResponse

Ƭ CreateResumeSearchEmbedUrlResponse: ResumeSearchEmbed

Contains response data for the createResumeSearchEmbedUrl operation.

CreateResumeSearchResponse

Ƭ CreateResumeSearchResponse: ResumeSearch

Contains response data for the createResumeSearch operation.

CreateTagResponse

Ƭ CreateTagResponse: Tag

Contains response data for the createTag operation.

CreateValidationResultResponse

Ƭ CreateValidationResultResponse: ValidationResult

Contains response data for the createValidationResult operation.

CreateWorkspaceMembershipResponse

Ƭ CreateWorkspaceMembershipResponse: WorkspaceMembership

Contains response data for the createWorkspaceMembership operation.

CreateWorkspaceResponse

Ƭ CreateWorkspaceResponse: Workspace

Contains response data for the createWorkspace operation.

DateFormatPreference

Ƭ DateFormatPreference: string

Defines values for DateFormatPreference.
KnownDateFormatPreference can be used interchangeably with DateFormatPreference, this enum contains the known values that the service supports.

Known values supported by the service

DMY
MDY
YMD

DateRange

Ƭ DateRange: string

Defines values for DateRange.
KnownDateRange can be used interchangeably with DateRange, this enum contains the known values that the service supports.

Known values supported by the service

today
yesterday
week
month
year

DeleteAnnotationResponse

Ƭ DeleteAnnotationResponse: AnotationDelete

Contains response data for the deleteAnnotation operation.

DocumentFormat

Ƭ DocumentFormat: string

Defines values for DocumentFormat.
KnownDocumentFormat can be used interchangeably with DocumentFormat, this enum contains the known values that the service supports.

Known values supported by the service

json
xml
hr-xml

DocumentState

Ƭ DocumentState: string

Defines values for DocumentState.
KnownDocumentState can be used interchangeably with DocumentState, this enum contains the known values that the service supports.

Known values supported by the service

uploaded
review
validated
archived
rejected

DocumentType

Ƭ DocumentType: string

Defines values for DocumentType.
KnownDocumentType can be used interchangeably with DocumentType, this enum contains the known values that the service supports.

Known values supported by the service

resumes
job_descriptions

DocumentUnion

Ƭ DocumentUnion: Document | Resume | Invoice | JobDescription | ResumeRedact

EditDocumentPagesResponse

Ƭ EditDocumentPagesResponse: Meta[]

Contains response data for the editDocumentPages operation.

EducationLevel

Ƭ EducationLevel: "school" | "certificate" | "bachelors" | "masters" | "doctoral"

Defines values for EducationLevel.

Enum20

Ƭ Enum20: string

Defines values for Enum20.
KnownEnum20 can be used interchangeably with Enum20, this enum contains the known values that the service supports.

Known values supported by the service

resumes
job_descriptions

GetAllAnnotationsResponse

Ƭ GetAllAnnotationsResponse: Paths1D5Zg6MV3AnnotationsGetResponses200ContentApplicationJsonSchema

Contains response data for the getAllAnnotations operation.

GetAllApiUsersResponse

Ƭ GetAllApiUsersResponse: Paths26Civ0V3ApiUsersGetResponses200ContentApplicationJsonSchema

Contains response data for the getAllApiUsers operation.

GetAllCollectionsResponse

Ƭ GetAllCollectionsResponse: Collection[]

Contains response data for the getAllCollections operation.

GetAllDataPointsResponse

Ƭ GetAllDataPointsResponse: DataPoint[]

Contains response data for the getAllDataPoints operation.

GetAllDocumentsResponse

Ƭ GetAllDocumentsResponse: PathsOxm5M7V3DocumentsGetResponses200ContentApplicationJsonSchema

Contains response data for the getAllDocuments operation.

GetAllExtractorsResponse

Ƭ GetAllExtractorsResponse: Extractor[]

Contains response data for the getAllExtractors operation.

GetAllIndexDocumentsResponse

Ƭ GetAllIndexDocumentsResponse: PathsO7SnenV3IndexNameDocumentsGetResponses200ContentApplicationJsonSchema

Contains response data for the getAllIndexDocuments operation.

GetAllIndexesResponse

Ƭ GetAllIndexesResponse: PathsDvrcp3V3IndexGetResponses200ContentApplicationJsonSchema

Contains response data for the getAllIndexes operation.

GetAllInvitationsResponse

Ƭ GetAllInvitationsResponse: Paths18Wh2VcV3InvitationsGetResponses200ContentApplicationJsonSchema

Contains response data for the getAllInvitations operation.

GetAllOrganizationMembershipsResponse

Ƭ GetAllOrganizationMembershipsResponse: PathsQ5Os5RV3OrganizationMembershipsGetResponses200ContentApplicationJsonSchema

Contains response data for the getAllOrganizationMemberships operation.

GetAllOrganizationsResponse

Ƭ GetAllOrganizationsResponse: Organization[]

Contains response data for the getAllOrganizations operation.

GetAllResthookSubscriptionsResponse

Ƭ GetAllResthookSubscriptionsResponse: PathsVz5Kj2V3ResthookSubscriptionsGetResponses200ContentApplicationJsonSchema

Contains response data for the getAllResthookSubscriptions operation.

GetAllTagsResponse

Ƭ GetAllTagsResponse: Tag[]

Contains response data for the getAllTags operation.

GetAllValidationResultsResponse

Ƭ GetAllValidationResultsResponse: ValidationResult[]

Contains response data for the getAllValidationResults operation.

GetAllWorkspaceMembershipsResponse

Ƭ GetAllWorkspaceMembershipsResponse: PathsZ1JuagV3WorkspaceMembershipsGetResponses200ContentApplicationJsonSchema

Contains response data for the getAllWorkspaceMemberships operation.

GetAllWorkspacesResponse

Ƭ GetAllWorkspacesResponse: Workspace[]

Contains response data for the getAllWorkspaces operation.

GetAnnotationResponse

Ƭ GetAnnotationResponse: Annotation

Contains response data for the getAnnotation operation.

GetApiUserResponse

Ƭ GetApiUserResponse: ApiUserWithoutKey

Contains response data for the getApiUser operation.

GetCollectionResponse

Ƭ GetCollectionResponse: Collection

Contains response data for the getCollection operation.

GetDataFieldForCollectionResponse

Ƭ GetDataFieldForCollectionResponse: CollectionField

Contains response data for the getDataFieldForCollection operation.

GetDataPointChoiceResponse

Ƭ GetDataPointChoiceResponse: DataPointChoice

Contains response data for the getDataPointChoice operation.

GetDataPointChoicesResponse

Ƭ GetDataPointChoicesResponse: PathsMnwxgV3DataPointChoicesGetResponses200ContentApplicationJsonSchema

Contains response data for the getDataPointChoices operation.

GetDataPointResponse

Ƭ GetDataPointResponse: DataPoint

Contains response data for the getDataPoint operation.

GetDocumentResponse

Ƭ GetDocumentResponse: DocumentUnion

Contains response data for the getDocument operation.

GetExtractorResponse

Ƭ GetExtractorResponse: Extractor

Contains response data for the getExtractor operation.

GetInvitationByTokenResponse

Ƭ GetInvitationByTokenResponse: Invitation

Contains response data for the getInvitationByToken operation.

GetInvitationResponse

Ƭ GetInvitationResponse: Invitation

Contains response data for the getInvitation operation.

GetJobDescriptionSearchConfigResponse

Ƭ GetJobDescriptionSearchConfigResponse: JobDescriptionSearchConfig

Contains response data for the getJobDescriptionSearchConfig operation.

GetJobDescriptionSearchDetailResponse

Ƭ GetJobDescriptionSearchDetailResponse: JobDescriptionSearchDetail

Contains response data for the getJobDescriptionSearchDetail operation.

GetMappingDataSourceResponse

Ƭ GetMappingDataSourceResponse: MappingDataSource

Contains response data for the getMappingDataSource operation.

GetMappingDataSourceValueResponse

Ƭ GetMappingDataSourceValueResponse: Record<string, unknown>

Contains response data for the getMappingDataSourceValue operation.

GetMappingResponse

Ƭ GetMappingResponse: Mapping

Contains response data for the getMapping operation.

GetOrganizationMembershipResponse

Ƭ GetOrganizationMembershipResponse: OrganizationMembership

Contains response data for the getOrganizationMembership operation.

GetOrganizationResponse

Ƭ GetOrganizationResponse: Organization

Contains response data for the getOrganization operation.

GetResthookSubscriptionResponse

Ƭ GetResthookSubscriptionResponse: ResthookSubscription

Contains response data for the getResthookSubscription operation.

GetResumeSearchConfigResponse

Ƭ GetResumeSearchConfigResponse: ResumeSearchConfig

Contains response data for the getResumeSearchConfig operation.

GetResumeSearchDetailResponse

Ƭ GetResumeSearchDetailResponse: ResumeSearchDetail

Contains response data for the getResumeSearchDetail operation.

GetResumeSearchMatchResponse

Ƭ GetResumeSearchMatchResponse: ResumeSearchMatch

Contains response data for the getResumeSearchMatch operation.

GetResumeSearchSuggestionJobTitleResponse

Ƭ GetResumeSearchSuggestionJobTitleResponse: Object

Contains response data for the getResumeSearchSuggestionJobTitle operation.

Type declaration

Name Type Description
body string[] The parsed response body.

GetResumeSearchSuggestionSkillResponse

Ƭ GetResumeSearchSuggestionSkillResponse: Object

Contains response data for the getResumeSearchSuggestionSkill operation.

Type declaration

Name Type Description
body string[] The parsed response body.

GetTagResponse

Ƭ GetTagResponse: Tag

Contains response data for the getTag operation.

GetUsageByCollectionResponse

Ƭ GetUsageByCollectionResponse: UsageByCollection[]

Contains response data for the getUsageByCollection operation.

GetUsageByWorkspaceResponse

Ƭ GetUsageByWorkspaceResponse: UsageByWorkspace[]

Contains response data for the getUsageByWorkspace operation.

GetValidationResultResponse

Ƭ GetValidationResultResponse: ValidationResult

Contains response data for the getValidationResult operation.

GetWorkspaceMembershipResponse

Ƭ GetWorkspaceMembershipResponse: WorkspaceMembership

Contains response data for the getWorkspaceMembership operation.

GetWorkspaceResponse

Ƭ GetWorkspaceResponse: Workspace

Contains response data for the getWorkspace operation.

IndexDocumentType

Ƭ IndexDocumentType: string

Defines values for IndexDocumentType.
KnownIndexDocumentType can be used interchangeably with IndexDocumentType, this enum contains the known values that the service supports.

Known values supported by the service

resumes
job_descriptions

InvitationResponseStatus

Ƭ InvitationResponseStatus: string

Defines values for InvitationResponseStatus.
KnownInvitationResponseStatus can be used interchangeably with InvitationResponseStatus, this enum contains the known values that the service supports.

Known values supported by the service

accepted
declined

InvitationStatus

Ƭ InvitationStatus: string

Defines values for InvitationStatus.
KnownInvitationStatus can be used interchangeably with InvitationStatus, this enum contains the known values that the service supports.

Known values supported by the service

pending
accepted
declined

JobDescriptionSearchConfigDistanceUnit

Ƭ JobDescriptionSearchConfigDistanceUnit: string

Defines values for JobDescriptionSearchConfigDistanceUnit.
KnownJobDescriptionSearchConfigDistanceUnit can be used interchangeably with JobDescriptionSearchConfigDistanceUnit, this enum contains the known values that the service supports.

Known values supported by the service

mi
km

ListMappingDataSourceValuesResponse

Ƭ ListMappingDataSourceValuesResponse: Paths1Qr7BnyV3MappingDataSourcesIdentifierValuesGetResponses200ContentApplicationJsonSchema

Contains response data for the listMappingDataSourceValues operation.

ListMappingDataSourcesResponse

Ƭ ListMappingDataSourcesResponse: Paths11QdcofV3MappingDataSourcesGetResponses200ContentApplicationJsonSchema

Contains response data for the listMappingDataSources operation.

ListMappingsResponse

Ƭ ListMappingsResponse: Paths1Dpvb2PV3MappingsGetResponses200ContentApplicationJsonSchema

Contains response data for the listMappings operation.

ListOccupationGroupsResponse

Ƭ ListOccupationGroupsResponse: OccupationGroup[]

Contains response data for the listOccupationGroups operation.

ManagementLevel

Ƭ ManagementLevel: "None" | "Low" | "Mid" | "Upper"

Defines values for ManagementLevel.

OrganizationRole

Ƭ OrganizationRole: string

Defines values for OrganizationRole.
KnownOrganizationRole can be used interchangeably with OrganizationRole, this enum contains the known values that the service supports.

Known values supported by the service

admin
member

OrganizationUserRole

Ƭ OrganizationUserRole: string

Defines values for OrganizationUserRole.
KnownOrganizationUserRole can be used interchangeably with OrganizationUserRole, this enum contains the known values that the service supports.

Known values supported by the service

admin
member

RegenerateApiKeyForApiUserResponse

Ƭ RegenerateApiKeyForApiUserResponse: ApiUserWithKey

Contains response data for the regenerateApiKeyForApiUser operation.

Region

Ƭ Region: string

Defines values for Region.
KnownRegion can be used interchangeably with Region, this enum contains the known values that the service supports.

Known values supported by the service

api
api.eu1
api.us1

ReplaceDataPointChoicesResponse

Ƭ ReplaceDataPointChoicesResponse: DataPointChoiceReplaceResponse

Contains response data for the replaceDataPointChoices operation.

ReplaceMappingDataSourceValuesResponse

Ƭ ReplaceMappingDataSourceValuesResponse: Record<string, unknown>[]

Contains response data for the replaceMappingDataSourceValues operation.

RespondToInvitationResponse

Ƭ RespondToInvitationResponse: Invitation

Contains response data for the respondToInvitation operation.

ResthookEvent

Ƭ ResthookEvent: string

Defines values for ResthookEvent.
KnownResthookEvent can be used interchangeably with ResthookEvent, this enum contains the known values that the service supports.

Known values supported by the service

resume.parse.succeeded
resume.parse.failed
resume.parse.completed
invoice.parse.succeeded
invoice.parse.failed
invoice.parse.completed
invoice.validate.completed
document.parse.succeeded
document.parse.failed
document.parse.completed
document.validate.completed
document.classify.succeeded
document.classify.failed
document.classify.completed
document.rejected
annotation.validated

ResthookSubscriptionVersion

Ƭ ResthookSubscriptionVersion: string

Defines values for ResthookSubscriptionVersion.
KnownResthookSubscriptionVersion can be used interchangeably with ResthookSubscriptionVersion, this enum contains the known values that the service supports.

Known values supported by the service

v1
v2
v3

ResumeDataLanguagesItem

Ƭ ResumeDataLanguagesItem: string

Defines values for ResumeDataLanguagesItem.
KnownResumeDataLanguagesItem can be used interchangeably with ResumeDataLanguagesItem, this enum contains the known values that the service supports.

Known values supported by the service

Ainu
Akan
Akkadian
Amharic
Anam
Arabic
Aramaic
Arem
Armenian
Awadhi
Aymara
Azari
Bagheli
Bagri
Bahasa
Bambara
Bangala
Bardi
Bassa
Batak
Belarusian
Bemba
Benga
Bengali
Berber
Bhojpuri
Bislama
Brahui
Bulgarian
Bunu
Cambodian
Carew
Carib
Catalan
Cebuano
Chakma
Chamorro
Chango
Chewa
Croatian
Czech
Dagbani
Danish
Dari
Dayi
Dhatki
Dhivehi
Dinka
Dogri
Duala
Dutch
English
Esperanto
Estonian
Ewondo
Faroese
Filipino
Finnish
Formula
French
Frisian
Friulian
Fula
Gaelic
Galo
Garhwali
Garifuna
German
Gikuyu
Gujarati
Gujerati
Gwere
Hawaiian
Haya
Hebrew
Hindi
Hmu
Hokkien
Hopi
Hungarian
Hup
Ibanag
Igbo
Ilokano
Indonesian
Intermediate
Irish
Italian
Japanese
Jiba
Kachin
Kalenjin
Kamayo
Kannada
Kaonde
Kayan
Khandeshi
Khmer
Kikuyu
Kodava
Koma
Kongo
Konkani
Korean
Korwa
Kreyol
Krio
Kumaoni
Kurdish
Kurukh
Kwa
Ladino
Lango
Latvian
Lawa
Lingala
Lithuanian
Lule
Luxembourgish
Magahi
Maithili
Malay
Malayalam
Malaysian
Malvi
Maninka
Manipuri
Manx
Marathi
Mayan
Medumba
Memoni
Mewari
Mizo
Montenegrin
Mwan
Mwanga
Ndebele
Nepali
Nimadi
Oriya
Oromo
Ovambo
Pamona
Pangasinan
Pashto
Phoenician
Polish
Portuguese
Pulaar
Pular
Punjabi
Quecha
Rajasthani
Romanian
Russian
Sakha
Sango
Santhali
Saraiki
Seim
Shading
Shama
Shan
Shona
Silesian
Sindhi
Slovak
Slovene
Soga
Sogdian
Sotho
Spanish
Sudanese
Sumerian
Surajpuri
Surigaonon
Swati
Swazi
Swedish
Tagalog
Tamil
Tausug
Telugu
Tetum
Tharu
Tibetan
Tigrinya
Tripuri
Tswana
Tulu
Turkish
Tuwali
Ubi
Ukrainian
Urdu
Veps
Vietnamese
Wagdi
Waziri
Xhosa
Yiddish
Yoruba

ResumeSearchConfigDistanceUnit

Ƭ ResumeSearchConfigDistanceUnit: string

Defines values for ResumeSearchConfigDistanceUnit.
KnownResumeSearchConfigDistanceUnit can be used interchangeably with ResumeSearchConfigDistanceUnit, this enum contains the known values that the service supports.

Known values supported by the service

mi
km

ResumeSkillSourcesItemSection

Ƭ ResumeSkillSourcesItemSection: string

Defines values for ResumeSkillSourcesItemSection.
KnownResumeSkillSourcesItemSection can be used interchangeably with ResumeSkillSourcesItemSection, this enum contains the known values that the service supports.

Known values supported by the service

Achievements
AdditionalInformation
Education
Extracurriculars
Organisations
Other
PersonalDetails
Projects
Publications
Referees
Skills
Summary
Training
WorkExperience
NotPopulated
Header
Footer
Skills/Interests/Languages
Training/Certifications
Extracurriculars/Leadership

SearchLocationUnit

Ƭ SearchLocationUnit: "km" | "mi"

Defines values for SearchLocationUnit.

SearchParametersCustomDataFilterType

Ƭ SearchParametersCustomDataFilterType: string

Defines values for SearchParametersCustomDataFilterType.
KnownSearchParametersCustomDataFilterType can be used interchangeably with SearchParametersCustomDataFilterType, this enum contains the known values that the service supports.

Known values supported by the service

equals
range

ThemeConfigPaletteMode

Ƭ ThemeConfigPaletteMode: string

Defines values for ThemeConfigPaletteMode.
KnownThemeConfigPaletteMode can be used interchangeably with ThemeConfigPaletteMode, this enum contains the known values that the service supports.

Known values supported by the service

light
dark

UpdateAnnotationResponse

Ƭ UpdateAnnotationResponse: Annotation

Contains response data for the updateAnnotation operation.

UpdateApiUserResponse

Ƭ UpdateApiUserResponse: ApiUserWithoutKey

Contains response data for the updateApiUser operation.

UpdateCollectionResponse

Ƭ UpdateCollectionResponse: Collection

Contains response data for the updateCollection operation.

UpdateDataFieldForCollectionResponse

Ƭ UpdateDataFieldForCollectionResponse: CollectionField

Contains response data for the updateDataFieldForCollection operation.

UpdateDataPointChoiceResponse

Ƭ UpdateDataPointChoiceResponse: DataPointChoice

Contains response data for the updateDataPointChoice operation.

UpdateDataPointResponse

Ƭ UpdateDataPointResponse: DataPoint

Contains response data for the updateDataPoint operation.

UpdateDocumentDataResponse

Ƭ UpdateDocumentDataResponse: DocumentUnion

Contains response data for the updateDocumentData operation.

UpdateDocumentResponse

Ƭ UpdateDocumentResponse: DocumentUnion

Contains response data for the updateDocument operation.

UpdateExtractorResponse

Ƭ UpdateExtractorResponse: Extractor

Contains response data for the updateExtractor operation.

UpdateIndexResponse

Ƭ UpdateIndexResponse: Index

Contains response data for the updateIndex operation.

UpdateInvitationResponse

Ƭ UpdateInvitationResponse: Invitation

Contains response data for the updateInvitation operation.

UpdateJobDescriptionSearchConfigResponse

Ƭ UpdateJobDescriptionSearchConfigResponse: JobDescriptionSearchConfig

Contains response data for the updateJobDescriptionSearchConfig operation.

UpdateMappingResponse

Ƭ UpdateMappingResponse: Mapping

Contains response data for the updateMapping operation.

UpdateOrganizationMembershipResponse

Ƭ UpdateOrganizationMembershipResponse: OrganizationMembership

Contains response data for the updateOrganizationMembership operation.

UpdateOrganizationResponse

Ƭ UpdateOrganizationResponse: Organization

Contains response data for the updateOrganization operation.

UpdateResthookSubscriptionResponse

Ƭ UpdateResthookSubscriptionResponse: ResthookSubscription

Contains response data for the updateResthookSubscription operation.

UpdateResumeSearchConfigResponse

Ƭ UpdateResumeSearchConfigResponse: ResumeSearchConfig

Contains response data for the updateResumeSearchConfig operation.

UpdateTagResponse

Ƭ UpdateTagResponse: Tag

Contains response data for the updateTag operation.

UpdateValidationResultResponse

Ƭ UpdateValidationResultResponse: ValidationResult

Contains response data for the updateValidationResult operation.

UpdateWorkspaceResponse

Ƭ UpdateWorkspaceResponse: Workspace

Contains response data for the updateWorkspace operation.

Version

Ƭ Version: string

Defines values for Version.
KnownVersion can be used interchangeably with Version, this enum contains the known values that the service supports.

Known values supported by the service

v1
v2
v3

WorkspaceSplitDocumentsOptions

Ƭ WorkspaceSplitDocumentsOptions: string

Defines values for WorkspaceSplitDocumentsOptions.
KnownWorkspaceSplitDocumentsOptions can be used interchangeably with WorkspaceSplitDocumentsOptions, this enum contains the known values that the service supports.

Known values supported by the service

leave
conservative
recommended
aggressive

WorkspaceVisibility

Ƭ WorkspaceVisibility: string

Defines values for WorkspaceVisibility.
KnownWorkspaceVisibility can be used interchangeably with WorkspaceVisibility, this enum contains the known values that the service supports.

Known values supported by the service

organization
private