@mapcreator/api 3.3.1 → 5.0.0-alpha.12

package/dist/resources/Domain.d.ts

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

package/dist/resources/Faq.d.ts

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

package/dist/resources/Feature.d.ts

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

package/dist/resources/Font.d.ts

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

package/dist/resources/FontFamily.d.ts

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

package/dist/resources/Highlight.d.ts

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

package/dist/resources/InsetMap.d.ts

@@ -1,10 +0,0 @@
-export default class InsetMap extends ResourceBase {
-    /**
-     * Get the inset map json
-     * @returns {CancelablePromise<Object>} - Inset map json
-     * @throws {ApiError} - If the api returns errors
-     */
-    getJson(): CancelablePromise<any>;
-}
-import ResourceBase from "./base/ResourceBase";
-//# sourceMappingURL=InsetMap.d.ts.map

package/dist/resources/Job.d.ts

@@ -1,56 +0,0 @@
-export default class Job extends CrudBase {
-    /**
-     * Get the list of associated job results
-     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
-     */
-    get results(): SimpleResourceProxy;
-    /**
-     * Get the list job revisions
-     * @returns {ResourceProxy} - A proxy for accessing the resource
-     */
-    get revisions(): ResourceProxy;
-    /**
-     * Get the most up to date preview url
-     * @returns {string} - Preview url
-     */
-    get previewUrl(): string;
-    /**
-     * Get the most up to date archive url
-     * @returns {string} - Last archive url
-     */
-    get lastArchiveUrl(): string;
-    /**
-     * Download the job preview
-     * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
-     * @returns {CancelablePromise<DownloadedResource>} - Job result preview
-     * @throws {ApiError} - If the api returns errors
-     */
-    downloadPreview(deleted?: string): CancelablePromise<DownloadedResource>;
-    /**
-     * Get archive blob url
-     * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
-     * @returns {CancelablePromise<DownloadedResource>} - Job result output
-     * @throws {ApiError} - If the api returns errors
-     */
-    downloadOutput(deleted?: string): CancelablePromise<DownloadedResource>;
-    /**
-     * Get the remote output url
-     * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
-     * @returns {CancelablePromise<string>} - The url to the output
-     * @throws {ApiError} - If the api returns errors
-     */
-    getOutputUrl(deleted?: string): CancelablePromise<string>;
-    /**
-     * Share the job
-     * @param {String} visibility - See {@link JobShareVisibility}, either `private`, `public` or `organisation`
-     * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
-     * @returns {CancelablePromise<JobShare>} - Object containing share links
-     * @throws {ApiError} - If the api returns errors
-     */
-    share(visibility?: string, deleted?: string): CancelablePromise<JobShare>;
-}
-import CrudBase from "./base/CrudBase";
-import ResourceProxy from "../proxy/ResourceProxy";
-import DownloadedResource from "./base/DownloadedResource";
-import JobShare from "./JobShare";
-//# sourceMappingURL=Job.d.ts.map

package/dist/resources/JobResult.d.ts

