geoserver-node-client 1.6.2 → 2.0.0

package/dist/types/src/layer.d.ts

@@ -0,0 +1,265 @@
+/**
+ * Client for GeoServer layers
+ *
+ * @module LayerClient
+ */
+export default class LayerClient {
+    /**
+     * Creates a GeoServer REST LayerClient instance.
+     *
+     * @param {String} url The URL of the GeoServer REST API endpoint
+     * @param {String} auth The Basic Authentication string
+     */
+    constructor(url: string, auth: string);
+    url: string;
+    auth: string;
+    /**
+     * Returns a GeoServer layer by the given workspace and layer name,
+     * e.g. "myWs:myLayer".
+     *
+     * @param {String} workspace The name of the workspace, can be undefined
+     * @param {String} layerName The name of the layer to query
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with layer information or undefined if it cannot be found
+     */
+    get(workspace: string, layerName: string): Object;
+    /**
+     * Sets the attribution text and link of a layer.
+     *
+     * @param {String} workspace The name of the workspace, can be undefined
+     * @param {String} layerName The name of the layer to query
+     * @param {String} [attributionText] The attribution text
+     * @param {String} [attributionLink] The attribution link
+     *
+     * @throws Error if request fails
+     */
+    modifyAttribution(workspace: string, layerName: string, attributionText?: string, attributionLink?: string): Promise<void>;
+    /**
+     * Returns all layers in the GeoServer.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with all layer information
+     */
+    getAll(): Object;
+    /**
+     * Get all layers of a workspace.
+     *
+     * @param {String} workspace The workspace
+     *
+     * @throws Error if request fails
+     *
+     * @return {Object} An object with the information about the layers
+     */
+    getLayers(workspace: string): Object;
+    /**
+     * Returns information about a cascaded WMS layer.
+     *
+     * @param {String} workspace The workspace
+     * @param {String} datastore The datastore
+     * @param {String} layerName The WMS layer name
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with layer information or undefined if it cannot be found
+     */
+    getWmsLayer(workspace: string, datastore: string, layerName: string): Object;
+    /**
+     * Returns information about a cascaded WMTS layer.
+     *
+     * @param {String} workspace The workspace
+     * @param {String} datastore The datastore
+     * @param {String} layerName The WMTS layer name
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with layer information or undefined if it cannot be found
+     */
+    getWmtsLayer(workspace: string, datastore: string, layerName: string): Object;
+    /**
+     * Publishes a FeatureType in the default data store of the workspace.
+     *
+     * @param {String} workspace Workspace to publish FeatureType in
+     * @param {String} nativeName Native name of FeatureType
+     * @param {String} [name] Published name of FeatureType, defaults to `nativeName`
+     * @param {String} [title] Published title of FeatureType, defaults to `name` or `nativeName`
+     * @param {String} [srs="EPSG:4326"] The SRS of the FeatureType
+     * @param {Boolean} [enabled=true] Flag to enable FeatureType by default
+     * @param {String} [abstract] The abstract of the layer
+     *
+     * @throws Error if request fails
+     */
+    publishFeatureTypeDefaultDataStore(workspace: string, nativeName: string, name?: string, title?: string, srs?: string, enabled?: boolean, abstract?: string): Promise<void>;
+    /**
+     * Publishes a FeatureType in the given data store of the workspace.
+     *
+     * @param {String} workspace Workspace to publish FeatureType in
+     * @param {String} dataStore The datastore where the FeatureType's data is in
+     * @param {String} nativeName Native name of FeatureType
+     * @param {String} [name] Published name of FeatureType, defaults to `nativeName`
+     * @param {String} [title] Published title of FeatureType, defaults to `name` or `nativeName`
+     * @param {String} [srs="EPSG:4326"] The SRS of the FeatureType
+     * @param {Boolean} [enabled=true] Flag to enable FeatureType by default
+     * @param {String} [abstract] The abstract of the layer
+     * @param {String} [nativeBoundingBox] The native BoundingBox of the FeatureType (has to be set if no data is in store at creation time)
+     *
+     * @throws Error if request fails
+     */
+    publishFeatureType(workspace: string, dataStore: string, nativeName: string, name?: string, title?: string, srs?: string, enabled?: boolean, abstract?: string, nativeBoundingBox?: string): Promise<void>;
+    /**
+     * Get detailed information about a FeatureType.
+     *
+     * @param {String} workspace The workspace of the FeatureType
+     * @param {String} datastore The datastore of the FeatureType
+     * @param {String} name The name of the FeatureType
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} The object of the FeatureType
+     */
+    getFeatureType(workspace: string, datastore: string, name: string): Object;
+    /**
+     * Get detailed information about a FeatureType.
+     *
+     * @param {String} workspace The workspace of the FeatureType
+     * @param {String} name The name of the FeatureType
+     *
+     * @throws GeoServerResponseError if request fails or layer does not exist or lacks the right properties.
+     *
+     * @returns {Object} The object of the FeatureType
+     */
+    getFeatureTypeFromLayer(workspace: string, layer: any): Object;
+    /**
+     *  Publishes a WMS layer.
+     *
+     * @param {String} workspace Workspace to publish WMS layer in
+     * @param {String} dataStore The datastore where the WMS is connected
+     * @param {String} nativeName Native name of WMS layer
+     * @param {String} [name] Published name of WMS layer, defaults to `nativeName`
+     * @param {String} [title] Published title of WMS layer, defaults to `name` or `nativeName`
+     * @param {String} [srs="EPSG:4326"] The SRS of the WMS layer
+     * @param {Boolean} [enabled=true] Flag to enable WMS layer by default
+     * @param {String} [abstract] The abstract of the layer
+     *
+     * @throws Error if request fails
+     */
+    publishWmsLayer(workspace: string, dataStore: string, nativeName: string, name?: string, title?: string, srs?: string, enabled?: boolean, abstract?: string): Promise<void>;
+    /**
+     * Publishes a raster stored in a database.
+     *
+     * @param {String} workspace Workspace to publish layer in
+     * @param {String} coverageStore The coveragestore where the layer's data is in
+     * @param {String} nativeName Native name of raster
+     * @param {String} [name] Published name of layer, defaults to `nativeName`
+     * @param {String} [title] Published title of layer, defaults to `name` or `nativeName`
+     * @param {String} [srs="EPSG:4326"] The SRS of the layer
+     * @param {Boolean} [enabled=true] Flag to enable layer by default
+     * @param {String} [abstract] The abstract of the layer
+     *
+     * @throws Error if request fails
+     */
+    publishDbRaster(workspace: string, coverageStore: string, nativeName: string, name?: string, title?: string, srs?: string, enabled?: boolean, abstract?: string): Promise<void>;
+    /**
+     * Deletes a FeatureType.
+     *
+     * @param {String} workspace Workspace where layer to delete is in
+     * @param {String} datastore The datastore where the layer to delete is in
+     * @param {String} name Layer to delete
+     * @param {Boolean} recurse Flag to enable recursive deletion
+     *
+     * @throws Error if request fails
+     */
+    deleteFeatureType(workspace: string, datastore: string, name: string, recurse: boolean): Promise<void>;
+    /**
+     * Enables TIME dimension for the given coverage layer.
+     *
+     * @param {String} workspace Workspace where layer to enable time dimension for is in
+     * @param {String} datastore The datastore where the layer to enable time dimension for is in
+     * @param {String} name Layer to enable time dimension for
+     * @param {String} presentation Presentation type: 'LIST' or 'DISCRETE_INTERVAL' or 'CONTINUOUS_INTERVAL'
+     * @param {Number} resolution Resolution in milliseconds, e.g. 3600000 for 1 hour
+     * @param {String} defaultValue The default time value, e.g. 'MINIMUM' or 'MAXIMUM' or 'NEAREST' or 'FIXED'
+     * @param {Boolean} [nearestMatchEnabled] Enable nearest match
+     * @param {Boolean} [rawNearestMatchEnabled] Enable raw nearest match
+     * @param {String} [acceptableInterval] Acceptable interval for nearest match, e.g.'PT30M'
+     *
+     * @throws Error if request fails
+     */
+    enableTimeCoverage(workspace: string, dataStore: any, name: string, presentation: string, resolution: number, defaultValue: string, nearestMatchEnabled?: boolean, rawNearestMatchEnabled?: boolean, acceptableInterval?: string): Promise<void>;
+    /**
+     * Enables TIME dimension for the given FeatureType layer.
+     *
+     * @param {String} workspace Workspace containing layer to enable time dimension for
+     * @param {String} datastore The datastore containing the FeatureType to enable time dimension for
+     * @param {String} name FeatureType to enable time dimension for
+     * @param {String} attribute Data column / attribute holding the time values
+     * @param {String} presentation Presentation type: 'LIST' or 'DISCRETE_INTERVAL' or 'CONTINUOUS_INTERVAL'
+     * @param {Number} resolution Resolution in milliseconds, e.g. 3600000 for 1 hour
+     * @param {String} defaultValue The default time value, e.g. 'MINIMUM' or 'MAXIMUM' or 'NEAREST' or 'FIXED'
+     * @param {Boolean} [nearestMatchEnabled] Enable nearest match
+     * @param {Boolean} [rawNearestMatchEnabled] Enable raw nearest match
+     *
+     * @throws Error if request fails
+     */
+    enableTimeFeatureType(workspace: string, dataStore: any, name: string, attribute: string, presentation: string, resolution: number, defaultValue: string, nearestMatchEnabled?: boolean, rawNearestMatchEnabled?: boolean, acceptableInterval: any): Promise<void>;
+    /**
+     * Returns a dedicated coverage object.
+     *
+     * @param {String} workspace Workspace containing the coverage
+     * @param {String} coverageStore The coveragestore containing the coverage
+     * @param {String} name Coverage to query
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with coverage information or undefined if it cannot be found
+     */
+    getCoverage(workspace: string, coverageStore: string, name: string): Object;
+    /**
+     * Returns a dedicated coverage object.
+     *
+     * @param {String} workspace Workspace containing the coverage
+     * @param {String} name Coverage to query
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with coverage information or undefined if it cannot be found
+     */
+    getCoverageFromLayer(workspace: string, name: string): Object;
+    /**
+     * Renames the existing bands of a coverage layer.
+     *
+     * Make sure to provide the same number of bands as existing in the layer.
+     *
+     * @param {String} workspace Workspace of layer
+     * @param {String} datastore The datastore of the layer
+     * @param {String} layername The layer name
+     * @param {String[]} bandNames An array of the new band names in correct order
+     *
+     * @throws Error if request fails
+     */
+    renameCoverageBands(workspace: string, dataStore: any, layername: string, bandNames: string[]): Promise<void>;
+    /**
+     * Returns the data store of a layer.
+     *
+     * @param {String} workspace The workspace of the layer
+     * @param {String} layer The name of the layer
+     *
+     * @throws GeoServerResponseError if request fails or layer does not exist or lacks a data store.
+     *
+     * @returns {Object} The data store object
+     */
+    getDataStore(workspace: string, layer: string): Object;
+    /**
+     * Returns the coverage store of a layer.
+     *
+     * @param {String} workspace The workspace of the layer
+     * @param {String} layer The name of the layer
+     *
+     * @throws GeoServerResponseError if request fails or layer does not exist or lacks a coverage store.
+     *
+     * @returns {Object} The coverage store object
+     */
+    getCoverageStore(workspace: string, layer: string): Object;
+}

