@mapcreator/api 2.8.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/ImageHandler.d.ts +56 -0
- package/dist/Mapcreator.d.ts +338 -0
- package/dist/PaginatedResourceListing.d.ts +156 -0
- package/dist/RequestParameters.d.ts +241 -0
- package/dist/ResourceLister.d.ts +155 -0
- package/dist/bundle.browser.js +1264 -1253
- package/dist/bundle.browser.min.js +1 -1
- package/dist/bundle.browser.min.js.LICENSE.txt +2 -2
- package/dist/bundle.js +1263 -1252
- package/dist/bundle.min.js +1 -1
- package/dist/bundle.min.js.LICENSE.txt +1 -1
- package/dist/enums/DeletedState.d.ts +16 -0
- package/dist/enums/Enum.d.ts +40 -0
- package/dist/enums/JobShareVisibility.d.ts +15 -0
- package/dist/enums/ResultStatus.d.ts +17 -0
- package/dist/enums/index.d.ts +5 -0
- package/dist/errors/AbstractError.d.ts +26 -0
- package/dist/errors/ApiError.d.ts +65 -0
- package/dist/errors/GeoError.d.ts +6 -0
- package/dist/errors/NodeError.d.ts +6 -0
- package/dist/errors/OAuthError.d.ts +17 -0
- package/dist/errors/StaticClassError.d.ts +7 -0
- package/dist/errors/ValidationError.d.ts +125 -0
- package/dist/errors/index.d.ts +8 -0
- package/dist/index.d.ts +27 -0
- package/dist/oauth/DummyFlow.d.ts +19 -0
- package/dist/oauth/ImplicitFlow.d.ts +68 -0
- package/dist/oauth/ImplicitFlowPopup.d.ts +25 -0
- package/dist/oauth/OAuth.d.ts +50 -0
- package/dist/oauth/OAuthToken.d.ts +67 -0
- package/dist/oauth/PasswordFlow.d.ts +56 -0
- package/dist/oauth/StateContainer.d.ts +36 -0
- package/dist/proxy/GeoResourceProxy.d.ts +69 -0
- package/dist/proxy/OrganisationProxy.d.ts +62 -0
- package/dist/proxy/OwnedResourceProxy.d.ts +60 -0
- package/dist/proxy/ResourceProxy.d.ts +32 -0
- package/dist/proxy/SimpleResourceProxy.d.ts +76 -0
- package/dist/proxy/index.d.ts +6 -0
- package/dist/resources/Choropleth.d.ts +20 -0
- package/dist/resources/Color.d.ts +9 -0
- package/dist/resources/Contract.d.ts +7 -0
- package/dist/resources/Dimension.d.ts +7 -0
- package/dist/resources/DimensionSet.d.ts +11 -0
- package/dist/resources/Domain.d.ts +7 -0
- package/dist/resources/Faq.d.ts +7 -0
- package/dist/resources/Feature.d.ts +9 -0
- package/dist/resources/Font.d.ts +4 -0
- package/dist/resources/FontFamily.d.ts +11 -0
- package/dist/resources/Highlight.d.ts +4 -0
- package/dist/resources/InsetMap.d.ts +10 -0
- package/dist/resources/Job.d.ts +56 -0
- package/dist/resources/JobResult.d.ts +76 -0
- package/dist/resources/JobRevision.d.ts +64 -0
- package/dist/resources/JobShare.d.ts +15 -0
- package/dist/resources/JobType.d.ts +9 -0
- package/dist/resources/Language.d.ts +4 -0
- package/dist/resources/Layer.d.ts +10 -0
- package/dist/resources/LayerFaq.d.ts +8 -0
- package/dist/resources/LayerGroup.d.ts +14 -0
- package/dist/resources/Mapstyle.d.ts +8 -0
- package/dist/resources/MapstyleSet.d.ts +13 -0
- package/dist/resources/MapstyleSetColor.d.ts +8 -0
- package/dist/resources/Message.d.ts +7 -0
- package/dist/resources/MessageVariant.d.ts +4 -0
- package/dist/resources/Notification.d.ts +4 -0
- package/dist/resources/Organisation.d.ts +97 -0
- package/dist/resources/Permission.d.ts +4 -0
- package/dist/resources/ProductTour.d.ts +10 -0
- package/dist/resources/ProductTourStep.d.ts +7 -0
- package/dist/resources/Role.d.ts +14 -0
- package/dist/resources/Svg.d.ts +4 -0
- package/dist/resources/SvgSet.d.ts +11 -0
- package/dist/resources/Tag.d.ts +9 -0
- package/dist/resources/TagType.d.ts +13 -0
- package/dist/resources/User.d.ts +119 -0
- package/dist/resources/VectorChoropleth.d.ts +4 -0
- package/dist/resources/VectorHighlight.d.ts +4 -0
- package/dist/resources/base/CrudBase.d.ts +65 -0
- package/dist/resources/base/CrudBase.d.ts.map +1 -0
- package/dist/resources/base/CrudSetBase.d.ts +27 -0
- package/dist/resources/base/CrudSetBase.d.ts.map +1 -0
- package/dist/resources/base/CrudSetItemBase.d.ts +19 -0
- package/dist/resources/base/CrudSetItemBase.d.ts.map +1 -0
- package/dist/resources/base/DownloadedResource.d.ts +72 -0
- package/dist/resources/base/DownloadedResource.d.ts.map +1 -0
- package/dist/resources/base/ResourceBase.d.ts +162 -0
- package/dist/resources/base/ResourceBase.d.ts.map +1 -0
- package/dist/resources/index.d.ts +45 -0
- package/dist/storage/CookiesDriver.d.ts +37 -0
- package/dist/storage/DataStoreContract.d.ts +46 -0
- package/dist/storage/DummyDriver.d.ts +15 -0
- package/dist/storage/FileDriver.d.ts +54 -0
- package/dist/storage/LocalStorageDriver.d.ts +13 -0
- package/dist/storage/StorageManager.d.ts +46 -0
- package/dist/traits/HandlesImages.d.ts +15 -0
- package/dist/traits/Injectable.d.ts +60 -0
- package/dist/traits/OwnableResource.d.ts +18 -0
- package/dist/traits/Trait.d.ts +12 -0
- package/dist/utils/Logger.d.ts +55 -0
- package/dist/utils/Singleton.d.ts +9 -0
- package/dist/utils/StaticClass.d.ts +7 -0
- package/dist/utils/Unobservable.d.ts +13 -0
- package/dist/utils/base64.d.ts +12 -0
- package/dist/utils/geo.d.ts +74 -0
- package/dist/utils/hash.d.ts +15 -0
- package/dist/utils/helpers.d.ts +47 -0
- package/dist/utils/node.d.ts +15 -0
- package/dist/utils/reflection.d.ts +43 -0
- package/dist/utils/requests.d.ts +24 -0
- package/dist/utils/uuid.d.ts +19 -0
- package/package.json +4 -1
- package/src/Mapcreator.js +53 -33
- package/src/enums/index.js +1 -1
- package/src/errors/index.js +6 -6
- package/src/index.js +14 -14
- package/src/proxy/index.js +5 -5
- package/src/resources/LayerFaq.js +47 -0
- package/src/resources/LayerGroup.js +1 -1
- package/src/resources/index.js +36 -35
- package/dist/bundle.browser.js.map +0 -1
- package/dist/bundle.browser.min.js.map +0 -1
- package/dist/bundle.js.map +0 -1
- package/dist/bundle.min.js.map +0 -1
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Used for proxying resource => organisation
|
|
3
|
+
*/
|
|
4
|
+
export default class OwnedResourceProxy extends SimpleResourceProxy {
|
|
5
|
+
static _getKeyValue(item: any): any;
|
|
6
|
+
/**
|
|
7
|
+
* OwnedResourceProxy Constructor
|
|
8
|
+
* @param {Mapcreator} api - Api instance
|
|
9
|
+
* @param {ResourceBase} parent - Parent instance
|
|
10
|
+
* @param {Class<ResourceBase>} Target - Target constructor
|
|
11
|
+
*/
|
|
12
|
+
constructor(api: Mapcreator, parent: ResourceBase, Target: Class<ResourceBase>);
|
|
13
|
+
/**
|
|
14
|
+
* Sync items to the organisation
|
|
15
|
+
* @param {Array<ResourceBase>|Array<number>|ResourceBase|number} items - List of items to sync
|
|
16
|
+
* @throws {TypeError}
|
|
17
|
+
* @throws {ApiError} - If the api returns errors
|
|
18
|
+
* @returns {CancelablePromise}
|
|
19
|
+
*/
|
|
20
|
+
sync(items: Array<ResourceBase> | Array<number> | ResourceBase | number): CancelablePromise;
|
|
21
|
+
/**
|
|
22
|
+
* Attach items to the organisation
|
|
23
|
+
* @param {Array<ResourceBase>|Array<number>|ResourceBase|number} items - List of items to attach
|
|
24
|
+
* @throws {TypeError}
|
|
25
|
+
* @throws {ApiError} - If the api returns errors
|
|
26
|
+
* @returns {CancelablePromise}
|
|
27
|
+
*/
|
|
28
|
+
attach(items: Array<ResourceBase> | Array<number> | ResourceBase | number): CancelablePromise;
|
|
29
|
+
/**
|
|
30
|
+
* Detach items from the organisation
|
|
31
|
+
* @param {Array<ResourceBase>|Array<number>|ResourceBase|number} items - List of items to unlink
|
|
32
|
+
* @throws {TypeError}
|
|
33
|
+
* @throws {ApiError} - If the api returns errors
|
|
34
|
+
* @returns {CancelablePromise}
|
|
35
|
+
*/
|
|
36
|
+
detach(items: Array<ResourceBase> | Array<number> | ResourceBase | number): CancelablePromise;
|
|
37
|
+
/**
|
|
38
|
+
* Attach parent resource to all organisations
|
|
39
|
+
* @throws {ApiError} - If the api returns errors
|
|
40
|
+
* @returns {CancelablePromise}
|
|
41
|
+
*/
|
|
42
|
+
attachAll(): CancelablePromise;
|
|
43
|
+
/**
|
|
44
|
+
* Detach parent resource to all organisations
|
|
45
|
+
* @throws {ApiError} - If the api returns errors
|
|
46
|
+
* @returns {CancelablePromise}
|
|
47
|
+
*/
|
|
48
|
+
detachAll(): CancelablePromise;
|
|
49
|
+
/**
|
|
50
|
+
* @param {Array<ResourceBase>|Array<number>|ResourceBase|number} items - List of items to sync, attach or detach
|
|
51
|
+
* @param {string} method - http method
|
|
52
|
+
* @throws {ApiError} - If the api returns errors
|
|
53
|
+
* @throws {TypeError}
|
|
54
|
+
* @returns {CancelablePromise}
|
|
55
|
+
* @private
|
|
56
|
+
*/
|
|
57
|
+
private _modifyResourceLink;
|
|
58
|
+
}
|
|
59
|
+
import SimpleResourceProxy from "./SimpleResourceProxy";
|
|
60
|
+
//# sourceMappingURL=OwnedResourceProxy.d.ts.map
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Proxy for accessing resource. This will make sure that they
|
|
3
|
+
* are properly wrapped before the promise resolves.
|
|
4
|
+
* @protected
|
|
5
|
+
*/
|
|
6
|
+
export default class ResourceProxy extends SimpleResourceProxy {
|
|
7
|
+
/**
|
|
8
|
+
* Parse selector
|
|
9
|
+
* @param {Number|String|Object} [id=] - The resource id to be requested
|
|
10
|
+
* @returns {Object} - Parsed selector
|
|
11
|
+
* @private
|
|
12
|
+
*/
|
|
13
|
+
private _parseSelector;
|
|
14
|
+
/**
|
|
15
|
+
* Get target resource
|
|
16
|
+
* @param {Number|String|Object} [id=] - The resource id to be requested
|
|
17
|
+
* @param {String} [deleted=null] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
18
|
+
* @returns {CancelablePromise<ResourceBase>} - Target resource
|
|
19
|
+
* @throws {ApiError} - If the api returns errors
|
|
20
|
+
*/
|
|
21
|
+
get(id?: number | string | any, deleted?: string): CancelablePromise<ResourceBase>;
|
|
22
|
+
/**
|
|
23
|
+
* Select target resource without obtaining data
|
|
24
|
+
* @param {Number|String} [id=] - Resource id
|
|
25
|
+
* @returns {ResourceBase} - Empty target resource
|
|
26
|
+
* @example
|
|
27
|
+
* api.users.select('me').colors().then(doSomethingCool);
|
|
28
|
+
*/
|
|
29
|
+
select(id?: number | string): ResourceBase;
|
|
30
|
+
}
|
|
31
|
+
import SimpleResourceProxy from "./SimpleResourceProxy";
|
|
32
|
+
//# sourceMappingURL=ResourceProxy.d.ts.map
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Proxy for accessing resource. This will make sure that they
|
|
3
|
+
* are properly wrapped before the promise resolves.
|
|
4
|
+
* @protected
|
|
5
|
+
*/
|
|
6
|
+
export default class SimpleResourceProxy {
|
|
7
|
+
/**
|
|
8
|
+
* @param {Mapcreator} api - Instance of the api
|
|
9
|
+
* @param {Class<ResourceBase>} Target - Target to wrap
|
|
10
|
+
* @param {?string} [altUrl=null] - Internal use, Optional alternative url for more complex routing
|
|
11
|
+
* @param {object} seedData - Internal use, used for seeding ::new
|
|
12
|
+
*/
|
|
13
|
+
constructor(api: Mapcreator, Target: Class<ResourceBase>, altUrl?: string | null, seedData?: object);
|
|
14
|
+
__baseUrl: string;
|
|
15
|
+
_api: Mapcreator;
|
|
16
|
+
_Target: Class<ResourceBase>;
|
|
17
|
+
_seedData: any;
|
|
18
|
+
/**
|
|
19
|
+
* Proxy target url
|
|
20
|
+
* @returns {string} url
|
|
21
|
+
* @example
|
|
22
|
+
* api.layers.select(100).organisations.baseUrl === "https://maponline-api.dev/v1/layers/100/organisations"
|
|
23
|
+
*/
|
|
24
|
+
get baseUrl(): string;
|
|
25
|
+
/**
|
|
26
|
+
* Get api instance
|
|
27
|
+
* @returns {Mapcreator} - Api instance
|
|
28
|
+
*/
|
|
29
|
+
get api(): Mapcreator;
|
|
30
|
+
/**
|
|
31
|
+
* Target to wrap results in
|
|
32
|
+
* @returns {Class<ResourceBase>} - Target constructor
|
|
33
|
+
*/
|
|
34
|
+
get Target(): Class<ResourceBase>;
|
|
35
|
+
/**
|
|
36
|
+
* Build a new instance of the target
|
|
37
|
+
* @param {Object<String, *>} data - Data for the object to be populated with
|
|
38
|
+
* @returns {ResourceBase} - Resource with target data
|
|
39
|
+
*/
|
|
40
|
+
new(data?: any): ResourceBase;
|
|
41
|
+
/**
|
|
42
|
+
* List target resource
|
|
43
|
+
* @param {Number|Object|RequestParameters} [params] - Parameters or the page number to be requested
|
|
44
|
+
* @param {Number} [params.page=1] - The page to be requested
|
|
45
|
+
* @param {Number} [params.perPage=RequestParameters.perPage] - Amount of items per page. This is silently capped by the API
|
|
46
|
+
* @param {String|String[]} [params.sort=''] - Amount of items per page. This is silently capped by the API
|
|
47
|
+
* @param {String} [params.deleted=RequestParameters.deleted] - Show deleted resources, posible values: only, none, all
|
|
48
|
+
* @param {?Object<String, String|Array<String>>} [params.search] - Search parameters
|
|
49
|
+
* @returns {CancelablePromise<PaginatedResourceListing>} - paginated resource
|
|
50
|
+
* @throws {ApiError} - If the api returns errors
|
|
51
|
+
* @example
|
|
52
|
+
* // Find layers with a name that starts with "test" and a scale_min between 1 and 10
|
|
53
|
+
* // See Api documentation for search query syntax
|
|
54
|
+
* const search = {
|
|
55
|
+
* name: '^:test',
|
|
56
|
+
* scale_min: ['>:1', '<:10'],
|
|
57
|
+
* };
|
|
58
|
+
*
|
|
59
|
+
* api.layers.list({perPage: 10, search});
|
|
60
|
+
*/
|
|
61
|
+
list(params?: number | any | RequestParameters): CancelablePromise<PaginatedResourceListing>;
|
|
62
|
+
/**
|
|
63
|
+
* Get the resource lister
|
|
64
|
+
*
|
|
65
|
+
* @param {object|RequestParameters} parameters - parameters
|
|
66
|
+
* @param {number} maxRows - Maximum amount of rows
|
|
67
|
+
* @returns {ResourceLister} - Resource lister
|
|
68
|
+
*/
|
|
69
|
+
lister(parameters?: object | RequestParameters, maxRows?: number): ResourceLister;
|
|
70
|
+
_buildResolver(params?: {}): any;
|
|
71
|
+
}
|
|
72
|
+
import ResourceBase from "../resources/base/ResourceBase";
|
|
73
|
+
import RequestParameters from "../RequestParameters";
|
|
74
|
+
import PaginatedResourceListing from "../PaginatedResourceListing";
|
|
75
|
+
import ResourceLister from "../ResourceLister";
|
|
76
|
+
//# sourceMappingURL=SimpleResourceProxy.d.ts.map
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export { default as GeoResourceProxy } from "./GeoResourceProxy";
|
|
2
|
+
export { default as OrganisationProxy } from "./OrganisationProxy";
|
|
3
|
+
export { default as OwnedResourceProxy } from "./OwnedResourceProxy";
|
|
4
|
+
export { default as ResourceProxy } from "./ResourceProxy";
|
|
5
|
+
export { default as SimpleResourceProxy } from "./SimpleResourceProxy";
|
|
6
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Choropleth resource
|
|
3
|
+
*/
|
|
4
|
+
export default class Choropleth extends ResourceBase {
|
|
5
|
+
/**
|
|
6
|
+
* Get the inset map json
|
|
7
|
+
* @returns {CancelablePromise<Object>} - Choropleth json
|
|
8
|
+
* @throws {ApiError} - If the api returns errors
|
|
9
|
+
*/
|
|
10
|
+
getJson(): CancelablePromise<any>;
|
|
11
|
+
/**
|
|
12
|
+
* Download the choropleth preview
|
|
13
|
+
* @returns {CancelablePromise<DownloadedResource>} - Choropleth preview
|
|
14
|
+
* @throws {ApiError} - If the api returns errors
|
|
15
|
+
*/
|
|
16
|
+
downloadPreview(): CancelablePromise<DownloadedResource>;
|
|
17
|
+
}
|
|
18
|
+
import ResourceBase from "./base/ResourceBase";
|
|
19
|
+
import DownloadedResource from "./base/DownloadedResource";
|
|
20
|
+
//# sourceMappingURL=Choropleth.d.ts.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Dimension sets
|
|
3
|
+
* @extends CrudSetBase
|
|
4
|
+
* @mixes OwnableResource
|
|
5
|
+
*/
|
|
6
|
+
export default class DimensionSet extends CrudSetBase {
|
|
7
|
+
get _Child(): typeof Dimension;
|
|
8
|
+
}
|
|
9
|
+
import CrudSetBase from "./base/CrudSetBase";
|
|
10
|
+
import Dimension from "./Dimension";
|
|
11
|
+
//# sourceMappingURL=DimensionSet.d.ts.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Font family
|
|
3
|
+
* @extends CrudSetBase
|
|
4
|
+
* @mixes OwnableResource
|
|
5
|
+
*/
|
|
6
|
+
export default class FontFamily extends CrudSetBase {
|
|
7
|
+
get _Child(): typeof Font;
|
|
8
|
+
}
|
|
9
|
+
import CrudSetBase from "./base/CrudSetBase";
|
|
10
|
+
import Font from "./Font";
|
|
11
|
+
//# sourceMappingURL=FontFamily.d.ts.map
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export default class InsetMap extends ResourceBase {
|
|
2
|
+
/**
|
|
3
|
+
* Get the inset map json
|
|
4
|
+
* @returns {CancelablePromise<Object>} - Inset map json
|
|
5
|
+
* @throws {ApiError} - If the api returns errors
|
|
6
|
+
*/
|
|
7
|
+
getJson(): CancelablePromise<any>;
|
|
8
|
+
}
|
|
9
|
+
import ResourceBase from "./base/ResourceBase";
|
|
10
|
+
//# sourceMappingURL=InsetMap.d.ts.map
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
export default class Job extends CrudBase {
|
|
2
|
+
/**
|
|
3
|
+
* Get the list of associated job results
|
|
4
|
+
* @returns {SimpleResourceProxy} - A proxy for accessing the resource
|
|
5
|
+
*/
|
|
6
|
+
get results(): SimpleResourceProxy;
|
|
7
|
+
/**
|
|
8
|
+
* Get the list job revisions
|
|
9
|
+
* @returns {ResourceProxy} - A proxy for accessing the resource
|
|
10
|
+
*/
|
|
11
|
+
get revisions(): ResourceProxy;
|
|
12
|
+
/**
|
|
13
|
+
* Get the most up to date preview url
|
|
14
|
+
* @returns {string} - Preview url
|
|
15
|
+
*/
|
|
16
|
+
get previewUrl(): string;
|
|
17
|
+
/**
|
|
18
|
+
* Get the most up to date archive url
|
|
19
|
+
* @returns {string} - Last archive url
|
|
20
|
+
*/
|
|
21
|
+
get lastArchiveUrl(): string;
|
|
22
|
+
/**
|
|
23
|
+
* Download the job preview
|
|
24
|
+
* @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
25
|
+
* @returns {CancelablePromise<DownloadedResource>} - Job result preview
|
|
26
|
+
* @throws {ApiError} - If the api returns errors
|
|
27
|
+
*/
|
|
28
|
+
downloadPreview(deleted?: string): CancelablePromise<DownloadedResource>;
|
|
29
|
+
/**
|
|
30
|
+
* Get archive blob url
|
|
31
|
+
* @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
32
|
+
* @returns {CancelablePromise<DownloadedResource>} - Job result output
|
|
33
|
+
* @throws {ApiError} - If the api returns errors
|
|
34
|
+
*/
|
|
35
|
+
downloadOutput(deleted?: string): CancelablePromise<DownloadedResource>;
|
|
36
|
+
/**
|
|
37
|
+
* Get the remote output url
|
|
38
|
+
* @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
39
|
+
* @returns {CancelablePromise<string>} - The url to the output
|
|
40
|
+
* @throws {ApiError} - If the api returns errors
|
|
41
|
+
*/
|
|
42
|
+
getOutputUrl(deleted?: string): CancelablePromise<string>;
|
|
43
|
+
/**
|
|
44
|
+
* Share the job
|
|
45
|
+
* @param {String} visibility - See {@link JobShareVisibility}, either `private`, `public` or `organisation`
|
|
46
|
+
* @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
47
|
+
* @returns {CancelablePromise<JobShare>} - Object containing share links
|
|
48
|
+
* @throws {ApiError} - If the api returns errors
|
|
49
|
+
*/
|
|
50
|
+
share(visibility?: string, deleted?: string): CancelablePromise<JobShare>;
|
|
51
|
+
}
|
|
52
|
+
import CrudBase from "./base/CrudBase";
|
|
53
|
+
import ResourceProxy from "../proxy/ResourceProxy";
|
|
54
|
+
import DownloadedResource from "./base/DownloadedResource";
|
|
55
|
+
import JobShare from "./JobShare";
|
|
56
|
+
//# sourceMappingURL=Job.d.ts.map
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
export default class JobResult extends ResourceBase {
|
|
2
|
+
/**
|
|
3
|
+
* Get the related job
|
|
4
|
+
* @returns {CancelablePromise<Job>} - The job related to this row
|
|
5
|
+
* @throws {ApiError} - If the api returns errors
|
|
6
|
+
*/
|
|
7
|
+
get job(): CancelablePromise<Job>;
|
|
8
|
+
/**
|
|
9
|
+
* Get the related job revision
|
|
10
|
+
* @returns {CancelablePromise<JobRevision>} - The job revision related to this row
|
|
11
|
+
* @throws {ApiError} - If the api returns errors
|
|
12
|
+
*/
|
|
13
|
+
get jobRevision(): CancelablePromise<JobRevision>;
|
|
14
|
+
/**
|
|
15
|
+
* Job result archive url
|
|
16
|
+
* @returns {string} - Archive url
|
|
17
|
+
*/
|
|
18
|
+
get outputUrl(): string;
|
|
19
|
+
/**
|
|
20
|
+
* Get archive blob url
|
|
21
|
+
* @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
22
|
+
* @returns {CancelablePromise<DownloadedResource>} - Job result output
|
|
23
|
+
* @throws {ApiError} - If the api returns errors
|
|
24
|
+
*/
|
|
25
|
+
downloadOutput(deleted?: string): CancelablePromise<DownloadedResource>;
|
|
26
|
+
/**
|
|
27
|
+
* Get the output url url
|
|
28
|
+
* @returns {string} - Output url url
|
|
29
|
+
*/
|
|
30
|
+
get outputUrlUrl(): string;
|
|
31
|
+
/**
|
|
32
|
+
* Get the remote output url
|
|
33
|
+
* @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
34
|
+
* @returns {CancelablePromise<string>} - The url to the output
|
|
35
|
+
* @throws {ApiError} - If the api returns errors
|
|
36
|
+
*/
|
|
37
|
+
getOutputUrl(deleted?: string): CancelablePromise<string>;
|
|
38
|
+
/**
|
|
39
|
+
* Job result log url
|
|
40
|
+
* @returns {string} - log url
|
|
41
|
+
*/
|
|
42
|
+
get logUrl(): string;
|
|
43
|
+
/**
|
|
44
|
+
* Download the job result log
|
|
45
|
+
* @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
46
|
+
* @returns {CancelablePromise<DownloadedResource>} - job result log
|
|
47
|
+
* @throws {ApiError} - If the api returns errors
|
|
48
|
+
*/
|
|
49
|
+
downloadLog(deleted?: string): CancelablePromise<DownloadedResource>;
|
|
50
|
+
/**
|
|
51
|
+
* Job result preview url, usable in an `<img>` tag
|
|
52
|
+
* @returns {string} - Preview url
|
|
53
|
+
*/
|
|
54
|
+
get previewUrl(): string;
|
|
55
|
+
/**
|
|
56
|
+
* Download the job preview
|
|
57
|
+
* @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
58
|
+
* @returns {CancelablePromise<DownloadedResource>} - Job result preview
|
|
59
|
+
* @throws {ApiError} - If the api returns errors
|
|
60
|
+
*/
|
|
61
|
+
downloadPreview(deleted?: string): CancelablePromise<DownloadedResource>;
|
|
62
|
+
/**
|
|
63
|
+
* Mark a job as dealt with
|
|
64
|
+
* This method is for internal use for our support team.
|
|
65
|
+
*
|
|
66
|
+
* @param {boolean} [value=true] - What to set the dealt-with value to
|
|
67
|
+
* @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
68
|
+
* @returns {CancelablePromise}
|
|
69
|
+
* @throws {ApiError} - If the api returns errors
|
|
70
|
+
*/
|
|
71
|
+
dealWith(value?: boolean, deleted?: string): CancelablePromise;
|
|
72
|
+
dealtWith: boolean;
|
|
73
|
+
}
|
|
74
|
+
import ResourceBase from "./base/ResourceBase";
|
|
75
|
+
import DownloadedResource from "./base/DownloadedResource";
|
|
76
|
+
//# sourceMappingURL=JobResult.d.ts.map
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
export default class JobRevision extends CrudBase {
|
|
2
|
+
/**
|
|
3
|
+
* Get layers
|
|
4
|
+
* @returns {SimpleResourceProxy} - A proxy for accessing the resource
|
|
5
|
+
*/
|
|
6
|
+
get layers(): SimpleResourceProxy;
|
|
7
|
+
/**
|
|
8
|
+
* Get the job result
|
|
9
|
+
* @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
10
|
+
* @returns {CancelablePromise<JobResult>} - The associated job result
|
|
11
|
+
* @throws {ApiError} - If the api returns errors
|
|
12
|
+
*/
|
|
13
|
+
result(deleted?: string): CancelablePromise<JobResult>;
|
|
14
|
+
/**
|
|
15
|
+
* Get a result proxy
|
|
16
|
+
*
|
|
17
|
+
* @returns {JobResult} - Empty job result used for
|
|
18
|
+
*/
|
|
19
|
+
get resultProxy(): JobResult;
|
|
20
|
+
/**
|
|
21
|
+
* Save updated job revision
|
|
22
|
+
* @param {Object} object - Map object
|
|
23
|
+
* @param {Array<Layer>|Array<Number>|null} layers - Array containing all layers for this revision. If set to null the same layers will be used
|
|
24
|
+
* @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
25
|
+
* @returns {CancelablePromise<JobRevision>} - New job revision
|
|
26
|
+
* @throws {TypeError}
|
|
27
|
+
* @throws {ApiError} - If the api returns errors
|
|
28
|
+
*/
|
|
29
|
+
save(object?: any, layers?: Array<Layer> | Array<number> | null, deleted?: string): CancelablePromise<JobRevision>;
|
|
30
|
+
/**
|
|
31
|
+
* Get job object
|
|
32
|
+
* @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
33
|
+
* @returns {CancelablePromise<Object>} - The map object
|
|
34
|
+
* @throws {ApiError} - If the api returns errors
|
|
35
|
+
*/
|
|
36
|
+
object(deleted?: string): CancelablePromise<any>;
|
|
37
|
+
/**
|
|
38
|
+
* Build the revision
|
|
39
|
+
* @param {String} callback - Optional callback url for when the job completes
|
|
40
|
+
* @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
41
|
+
* @throws {ApiError} - If the api returns errors
|
|
42
|
+
* @returns {CancelablePromise}
|
|
43
|
+
*/
|
|
44
|
+
build(callback: string, deleted?: string): CancelablePromise;
|
|
45
|
+
/**
|
|
46
|
+
* Cancels a running job
|
|
47
|
+
* @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
48
|
+
* @returns {CancelablePromise}
|
|
49
|
+
* @throws {ApiError} - If the api returns errors
|
|
50
|
+
*/
|
|
51
|
+
cancel(deleted?: string): CancelablePromise;
|
|
52
|
+
/**
|
|
53
|
+
* Clones a job revision to the user requesting it
|
|
54
|
+
* @param {String} [title=null] - The new title for the job
|
|
55
|
+
* @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
|
|
56
|
+
* @throws {ApiError} - If the api returns errors
|
|
57
|
+
* @returns {CancelablePromise<JobRevision>} - The new job revision, which will be linked to a new job
|
|
58
|
+
*/
|
|
59
|
+
clone(title?: string, deleted?: string): CancelablePromise<JobRevision>;
|
|
60
|
+
}
|
|
61
|
+
import CrudBase from "./base/CrudBase";
|
|
62
|
+
import JobResult from "./JobResult";
|
|
63
|
+
import Layer from "./Layer";
|
|
64
|
+
//# sourceMappingURL=JobRevision.d.ts.map
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export default class JobShare extends CrudBase {
|
|
2
|
+
/**
|
|
3
|
+
* Accessor for {@link JobShareVisibility} enum
|
|
4
|
+
* @returns {Enum<JobShareVisibility>} - Accessor for enum
|
|
5
|
+
*/
|
|
6
|
+
static get visibility(): Enum<string>;
|
|
7
|
+
/**
|
|
8
|
+
* Unsupported method implemented due to CrudBase abstraction
|
|
9
|
+
* @throws {Error}
|
|
10
|
+
* @private
|
|
11
|
+
*/
|
|
12
|
+
private save;
|
|
13
|
+
}
|
|
14
|
+
import CrudBase from "./base/CrudBase";
|
|
15
|
+
//# sourceMappingURL=JobShare.d.ts.map
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LayerGroup
|
|
3
|
+
* @extends CrudBase
|
|
4
|
+
* @mixes OwnableResource
|
|
5
|
+
* @mixes HandlesImages
|
|
6
|
+
*/
|
|
7
|
+
export default class LayerGroup {
|
|
8
|
+
static get resourceName(): string;
|
|
9
|
+
get items(): OwnedResourceProxy;
|
|
10
|
+
get _Child(): typeof Layer;
|
|
11
|
+
}
|
|
12
|
+
import { OwnedResourceProxy } from "../proxy";
|
|
13
|
+
import Layer from "./Layer";
|
|
14
|
+
//# sourceMappingURL=LayerGroup.d.ts.map
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Mapstyle set
|
|
3
|
+
* @extends CrudSetBase
|
|
4
|
+
* @mixes OwnableResource
|
|
5
|
+
*/
|
|
6
|
+
export default class MapstyleSet extends CrudSetBase {
|
|
7
|
+
get _Child(): typeof Mapstyle;
|
|
8
|
+
get colors(): ResourceProxy;
|
|
9
|
+
}
|
|
10
|
+
import CrudSetBase from "./base/CrudSetBase";
|
|
11
|
+
import Mapstyle from "./Mapstyle";
|
|
12
|
+
import ResourceProxy from "../proxy/ResourceProxy";
|
|
13
|
+
//# sourceMappingURL=MapstyleSet.d.ts.map
|