/** * Faraday REST API * The [Faraday](https://faraday.ai) API makes it easy to predict customer behavior programmatically. See our [API change policy](https://faraday.ai/legal). * * The version of the OpenAPI document: 1.0.0 * Contact: support@faraday.ai * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { ArchiveConfig, Place, PlaceMergePatch, PlacePost } from '../models'; export interface ArchivePlaceRequest { placeId: string; archiveConfig: ArchiveConfig; } export interface CreatePlaceRequest { placeFields: PlacePost; } export interface DeletePlaceRequest { placeId: string; } export interface ForceUpdatePlaceRequest { placeId: string; } export interface GetPlaceRequest { placeId: string; } export interface GetPlacesRequest { ids?: Array; } export interface UnarchivePlaceRequest { placeId: string; archiveConfig: ArchiveConfig; } export interface UpdatePlaceRequest { placeId: string; placeFields: PlaceMergePatch; } /** * */ export declare class PlacesApi extends runtime.BaseAPI { /** * Archive a place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See POST /atlases/{atlas_id}/archive. * Archive a place */ archivePlaceRaw(requestParameters: ArchivePlaceRequest): Promise>; /** * Archive a place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See POST /atlases/{atlas_id}/archive. * Archive a place */ archivePlace(placeId: string, archiveConfig: ArchiveConfig): Promise; /** * Create a new place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. Build new spatial filters on an atlas: see POST /atlases. * Create place */ createPlaceRaw(requestParameters: CreatePlaceRequest): Promise>; /** * Create a new place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. Build new spatial filters on an atlas: see POST /atlases. * Create place */ createPlace(placeFields: PlacePost): Promise; /** * Delete a place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See DELETE /atlases/{atlas_id}. * Delete a place */ deletePlaceRaw(requestParameters: DeletePlaceRequest): Promise>; /** * Delete a place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See DELETE /atlases/{atlas_id}. * Delete a place */ deletePlace(placeId: string): Promise; /** * Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See POST /atlases/{atlas_id}/force_update. * Trigger a rerun for this resource. */ forceUpdatePlaceRaw(requestParameters: ForceUpdatePlaceRequest): Promise>; /** * Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See POST /atlases/{atlas_id}/force_update. * Trigger a rerun for this resource. */ forceUpdatePlace(placeId: string): Promise; /** * Retrieve details on a specific place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See GET /atlases/{atlas_id}. * Retrieve a place */ getPlaceRaw(requestParameters: GetPlaceRequest): Promise>; /** * Retrieve details on a specific place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See GET /atlases/{atlas_id}. * Retrieve a place */ getPlace(placeId: string): Promise; /** * Get a list of the places defined on the account. Geometry and addresses are omitted from this endpoint\'s response to avoid overly large response sizes. If you want to inspect a place\'s geometry or addresses, then use GET /places/. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See GET /atlases. * List places */ getPlacesRaw(requestParameters: GetPlacesRequest): Promise>>; /** * Get a list of the places defined on the account. Geometry and addresses are omitted from this endpoint\'s response to avoid overly large response sizes. If you want to inspect a place\'s geometry or addresses, then use GET /places/. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See GET /atlases. * List places */ getPlaces(ids?: Array): Promise>; /** * Unarchive a place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See POST /atlases/{atlas_id}/unarchive. * Unarchive a place */ unarchivePlaceRaw(requestParameters: UnarchivePlaceRequest): Promise>; /** * Unarchive a place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See POST /atlases/{atlas_id}/unarchive. * Unarchive a place */ unarchivePlace(placeId: string, archiveConfig: ArchiveConfig): Promise; /** * Update an existing place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See PATCH /atlases/{atlas_id}. * Update place */ updatePlaceRaw(requestParameters: UpdatePlaceRequest): Promise>; /** * Update an existing place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See PATCH /atlases/{atlas_id}. * Update place */ updatePlace(placeId: string, placeFields: PlaceMergePatch): Promise; }