package/dist/types/src/layergroup.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Client for GeoServer layergroups
+ *
+ * @module LayerGroupClient
+ */
+export default class LayerGroupClient {
+    /**
+     * Creates a GeoServer REST LayerGroupClient instance.
+     *
+     * @param {String} url The URL of the GeoServer REST API endpoint
+     * @param {String} auth The Basic Authentication string
+     */
+    constructor(url: string, auth: string);
+    url: string;
+    auth: string;
+    /**
+     * @typedef {object} bounds
+     * @property {number} minx The minimum x coordinates. Default: -180
+     * @property {number} miny The minimum y coordinates. Default: -90
+     * @property {number} maxx The maximum x coordinates. Default: 180
+     * @property {number} maxy The maximum y coordinates. Default: 90
+     * @property {String} crs The crs of the bounds. Default: 'EPSG:4326'
+     */
+    /**
+     * Create a GeoServer layergroup by the given workspace, layerGroupName, layers and options
+     * @param {String} workspace The name of the workspace
+     * @param {String} layerGroupName The name of the layer group
+     * @param {Array.<String>} layers List of layers to be added to the group. Must be in same workspace as layergroup
+     * @param {String} options.mode The mode of the layergroup. Default to SINGLE
+     * @param {String} options.layerGroupTitle The title of the layergroup.
+     * @param {bounds} options.bounds The bounds of the layer group.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {string} A string with layer group location or undefined if not found
+     */
+    create(workspace: string, layerGroupName: string, layers: Array<string>, layerGroupOptions: any): string;
+    /**
+     * Returns a GeoServer layergroup by the given workspace and layergroup name,
+     * e.g. "myWs:myLayergroup".
+     *
+     * @param {String} workspace The name of the workspace
+     * @param {String} layerGroupName The name of the layer group to query
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with layer group information or undefined if it cannot be found
+     */
+    get(workspace: string, layerGroupName: string): Object;
+    /**
+     * Updates an existing GeoServer layergroup
+     *
+     * @param {String} workspace The name of the workspace
+     * @param {String} layerName The name of the layergroup to update
+     * @param {Object} layerGroupDefinition The updated definiton of the layergroup
+     *
+     * @throws Error if request fails
+     */
+    update(workspace: string, layerGroupName: any, layerGroupDefinition: Object): Promise<void>;
+}

