arlas-api
Version:
ARLAS Api.
2,235 lines • 160 kB
TypeScript
/// <reference path="custom.d.ts" />
import { Configuration } from "./configuration";
/**
*
* @export
*/
export declare const COLLECTION_FORMATS: {
csv: string;
ssv: string;
tsv: string;
pipes: string;
};
/**
*
* @export
* @interface FetchAPI
*/
export interface FetchAPI {
(url: string, init?: any): Promise<Response>;
}
/**
*
* @export
* @interface FetchArgs
*/
export interface FetchArgs {
url: string;
options: any;
}
/**
*
* @export
* @class BaseAPI
*/
export declare class BaseAPI {
protected basePath: string;
protected fetch: FetchAPI;
protected configuration: Configuration;
constructor(configuration?: Configuration, basePath?: string, fetch?: FetchAPI);
}
/**
*
* @export
* @class RequiredError
* @extends {Error}
*/
export declare class RequiredError extends Error {
field: string;
name: "RequiredError";
constructor(field: string, msg?: string);
}
/**
*
* @export
* @interface Aggregation
*/
export interface Aggregation {
/**
*
* @type {string}
* @memberof Aggregation
*/
type?: Aggregation.TypeEnum;
/**
*
* @type {string}
* @memberof Aggregation
*/
field?: string;
/**
*
* @type {Interval}
* @memberof Aggregation
*/
interval?: Interval;
/**
*
* @type {string}
* @memberof Aggregation
*/
format?: string;
/**
*
* @type {Array<Metric>}
* @memberof Aggregation
*/
metrics?: Array<Metric>;
/**
*
* @type {string}
* @memberof Aggregation
*/
order?: Aggregation.OrderEnum;
/**
*
* @type {string}
* @memberof Aggregation
*/
on?: Aggregation.OnEnum;
/**
*
* @type {string}
* @memberof Aggregation
*/
size?: string;
/**
*
* @type {string}
* @memberof Aggregation
*/
include?: string;
/**
*
* @type {Array<RawGeometry>}
* @memberof Aggregation
*/
raw_geometries?: Array<RawGeometry>;
/**
*
* @type {Array<string>}
* @memberof Aggregation
*/
aggregated_geometries?: Array<Aggregation.AggregatedGeometriesEnum>;
/**
*
* @type {HitsFetcher}
* @memberof Aggregation
*/
fetch_hits?: HitsFetcher;
}
/**
* @export
* @namespace Aggregation
*/
export declare namespace Aggregation {
/**
* @export
* @enum {string}
*/
enum TypeEnum {
Datehistogram,
Geohash,
Geotile,
Histogram,
Term,
H3,
}
/**
* @export
* @enum {string}
*/
enum OrderEnum {
Asc,
Desc,
}
/**
* @export
* @enum {string}
*/
enum OnEnum {
Field,
Count,
Result,
}
/**
* @export
* @enum {string}
*/
enum AggregatedGeometriesEnum {
BBOX,
CENTROID,
CELL,
CELLCENTER,
GEOHASH,
GEOHASHCENTER,
}
}
/**
*
* @export
* @interface AggregationMetric
*/
export interface AggregationMetric {
/**
*
* @type {string}
* @memberof AggregationMetric
*/
type?: string;
/**
*
* @type {string}
* @memberof AggregationMetric
*/
field?: string;
/**
*
* @type {any}
* @memberof AggregationMetric
*/
value?: any;
}
/**
*
* @export
* @interface AggregationResponse
*/
export interface AggregationResponse {
/**
*
* @type {number}
* @memberof AggregationResponse
*/
query_time?: number;
/**
*
* @type {number}
* @memberof AggregationResponse
*/
total_time?: number;
/**
*
* @type {number}
* @memberof AggregationResponse
*/
totalnb?: number;
/**
*
* @type {string}
* @memberof AggregationResponse
*/
name?: string;
/**
*
* @type {number}
* @memberof AggregationResponse
*/
count?: number;
/**
*
* @type {number}
* @memberof AggregationResponse
*/
sumotherdoccounts?: number;
/**
*
* @type {any}
* @memberof AggregationResponse
*/
key?: any;
/**
*
* @type {any}
* @memberof AggregationResponse
*/
key_as_string?: any;
/**
*
* @type {Array<AggregationResponse>}
* @memberof AggregationResponse
*/
elements?: Array<AggregationResponse>;
/**
*
* @type {Array<AggregationMetric>}
* @memberof AggregationResponse
*/
metrics?: Array<AggregationMetric>;
/**
*
* @type {Array<any>}
* @memberof AggregationResponse
*/
hits?: Array<any>;
/**
*
* @type {Array<ReturnedGeometry>}
* @memberof AggregationResponse
*/
geometries?: Array<ReturnedGeometry>;
/**
*
* @type {{ [key: string]: any; }}
* @memberof AggregationResponse
*/
flattened_elements?: {
[key: string]: any;
};
}
/**
*
* @export
* @interface AggregationsRequest
*/
export interface AggregationsRequest {
/**
*
* @type {Filter}
* @memberof AggregationsRequest
*/
filter?: Filter;
/**
*
* @type {Form}
* @memberof AggregationsRequest
*/
form?: Form;
/**
*
* @type {Array<Aggregation>}
* @memberof AggregationsRequest
*/
aggregations?: Array<Aggregation>;
}
/**
*
* @export
* @interface Bbox
*/
export interface Bbox {
/**
*
* @type {number}
* @memberof Bbox
*/
north: number;
/**
*
* @type {number}
* @memberof Bbox
*/
south: number;
/**
*
* @type {number}
* @memberof Bbox
*/
east: number;
/**
*
* @type {number}
* @memberof Bbox
*/
west: number;
}
/**
*
* @export
* @interface CollectionDisplayNames
*/
export interface CollectionDisplayNames {
/**
*
* @type {string}
* @memberof CollectionDisplayNames
*/
collection?: string;
/**
*
* @type {{ [key: string]: string; }}
* @memberof CollectionDisplayNames
*/
fields?: {
[key: string]: string;
};
/**
*
* @type {{ [key: string]: string; }}
* @memberof CollectionDisplayNames
*/
shape_columns?: {
[key: string]: string;
};
}
/**
*
* @export
* @interface CollectionReference
*/
export interface CollectionReference {
/**
*
* @type {string}
* @memberof CollectionReference
*/
collection_name: string;
/**
*
* @type {CollectionReferenceParameters}
* @memberof CollectionReference
*/
params: CollectionReferenceParameters;
}
/**
*
* @export
* @interface CollectionReferenceDescription
*/
export interface CollectionReferenceDescription {
/**
*
* @type {{ [key: string]: CollectionReferenceDescriptionProperty; }}
* @memberof CollectionReferenceDescription
*/
properties?: {
[key: string]: CollectionReferenceDescriptionProperty;
};
/**
*
* @type {string}
* @memberof CollectionReferenceDescription
*/
collection_name: string;
/**
*
* @type {CollectionReferenceParameters}
* @memberof CollectionReferenceDescription
*/
params: CollectionReferenceParameters;
}
/**
*
* @export
* @interface CollectionReferenceDescriptionProperty
*/
export interface CollectionReferenceDescriptionProperty {
/**
*
* @type {string}
* @memberof CollectionReferenceDescriptionProperty
*/
type?: CollectionReferenceDescriptionProperty.TypeEnum;
/**
*
* @type {string}
* @memberof CollectionReferenceDescriptionProperty
*/
format?: string;
/**
*
* @type {string}
* @memberof CollectionReferenceDescriptionProperty
*/
hash_field?: string;
/**
*
* @type {{ [key: string]: CollectionReferenceDescriptionProperty; }}
* @memberof CollectionReferenceDescriptionProperty
*/
properties?: {
[key: string]: CollectionReferenceDescriptionProperty;
};
/**
*
* @type {boolean}
* @memberof CollectionReferenceDescriptionProperty
*/
taggable?: boolean;
/**
*
* @type {boolean}
* @memberof CollectionReferenceDescriptionProperty
*/
indexed?: boolean;
}
/**
* @export
* @namespace CollectionReferenceDescriptionProperty
*/
export declare namespace CollectionReferenceDescriptionProperty {
/**
* @export
* @enum {string}
*/
enum TypeEnum {
TEXT,
KEYWORD,
LONG,
INTEGER,
SHORT,
BYTE,
DOUBLE,
FLOAT,
DATE,
BOOLEAN,
BINARY,
INTRANGE,
FLOATRANGE,
LONGRANGE,
DOUBLERANGE,
DATERANGE,
OBJECT,
NESTED,
GEOPOINT,
GEOSHAPE,
IP,
COMPLETION,
TOKENCOUNT,
MAPPERMURMUR3,
UNKNOWN,
VARCHAR,
CHAR,
CHARACTER,
BIT,
TINYINT,
SMALLINT,
INT,
BIGINT,
DECIMAL,
NUMERIC,
REAL,
DOUBLEPRECISION,
TIMESTAMP,
TIME,
INTERVAL,
GEOMETRY,
GEOGRAPHY,
POINT,
LINESTRING,
POLYGON,
MULTIPOINT,
MULTILINESTRING,
MULTIPOLYGON,
GEOMETRYCOLLECTION,
MURMUR3,
}
}
/**
*
* @export
* @interface CollectionReferenceParameters
*/
export interface CollectionReferenceParameters {
/**
*
* @type {string}
* @memberof CollectionReferenceParameters
*/
index_name: string;
/**
*
* @type {string}
* @memberof CollectionReferenceParameters
*/
id_path: string;
/**
*
* @type {string}
* @memberof CollectionReferenceParameters
*/
geometry_path: string;
/**
*
* @type {string}
* @memberof CollectionReferenceParameters
*/
centroid_path: string;
/**
*
* @type {string}
* @memberof CollectionReferenceParameters
*/
h3_path?: string;
/**
*
* @type {string}
* @memberof CollectionReferenceParameters
*/
timestamp_path: string;
/**
*
* @type {string}
* @memberof CollectionReferenceParameters
*/
exclude_fields?: string;
/**
*
* @type {number}
* @memberof CollectionReferenceParameters
*/
update_max_hits?: number;
/**
*
* @type {string}
* @memberof CollectionReferenceParameters
*/
taggable_fields?: string;
/**
*
* @type {string}
* @memberof CollectionReferenceParameters
*/
exclude_wfs_fields?: string;
/**
*
* @type {{ [key: string]: string; }}
* @memberof CollectionReferenceParameters
*/
custom_params?: {
[key: string]: string;
};
/**
*
* @type {CollectionDisplayNames}
* @memberof CollectionReferenceParameters
*/
display_names?: CollectionDisplayNames;
/**
*
* @type {Feed}
* @memberof CollectionReferenceParameters
*/
atom_feed?: Feed;
/**
*
* @type {OpenSearch}
* @memberof CollectionReferenceParameters
*/
open_search?: OpenSearch;
/**
*
* @type {Inspire}
* @memberof CollectionReferenceParameters
*/
inspire?: Inspire;
/**
*
* @type {DublinCoreElementName}
* @memberof CollectionReferenceParameters
*/
dublin_core_element_name?: DublinCoreElementName;
/**
*
* @type {RasterTileURL}
* @memberof CollectionReferenceParameters
*/
raster_tile_url?: RasterTileURL;
/**
*
* @type {number}
* @memberof CollectionReferenceParameters
*/
raster_tile_width?: number;
/**
*
* @type {number}
* @memberof CollectionReferenceParameters
*/
raster_tile_height?: number;
/**
*
* @type {Filter}
* @memberof CollectionReferenceParameters
*/
filter?: Filter;
/**
*
* @type {string}
* @memberof CollectionReferenceParameters
*/
license_name?: string;
/**
*
* @type {Array<string>}
* @memberof CollectionReferenceParameters
*/
license_urls?: Array<string>;
}
/**
*
* @export
* @interface ComputationRequest
*/
export interface ComputationRequest {
/**
*
* @type {Filter}
* @memberof ComputationRequest
*/
filter?: Filter;
/**
*
* @type {Form}
* @memberof ComputationRequest
*/
form?: Form;
/**
*
* @type {string}
* @memberof ComputationRequest
*/
field?: string;
/**
*
* @type {string}
* @memberof ComputationRequest
*/
metric?: ComputationRequest.MetricEnum;
/**
*
* @type {number}
* @memberof ComputationRequest
*/
precision_threshold?: number;
}
/**
* @export
* @namespace ComputationRequest
*/
export declare namespace ComputationRequest {
/**
* @export
* @enum {string}
*/
enum MetricEnum {
AVG,
MAX,
MIN,
SUM,
CARDINALITY,
SPANNING,
GEOBBOX,
GEOCENTROID,
}
}
/**
*
* @export
* @interface ComputationResponse
*/
export interface ComputationResponse {
/**
*
* @type {number}
* @memberof ComputationResponse
*/
query_time?: number;
/**
*
* @type {number}
* @memberof ComputationResponse
*/
total_time?: number;
/**
*
* @type {number}
* @memberof ComputationResponse
*/
totalnb?: number;
/**
*
* @type {string}
* @memberof ComputationResponse
*/
field?: string;
/**
*
* @type {string}
* @memberof ComputationResponse
*/
metric?: ComputationResponse.MetricEnum;
/**
*
* @type {number}
* @memberof ComputationResponse
*/
value?: number;
/**
*
* @type {GeoJsonObject}
* @memberof ComputationResponse
*/
geometry?: GeoJsonObject;
}
/**
* @export
* @namespace ComputationResponse
*/
export declare namespace ComputationResponse {
/**
* @export
* @enum {string}
*/
enum MetricEnum {
AVG,
MAX,
MIN,
SUM,
CARDINALITY,
SPANNING,
GEOBBOX,
GEOCENTROID,
}
}
/**
*
* @export
* @interface Count
*/
export interface Count {
/**
*
* @type {Filter}
* @memberof Count
*/
filter?: Filter;
/**
*
* @type {Form}
* @memberof Count
*/
form?: Form;
}
/**
*
* @export
* @interface Crs
*/
export interface Crs {
/**
*
* @type {string}
* @memberof Crs
*/
type?: Crs.TypeEnum;
/**
*
* @type {{ [key: string]: any; }}
* @memberof Crs
*/
properties?: {
[key: string]: any;
};
}
/**
* @export
* @namespace Crs
*/
export declare namespace Crs {
/**
* @export
* @enum {string}
*/
enum TypeEnum {
Name,
Link,
}
}
/**
*
* @export
* @interface DublinCoreElementName
*/
export interface DublinCoreElementName {
/**
*
* @type {string}
* @memberof DublinCoreElementName
*/
title?: string;
/**
*
* @type {string}
* @memberof DublinCoreElementName
*/
creator?: string;
/**
*
* @type {string}
* @memberof DublinCoreElementName
*/
subject?: string;
/**
*
* @type {string}
* @memberof DublinCoreElementName
*/
description?: string;
/**
*
* @type {string}
* @memberof DublinCoreElementName
*/
publisher?: string;
/**
*
* @type {string}
* @memberof DublinCoreElementName
*/
contributor?: string;
/**
*
* @type {string}
* @memberof DublinCoreElementName
*/
type?: string;
/**
*
* @type {string}
* @memberof DublinCoreElementName
*/
format?: string;
/**
*
* @type {string}
* @memberof DublinCoreElementName
*/
identifier?: string;
/**
*
* @type {string}
* @memberof DublinCoreElementName
*/
source?: string;
/**
*
* @type {string}
* @memberof DublinCoreElementName
*/
language?: string;
/**
*
* @type {Bbox}
* @memberof DublinCoreElementName
*/
bbox?: Bbox;
/**
*
* @type {string}
* @memberof DublinCoreElementName
*/
date?: string;
/**
*
* @type {{ [key: string]: any; }}
* @memberof DublinCoreElementName
*/
coverage?: {
[key: string]: any;
};
/**
*
* @type {string}
* @memberof DublinCoreElementName
*/
coverage_centroid?: string;
}
/**
*
* @export
* @interface Expression
*/
export interface Expression {
/**
*
* @type {string}
* @memberof Expression
*/
field?: string;
/**
*
* @type {string}
* @memberof Expression
*/
op?: Expression.OpEnum;
/**
*
* @type {string}
* @memberof Expression
*/
value?: string;
}
/**
* @export
* @namespace Expression
*/
export declare namespace Expression {
/**
* @export
* @enum {string}
*/
enum OpEnum {
Eq,
Gte,
Gt,
Lte,
Lt,
Like,
Ne,
Range,
Within,
Notwithin,
Intersects,
Notintersects,
}
}
/**
*
* @export
* @interface Feature
*/
export interface Feature {
/**
*
* @type {Crs}
* @memberof Feature
*/
crs?: Crs;
/**
*
* @type {Array<number>}
* @memberof Feature
*/
bbox?: Array<number>;
/**
*
* @type {{ [key: string]: any; }}
* @memberof Feature
*/
properties?: {
[key: string]: any;
};
/**
*
* @type {GeoJsonObject}
* @memberof Feature
*/
geometry?: GeoJsonObject;
/**
*
* @type {string}
* @memberof Feature
*/
id?: string;
}
/**
*
* @export
* @interface FeatureCollection
*/
export interface FeatureCollection {
/**
*
* @type {Crs}
* @memberof FeatureCollection
*/
crs?: Crs;
/**
*
* @type {Array<number>}
* @memberof FeatureCollection
*/
bbox?: Array<number>;
/**
*
* @type {Array<Feature>}
* @memberof FeatureCollection
*/
features?: Array<Feature>;
}
/**
*
* @export
* @interface Feed
*/
export interface Feed {
/**
*
* @type {Person}
* @memberof Feed
*/
author?: Person;
/**
*
* @type {Person}
* @memberof Feed
*/
contributor?: Person;
/**
*
* @type {string}
* @memberof Feed
*/
icon?: string;
/**
*
* @type {string}
* @memberof Feed
*/
logo?: string;
/**
*
* @type {string}
* @memberof Feed
*/
rights?: string;
/**
*
* @type {string}
* @memberof Feed
*/
subtitle?: string;
/**
*
* @type {Generator}
* @memberof Feed
*/
generator?: Generator;
}
/**
*
* @export
* @interface Filter
*/
export interface Filter {
/**
*
* @type {Array<Array<Expression>>}
* @memberof Filter
*/
f?: Array<Array<Expression>>;
/**
*
* @type {Array<Array<string>>}
* @memberof Filter
*/
q?: Array<Array<string>>;
/**
*
* @type {string}
* @memberof Filter
*/
dateformat?: string;
/**
*
* @type {boolean}
* @memberof Filter
*/
righthand?: boolean;
}
/**
*
* @export
* @interface Form
*/
export interface Form {
/**
*
* @type {boolean}
* @memberof Form
*/
pretty?: boolean;
/**
*
* @type {boolean}
* @memberof Form
*/
flat?: boolean;
}
/**
*
* @export
* @interface Generator
*/
export interface Generator {
/**
*
* @type {string}
* @memberof Generator
*/
name?: string;
/**
*
* @type {string}
* @memberof Generator
*/
version?: string;
/**
*
* @type {string}
* @memberof Generator
*/
uri?: string;
}
/**
*
* @export
* @interface Geo
*/
export interface Geo {
/**
*
* @type {string}
* @memberof Geo
*/
path?: string;
/**
*
* @type {GeoJsonObject}
* @memberof Geo
*/
geometry?: GeoJsonObject;
}
/**
*
* @export
* @interface GeoJsonObject
*/
export interface GeoJsonObject {
/**
*
* @type {Crs}
* @memberof GeoJsonObject
*/
crs?: Crs;
/**
*
* @type {Array<number>}
* @memberof GeoJsonObject
*/
bbox?: Array<number>;
}
/**
*
* @export
* @interface Hit
*/
export interface Hit {
/**
*
* @type {MD}
* @memberof Hit
*/
md?: MD;
/**
*
* @type {any}
* @memberof Hit
*/
data?: any;
}
/**
*
* @export
* @interface Hits
*/
export interface Hits {
/**
*
* @type {string}
* @memberof Hits
*/
collection?: string;
/**
*
* @type {Array<Hit>}
* @memberof Hits
*/
hits?: Array<Hit>;
/**
*
* @type {number}
* @memberof Hits
*/
nbhits?: number;
/**
*
* @type {number}
* @memberof Hits
*/
totalnb?: number;
/**
*
* @type {{ [key: string]: Link; }}
* @memberof Hits
*/
links?: {
[key: string]: Link;
};
}
/**
*
* @export
* @interface HitsFetcher
*/
export interface HitsFetcher {
/**
*
* @type {number}
* @memberof HitsFetcher
*/
size?: number;
/**
*
* @type {Array<string>}
* @memberof HitsFetcher
*/
include?: Array<string>;
}
/**
*
* @export
* @interface Inspire
*/
export interface Inspire {
/**
*
* @type {Array<Keyword>}
* @memberof Inspire
*/
keywords?: Array<Keyword>;
/**
*
* @type {Array<string>}
* @memberof Inspire
*/
topic_categories?: Array<string>;
/**
*
* @type {string}
* @memberof Inspire
*/
lineage?: string;
/**
*
* @type {Array<string>}
* @memberof Inspire
*/
languages?: Array<string>;
/**
*
* @type {InspireSpatialResolution}
* @memberof Inspire
*/
spatial_resolution?: InspireSpatialResolution;
/**
*
* @type {InspireURI}
* @memberof Inspire
*/
inspire_uri?: InspireURI;
/**
*
* @type {InspireLimitationAccess}
* @memberof Inspire
*/
inspire_limitation_access?: InspireLimitationAccess;
/**
*
* @type {string}
* @memberof Inspire
*/
inspire_use_conditions?: string;
}
/**
*
* @export
* @interface InspireLimitationAccess
*/
export interface InspireLimitationAccess {
/**
*
* @type {string}
* @memberof InspireLimitationAccess
*/
access_constraints?: string;
/**
*
* @type {string}
* @memberof InspireLimitationAccess
*/
other_constraints?: string;
/**
*
* @type {string}
* @memberof InspireLimitationAccess
*/
classification?: string;
}
/**
*
* @export
* @interface InspireSpatialResolution
*/
export interface InspireSpatialResolution {
/**
*
* @type {Number}
* @memberof InspireSpatialResolution
*/
value?: Number;
/**
*
* @type {string}
* @memberof InspireSpatialResolution
*/
unit_of_measure?: string;
}
/**
*
* @export
* @interface InspireURI
*/
export interface InspireURI {
/**
*
* @type {string}
* @memberof InspireURI
*/
code?: string;
/**
*
* @type {string}
* @memberof InspireURI
*/
namespace?: string;
}
/**
*
* @export
* @interface Interval
*/
export interface Interval {
/**
*
* @type {Number}
* @memberof Interval
*/
value?: Number;
/**
*
* @type {string}
* @memberof Interval
*/
unit?: Interval.UnitEnum;
}
/**
* @export
* @namespace Interval
*/
export declare namespace Interval {
/**
* @export
* @enum {string}
*/
enum UnitEnum {
Year,
Quarter,
Month,
Week,
Day,
Hour,
Minute,
Second,
}
}
/**
*
* @export
* @interface Keyword
*/
export interface Keyword {
/**
*
* @type {string}
* @memberof Keyword
*/
value?: string;
/**
*
* @type {string}
* @memberof Keyword
*/
vocabulary?: string;
/**
*
* @type {string}
* @memberof Keyword
*/
date_of_publication?: string;
}
/**
*
* @export
* @interface Link
*/
export interface Link {
/**
*
* @type {string}
* @memberof Link
*/
href: string;
/**
*
* @type {string}
* @memberof Link
*/
method: string;
/**
*
* @type {any}
* @memberof Link
*/
body?: any;
}
/**
*
* @export
* @interface LngLatAlt
*/
export interface LngLatAlt {
/**
*
* @type {number}
* @memberof LngLatAlt
*/
longitude?: number;
/**
*
* @type {number}
* @memberof LngLatAlt
*/
latitude?: number;
/**
*
* @type {number}
* @memberof LngLatAlt
*/
altitude?: number;
/**
*
* @type {Array<number>}
* @memberof LngLatAlt
*/
additional_elements?: Array<number>;
}
/**
*
* @export
* @interface MD
*/
export interface MD {
/**
*
* @type {string}
* @memberof MD
*/
id?: string;
/**
*
* @type {number}
* @memberof MD
*/
timestamp?: number;
/**
*
* @type {GeoJsonObject}
* @memberof MD
*/
geometry?: GeoJsonObject;
/**
*
* @type {GeoJsonObject}
* @memberof MD
*/
centroid?: GeoJsonObject;
/**
*
* @type {Array<Geo>}
* @memberof MD
*/
returned_geometries?: Array<Geo>;
}
/**
*
* @export
* @interface Metric
*/
export interface Metric {
/**
*
* @type {string}
* @memberof Metric
*/
collect_field?: string;
/**
*
* @type {string}
* @memberof Metric
*/
collect_fct?: Metric.CollectFctEnum;
/**
*
* @type {number}
* @memberof Metric
*/
precision_threshold?: number;
}
/**
* @export
* @namespace Metric
*/
export declare namespace Metric {
/**
* @export
* @enum {string}
*/
enum CollectFctEnum {
AVG,
CARDINALITY,
MAX,
MIN,
SUM,
GEOCENTROID,
GEOBBOX,
}
}
/**
*
* @export
* @interface ModelError
*/
export interface ModelError {
/**
*
* @type {number}
* @memberof ModelError
*/
status?: number;
/**
*
* @type {string}
* @memberof ModelError
*/
message?: string;
/**
*
* @type {string}
* @memberof ModelError
*/
error?: string;
}
/**
*
* @export
* @interface Number
*/
export interface Number {
}
/**
*
* @export
* @interface OpenSearch
*/
export interface OpenSearch {
/**
*
* @type {string}
* @memberof OpenSearch
*/
short_name?: string;
/**
*
* @type {string}
* @memberof OpenSearch
*/
description?: string;
/**
*
* @type {string}
* @memberof OpenSearch
*/
contact?: string;
/**
*
* @type {string}
* @memberof OpenSearch
*/
tags?: string;
/**
*
* @type {string}
* @memberof OpenSearch
*/
long_name?: string;
/**
*
* @type {string}
* @memberof OpenSearch
*/
image_height?: string;
/**
*
* @type {string}
* @memberof OpenSearch
*/
image_width?: string;
/**
*
* @type {string}
* @memberof OpenSearch
*/
image_type?: string;
/**
*
* @type {string}
* @memberof OpenSearch
*/
image_url?: string;
/**
*
* @type {string}
* @memberof OpenSearch
*/
developer?: string;
/**
*
* @type {string}
* @memberof OpenSearch
*/
attribution?: string;
/**
*
* @type {string}
* @memberof OpenSearch
*/
syndication_right?: string;
/**
*
* @type {string}
* @memberof OpenSearch
*/
adult_content?: string;
/**
*
* @type {string}
* @memberof OpenSearch
*/
language?: string;
/**
*
* @type {string}
* @memberof OpenSearch
*/
input_encoding?: string;
/**
*
* @type {string}
* @memberof OpenSearch
*/
output_encoding?: string;
}
/**
*
* @export
* @interface Page
*/
export interface Page {
/**
*
* @type {number}
* @memberof Page
*/
size?: number;
/**
*
* @type {number}
* @memberof Page
*/
from?: number;
/**
*
* @type {string}
* @memberof Page
*/
sort?: string;
/**
*
* @type {string}
* @memberof Page
*/
after?: string;
/**
*
* @type {string}
* @memberof Page
*/
before?: string;
}
/**
*
* @export
* @interface Person
*/
export interface Person {
/**
*
* @type {string}
* @memberof Person
*/
name?: string;
/**
*
* @type {string}
* @memberof Person
*/
email?: string;
/**
*
* @type {string}
* @memberof Person
*/
uri?: string;
}
/**
*
* @export
* @interface Projection
*/
export interface Projection {
/**
*
* @type {string}
* @memberof Projection
*/
includes?: string;
/**
*
* @type {string}
* @memberof Projection
*/
excludes?: string;
}
/**
*
* @export
* @interface RasterTileURL
*/
export interface RasterTileURL {
/**
*
* @type {string}
* @memberof RasterTileURL
*/
url: string;
/**
*
* @type {string}
* @memberof RasterTileURL
*/
id_path: string;
/**
*
* @type {number}
* @memberof RasterTileURL
*/
min_z?: number;
/**
*
* @type {number}
* @memberof RasterTileURL
*/
max_z?: number;
/**
*
* @type {boolean}
* @memberof RasterTileURL
*/
check_geometry?: boolean;
}
/**
*
* @export
* @interface RawGeometry
*/
export interface RawGeometry {
/**
*
* @type {string}
* @memberof RawGeometry
*/
geometry?: string;
/**
*
* @type {string}
* @memberof RawGeometry
*/
sort?: string;
}
/**
*
* @export
* @interface ReturnedGeometry
*/
export interface ReturnedGeometry {
/**
*
* @type {string}
* @memberof ReturnedGeometry
*/
reference?: string;
/**
*
* @type {GeoJsonObject}
* @memberof ReturnedGeometry
*/
geometry?: GeoJsonObject;
/**
*
* @type {string}
* @memberof ReturnedGeometry
*/
sort?: string;
/**
*
* @type {boolean}
* @memberof ReturnedGeometry
*/
is_raw?: boolean;
}
/**
*
* @export
* @interface Search
*/
export interface Search {
/**
*
* @type {Filter}
* @memberof Search
*/
filter?: Filter;
/**
*
* @type {Form}
* @memberof Search
*/
form?: Form;
/**
*
* @type {Page}
* @memberof Search
*/
page?: Page;
/**
*
* @type {Projection}
* @memberof Search
*/
projection?: Projection;
/**
*
* @type {string}
* @memberof Search
*/
returned_geometries?: string;
}
/**
*
* @export
* @interface Success
*/
export interface Success {
/**
*
* @type {number}
* @memberof Success
*/
status?: number;
/**
*
* @type {string}
* @memberof Success
*/
message?: string;
}
/**
*
* @export
* @interface GeometryCollection
*/
export interface GeometryCollection extends GeoJsonObject {
/**
*
* @type {Array<GeoJsonObject>}
* @memberof GeometryCollection
*/
geometries?: Array<GeoJsonObject>;
}
/**
*
* @export
* @interface LineString
*/
export interface LineString extends GeoJsonObject {
/**
*
* @type {Array<LngLatAlt>}
* @memberof LineString
*/
coordinates?: Array<LngLatAlt>;
}
/**
*
* @export
* @interface MultiLineString
*/
export interface MultiLineString extends GeoJsonObject {
/**
*
* @type {Array<Array<LngLatAlt>>}
* @memberof MultiLineString
*/
coordinates?: Array<Array<LngLatAlt>>;
}
/**
*
* @export
* @interface MultiPoint
*/
export interface MultiPoint extends GeoJsonObject {
/**
*
* @type {Array<LngLatAlt>}
* @memberof MultiPoint
*/
coordinates?: Array<LngLatAlt>;
}
/**
*
* @export
* @interface MultiPolygon
*/
export interface MultiPolygon extends GeoJsonObject {
/**
*
* @type {Array<Array<Array<LngLatAlt>>>}
* @memberof MultiPolygon
*/
coordinates?: Array<Array<Array<LngLatAlt>>>;
}
/**
*
* @export
* @interface Point
*/
export interface Point extends GeoJsonObject {
/**
*
* @type {LngLatAlt}
* @memberof Point
*/
coordinates?: LngLatAlt;
}
/**
*
* @export
* @interface Polygon
*/
export interface Polygon extends GeoJsonObject {
/**
*
* @type {Array<Array<LngLatAlt>>}
* @memberof Polygon
*/
coordinates?: Array<Array<LngLatAlt>>;
}
/**
* CollectionsApi - fetch parameter creator
* @export
*/
export declare const CollectionsApiFetchParamCreator: (configuration?: Configuration) => {
_delete(collection: string, pretty?: boolean, options?: any): FetchArgs;
exportCollections(options?: any): FetchArgs;
get(collection: string, pretty?: boolean, options?: any): FetchArgs;
getAll(pretty?: boolean, options?: any): FetchArgs;
importCollections(file?: any, options?: any): FetchArgs;
put(collection: string, collection_params: CollectionReferenceParameters, pretty?: boolean, checkfields?: boolean, options?: any): FetchArgs;
};
/**
* CollectionsApi - functional programming interface
* @export
*/
export declare const CollectionsApiFp: (configuration?: Configuration) => {
_delete(collection: string, pretty?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Success>;
exportCollections(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CollectionReference[]>;
get(collection: string, pretty?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CollectionReference>;
getAll(pretty?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CollectionReference[]>;
importCollections(file?: any, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<string>;
put(collection: string, collection_params: CollectionReferenceParameters, pretty?: boolean, checkfields?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CollectionReference>;
};
/**
* CollectionsApi - factory interface
* @export
*/
export declare const CollectionsApiFactory: (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) => {
_delete(collection: string, pretty?: boolean, options?: any): Promise<Success>;
exportCollections(options?: any): Promise<CollectionReference[]>;
get(collection: string, pretty?: boolean, options?: any): Promise<CollectionReference>;
getAll(pretty?: boolean, options?: any): Promise<CollectionReference[]>;
importCollections(file?: any, options?: any): Promise<string>;
put(collection: string, collection_params: CollectionReferenceParameters, pretty?: boolean, checkfields?: boolean, options?: any): Promise<CollectionReference>;
};
/**
* CollectionsApi - object-oriented interface
* @export
* @class CollectionsApi
* @extends {BaseAPI}
*/
export declare class CollectionsApi extends BaseAPI {
/**
* Delete a collection reference in ARLAS
* @summary Delete a collection reference
* @param {string} collection collection
* @param {boolean} [pretty] Pretty print
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CollectionsApi
*/
_delete(collection: string, pretty?: boolean, options?: any): Promise<Success>;
/**
* Get all collection references in ARLAS as json file
* @summary Get all collection references as a json file
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CollectionsApi
*/
exportCollections(options?: any): Promise<CollectionReference[]>;
/**
* Get a collection reference in ARLAS
* @summary Get a collection reference
* @param {string} collection collection
* @param {boolean} [pretty] Pretty print
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CollectionsApi
*/
get(collection: string, pretty?: boolean, options?: any): Promise<CollectionReference>;
/**
* Get all collection references in ARLAS
* @summary Get all collection references
* @param {boolean} [pretty] Pretty print
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CollectionsApi
*/
getAll(pretty?: boolean, options?: any): Promise<CollectionReference[]>;
/**
* Add collection references in ARLAS from a json file
* @summary Add collection references from a json file
* @param {any} [file]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CollectionsApi
*/
importCollections(file?: any, options?: any): Promise<string>;
/**
* Add a collection reference in ARLAS
* @summary Add a collection reference
* @param {string} collection collection
* @param {CollectionReferenceParameters} collection_params collectionParams
* @param {boolean} [pretty] Pretty print
* @param {boolean} [checkfields]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CollectionsApi
*/
put(collection: string, collection_params: CollectionReferenceParameters, pretty?: boolean, checkfields?: boolean, options?: any): Promise<CollectionReference>;
}
/**
* ExploreApi - fetch parameter creator
* @export
*/
export declare const ExploreApiFetchParamCreator: (configuration?: Configuration) => {
aggregate(collection: string, agg: string[], f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, flat?: boolean, max_age_cache?: number, options?: any): FetchArgs;
aggregatePost(collection: string, body?: AggregationsRequest, pretty?: boolean, max_age_cache?: number, options?: any): FetchArgs;
compute(collection: string, field: string, metric: string, precision?: number, f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, max_age_cache?: number, options?: any): FetchArgs;
computePost(collection: string, body?: ComputationRequest, pretty?: boolean, max_age_cache?: number, options?: any): FetchArgs;
count(collection: string, f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, max_age_cache?: number, options?: any): FetchArgs;
countPost(collection: string, pretty?: boolean, body?: Count, options?: any): FetchArgs;
describe(collection: string, pretty?: boolean, max_age_cache?: number, options?: any): FetchArgs;
geoaggregate(collection: string, agg: string[], f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, flat?: boolean, max_age_cache?: number, options?: any): FetchArgs;
geoaggregatePost(collection: string, body?: AggregationsRequest, pretty?: boolean, max_age_cache?: number, options?: any): FetchArgs;
geohashgeoaggregate(collection: string, geohash: string, agg?: string[], f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, flat?: boolean, max_age_cache?: number, options?: any): FetchArgs;
geosearch(collection: string, f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, flat?: boolean, include?: string[], exclude?: string[], returned_geometries?: string, size?: number, from?: number, sort?: string[], after?: string, before?: string, max_age_cache?: number, options?: any): FetchArgs;
geosearchPost(collection: string, body?: Search, pretty?: boolean, max_age_cache?: number, options?: any): FetchArgs;
geotilegeoaggregate(collection: string, z: number, x: number, y: number, agg?: string[], f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, flat?: boolean, max_age_cache?: number, options?: any): FetchArgs;
getArlasHit(collection: string, identifier: string, pretty?: boolean, flat?: boolean, max_age_cache?: number, options?: any): FetchArgs;
list(pretty?: boolean, max_age_cache?: number, options?: any): FetchArgs;
search(collection: string, f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, flat?: boolean, include?: string[], exclude?: string[], returned_geometries?: string, size?: number, from?: number, sort?: string, after?: string, before?: string, max_age_cache?: number, options?: any): FetchArgs;
searchPost(collection: string, body?: Search, pretty?: boolean, max_age_cache?: number, options?: any): FetchArgs;
shapeaggregate(collection: string, agg: string[], f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, max_age_cache?: number, options?: any): FetchArgs;
shapeaggregatePost(collection: string, body?: AggregationsRequest, pretty?: boolean, max_age_cache?: number, options?: any): FetchArgs;
shapesearch(collection: string, f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, include?: string[], exclude?: string[], returned_geometries?: string, size?: number, from?: number, sort?: string[], after?: string, before?: string, max_age_cache?: number, options?: any): FetchArgs;
shapesearchPost(collection: string, body?: Search, pretty?: boolean, max_age_cache?: number, options?: any): FetchArgs;
suggest(collections: string, f?: string[], q?: string, pretty?: boolean, size?: number, from?: number, field?: string, max_age_cache?: number, options?: any): FetchArgs;
tiledgeosearch(collection: string, x: number, y: number, z: number, f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, flat?: boolean, include?: string[], exclude?: string[], returned_geometries?: string, size?: number, from?: number, sort?: string[], after?: string, before?: string, max_age_cache?: number, options?: any): FetchArgs;
tiledgeosearch1(collection: string, x: number, y: number, z: number, f?: string[], q?: string[], dateformat?: string, righthand?: boolean, size?: number, from?: number, sort?: string[], after?: string, before?: string, sampling?: number, coverage?: number, max_age_cache?: number, options?: any): FetchArgs;
};
/**
* ExploreApi - functional programming interface
* @export
*/
export declare const ExploreApiFp: (configuration?: Configuration) => {
aggregate(collection: string, agg: string[], f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, flat?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AggregationResponse>;
aggregatePost(collection: string, body?: AggregationsRequest, pretty?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AggregationResponse>;
compute(collection: string, field: string, metric: string, precision?: number, f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ComputationResponse>;
computePost(collection: string, body?: ComputationRequest, pretty?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ComputationResponse>;
count(collection: string, f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Hits>;
countPost(collection: string, pretty?: boolean, body?: Count, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Hits>;
describe(collection: string, pretty?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CollectionReferenceDescription>;
geoaggregate(collection: string, agg: string[], f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, flat?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<FeatureCollection>;
geoaggregatePost(collection: string, body?: AggregationsRequest, pretty?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<FeatureCollection>;
geohashgeoaggregate(collection: string, geohash: string, agg?: string[], f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, flat?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<FeatureCollection>;
geosearch(collection: string, f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, flat?: boolean, include?: string[], exclude?: string[], returned_geometries?: string, size?: number, from?: number, sort?: string[], after?: string, before?: string, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<FeatureCollection>;
geosearchPost(collection: string, body?: Search, pretty?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<FeatureCollection>;
geotilegeoaggregate(collection: string, z: number, x: number, y: number, agg?: string[], f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, flat?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<FeatureCollection>;
getArlasHit(collection: string, identifier: string, pretty?: boolean, flat?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Hit>;
list(pretty?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CollectionReferenceDescription[]>;
search(collection: string, f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, flat?: boolean, include?: string[], exclude?: string[], returned_geometries?: string, size?: number, from?: number, sort?: string, after?: string, before?: string, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Hits>;
searchPost(collection: string, body?: Search, pretty?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Hits>;
shapeaggregate(collection: string, agg: string[], f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
shapeaggregatePost(collection: string, body?: AggregationsRequest, pretty?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
shapesearch(collection: string, f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, include?: string[], exclude?: string[], returned_geometries?: string, size?: number, from?: number, sort?: string[], after?: string, before?: string, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
shapesearchPost(collection: string, body?: Search, pretty?: boolean, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
suggest(collections: string, f?: string[], q?: string, pretty?: boolean, size?: number, from?: number, field?: string, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
tiledgeosearch(collection: string, x: number, y: number, z: number, f?: string[], q?: string[], dateformat?: string, righthand?: boolean, pretty?: boolean, flat?: boolean, include?: string[], exclude?: string[], returned_geometries?: string, size?: number, from?: number, sort?: string[], after?: string, before?: string, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<FeatureCollection>;
tiledgeosearch1(collection: string, x: number, y: number, z: number, f?: string[], q?: string[], dateformat?: string, righthand?: boolean, size?: number, from?: number, sort?: string[], after?: string, before?: string, sampling?: number, coverage?: number, max_age_cache?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
};
/**
* ExploreApi - factory interface
* @export
*/
export declare const ExploreApiFactory: (configuration?: Configuration, fetch?: FetchAPI, basePath?: string)