@@ -1,76 +0,0 @@
-export default class JobResult extends ResourceBase {
-    /**
-     * Get the related job
-     * @returns {CancelablePromise<Job>} - The job related to this row
-     * @throws {ApiError} - If the api returns errors
-     */
-    get job(): CancelablePromise<Job>;
-    /**
-     * Get the related job revision
-     * @returns {CancelablePromise<JobRevision>} - The job revision related to this row
-     * @throws {ApiError} - If the api returns errors
-     */
-    get jobRevision(): CancelablePromise<JobRevision>;
-    /**
-     * Job result archive url
-     * @returns {string} - Archive url
-     */
-    get outputUrl(): string;
-    /**
-     * Get archive blob url
-     * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
-     * @returns {CancelablePromise<DownloadedResource>} - Job result output
-     * @throws {ApiError} - If the api returns errors
-     */
-    downloadOutput(deleted?: string): CancelablePromise<DownloadedResource>;
-    /**
-     * Get the output url url
-     * @returns {string} - Output url url
-     */
-    get outputUrlUrl(): string;
-    /**
-     * Get the remote output url
-     * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
-     * @returns {CancelablePromise<string>} - The url to the output
-     * @throws {ApiError} - If the api returns errors
-     */
-    getOutputUrl(deleted?: string): CancelablePromise<string>;
-    /**
-     * Job result log url
-     * @returns {string} - log url
-     */
-    get logUrl(): string;
-    /**
-     * Download the job result log
-     * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
-     * @returns {CancelablePromise<DownloadedResource>} - job result log
-     * @throws {ApiError} - If the api returns errors
-     */
-    downloadLog(deleted?: string): CancelablePromise<DownloadedResource>;
-    /**
-     * Job result preview url, usable in an `<img>` tag
-     * @returns {string} - Preview url
-     */
-    get previewUrl(): string;
-    /**
-     * Download the job preview
-     * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
-     * @returns {CancelablePromise<DownloadedResource>} - Job result preview
-     * @throws {ApiError} - If the api returns errors
-     */
-    downloadPreview(deleted?: string): CancelablePromise<DownloadedResource>;
-    /**
-     * Mark a job as dealt with
-     * This method is for internal use for our support team.
-     *
-     * @param {boolean} [value=true] - What to set the dealt-with value to
-     * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
-     * @returns {CancelablePromise}
-     * @throws {ApiError} - If the api returns errors
-     */
-    dealWith(value?: boolean, deleted?: string): CancelablePromise;
-    dealtWith: boolean;
-}
-import ResourceBase from "./base/ResourceBase";
-import DownloadedResource from "./base/DownloadedResource";
-//# sourceMappingURL=JobResult.d.ts.map

package/dist/resources/JobRevision.d.ts

@@ -1,64 +0,0 @@
-export default class JobRevision extends CrudBase {
-    /**
-     * Get layers
-     * @returns {SimpleResourceProxy} - A proxy for accessing the resource
-     */
-    get layers(): SimpleResourceProxy;
-    /**
-     * Get the job result
-     * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
-     * @returns {CancelablePromise<JobResult>} - The associated job result
-     * @throws {ApiError} - If the api returns errors
-     */
-    result(deleted?: string): CancelablePromise<JobResult>;
-    /**
-     * Get a result proxy
-     *
-     * @returns {JobResult} - Empty job result used for
-     */
-    get resultProxy(): JobResult;
-    /**
-     * Save updated job revision
-     * @param {Object} object - Map object
-     * @param {Array<Layer>|Array<Number>|null} layers - Array containing all layers for this revision. If set to null the same layers will be used
-     * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
-     * @returns {CancelablePromise<JobRevision>} - New job revision
-     * @throws {TypeError}
-     * @throws {ApiError} - If the api returns errors
-     */
-    save(object?: any, layers?: Array<Layer> | Array<number> | null, deleted?: string): CancelablePromise<JobRevision>;
-    /**
-     * Get job object
-     * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
-     * @returns {CancelablePromise<Object>} - The map object
-     * @throws {ApiError} - If the api returns errors
-     */
-    object(deleted?: string): CancelablePromise<any>;
-    /**
-     * Build the revision
-     * @param {String} callback - Optional callback url for when the job completes
-     * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
-     * @throws {ApiError} - If the api returns errors
-     * @returns {CancelablePromise}
-     */
-    build(callback: string, deleted?: string): CancelablePromise;
-    /**
-     * Cancels a running job
-     * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
-     * @returns {CancelablePromise}
-     * @throws {ApiError} - If the api returns errors
-     */
-    cancel(deleted?: string): CancelablePromise;
-    /**
-     * Clones a job revision to the user requesting it
-     * @param {String} [title=null] - The new title for the job
-     * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
-     * @throws {ApiError} - If the api returns errors
-     * @returns {CancelablePromise<JobRevision>} - The new job revision, which will be linked to a new job
-     */
-    clone(title?: string, deleted?: string): CancelablePromise<JobRevision>;
-}
-import CrudBase from "./base/CrudBase";
-import JobResult from "./JobResult";
-import Layer from "./Layer";
-//# sourceMappingURL=JobRevision.d.ts.map

