@spaciv/sdk 0.1.26 → 0.1.27

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 (46) 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/esm/apis/FilesApi.d.ts +52 -27
  6. package/dist/esm/apis/FilesApi.js +51 -13
  7. package/dist/esm/models/AccountDirectoryPatchBody.d.ts +12 -0
  8. package/dist/esm/models/AccountDirectoryPatchBody.js +4 -0
  9. package/dist/esm/models/AccountFilePatchBody.d.ts +12 -0
  10. package/dist/esm/models/AccountFilePatchBody.js +4 -0
  11. package/dist/esm/models/Directory.d.ts +14 -0
  12. package/dist/esm/models/Directory.js +4 -0
  13. package/dist/esm/models/ListPage.d.ts +1 -1
  14. package/dist/esm/models/ModelRecord.d.ts +14 -0
  15. package/dist/esm/models/ModelRecord.js +4 -0
  16. package/dist/esm/models/ReservedTagInfo.d.ts +46 -0
  17. package/dist/esm/models/ReservedTagInfo.js +54 -0
  18. package/dist/esm/models/TagList.d.ts +39 -0
  19. package/dist/esm/models/TagList.js +48 -0
  20. package/dist/esm/models/index.d.ts +2 -0
  21. package/dist/esm/models/index.js +2 -0
  22. package/dist/models/AccountDirectoryPatchBody.d.ts +12 -0
  23. package/dist/models/AccountDirectoryPatchBody.js +4 -0
  24. package/dist/models/AccountFilePatchBody.d.ts +12 -0
  25. package/dist/models/AccountFilePatchBody.js +4 -0
  26. package/dist/models/Directory.d.ts +14 -0
  27. package/dist/models/Directory.js +4 -0
  28. package/dist/models/ListPage.d.ts +1 -1
  29. package/dist/models/ModelRecord.d.ts +14 -0
  30. package/dist/models/ModelRecord.js +4 -0
  31. package/dist/models/ReservedTagInfo.d.ts +46 -0
  32. package/dist/models/ReservedTagInfo.js +62 -0
  33. package/dist/models/TagList.d.ts +39 -0
  34. package/dist/models/TagList.js +55 -0
  35. package/dist/models/index.d.ts +2 -0
  36. package/dist/models/index.js +2 -0
  37. package/package.json +1 -1
  38. package/src/apis/FilesApi.ts +89 -26
  39. package/src/models/AccountDirectoryPatchBody.ts +16 -0
  40. package/src/models/AccountFilePatchBody.ts +16 -0
  41. package/src/models/Directory.ts +16 -0
  42. package/src/models/ListPage.ts +1 -1
  43. package/src/models/ModelRecord.ts +16 -0
  44. package/src/models/ReservedTagInfo.ts +86 -0
  45. package/src/models/TagList.ts +83 -0
  46. package/src/models/index.ts +2 -0