package/dist/types/src/namespace.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Client for GeoServer namespace
+ *
+ * @module NamespaceClient
+ */
+export default class NamespaceClient {
+    /**
+     * Creates a GeoServer REST NamespaceClient instance.
+     *
+     * @param {String} url The URL of the GeoServer REST API endpoint
+     * @param {String} auth The Basic Authentication string
+     */
+    constructor(url: string, auth: string);
+    url: string;
+    auth: string;
+    /**
+     * Returns all namespaces.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object describing the namespace
+     */
+    getAll(): Object;
+    /**
+     * Creates a new namespace.
+     *
+     * @param {String} prefix Prefix of the new namespace
+     * @param {String} uri Uri of the new namespace
+     *
+     * @throws Error if request fails
+     *
+     * @returns {String} The name of the created namespace
+     */
+    create(prefix: string, uri: string): string;
+    /**
+     * Returns a namespace.
+     *
+     * @param {String} name Name of the namespace
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object describing the namespace or undefined if it cannot be found
+     */
+    get(name: string): Object;
+    /**
+     * Deletes a namespace.
+     *
+     * @param {String} name Name of the namespace to delete
+     *
+     * @throws Error if request fails
+     */
+    delete(name: string): Promise<void>;
+}

package/dist/types/src/reset-reload.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Client for GeoServer "Reset/Reload" to clear internal caches and reload
+ * configuration from disk endpoint.
+ *
+ * @module ResetReloadClient
+ */
+export default class ResetReloadClient {
+    /**
+     * Creates a GeoServer REST ResetReloadClient instance.
+     *
+     * @param {String} url The URL of the GeoServer REST API endpoint
+     * @param {String} auth The Basic Authentication string
+     */
+    constructor(url: string, auth: string);
+    url: string;
+    auth: string;
+    /**
+     * Resets all store, raster, and schema caches. This operation is used to
+     * force GeoServer to drop all caches and store connections and reconnect to
+     * each of them the next time they are needed by a request.
+     * This is useful in case the stores themselves cache some information about
+     * the data structures they manage that may have changed in the meantime.
+     *
+     * @throws Error if request fails
+     */
+    reset(): Promise<void>;
+    /**
+     * Reloads the GeoServer catalog and configuration from disk. This operation
+     * is used in cases where an external tool has modified the on-disk
+     * configuration. This operation will also force GeoServer to drop any
+     * internal caches and reconnect to all data stores.
+     *
+     * @throws Error if request fails
+     */
+    reload(): Promise<void>;
+}

