@spaciv/sdk 0.1.26 → 0.1.28

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.
Files changed (51) hide show
  1. package/.openapi-generator/FILES +2 -0
  2. package/README.md +2 -2
  3. package/dist/apis/FilesApi.d.ts +52 -27
  4. package/dist/apis/FilesApi.js +50 -12
  5. package/dist/apis/LogicLayersApi.d.ts +8 -18
  6. package/dist/apis/LogicLayersApi.js +5 -15
  7. package/dist/esm/apis/FilesApi.d.ts +52 -27
  8. package/dist/esm/apis/FilesApi.js +51 -13
  9. package/dist/esm/apis/LogicLayersApi.d.ts +8 -18
  10. package/dist/esm/apis/LogicLayersApi.js +4 -14
  11. package/dist/esm/models/AccountDirectoryPatchBody.d.ts +12 -0
  12. package/dist/esm/models/AccountDirectoryPatchBody.js +4 -0
  13. package/dist/esm/models/AccountFilePatchBody.d.ts +12 -0
  14. package/dist/esm/models/AccountFilePatchBody.js +4 -0
  15. package/dist/esm/models/Directory.d.ts +14 -0
  16. package/dist/esm/models/Directory.js +4 -0
  17. package/dist/esm/models/ListPage.d.ts +1 -1
  18. package/dist/esm/models/ModelRecord.d.ts +14 -0
  19. package/dist/esm/models/ModelRecord.js +4 -0
  20. package/dist/esm/models/ReservedTagInfo.d.ts +46 -0
  21. package/dist/esm/models/ReservedTagInfo.js +54 -0
  22. package/dist/esm/models/TagList.d.ts +39 -0
  23. package/dist/esm/models/TagList.js +48 -0
  24. package/dist/esm/models/index.d.ts +2 -0
  25. package/dist/esm/models/index.js +2 -0
  26. package/dist/models/AccountDirectoryPatchBody.d.ts +12 -0
  27. package/dist/models/AccountDirectoryPatchBody.js +4 -0
  28. package/dist/models/AccountFilePatchBody.d.ts +12 -0
  29. package/dist/models/AccountFilePatchBody.js +4 -0
  30. package/dist/models/Directory.d.ts +14 -0
  31. package/dist/models/Directory.js +4 -0
  32. package/dist/models/ListPage.d.ts +1 -1
  33. package/dist/models/ModelRecord.d.ts +14 -0
  34. package/dist/models/ModelRecord.js +4 -0
  35. package/dist/models/ReservedTagInfo.d.ts +46 -0
  36. package/dist/models/ReservedTagInfo.js +62 -0
  37. package/dist/models/TagList.d.ts +39 -0
  38. package/dist/models/TagList.js +55 -0
  39. package/dist/models/index.d.ts +2 -0
  40. package/dist/models/index.js +2 -0
  41. package/package.json +1 -1
  42. package/src/apis/FilesApi.ts +89 -26
  43. package/src/apis/LogicLayersApi.ts +8 -23
  44. package/src/models/AccountDirectoryPatchBody.ts +16 -0
  45. package/src/models/AccountFilePatchBody.ts +16 -0
  46. package/src/models/Directory.ts +16 -0
  47. package/src/models/ListPage.ts +1 -1
  48. package/src/models/ModelRecord.ts +16 -0
  49. package/src/models/ReservedTagInfo.ts +86 -0
  50. package/src/models/TagList.ts +83 -0
  51. package/src/models/index.ts +2 -0
@@ -32,8 +32,10 @@ function AccountFilePatchBodyFromJSONTyped(json, ignoreDiscriminator) {
32
32
  return json;
33
33
  }
34
34
  return {
35
+ 'addTags': json['addTags'] == null ? undefined : json['addTags'],
35
36
  'name': json['name'] == null ? undefined : json['name'],
36
37
  'parentId': json['parentId'] == null ? undefined : json['parentId'],
38
+ 'removeTags': json['removeTags'] == null ? undefined : json['removeTags'],
37
39
  };
38
40
  }
39
41
  function AccountFilePatchBodyToJSON(json) {
@@ -44,7 +46,9 @@ function AccountFilePatchBodyToJSONTyped(value, ignoreDiscriminator = false) {
44
46
  return value;
45
47
  }
46
48
  return {
49
+ 'addTags': value['addTags'],
47
50
  'name': value['name'],
48
51
  'parentId': value['parentId'],
52
+ 'removeTags': value['removeTags'],
49
53
  };
50
54
  }
