Class DescartesClient

Index

Constructors

Methods

_getParsedResponse abort agreeToTermsOfService createAbortController createSchedule deleteNotification deleteSchedule getArchives getArchiveSessionDetails getCityExists getConfigurationInfo getDescartesVersion getElementHistory getExpandedDataBounds getFeatures getHistoryProposal getHouseNumbers getIssues getIssuesPage getMTEClosureProposals getMTEDetails getMTEList getPartnersByGeometry getProblemDetailsByIds getSchedule getSchedules getUpdateRequestSessionsByIds getUserProfile postFeatures postFeaturesBulk postImageryLayersCreateMapId postImageryRequest postOnlineEditorLocation postOnlineEditorVisibility postSuggestions postUploadVenueImage publishMTE readIssue searchIssuesByBbox starIssue submitMTE updateSchedule deleteIssueSearch getLocationSearchCity getLocationSearchCountries getLocationSearchStates getSharedIssueSearch queryLocationSearchCities saveIssueSearch shareIssueSearch updateIssueSearch

Constructors

constructor

new DescartesClient(): DescartesClient
Returns DescartesClient

Methods

_getParsedResponse

_getParsedResponse(
url: string,
params: HTTPRequestData,
): Promise<ParsedResponse>
Parameters
- url: string
- params: HTTPRequestData
Returns Promise<ParsedResponse>

abort

abort(key: AbortControllerKey): void
Parameters
- key: AbortControllerKey
Returns void

agreeToTermsOfService

agreeToTermsOfService(): Promise<unknown>
Returns Promise<unknown>

createAbortController

createAbortController(key: AbortControllerKey): AbortController
Parameters
- key: AbortControllerKey
Returns AbortController

createSchedule

createSchedule(schedulePayload: SchedulePayload): Promise<RawSchedule>
Parameters
- schedulePayload: SchedulePayload
Returns Promise<RawSchedule>

deleteNotification

deleteNotification(id: number): Promise<unknown>
Parameters
- id: number
Returns Promise<unknown>

deleteSchedule

deleteSchedule(id: string): Promise<unknown>
Parameters
- id: string
Returns Promise<unknown>

getArchives

getArchives(
    __namedParameters: {
        count: number;
        minDistance: number;
        offset: number;
        username: string;
    },
): Promise<ParsedResponse>
Parameters
- __namedParameters: { count: number; minDistance: number; offset: number; username: string }
Returns Promise<ParsedResponse>

getArchiveSessionDetails

getArchiveSessionDetails(id: string): Promise<ParsedResponse>
Parameters
- id: string
Returns Promise<ParsedResponse>

getCityExists

getCityExists(
    cityName: string,
    countryID: string | number,
    stateID: string | number,
): Promise<RawCityExistsResponse>
Parameters
- cityName: string
- countryID: string | number
- stateID: string | number
Returns Promise<RawCityExistsResponse>

getConfigurationInfo

getConfigurationInfo(): Promise<ServerConfigInterface>
Returns Promise<ServerConfigInterface>

getDescartesVersion

getDescartesVersion(): Promise<string>
Returns Promise<string>

getElementHistory

getElementHistory(
    objectType: ObjectType,
    objectID: ObjectId,
    fromTxID?: null | string,
    options?: HTTPRequestOptions,
): Promise<ParsedResponse>
Parameters
- objectType: ObjectType
- objectID: ObjectId
- fromTxID: null | string = null
- Optionaloptions: HTTPRequestOptions
Returns Promise<ParsedResponse>

getExpandedDataBounds

getExpandedDataBounds(bounds: BBox): BBox
Parameters
- bounds: BBox
Returns BBox

getFeatures

getFeatures(
    bounds: BBox,
    filter: FeatureRequestParams,
    zoomLevel: ZoomLevel,
    requestUUID: string,
    options?: ObjectLiteral,
    version?: number,
): Promise<ParsedResponse>
Parameters
- bounds: BBox
- filter: FeatureRequestParams
- zoomLevel: ZoomLevel
- requestUUID: string
- Optionaloptions: ObjectLiteral
- version: number = 2
Returns Promise<ParsedResponse>