package/dist/types/src/security.d.ts

@@ -0,0 +1,110 @@
+/**
+ * Client for GeoServer security.
+ *
+ * @module SecurityClient
+ */
+export default class SecurityClient {
+    /**
+     * Creates a GeoServer REST SecurityClient instance.
+     *
+     * @param {String} url The URL of the GeoServer REST API endpoint
+     * @param {String} auth The Basic Authentication string
+     */
+    constructor(url: string, auth: string);
+    url: string;
+    auth: string;
+    /**
+     * Returns all users registered in GeoServer.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with all users
+     */
+    getAllUsers(): Object;
+    /**
+     * Creates a new user.
+     *
+     * @param {String} username The name of the user to be created
+     * @param {String} password The password of the user to be created
+     *
+     * @throws Error if request fails
+     */
+    createUser(username: string, password: string): Promise<void>;
+    /**
+     * Updates an existing user. User name is only taken for identification and
+     * cannot be changed with this API call.
+     *
+     * @param {String} username The name of the user to be created
+     * @param {String} password The password of the user to be created
+     * @param {Boolean} enabled Enable / disable the user
+     *
+     * @throws Error if request fails
+     */
+    updateUser(username: string, password: string, enabled: boolean): Promise<void>;
+    /**
+     * Deletes an existing user.
+     *
+     * @param {String} username The name of the user to be deleted
+     *
+     * @throws Error if request fails
+     */
+    deleteUser(username: string): Promise<void>;
+    /**
+     * Returns all roles registered in GeoServer.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with all roles like { "roles": ["ADMIN", "GROUP_ADMIN"] }
+     */
+    getAllRoles(): Object;
+    /**
+     * Creates a new role.
+     *
+     * @param {String} role The name of the role to be created
+     *
+     * @throws Error if request fails
+     */
+    createRole(role: string): Promise<void>;
+    /**
+     * Deletes an existing role.
+     *
+     * @param {String} role The name of the role to be deleted
+     *
+     * @throws Error if request fails
+     */
+    deleteRole(role: string): Promise<void>;
+    /**
+     * Associates the given role to the user.
+     *
+     * @param {String} username The name of the user to add the role to
+     * @param {String} role The role to associate
+     *
+     * @throws Error if request fails
+     */
+    associateUserRole(username: string, role: string): Promise<void>;
+    /**
+     * Returns all data access rules registered in GeoServer.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with all data access rules like { "*.*.r": ["ADMIN", "GROUP_ADMIN"] }
+     */
+    getAllAccessRules(): Object;
+    /**
+     * Creates a new data access rule.
+     *
+     * @param {String} rule The rule in the form '<MY_WS>.<MY_LAYER>.r'
+     * @param {String[]} roles The roles to allow access to rule
+     *
+     * @throws Error if request fails
+     */
+    createDataAccessRule(rule: string, roles: string[]): Promise<void>;
+    /**
+     * Deletes an existing data access rule.
+     *
+     * @param {String} rule The rule to be deleted, like '<MY_WS>.<MY_LAYER>.r'
+     *
+     * @throws Error if request fails
+     */
+    deleteDataAccessRule(rule: string): Promise<void>;
+}

