@mapcreator/api 2.8.0 → 3.0.0

package/dist/resources/Organisation.d.ts

@@ -0,0 +1,97 @@
+export default class Organisation extends CrudBase {
+    /**
+     * Get a proxy for font families linked to the organisation
+     * @returns {OwnedResourceProxy} - A proxy for accessing the resource
+     */
+    get fontFamilies(): OwnedResourceProxy;
+    /**
+     * Get a proxy for dimension sets linked to the organisation
+     * @returns {OwnedResourceProxy} - A proxy for accessing the resource
+     */
+    get dimensionSets(): OwnedResourceProxy;
+    /**
+     * Get a proxy for mapstyle sets linked to the organisation
+     * @returns {OwnedResourceProxy} - A proxy for accessing the resource
+     */
+    get mapstyleSets(): OwnedResourceProxy;
+    /**
+     * Get a proxy for svg sets linked to the organisation
+     * @returns {OwnedResourceProxy} - A proxy for accessing the resource
+     */
+    get svgSets(): OwnedResourceProxy;
+    /**
+     * Get a proxy for colors linked to the organisation
+     * @returns {OwnedResourceProxy} - A proxy for accessing the resource
+     */
+    get colors(): OwnedResourceProxy;
+    /**
+     * Get a proxy for tags linked to the organisation
+     * @returns {OwnedResourceProxy} - A proxy for accessing the resource
+     */
+    get tags(): OwnedResourceProxy;
+    /**
+     * Get a proxy for features linked to the organisation
+     * @returns {OwnedResourceProxy} - A proxy for accessing the resource
+     */
+    get features(): OwnedResourceProxy;
+    /**
+     * Get a proxy for layers linked to the organisation
+     * @returns {OwnedResourceProxy} - A proxy for accessing the resource
+     */
+    get layers(): OwnedResourceProxy;
+    /**
+     * Get a proxy for layer groups linked to the organisation
+     * @returns {OwnedResourceProxy} - A proxy for accessing the resource
+     */
+    get layerGroups(): OwnedResourceProxy;
+    /**
+     * Get a proxy for jobs linked to the organisation, also known as company maps
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get jobs(): SimpleResourceProxy;
+    /**
+     * Get a proxy for job types linked to the organisation
+     * @returns {OwnedResourceProxy} - A proxy for accessing the resource
+     */
+    get jobTypes(): OwnedResourceProxy;
+    /**
+     * Get a proxy for job shares linked to the organisation
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get jobShares(): SimpleResourceProxy;
+    /**
+     * Get a proxy for users linked to the organisation
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get users(): SimpleResourceProxy;
+    /**
+     * Get a proxy for contracts linked to the organisation
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get contracts(): SimpleResourceProxy;
+    /**
+     * Get a proxy for contracts linked to the organisation
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get domains(): SimpleResourceProxy;
+    /**
+     * Get a tree representation of the organisation's relationships
+     * @returns {CancelablePromise<Array<Organisation>>} - List of organisation root nodes. Organisations contain an extra property called "children"
+     * @throws {ApiError} - If the api returns errors
+     * @example
+     * function printTree(nodes, prefix = '-') {
+     *  for (const node of nodes) {
+     *    console.log(`${prefix} ${node.name}`);
+     *
+     *    printTree(node.children, prefix + '-');
+     *  }
+     * }
+     *
+     * organisation.getTree().then(printTree)
+     */
+    getTree(deleted?: any): CancelablePromise<Organisation[]>;
+    _parseTree(rawNode: any): any;
+}
+import CrudBase from "./base/CrudBase";
+import OwnedResourceProxy from "../proxy/OwnedResourceProxy";
+//# sourceMappingURL=Organisation.d.ts.map

package/dist/resources/Permission.d.ts

@@ -0,0 +1,4 @@
+export default class Permission extends ResourceBase {
+}
+import ResourceBase from "./base/ResourceBase";
+//# sourceMappingURL=Permission.d.ts.map