getHistoryProposal

getHistoryProposal(
proposalId: string,
options?: HTTPRequestOptions,
): Promise<null | EditSuggestion>
Parameters
- proposalId: string
- options: HTTPRequestOptions = {}
Returns Promise<null | EditSuggestion>

getHouseNumbers

getHouseNumbers(segmentIds: number[]): Promise<ParsedResponse>
Parameters
- segmentIds: number[]
Returns Promise<ParsedResponse>

getIssues

getIssues(params: GetIssueRequestParamsType): Promise<ParsedResponse>
Parameters
- params: GetIssueRequestParamsType
Returns Promise<ParsedResponse>

getIssuesPage

getIssuesPage(
    params: IssueTrackerRawFilters,
    map: WMEMap,
    requestUUID: string,
): Promise<RawIssuesListResponseData>
Parameters
- params: IssueTrackerRawFilters
- map: WMEMap
- requestUUID: string
Returns Promise<RawIssuesListResponseData>

getMTEClosureProposals

getMTEClosureProposals(id: string): Promise<ParsedResponse>
Parameters
- id: string
Returns Promise<ParsedResponse>

getMTEDetails

getMTEDetails(id: string, includePastClosures: boolean): Promise<ParsedResponse>
Parameters
- id: string
- includePastClosures: boolean
Returns Promise<ParsedResponse>

getMTEList

getMTEList(params: MTESearchParams): Promise<ParsedResponse>
Parameters
- params: MTESearchParams
Returns Promise<ParsedResponse>

getPartnersByGeometry

getPartnersByGeometry(bbox: BBox): Promise<RawPartnersResponse>
Parameters
- bbox: BBox
Returns Promise<RawPartnersResponse>

getProblemDetailsByIds

getProblemDetailsByIds(ids: string[]): Promise<ParsedResponse>
Parameters
- ids: string[]
Returns Promise<ParsedResponse>

getSchedule

getSchedule(
scheduleId: string,
options?: { expand: boolean },
): Promise<void | ParsedResponse>
Parameters
- scheduleId: string
- Optionaloptions: { expand: boolean }
Returns Promise<void | ParsedResponse>

getSchedules

getSchedules(params: SchedulesSearchParams): Promise<void | ParsedResponse>
Parameters
- params: SchedulesSearchParams
Returns Promise<void | ParsedResponse>

getUpdateRequestSessionsByIds

getUpdateRequestSessionsByIds(ids: number[]): Promise<ParsedResponse>
Parameters
- ids: number[]
Returns Promise<ParsedResponse>

getUserProfile

getUserProfile(username: string): Promise<RawUserProfile>
Parameters
- username: string
Returns Promise<RawUserProfile>

postFeatures

postFeatures(
operations: SaveFeaturesPayload,
ignoreWarnings: boolean,
): Promise<SaveResponse>
Parameters
- operations: SaveFeaturesPayload
- ignoreWarnings: boolean
Returns Promise<SaveResponse>

postFeaturesBulk

postFeaturesBulk(
operations: SaveFeaturesBulkPayload,
ignoreWarnings: boolean,
): Promise<AppControllerSaveBulkResponse>
Parameters
- operations: SaveFeaturesBulkPayload
- ignoreWarnings: boolean
Returns Promise<AppControllerSaveBulkResponse>

postImageryLayersCreateMapId

postImageryLayersCreateMapId(
layerId: EARTH_ENGINE_LAYERS_UNIQUE_NAMES_TYPE,
): Promise<RawImageryLayersCreateMapIdResponse>
Parameters
- layerId: EARTH_ENGINE_LAYERS_UNIQUE_NAMES_TYPE
Returns Promise<RawImageryLayersCreateMapIdResponse>

postImageryRequest

postImageryRequest(
params: ImageryRequestPayload,
): Promise<RawImageryRequestResponse>
Parameters
- params: ImageryRequestPayload
Returns Promise<RawImageryRequestResponse>

postOnlineEditorLocation