@@ -67,6 +67,18 @@ export interface ModelRecord {
67
67
  * @memberof ModelRecord
68
68
  */
69
69
  size: number;
70
+ /**
71
+ * Problems found with the file by its reserved tags' checks, by tag. Absent when there are none.
72
+ * @type {{ [key: string]: Array<string>; }}
73
+ * @memberof ModelRecord
74
+ */
75
+ tagProblems?: { [key: string]: Array<string>; };
76
+ /**
77
+ * The file's tags, in alphabetical order. Absent when the file has none.
78
+ * @type {Array<string>}
79
+ * @memberof ModelRecord
80
+ */
81
+ tags?: Array<string>;
70
82
  /**
71
83
  * Identifier of the user who uploaded the file.
72
84
  * @type {number}
@@ -106,6 +118,8 @@ export function ModelRecordFromJSONTyped(json: any, ignoreDiscriminator: boolean
106
118
  'quarantineSignature': json['quarantineSignature'] == null ? undefined : json['quarantineSignature'],
107
119
  'quarantinedAt': json['quarantinedAt'] == null ? undefined : (new Date(json['quarantinedAt'])),
108
120
  'size': json['size'],
121
+ 'tagProblems': json['tagProblems'] == null ? undefined : json['tagProblems'],
122
+ 'tags': json['tags'] == null ? undefined : json['tags'],
109
123
  'uploadedBy': json['uploadedBy'],
110
124
  };
111
125
  }
@@ -129,6 +143,8 @@ export function ModelRecordToJSONTyped(value?: ModelRecord | null, ignoreDiscrim
129
143
  'quarantineSignature': value['quarantineSignature'],
130
144
  'quarantinedAt': value['quarantinedAt'] == null ? undefined : ((value['quarantinedAt']).toISOString()),
131
145
  'size': value['size'],
146
+ 'tagProblems': value['tagProblems'],
147
+ 'tags': value['tags'],
132
148
  'uploadedBy': value['uploadedBy'],
133
149
  };
134
150
  }
@@ -0,0 +1,86 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * spaciv API
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@spaciv.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface ReservedTagInfo
20
+ */
21
+ export interface ReservedTagInfo {
22
+ /**
23
+ * The kinds of item the tag can be applied to.
24
+ * @type {Array<string>}
25
+ * @memberof ReservedTagInfo
26
+ */
27
+ kinds: Array<ReservedTagInfoKindsEnum>;
28
+ /**
29
+ * The reserved tag.
30
+ * @type {string}
31
+ * @memberof ReservedTagInfo
32
+ */
33
+ name: string;
34
+ }
35
+
36
+
37
+ /**
38
+ * @export
39
+ */
40
+ export const ReservedTagInfoKindsEnum = {
41
+ File: 'file',
42
+ Directory: 'directory'
43
+ } as const;
44
+ export type ReservedTagInfoKindsEnum = typeof ReservedTagInfoKindsEnum[keyof typeof ReservedTagInfoKindsEnum];
45
+
46
+
47
+ /**
48
+ * Check if a given object implements the ReservedTagInfo interface.
49
+ */
50
+ export function instanceOfReservedTagInfo(value: object): value is ReservedTagInfo {
51
+ if (!('kinds' in value) || value['kinds'] === undefined) return false;
52
+ if (!('name' in value) || value['name'] === undefined) return false;
53
+ return true;
54
+ }
55
+
56
+ export function ReservedTagInfoFromJSON(json: any): ReservedTagInfo {
57
+ return ReservedTagInfoFromJSONTyped(json, false);
58
+ }
59
+
60
+ export function ReservedTagInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReservedTagInfo {
61
+ if (json == null) {
62
+ return json;
63
+ }
64
+ return {
65
+
66
+ 'kinds': json['kinds'],
67
+ 'name': json['name'],
68
+ };
69
+ }
70
+
71
+ export function ReservedTagInfoToJSON(json: any): ReservedTagInfo {
72
+ return ReservedTagInfoToJSONTyped(json, false);
73
+ }
74
+
75
+ export function ReservedTagInfoToJSONTyped(value?: ReservedTagInfo | null, ignoreDiscriminator: boolean = false): any {
76
+ if (value == null) {
77
+ return value;
78
+ }
79
+
80
+ return {
81
+
82
+ 'kinds': value['kinds'],
83
+ 'name': value['name'],
84
+ };
85
+ }
86
+
@@ -0,0 +1,83 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * spaciv API
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@spaciv.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { ReservedTagInfo } from './ReservedTagInfo';
17
+ import {
18
+ ReservedTagInfoFromJSON,
19
+ ReservedTagInfoFromJSONTyped,
20
+ ReservedTagInfoToJSON,
21
+ ReservedTagInfoToJSONTyped,
22
+ } from './ReservedTagInfo';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface TagList
28
+ */
29
+ export interface TagList {
30
+ /**
31
+ * 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.
32
+ * @type {Array<ReservedTagInfo>}
33
+ * @memberof TagList
34
+ */
35
+ reserved: Array<ReservedTagInfo>;
36
+ /**
37
+ * Every tag on the account's files and directories, in alphabetical order.
38
+ * @type {Array<string>}
39
+ * @memberof TagList
40
+ */
41
+ tags: Array<string>;
42
+ }
43
+
44
+ /**
45
+ * Check if a given object implements the TagList interface.
46
+ */
47
+ export function instanceOfTagList(value: object): value is TagList {
48
+ if (!('reserved' in value) || value['reserved'] === undefined) return false;
49
+ if (!('tags' in value) || value['tags'] === undefined) return false;
50
+ return true;
51
+ }
52
+
53
+ export function TagListFromJSON(json: any): TagList {
54
+ return TagListFromJSONTyped(json, false);
55
+ }
56
+
57
+ export function TagListFromJSONTyped(json: any, ignoreDiscriminator: boolean): TagList {
58
+ if (json == null) {
59
+ return json;
60
+ }
61
+ return {
62
+
63
+ 'reserved': ((json['reserved'] as Array<any>).map(ReservedTagInfoFromJSON)),
64
+ 'tags': json['tags'],
65
+ };
66
+ }
67
+
68
+ export function TagListToJSON(json: any): TagList {
69
+ return TagListToJSONTyped(json, false);
70
+ }
71
+
72
+ export function TagListToJSONTyped(value?: TagList | null, ignoreDiscriminator: boolean = false): any {
73
+ if (value == null) {
74
+ return value;
75
+ }
76
+
77
+ return {
78
+
79
+ 'reserved': ((value['reserved'] as Array<any>).map(ReservedTagInfoToJSON)),
80
+ 'tags': value['tags'],
81
+ };
82
+ }
83
+
@@ -309,6 +309,7 @@ export * from './ReferencesRes';
309
309
  export * from './RelationshipData';
310
310
  export * from './RepairFloorplansResBody';
311
311
  export * from './ReportParamsWrapperBody';
312
+ export * from './ReservedTagInfo';
312
313
  export * from './RetriesResBody';
313
314
  export * from './RetryBody';
314
315
  export * from './RoleTagsData';
@@ -370,6 +371,7 @@ export * from './SpaceRulesetListEntry';
370
371
  export * from './SpaceRulesetUpdate';
371
372
  export * from './Step';
372
373
  export * from './SysAdminUpdateFeatureGroupsParamsWrapperBody';
374
+ export * from './TagList';
373
375
  export * from './TopDownModelChangelogBody';
374
376
  export * from './TopDownModelEntry';
375
377
  export * from './TopDownModelEntryChangelogBody';