package/dist/types/src/settings.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Client for GeoServer settings.
+ *
+ * @module SettingsClient
+ */
+export default class SettingsClient {
+    /**
+     * Creates a GeoServer REST SettingsClient instance.
+     *
+     * @param {String} url The URL of the GeoServer REST API endpoint
+     * @param {String} auth The Basic Authentication string
+     */
+    constructor(url: string, auth: string);
+    url: string;
+    auth: string;
+    /**
+     * Get the complete GeoServer settings object.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} Settings object
+     */
+    getSettings(): Object;
+    /**
+     * Update the global GeoServer settings.
+     *
+     * @param {Object} settings The adapted GeoServer settings object
+     */
+    updateSettings(settings: Object): Promise<void>;
+    /**
+     * Update the global proxyBaseUrl setting.
+     *
+     * @param {String} proxyBaseUrl The proxy base URL
+     */
+    updateProxyBaseUrl(proxyBaseUrl: string): Promise<false | undefined>;
+    /**
+     * Get the contact information of the GeoServer.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with contact information
+     */
+    getContactInformation(): Object;
+    /**
+     * Update the contact information.
+     *
+     * Deleting is not supported.
+     *
+     * @param {String} [address] The contact's address
+     * @param {String} [city] The contact's city
+     * @param {String} [country] The contact's country
+     * @param {String} [postalCode] The contact's postCode
+     * @param {String} [state] The contact's state
+     * @param {String} [email] The contact's email
+     * @param {String} [organization] The contact's organization
+     * @param {String} [contactPerson] The contact person
+     * @param {String} [phoneNumber] The contact's phone number
+     *
+     * @throws Error if request fails
+     */
+    updateContactInformation(address?: string, city?: string, country?: string, postalCode?: string, state?: string, email?: string, organization?: string, contactPerson?: string, phoneNumber?: string): Promise<void>;
+}