postOnlineEditorLocation(mapCenter: LonLat): Promise<void>
Parameters
- mapCenter: LonLat
Returns Promise<void>

postOnlineEditorVisibility

postOnlineEditorVisibility(visible: boolean): Promise<void>
Parameters
- visible: boolean
Returns Promise<void>

postSuggestions

postSuggestions(
saveSuggestionsPayload: SaveSuggestionsPayload,
): Promise<SaveProposalResponse>
Parameters
- saveSuggestionsPayload: SaveSuggestionsPayload
Returns Promise<SaveProposalResponse>

postUploadVenueImage

postUploadVenueImage(imageData: Uint8Array): Promise<RawImage>
Parameters
- imageData: Uint8Array
Returns Promise<RawImage>

publishMTE

publishMTE(model: MajorTrafficEvent, dataModel: DataModel): Promise<undefined>
Parameters
- model: MajorTrafficEvent
- dataModel: DataModel
Returns Promise<undefined>

readIssue

readIssue(params: ReadIssueRequestParamsType): Promise<void>
Parameters
- params: ReadIssueRequestParamsType
Returns Promise<void>

searchIssuesByBbox

searchIssuesByBbox(
    params: IssueTrackerRawFilters,
    map: WMEMap,
    requestUUID: string,
): Promise<ParsedResponse>
Parameters
- params: IssueTrackerRawFilters
- map: WMEMap
- requestUUID: string
Returns Promise<ParsedResponse>

starIssue

starIssue(params: StarIssueRequestParamsType): Promise<void>
Parameters
- params: StarIssueRequestParamsType
Returns Promise<void>

submitMTE

submitMTE(model: MajorTrafficEvent, dataModel: DataModel): Promise<undefined>
Parameters
- model: MajorTrafficEvent
- dataModel: DataModel
Returns Promise<undefined>

updateSchedule

updateSchedule(
scheduleId: string,
schedulePayload: SchedulePayload,
): Promise<RawSchedule>
Parameters
- scheduleId: string
- schedulePayload: SchedulePayload
Returns Promise<RawSchedule>

`Static`deleteIssueSearch

deleteIssueSearch(id: string): Promise<unknown>
Parameters
- id: string
Returns Promise<unknown>

`Static`getLocationSearchCity

getLocationSearchCity(cityId: number): Promise<RawCityById>
Parameters
- cityId: number
Returns Promise<RawCityById>

`Static`getLocationSearchCountries

getLocationSearchCountries(): Promise<LocationSearchCountry[]>
Returns Promise<LocationSearchCountry[]>

`Static`getLocationSearchStates

getLocationSearchStates(countryId: number): Promise<LocationSearchState[]>
Parameters
- countryId: number
Returns Promise<LocationSearchState[]>

`Static`getSharedIssueSearch

getSharedIssueSearch(id: string): Promise<IssueTrackerRawFilters>
Parameters
- id: string
Returns Promise<IssueTrackerRawFilters>

`Static`queryLocationSearchCities

queryLocationSearchCities(
    countryId: number,
    stateId: null | number,
    query: string,
): Promise<LocationSearchCity[]>
Parameters
- countryId: number
- stateId: null | number
- query: string
Returns Promise<LocationSearchCity[]>

`Static`saveIssueSearch

saveIssueSearch(
params: IssueTrackerSavedSearchParams,
): Promise<IssueTrackerSavedSearchResponse>
Parameters
- params: IssueTrackerSavedSearchParams
Returns Promise<IssueTrackerSavedSearchResponse>

`Static`shareIssueSearch

shareIssueSearch(
filters: IssueTrackerRawFilters,
): Promise<IssueTrackerCreateSharedSavedSearchResponse>
Parameters
- filters: IssueTrackerRawFilters
Returns Promise<IssueTrackerCreateSharedSavedSearchResponse>

`Static`updateIssueSearch

updateIssueSearch(
id: string,
params: Partial<IssueTrackerSavedSearchParams>,
): Promise<unknown>
Parameters
- id: string
- params: Partial<IssueTrackerSavedSearchParams>
Returns Promise<unknown>