package/dist/resources/ProductTour.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Mapstyle set
+ * @extends CrudSetBase
+ */
+export default class ProductTour extends CrudSetBase {
+    get _Child(): typeof ProductTourStep;
+}
+import CrudSetBase from "./base/CrudSetBase";
+import ProductTourStep from "./ProductTourStep";
+//# sourceMappingURL=ProductTour.d.ts.map

package/dist/resources/ProductTourStep.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @extends CrudSetItemBase
+ */
+export default class ProductTourStep extends CrudSetItemBase {
+}
+import CrudSetItemBase from "./base/CrudSetItemBase";
+//# sourceMappingURL=ProductTourStep.d.ts.map

package/dist/resources/Role.d.ts

@@ -0,0 +1,14 @@
+export default class Role extends CrudBase {
+    /**
+     * Get the list permissions linked to the role
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get permissions(): SimpleResourceProxy;
+    /**
+     * Get the list users linked to the role
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get users(): SimpleResourceProxy;
+}
+import CrudBase from "./base/CrudBase";
+//# sourceMappingURL=Role.d.ts.map

package/dist/resources/Svg.d.ts

@@ -0,0 +1,4 @@
+export default class Svg extends CrudSetItemBase {
+}
+import CrudSetItemBase from "./base/CrudSetItemBase";
+//# sourceMappingURL=Svg.d.ts.map

package/dist/resources/SvgSet.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Svg set
+ * @extends CrudSetBase
+ * @mixes OwnableResource
+ */
+export default class SvgSet extends CrudSetBase {
+    get _Child(): typeof Svg;
+}
+import CrudSetBase from "./base/CrudSetBase";
+import Svg from "./Svg";
+//# sourceMappingURL=SvgSet.d.ts.map

package/dist/resources/Tag.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Tag resource
+ * @extends CrudSetItemBase
+ * @mixes OwnableResource
+ */
+export default class Tag extends CrudSetItemBase {
+}
+import CrudSetItemBase from "./base/CrudSetItemBase";
+//# sourceMappingURL=Tag.d.ts.map

package/dist/resources/TagType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * TagType resource
+ * @mixes CrudSetBase
+ */
+export default class TagType extends CrudBase {
+    /**
+     * Get the list of tags that are attached to this type
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get tags(): SimpleResourceProxy;
+}
+import CrudBase from "./base/CrudBase";
+//# sourceMappingURL=TagType.d.ts.map

package/dist/resources/User.d.ts

@@ -0,0 +1,119 @@
+export default class User extends CrudBase {
+    /**
+     * Get all known ips
+     * @returns {CancelablePromise<string[]>} - List of ip addresses
+     * @throws {ApiError} - If the api returns errors
+     */
+    ips(): CancelablePromise<string[]>;
+    /**
+     * Get the user's organisation
+     * @returns {CancelablePromise<Organisation>} - User's organisation
+     * @throws {ApiError} - If the api returns errors
+     */
+    organisation(): CancelablePromise<Organisation>;
+    /**
+     * Get the user's language
+     * @returns {CancelablePromise<Language>} - User's language
+     * @throws {ApiError} - If the api returns errors
+     */
+    language(): CancelablePromise<Language>;
+    /**
+     * Get the list notifications linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get notifications(): SimpleResourceProxy;
+    /**
+     * Get a list of read/unread messages for the user
+     * @returns {CancelablePromise<{read: Message[], unread: Message[]}>} - Read and unread messages
+     */
+    messages(): CancelablePromise<{
+        read: Message[];
+        unread: Message[];
+    }>;
+    /**
+     * Get the list mapstyle sets linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get mapstyleSets(): SimpleResourceProxy;
+    /**
+     * Get the list mapstyles linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get mapstyles(): SimpleResourceProxy;
+    /**
+     * Get the list dimension sets linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get dimensionSets(): SimpleResourceProxy;
+    /**
+     * Get the list dimensions linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get dimensions(): SimpleResourceProxy;
+    /**
+     * Get the list font families linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get fontFamilies(): SimpleResourceProxy;
+    /**
+     * Get the list fonts linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get fonts(): SimpleResourceProxy;
+    /**
+     * Get the list svg sets linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get svgSets(): SimpleResourceProxy;
+    /**
+     * Get the list svgs linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get svgs(): SimpleResourceProxy;
+    /**
+     * Get the list colors linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get colors(): SimpleResourceProxy;
+    /**
+     * Get the list jobs linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get jobs(): SimpleResourceProxy;
+    /**
+     * Get the list features linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get features(): SimpleResourceProxy;
+    /**
+     * Get the list layers linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get layers(): SimpleResourceProxy;
+    /**
+     * Get the list job types linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get jobTypes(): SimpleResourceProxy;
+    /**
+     * Get the list job shares linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get jobShares(): SimpleResourceProxy;
+    /**
+     * Get the list permissions linked to the user
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get permissions(): SimpleResourceProxy;
+    /**
+     * Get the list roles linked to the user
+     * @returns {OwnedResourceProxy} - A proxy for accessing the resource
+     */
+    get roles(): OwnedResourceProxy;
+}
+import CrudBase from "./base/CrudBase";
+import Organisation from "./Organisation";
+import Language from "./Language";
+import Message from "./Message";
+import OwnedResourceProxy from "../proxy/OwnedResourceProxy";
+//# sourceMappingURL=User.d.ts.map

package/dist/resources/VectorChoropleth.d.ts

@@ -0,0 +1,4 @@
+export default class VectorChoropleth extends ResourceBase {
+}
+import ResourceBase from "./base/ResourceBase";
+//# sourceMappingURL=VectorChoropleth.d.ts.map

package/dist/resources/VectorHighlight.d.ts

@@ -0,0 +1,4 @@
+export default class VectorHighlight extends ResourceBase {
+}
+import ResourceBase from "./base/ResourceBase";
+//# sourceMappingURL=VectorHighlight.d.ts.map

package/dist/resources/base/CrudBase.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Base of all resource items that support Crud operations
+ * @abstract
+ */
+export default class CrudBase extends ResourceBase {
+    /**
+     * @param {Mapcreator} api - Api instance
+     * @param {Object<String, *>} data - Item data
+     */
+    constructor(api: Mapcreator, data?: any);
+    /**
+     * Build data for create operation
+     * @returns {Object<String, *>} - Create data
+     * @protected
+     */
+    protected _buildCreateData(): any;
+    /**
+     * Save item. This will create a new item if `id` is unset
+     * @returns {CancelablePromise<CrudBase>} - Current instance
+     * @throws {ApiError} - If the api returns errors
+     * @throws {ValidationError} - If the submitted data isn't valid
+     */
+    save(): CancelablePromise<CrudBase>;
+    /**
+     * Store new item
+     * @returns {CancelablePromise<CrudBase>} - Current instance
+     * @throws {ApiError} - If the api returns errors
+     * @throws {ValidationError} - If the submitted data isn't valid
+     * @private
+     */
+    private _create;
+    /**
+     * Update existing item
+     * @returns {CancelablePromise<CrudBase>} - Current instance
+     * @throws {ApiError} - If the api returns errors
+     * @throws {ValidationError} - If the submitted data isn't valid
+     * @protected
+     */
+    protected _update(): CancelablePromise<CrudBase>;
+    /**
+     * Delete item
+     * @param {Boolean} [updateSelf=true] - Update current instance (set the deletedAt property)
+     * @returns {CancelablePromise<CrudBase>} - Current instance
+     * @throws {ApiError} - If the api returns errors
+     * @throws {ValidationError} - If the submitted data isn't valid
+     */
+    delete(updateSelf?: boolean): CancelablePromise<CrudBase>;
+    /**
+     * Restore item
+     * @param {Boolean} [updateSelf=true] - Update current instance (unset the deletedAt property)
+     * @returns {CancelablePromise<CrudBase>} - New restored instance
+     * @throws {ApiError} - If the api returns errors
+     * @throws {ValidationError} - If the submitted data isn't valid
+     */
+    restore(updateSelf?: boolean): CancelablePromise<CrudBase>;
+    /**
+     * Prepare data to be sent to the api
+     * @param {Object} data
+     * @returns {Object} prepared
+     * @private
+     */
+    private _prepareData;
+}
+import ResourceBase from "./ResourceBase";
+//# sourceMappingURL=CrudBase.d.ts.map

package/dist/resources/base/CrudBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CrudBase.d.ts","sourceRoot":"","sources":["../../../src/resources/base/CrudBase.js"],"names":[],"mappings":"AAoCA;;;GAGG;AACH;IACE;;;OAGG;IACH,yCAMC;IAED;;;;OAIG;IACH,kCAgBC;IAED;;;;;OAKG;IACH,oCAEC;IAED;;;;;;OAMG;IACH,gBAaC;IAED;;;;;;OAMG;IACH,iDAwBC;IAED;;;;;;OAMG;IACH,0DAUC;IAED;;;;;;OAMG;IACH,2DAcC;IAED;;;;;OAKG;IACH,qBAYC;CACF"}

package/dist/resources/base/CrudSetBase.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Crud base for resource sets
+ * @abstract
+ */
+export default class CrudSetBase extends CrudBase {
+    /**
+     * Get the foreign key name
+     * @returns {string} - Foreign key name
+     * @example
+     * api.fontFamilies.select(1).constructor.foreignKeyName === 'fontFamilyId'
+     */
+    static get foreignKeyName(): string;
+    /**
+     * Get items associated with the set
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     */
+    get items(): SimpleResourceProxy;
+    /**
+     * Child constructor
+     * @returns {Class<ResourceBase>} - Child constructor
+     * @abstract
+     * @protected
+     */
+    protected get _Child(): Class<ResourceBase>;
+}
+import CrudBase from "./CrudBase";
+//# sourceMappingURL=CrudSetBase.d.ts.map

package/dist/resources/base/CrudSetBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CrudSetBase.d.ts","sourceRoot":"","sources":["../../../src/resources/base/CrudSetBase.js"],"names":[],"mappings":"AAoCA;;;GAGG;AACH;IAyBE;;;;;OAKG;IACH,oCAUC;IAvCD;;;OAGG;IACH,iCAOC;IAED;;;;;OAKG;IACH,4CAEC;CAmBF"}

package/dist/resources/base/CrudSetItemBase.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Items that are part of a set
+ * @abstract
+ */
+export default class CrudSetItemBase extends CrudBase {
+    /**
+     * Get the parent key
+     * @returns {string} - Parent key
+     */
+    static get parentKey(): string;
+    get hasParent(): boolean;
+    /**
+     * Get the parent id
+     * @returns {number|undefined} - Parent number
+     */
+    get parentId(): number;
+}
+import CrudBase from "./CrudBase";
+//# sourceMappingURL=CrudSetItemBase.d.ts.map

package/dist/resources/base/CrudSetItemBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CrudSetItemBase.d.ts","sourceRoot":"","sources":["../../../src/resources/base/CrudSetItemBase.js"],"names":[],"mappings":"AAoCA;;;GAGG;AACH;IAiCE;;;OAGG;IACH,+BAEC;IA1BD,yBAIC;IAED;;;OAGG;IACH,uBAQC;CASF"}

package/dist/resources/base/DownloadedResource.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Downloaded resource from the api
+ */
+export default class DownloadedResource {
+    /**
+     * Build instance from response
+     * @param {Response} response - Response
+     * @returns {DownloadedResource} - Instance
+     */
+    static fromResponse(response: Response): DownloadedResource;
+    /**
+     *
+     * @param {ArrayBuffer|Buffer} data - Data
+     * @param {string} [type=application/octet-stream] - Mime-type
+     * @param {string} [fileName=Untitled] - File name
+     */
+    constructor(data: ArrayBuffer | Buffer, type?: string, fileName?: string);
+    _data: ArrayBuffer | Buffer;
+    _type: string;
+    _fileName: string;
+    /**
+     * In Nodejs it will return a {@link Buffer} and in the browser it will respond with a {@link ArrayBuffer}
+     * @returns {ArrayBuffer|Buffer} - Resource data
+     */
+    get data(): ArrayBuffer | Buffer;
+    /**
+     * Resource mime-type
+     * @return {string} - Mime-type
+     */
+    get type(): string;
+    /**
+     * Resource file name, if available
+     * @return {string} - File name
+     */
+    get fileName(): string;
+    /**
+     * Get the size of the data
+     * @return {Number} - Size in bytes
+     */
+    get size(): number;
+    /**
+     * Create a object url
+     * The URL lifetime is tied to the document in the window on which it
+     * was created. The new object URL represents the resource.
+     * *Do not forget* to release the object urls once used.
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL#Memory_management
+     * @return {string} - Object url
+     */
+    createObjectUrl(): string;
+    /**
+     * Create a blob from the resource
+     * @returns {Blob}
+     */
+    createBlob(): Blob;
+    /**
+     * Get base64-encoded data uri
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs
+     * @returns {string} - Data uri
+     */
+    toDataUri(): string;
+    /**
+     * Base64 encode data
+     * @returns {string} - Base64 encoded data
+     */
+    toBase64(): string;
+    /**
+     * @inheritDoc
+     */
+    toString(): string;
+}
+//# sourceMappingURL=DownloadedResource.d.ts.map

package/dist/resources/base/DownloadedResource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DownloadedResource.d.ts","sourceRoot":"","sources":["../../../src/resources/base/DownloadedResource.js"],"names":[],"mappings":"AAmCA;;GAEG;AACH;IAaE;;;;OAIG;IACH,8BAHW,QAAQ,GACN,kBAAkB,CA4B9B;IA3CD;;;;;OAKG;IACH,kBAJW,WAAW,GAAC,MAAM,SAClB,MAAM,aACN,MAAM,EAMhB;IAHC,4BAAiB;IACjB,cAAiB;IACjB,kBAAyB;IAoC3B;;;OAGG;IACH,iCAEC;IAED;;;OAGG;IACH,mBAEC;IAED;;;OAGG;IACH,uBAEC;IAED;;;OAGG;IACH,mBAEC;IAED;;;;;;;;OAQG;IACH,mBAFY,MAAM,CAQjB;IAED;;;OAGG;IACH,cAFa,IAAI,CAIhB;IAED;;;;OAIG;IACH,aAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,YAFa,MAAM,CAIlB;IAED;;OAEG;IACH,mBAEC;CACF"}

package/dist/resources/base/ResourceBase.d.ts

@@ -0,0 +1,162 @@
+/**
+ * Resource base
+ * @abstract
+ */
+export default class ResourceBase {
+    /**
+     * Resource path template
+     * @returns {String} - Path template
+     */
+    static get resourcePath(): string;
+    /**
+     * Resource name
+     * @returns {String} - Resource name
+     * @abstract
+     */
+    static get resourceName(): string;
+    /**
+     * Returns the url key of the resource
+     * @returns {String} - Resource key
+     */
+    static get resourceUrlKey(): string;
+    /**
+     * Protected read-only fields
+     * @returns {Array<string>} - Array containing protected read-only fields
+     * @protected
+     */
+    protected static get protectedFields(): string[];
+    /**
+     * Returns if the resource is readonly
+     * @returns {boolean} - Readonly
+     */
+    static get readonly(): boolean;
+    /**
+     * @param {Mapcreator} api - Api instance
+     * @param {Object<String, *>} data - Item data
+     */
+    constructor(api: Mapcreator, data?: any);
+    /**
+     * Set the api instance
+     * @param {Mapcreator} value - Api instance
+     */
+    set api(arg: Mapcreator);
+    /**
+     * Get api instance
+     * @returns {Mapcreator} - Api instance
+     */
+    get api(): Mapcreator;
+    _baseProperties: any;
+    _properties: {};
+    _api: Mapcreator;
+    _knownFields: string[];
+    /**
+     * Moves new fields to this._properties and turns them into a getter/setter
+     * @protected
+     */
+    protected _updateProperties(): void;
+    /**
+     * Clean up instance and commit all changes locally.
+     * This means that any changed fields will be marked
+     * as unchanged whilst  keeping their new values. The
+     * changes will not be saved.
+     */
+    sanitize(): void;
+    /**
+     * Resets model instance to it's original state
+     * @param {Array<string>|string|null} [fields=null] - Fields to reset, defaults to all fields
+     */
+    reset(fields?: Array<string> | string | null): void;
+    /**
+     * Clone the object
+     * @returns {ResourceBase} - Exact clone of the object
+     */
+    clone(): ResourceBase;
+    /**
+     * Refresh the resource by requesting it from the server again
+     * @param {Boolean} updateSelf - Update the current instance
+     * @returns {CancelablePromise<ResourceBase>} - Refreshed instance
+     * @throws {ApiError} - If the api returns errors
+     */
+    refresh(updateSelf?: boolean): CancelablePromise<ResourceBase>;
+    /**
+     * Create proxy for property
+     * @param {string} key - property key
+     * @private
+     */
+    private _applyProperty;
+    /**
+     * Guess type based on property name
+     * @param {string} name - Field name
+     * @param {*} value - Field Value
+     * @protected
+     * @returns {*} - Original or converted value
+     */
+    protected _guessType(name: string, value: any): any;
+    /**
+     * If the resource can be owned by an organisation
+     * @returns {boolean} - Can be owned by an organisation
+     */
+    get ownable(): boolean;
+    /**
+     * Auto generated resource url
+     * @returns {string} - Resource url
+     */
+    get url(): string;
+    _url: string;
+    /**
+     * Auto generated Resource base url
+     * @returns {string} - Resource base url
+     */
+    get baseUrl(): string;
+    /**
+     * List fields that contain object data
+     * @returns {Array<String>} - A list of fields
+     */
+    get fieldNames(): string[];
+    /**
+     * String representation of the resource, similar to Python's __repr__
+     * @returns {string} - Resource name and id
+     */
+    toString(): string;
+    /**
+     * Transform instance to object
+     * @param {boolean} [camelCaseKeys=false] - camelCase object keys
+     * @returns {{}} - Object
+     */
+    toObject(camelCaseKeys?: boolean): {};
+    /**
+     * Macro for resource listing
+     * @param {string|Class<ResourceBase>} Target - Target object
+     * @param {?String} url - Target url, if null it will guess
+     * @param {object} seedData - Internal use, used for seeding SimpleResourceProxy::new
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     * @protected
+     */
+    protected _proxyResourceList(Target: string | Class<ResourceBase>, url?: string | null, seedData?: object): SimpleResourceProxy;
+    /**
+     * Static proxy generation
+     * @param {string|Class} Target - Constructor or url
+     * @param {Class?} Constructor - Constructor for a resource that the results should be cast to
+     * @param {Object<string, *>} seedData - Optional data to seed the resolved resources
+     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+     * @example
+     * user.static('jobs').lister();
+     *
+     * @example
+     * class FooBar extends ResourceBase {
+     *    static get resourceName() {
+     *      return 'custom';
+     *    }
+     * }
+     *
+     * api.static(FooBar)
+     *   .get(1)
+     *   .then(console.log);
+     */
+    static(Target: string | Class, Constructor?: Class, seedData?: {
+        [x: string]: any;
+    }): SimpleResourceProxy;
+}
+import Mapcreator from "../../Mapcreator";
+import SimpleResourceProxy from "../../proxy/SimpleResourceProxy";
+//# sourceMappingURL=ResourceBase.d.ts.map