package/dist/types/src/style.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Client for GeoServer styles
+ *
+ * @module StyleClient
+ */
+export default class StyleClient {
+    /**
+     * Creates a GeoServer REST StyleClient instance.
+     *
+     * @param {String} url The URL of the GeoServer REST API endpoint
+     * @param {String} auth The Basic Authentication string
+     */
+    constructor(url: string, auth: string);
+    url: string;
+    auth: string;
+    /**
+     * Returns all default styles.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with the default styles
+     */
+    getDefaults(): Object;
+    /**
+     * Returns all styles in a workspace.
+     *
+     * @param {String} workspace Workspace name to get styles for
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with all styles
+     */
+    getInWorkspace(workspace: string): Object;
+    /**
+     * Returns all styles defined in workspaces.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object[]} An array with all style objects
+     */
+    getAllWorkspaceStyles(): Object[];
+    /**
+     * Returns all styles as combined object (default ones and those in
+     * workspaces).
+     *
+     * @returns {Object[]} An array with all style objects
+     */
+    getAll(): Object[];
+    /**
+     * Publishes a new SLD style.
+     *
+     * @param {String} workspace The workspace to publish the style in
+     * @param {String} name Name of the style
+     * @param {String} sldBody SLD style (as XML text)
+     *
+     * @throws Error if request fails
+     */
+    publish(workspace: string, name: string, sldBody: string): Promise<void>;
+    /**
+     * Deletes a style.
+     *
+     * @param {String} workspace The name of the workspace, can be undefined if style is not assigned to a workspace
+     * @param {String} name The name of the style to delete
+     * @param {Boolean} [recurse=false] If references to the specified style in existing layers should be deleted
+     * @param {Boolean} [purge=false] Whether the underlying file containing the style should be deleted on disk
+     */
+    delete(workspace: string, name: string, recurse?: boolean, purge?: boolean): Promise<void>;
+    /**
+     * Assigns a style to a layer.
+     *
+     * @param {String} workspaceOfLayer The name of the layer's workspace, can be undefined
+     * @param {String} layerName The name of the layer to query
+     * @param {String} workspaceOfStyle The workspace of the style, can be undefined
+     * @param {String} styleName The name of the style
+     * @param {Boolean} [isDefaultStyle=true] If the style should be the default style of the layer
+     *
+     * @throws Error if request fails
+     */
+    assignStyleToLayer(workspaceOfLayer: string, layerName: string, workspaceOfStyle: string, styleName: string, isDefaultStyle?: boolean): Promise<void>;
+    /**
+     * Get information about a style.
+     *
+     * @param {String} workspace The name of the workspace, can be undefined
+     * @param {String} styleName The name of the style
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object about the style or undefined if it cannot be found
+     */
+    getStyleInformation(workspace: string, styleName: string): Object;
+}