package/dist/resources/JobShare.d.ts

@@ -1,15 +0,0 @@
-export default class JobShare extends CrudBase {
-    /**
-     * Accessor for {@link JobShareVisibility} enum
-     * @returns {Enum<JobShareVisibility>} - Accessor for enum
-     */
-    static get visibility(): Enum<string>;
-    /**
-     * Unsupported method implemented due to CrudBase abstraction
-     * @throws {Error}
-     * @private
-     */
-    private save;
-}
-import CrudBase from "./base/CrudBase";
-//# sourceMappingURL=JobShare.d.ts.map

package/dist/resources/JobType.d.ts

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

package/dist/resources/Language.d.ts

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

package/dist/resources/Layer.d.ts

@@ -1,10 +0,0 @@
-/**
- * Layer
- * @extends CrudBase
- * @mixes OwnableResource
- * @mixes HandlesImages
- */
-export default class Layer extends CrudBase {
-}
-import CrudBase from "./base/CrudBase";
-//# sourceMappingURL=Layer.d.ts.map

package/dist/resources/LayerFaq.d.ts

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

package/dist/resources/LayerGroup.d.ts

@@ -1,14 +0,0 @@
-/**
- * LayerGroup
- * @extends CrudBase
- * @mixes OwnableResource
- * @mixes HandlesImages
- */
-export default class LayerGroup {
-    static get resourceName(): string;
-    get items(): OwnedResourceProxy;
-    get _Child(): typeof Layer;
-}
-import { OwnedResourceProxy } from "../proxy";
-import Layer from "./Layer";
-//# sourceMappingURL=LayerGroup.d.ts.map

package/dist/resources/Mapstyle.d.ts

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

package/dist/resources/MapstyleSet.d.ts

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

package/dist/resources/MapstyleSetColor.d.ts

@@ -1,8 +0,0 @@
-/**
- * Mapstyle set color
- * @extends CrudSetItemBase
- */
-export default class MapstyleSetColor extends CrudSetItemBase {
-}
-import CrudSetItemBase from "./base/CrudSetItemBase";
-//# sourceMappingURL=MapstyleSetColor.d.ts.map

package/dist/resources/Message.d.ts

@@ -1,7 +0,0 @@
-export default class Message extends CrudBase {
-    _guessType(name: any, value: any): any;
-    _buildCreateData(): {};
-    _update(): import("../utils/helpers").CancelablePromise;
-}
-import CrudBase from "./base/CrudBase";
-//# sourceMappingURL=Message.d.ts.map

package/dist/resources/MessageVariant.d.ts

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

package/dist/resources/Notification.d.ts

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

package/dist/resources/Organisation.d.ts

@@ -1,99 +0,0 @@
-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 notes(): ResourceProxy;
-    /**
-     * 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";
-import ResourceProxy from "../proxy/ResourceProxy";
-//# sourceMappingURL=Organisation.d.ts.map

package/dist/resources/OrganisationNote.d.ts

@@ -1,17 +0,0 @@
-/**
- * Font family
- * @extends CrudSetBase
- * @mixes OwnableResource
- *
- * @property {number} id
- * @property {number} organisationId
- * @property {number} userId
- * @property {string} content
- * @property {Date} createdAt
- * @property {Date} updatedAt
- */
-export default class OrganisationNote {
-    static get resourcePath(): string;
-    static get resourceName(): string;
-}
-//# sourceMappingURL=OrganisationNote.d.ts.map

package/dist/resources/Permission.d.ts

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

package/dist/resources/ProductTour.d.ts

@@ -1,10 +0,0 @@
-/**
- * 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

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

package/dist/resources/Role.d.ts

@@ -1,14 +0,0 @@
-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

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

package/dist/resources/SvgSet.d.ts

@@ -1,11 +0,0 @@
-/**
- * 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

@@ -1,9 +0,0 @@
-/**
- * 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

@@ -1,13 +0,0 @@
-/**
- * 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