@@ -45,6 +45,20 @@ export interface Directory {
45
45
  * @memberof Directory
46
46
  */
47
47
  parentId?: string;
48
+ /**
49
+ * Problems found with the directory by its reserved tags' checks, by tag. Absent when there are none.
50
+ * @type {{ [key: string]: Array<string>; }}
51
+ * @memberof Directory
52
+ */
53
+ tagProblems?: {
54
+ [key: string]: Array<string>;
55
+ };
56
+ /**
57
+ * The directory's tags, in alphabetical order. Absent when the directory has none.
58
+ * @type {Array<string>}
59
+ * @memberof Directory
60
+ */
61
+ tags?: Array<string>;
48
62
  }
49
63
  /**
50
64
  * Check if a given object implements the Directory interface.
@@ -45,6 +45,8 @@ function DirectoryFromJSONTyped(json, ignoreDiscriminator) {
45
45
  'id': json['id'],
46
46
  'name': json['name'],
47
47
  'parentId': json['parentId'] == null ? undefined : json['parentId'],
48
+ 'tagProblems': json['tagProblems'] == null ? undefined : json['tagProblems'],
49
+ 'tags': json['tags'] == null ? undefined : json['tags'],
48
50
  };
49
51
  }
50
52
  function DirectoryToJSON(json) {
@@ -60,5 +62,7 @@ function DirectoryToJSONTyped(value, ignoreDiscriminator = false) {
60
62
  'id': value['id'],
61
63
  'name': value['name'],
62
64
  'parentId': value['parentId'],
65
+ 'tagProblems': value['tagProblems'],
66
+ 'tags': value['tags'],
63
67
  };
64
68
  }
@@ -18,7 +18,7 @@ import type { Directory } from './Directory';
18
18
  */
19
19
  export interface ListPage {
20
20
  /**
21
- * Directories directly inside the listed directory. Returned only when a parent is given, and only on the pages that hold some.
21
+ * With a parent, the directories directly inside it; with a tag, the directories that have it. Returned only on the pages that hold some.
22
22
  * @type {Array<Directory>}
23
23
  * @memberof ListPage
24
24
  */
@@ -63,6 +63,20 @@ export interface ModelRecord {
63
63
  * @memberof ModelRecord
64
64
  */
65
65
  size: number;
66
+ /**
67
+ * Problems found with the file by its reserved tags' checks, by tag. Absent when there are none.
68
+ * @type {{ [key: string]: Array<string>; }}
69
+ * @memberof ModelRecord
70
+ */
71
+ tagProblems?: {
72
+ [key: string]: Array<string>;
73
+ };
74
+ /**
75
+ * The file's tags, in alphabetical order. Absent when the file has none.
76
+ * @type {Array<string>}
77
+ * @memberof ModelRecord
78
+ */
79
+ tags?: Array<string>;
66
80
  /**
67
81
  * Identifier of the user who uploaded the file.
68
82
  * @type {number}
@@ -52,6 +52,8 @@ function ModelRecordFromJSONTyped(json, ignoreDiscriminator) {
52
52
  'quarantineSignature': json['quarantineSignature'] == null ? undefined : json['quarantineSignature'],
53
53
  'quarantinedAt': json['quarantinedAt'] == null ? undefined : (new Date(json['quarantinedAt'])),
54
54
  'size': json['size'],
55
+ 'tagProblems': json['tagProblems'] == null ? undefined : json['tagProblems'],
56
+ 'tags': json['tags'] == null ? undefined : json['tags'],
55
57
  'uploadedBy': json['uploadedBy'],
56
58
  };
57
59
  }
@@ -71,6 +73,8 @@ function ModelRecordToJSONTyped(value, ignoreDiscriminator = false) {
71
73
  'quarantineSignature': value['quarantineSignature'],
72
74
  'quarantinedAt': value['quarantinedAt'] == null ? undefined : ((value['quarantinedAt']).toISOString()),
73
75
  'size': value['size'],
76
+ 'tagProblems': value['tagProblems'],
77
+ 'tags': value['tags'],
74
78
  'uploadedBy': value['uploadedBy'],
75
79
  };
76
80
  }
@@ -0,0 +1,46 @@
1
+ /**
2
+ * spaciv API
3
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@spaciv.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface ReservedTagInfo
16
+ */
17
+ export interface ReservedTagInfo {
18
+ /**
19
+ * The kinds of item the tag can be applied to.
20
+ * @type {Array<string>}
21
+ * @memberof ReservedTagInfo
22
+ */
23
+ kinds: Array<ReservedTagInfoKindsEnum>;
24
+ /**
25
+ * The reserved tag.
26
+ * @type {string}
27
+ * @memberof ReservedTagInfo
28
+ */
29
+ name: string;
30
+ }
31
+ /**
32
+ * @export
33
+ */
34
+ export declare const ReservedTagInfoKindsEnum: {
35
+ readonly File: "file";
36
+ readonly Directory: "directory";
37
+ };
38
+ export type ReservedTagInfoKindsEnum = typeof ReservedTagInfoKindsEnum[keyof typeof ReservedTagInfoKindsEnum];
39
+ /**
40
+ * Check if a given object implements the ReservedTagInfo interface.
41
+ */
42
+ export declare function instanceOfReservedTagInfo(value: object): value is ReservedTagInfo;
43
+ export declare function ReservedTagInfoFromJSON(json: any): ReservedTagInfo;
44
+ export declare function ReservedTagInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReservedTagInfo;
45
+ export declare function ReservedTagInfoToJSON(json: any): ReservedTagInfo;
46
+ export declare function ReservedTagInfoToJSONTyped(value?: ReservedTagInfo | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,62 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * spaciv API
6
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: support@spaciv.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ReservedTagInfoKindsEnum = void 0;
17
+ exports.instanceOfReservedTagInfo = instanceOfReservedTagInfo;
18
+ exports.ReservedTagInfoFromJSON = ReservedTagInfoFromJSON;
19
+ exports.ReservedTagInfoFromJSONTyped = ReservedTagInfoFromJSONTyped;
20
+ exports.ReservedTagInfoToJSON = ReservedTagInfoToJSON;
21
+ exports.ReservedTagInfoToJSONTyped = ReservedTagInfoToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.ReservedTagInfoKindsEnum = {
26
+ File: 'file',
27
+ Directory: 'directory'
28
+ };
29
+ /**
30
+ * Check if a given object implements the ReservedTagInfo interface.
31
+ */
32
+ function instanceOfReservedTagInfo(value) {
33
+ if (!('kinds' in value) || value['kinds'] === undefined)
34
+ return false;
35
+ if (!('name' in value) || value['name'] === undefined)
36
+ return false;
37
+ return true;
38
+ }
39
+ function ReservedTagInfoFromJSON(json) {
40
+ return ReservedTagInfoFromJSONTyped(json, false);
41
+ }
42
+ function ReservedTagInfoFromJSONTyped(json, ignoreDiscriminator) {
43
+ if (json == null) {
44
+ return json;
45
+ }
46
+ return {
47
+ 'kinds': json['kinds'],
48
+ 'name': json['name'],
49
+ };
50
+ }
51
+ function ReservedTagInfoToJSON(json) {
52
+ return ReservedTagInfoToJSONTyped(json, false);
53
+ }
54
+ function ReservedTagInfoToJSONTyped(value, ignoreDiscriminator = false) {
55
+ if (value == null) {
56
+ return value;
57
+ }
58
+ return {
59
+ 'kinds': value['kinds'],
60
+ 'name': value['name'],
61
+ };
62
+ }
@@ -0,0 +1,39 @@
1
+ /**
2
+ * spaciv API
3
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@spaciv.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { ReservedTagInfo } from './ReservedTagInfo';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface TagList
17
+ */
18
+ export interface TagList {
19
+ /**
20
+ * The tags that give an item a meaning Spaciv acts on. Adding or removing one, or changing anything in an item that has one, needs a particular permission.
21
+ * @type {Array<ReservedTagInfo>}
22
+ * @memberof TagList
23
+ */
24
+ reserved: Array<ReservedTagInfo>;
25
+ /**
26
+ * Every tag on the account's files and directories, in alphabetical order.
27
+ * @type {Array<string>}
28
+ * @memberof TagList
29
+ */
30
+ tags: Array<string>;
31
+ }
32
+ /**
33
+ * Check if a given object implements the TagList interface.
34
+ */
35
+ export declare function instanceOfTagList(value: object): value is TagList;
36
+ export declare function TagListFromJSON(json: any): TagList;
37
+ export declare function TagListFromJSONTyped(json: any, ignoreDiscriminator: boolean): TagList;
38
+ export declare function TagListToJSON(json: any): TagList;
39
+ export declare function TagListToJSONTyped(value?: TagList | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,55 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * spaciv API
6
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: support@spaciv.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfTagList = instanceOfTagList;
17
+ exports.TagListFromJSON = TagListFromJSON;
18
+ exports.TagListFromJSONTyped = TagListFromJSONTyped;
19
+ exports.TagListToJSON = TagListToJSON;
20
+ exports.TagListToJSONTyped = TagListToJSONTyped;
21
+ const ReservedTagInfo_1 = require("./ReservedTagInfo");
22
+ /**
23
+ * Check if a given object implements the TagList interface.
24
+ */
25
+ function instanceOfTagList(value) {
26
+ if (!('reserved' in value) || value['reserved'] === undefined)
27
+ return false;
28
+ if (!('tags' in value) || value['tags'] === undefined)
29
+ return false;
30
+ return true;
31
+ }
32
+ function TagListFromJSON(json) {
33
+ return TagListFromJSONTyped(json, false);
34
+ }
35
+ function TagListFromJSONTyped(json, ignoreDiscriminator) {
36
+ if (json == null) {
37
+ return json;
38
+ }
39
+ return {
40
+ 'reserved': (json['reserved'].map(ReservedTagInfo_1.ReservedTagInfoFromJSON)),
41
+ 'tags': json['tags'],
42
+ };
43
+ }
44
+ function TagListToJSON(json) {
45
+ return TagListToJSONTyped(json, false);
46
+ }
47
+ function TagListToJSONTyped(value, ignoreDiscriminator = false) {
48
+ if (value == null) {
49
+ return value;
50
+ }
51
+ return {
52
+ 'reserved': (value['reserved'].map(ReservedTagInfo_1.ReservedTagInfoToJSON)),
53
+ 'tags': value['tags'],
54
+ };
55
+ }
@@ -307,6 +307,7 @@ export * from './ReferencesRes';
307
307
  export * from './RelationshipData';
308
308
  export * from './RepairFloorplansResBody';
309
309
  export * from './ReportParamsWrapperBody';
310
+ export * from './ReservedTagInfo';
310
311
  export * from './RetriesResBody';
311
312
  export * from './RetryBody';
312
313
  export * from './RoleTagsData';
@@ -368,6 +369,7 @@ export * from './SpaceRulesetListEntry';
368
369
  export * from './SpaceRulesetUpdate';
369
370
  export * from './Step';
370
371
  export * from './SysAdminUpdateFeatureGroupsParamsWrapperBody';
372
+ export * from './TagList';
371
373
  export * from './TopDownModelChangelogBody';
372
374
  export * from './TopDownModelEntry';
373
375
  export * from './TopDownModelEntryChangelogBody';
@@ -325,6 +325,7 @@ __exportStar(require("./ReferencesRes"), exports);
325
325
  __exportStar(require("./RelationshipData"), exports);
326
326
  __exportStar(require("./RepairFloorplansResBody"), exports);
327
327
  __exportStar(require("./ReportParamsWrapperBody"), exports);
328
+ __exportStar(require("./ReservedTagInfo"), exports);
328
329
  __exportStar(require("./RetriesResBody"), exports);
329
330
  __exportStar(require("./RetryBody"), exports);
330
331
  __exportStar(require("./RoleTagsData"), exports);
@@ -386,6 +387,7 @@ __exportStar(require("./SpaceRulesetListEntry"), exports);
386
387
  __exportStar(require("./SpaceRulesetUpdate"), exports);
387
388
  __exportStar(require("./Step"), exports);
388
389
  __exportStar(require("./SysAdminUpdateFeatureGroupsParamsWrapperBody"), exports);
390
+ __exportStar(require("./TagList"), exports);
389
391
  __exportStar(require("./TopDownModelChangelogBody"), exports);
390
392
  __exportStar(require("./TopDownModelEntry"), exports);
391
393
  __exportStar(require("./TopDownModelEntryChangelogBody"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spaciv/sdk",
3
- "version": "0.1.26",
3
+ "version": "0.1.28",
4
4
  "description": "OpenAPI client for @spaciv/sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {