@spaciv/sdk 0.1.1 → 0.1.2

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 (151) hide show
  1. package/.openapi-generator/FILES +23 -0
  2. package/README.md +2 -2
  3. package/dist/apis/AccountsApi.d.ts +24 -24
  4. package/dist/apis/AccountsApi.js +12 -12
  5. package/dist/apis/AuditLogApi.d.ts +1 -1
  6. package/dist/apis/AuthenticationApi.d.ts +8 -8
  7. package/dist/apis/AuthenticationApi.js +4 -4
  8. package/dist/apis/ScriptsApi.d.ts +383 -0
  9. package/dist/apis/ScriptsApi.js +559 -0
  10. package/dist/apis/UsersApi.d.ts +4 -4
  11. package/dist/apis/UsersApi.js +2 -2
  12. package/dist/apis/index.d.ts +1 -0
  13. package/dist/apis/index.js +1 -0
  14. package/dist/esm/apis/AccountsApi.d.ts +24 -24
  15. package/dist/esm/apis/AccountsApi.js +12 -12
  16. package/dist/esm/apis/AuditLogApi.d.ts +1 -1
  17. package/dist/esm/apis/AuthenticationApi.d.ts +8 -8
  18. package/dist/esm/apis/AuthenticationApi.js +4 -4
  19. package/dist/esm/apis/ScriptsApi.d.ts +383 -0
  20. package/dist/esm/apis/ScriptsApi.js +555 -0
  21. package/dist/esm/apis/UsersApi.d.ts +4 -4
  22. package/dist/esm/apis/UsersApi.js +2 -2
  23. package/dist/esm/apis/index.d.ts +1 -0
  24. package/dist/esm/apis/index.js +1 -0
  25. package/dist/esm/models/APIKey.d.ts +6 -0
  26. package/dist/esm/models/APIKey.js +2 -0
  27. package/dist/esm/models/ScriptAuditEntry.d.ts +67 -0
  28. package/dist/esm/models/ScriptAuditEntry.js +63 -0
  29. package/dist/esm/models/ScriptAuditResBody.d.ts +39 -0
  30. package/dist/esm/models/ScriptAuditResBody.js +46 -0
  31. package/dist/esm/models/ScriptDetail.d.ts +161 -0
  32. package/dist/esm/models/ScriptDetail.js +122 -0
  33. package/dist/esm/models/ScriptExport.d.ts +174 -0
  34. package/dist/esm/models/ScriptExport.js +129 -0
  35. package/dist/esm/models/ScriptExportResBody.d.ts +39 -0
  36. package/dist/esm/models/ScriptExportResBody.js +48 -0
  37. package/dist/esm/models/ScriptExportRun.d.ts +92 -0
  38. package/dist/esm/models/ScriptExportRun.js +73 -0
  39. package/dist/esm/models/ScriptKey.d.ts +64 -0
  40. package/dist/esm/models/ScriptKey.js +58 -0
  41. package/dist/esm/models/ScriptListResBody.d.ts +33 -0
  42. package/dist/esm/models/ScriptListResBody.js +44 -0
  43. package/dist/esm/models/ScriptLogLine.d.ts +38 -0
  44. package/dist/esm/models/ScriptLogLine.js +47 -0
  45. package/dist/esm/models/ScriptPatchReqBody.d.ts +98 -0
  46. package/dist/esm/models/ScriptPatchReqBody.js +70 -0
  47. package/dist/esm/models/ScriptPostReqBody.d.ts +113 -0
  48. package/dist/esm/models/ScriptPostReqBody.js +82 -0
  49. package/dist/esm/models/ScriptRun.d.ts +86 -0
  50. package/dist/esm/models/ScriptRun.js +69 -0
  51. package/dist/esm/models/ScriptRunLogsResBody.d.ts +39 -0
  52. package/dist/esm/models/ScriptRunLogsResBody.js +48 -0
  53. package/dist/esm/models/ScriptRunsResBody.d.ts +39 -0
  54. package/dist/esm/models/ScriptRunsResBody.js +46 -0
  55. package/dist/esm/models/ScriptRuntime.d.ts +62 -0
  56. package/dist/esm/models/ScriptRuntime.js +51 -0
  57. package/dist/esm/models/ScriptSchedule.d.ts +38 -0
  58. package/dist/esm/models/ScriptSchedule.js +43 -0
  59. package/dist/esm/models/ScriptSchedulePreviewReqBody.d.ts +44 -0
  60. package/dist/esm/models/ScriptSchedulePreviewReqBody.js +45 -0
  61. package/dist/esm/models/ScriptSchedulePreviewResBody.d.ts +44 -0
  62. package/dist/esm/models/ScriptSchedulePreviewResBody.js +49 -0
  63. package/dist/esm/models/ScriptSecretsReqBody.d.ts +40 -0
  64. package/dist/esm/models/ScriptSecretsReqBody.js +43 -0
  65. package/dist/esm/models/ScriptSecretsResBody.d.ts +134 -0
  66. package/dist/esm/models/ScriptSecretsResBody.js +111 -0
  67. package/dist/esm/models/ScriptSummary.d.ts +128 -0
  68. package/dist/esm/models/ScriptSummary.js +107 -0
  69. package/dist/esm/models/ScriptWebhookResBody.d.ts +32 -0
  70. package/dist/esm/models/ScriptWebhookResBody.js +43 -0
  71. package/dist/esm/models/index.d.ts +22 -0
  72. package/dist/esm/models/index.js +22 -0
  73. package/dist/models/APIKey.d.ts +6 -0
  74. package/dist/models/APIKey.js +2 -0
  75. package/dist/models/ScriptAuditEntry.d.ts +67 -0
  76. package/dist/models/ScriptAuditEntry.js +71 -0
  77. package/dist/models/ScriptAuditResBody.d.ts +39 -0
  78. package/dist/models/ScriptAuditResBody.js +53 -0
  79. package/dist/models/ScriptDetail.d.ts +161 -0
  80. package/dist/models/ScriptDetail.js +130 -0
  81. package/dist/models/ScriptExport.d.ts +174 -0
  82. package/dist/models/ScriptExport.js +137 -0
  83. package/dist/models/ScriptExportResBody.d.ts +39 -0
  84. package/dist/models/ScriptExportResBody.js +55 -0
  85. package/dist/models/ScriptExportRun.d.ts +92 -0
  86. package/dist/models/ScriptExportRun.js +80 -0
  87. package/dist/models/ScriptKey.d.ts +64 -0
  88. package/dist/models/ScriptKey.js +66 -0
  89. package/dist/models/ScriptListResBody.d.ts +33 -0
  90. package/dist/models/ScriptListResBody.js +51 -0
  91. package/dist/models/ScriptLogLine.d.ts +38 -0
  92. package/dist/models/ScriptLogLine.js +54 -0
  93. package/dist/models/ScriptPatchReqBody.d.ts +98 -0
  94. package/dist/models/ScriptPatchReqBody.js +78 -0
  95. package/dist/models/ScriptPostReqBody.d.ts +113 -0
  96. package/dist/models/ScriptPostReqBody.js +90 -0
  97. package/dist/models/ScriptRun.d.ts +86 -0
  98. package/dist/models/ScriptRun.js +76 -0
  99. package/dist/models/ScriptRunLogsResBody.d.ts +39 -0
  100. package/dist/models/ScriptRunLogsResBody.js +55 -0
  101. package/dist/models/ScriptRunsResBody.d.ts +39 -0
  102. package/dist/models/ScriptRunsResBody.js +53 -0
  103. package/dist/models/ScriptRuntime.d.ts +62 -0
  104. package/dist/models/ScriptRuntime.js +58 -0
  105. package/dist/models/ScriptSchedule.d.ts +38 -0
  106. package/dist/models/ScriptSchedule.js +50 -0
  107. package/dist/models/ScriptSchedulePreviewReqBody.d.ts +44 -0
  108. package/dist/models/ScriptSchedulePreviewReqBody.js +52 -0
  109. package/dist/models/ScriptSchedulePreviewResBody.d.ts +44 -0
  110. package/dist/models/ScriptSchedulePreviewResBody.js +56 -0
  111. package/dist/models/ScriptSecretsReqBody.d.ts +40 -0
  112. package/dist/models/ScriptSecretsReqBody.js +50 -0
  113. package/dist/models/ScriptSecretsResBody.d.ts +134 -0
  114. package/dist/models/ScriptSecretsResBody.js +119 -0
  115. package/dist/models/ScriptSummary.d.ts +128 -0
  116. package/dist/models/ScriptSummary.js +115 -0
  117. package/dist/models/ScriptWebhookResBody.d.ts +32 -0
  118. package/dist/models/ScriptWebhookResBody.js +50 -0
  119. package/dist/models/index.d.ts +22 -0
  120. package/dist/models/index.js +22 -0
  121. package/package.json +1 -1
  122. package/src/apis/AccountsApi.ts +24 -24
  123. package/src/apis/AuditLogApi.ts +1 -1
  124. package/src/apis/AuthenticationApi.ts +8 -8
  125. package/src/apis/ScriptsApi.ts +984 -0
  126. package/src/apis/UsersApi.ts +4 -4
  127. package/src/apis/index.ts +1 -0
  128. package/src/models/APIKey.ts +8 -0
  129. package/src/models/ScriptAuditEntry.ts +112 -0
  130. package/src/models/ScriptAuditResBody.ts +82 -0
  131. package/src/models/ScriptDetail.ts +265 -0
  132. package/src/models/ScriptExport.ts +289 -0
  133. package/src/models/ScriptExportResBody.ts +83 -0
  134. package/src/models/ScriptExportRun.ts +151 -0
  135. package/src/models/ScriptKey.ts +109 -0
  136. package/src/models/ScriptListResBody.ts +74 -0
  137. package/src/models/ScriptLogLine.ts +75 -0
  138. package/src/models/ScriptPatchReqBody.ts +158 -0
  139. package/src/models/ScriptPostReqBody.ts +176 -0
  140. package/src/models/ScriptRun.ts +142 -0
  141. package/src/models/ScriptRunLogsResBody.ts +83 -0
  142. package/src/models/ScriptRunsResBody.ts +82 -0
  143. package/src/models/ScriptRuntime.ts +105 -0
  144. package/src/models/ScriptSchedule.ts +73 -0
  145. package/src/models/ScriptSchedulePreviewReqBody.ts +81 -0
  146. package/src/models/ScriptSchedulePreviewResBody.ts +83 -0
  147. package/src/models/ScriptSecretsReqBody.ts +73 -0
  148. package/src/models/ScriptSecretsResBody.ts +225 -0
  149. package/src/models/ScriptSummary.ts +216 -0
  150. package/src/models/ScriptWebhookResBody.ts +66 -0
  151. package/src/models/index.ts +22 -0
@@ -0,0 +1,129 @@
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
+ import { ScriptKeyFromJSON, ScriptKeyToJSON, } from './ScriptKey';
15
+ import { ScriptScheduleFromJSON, ScriptScheduleToJSON, } from './ScriptSchedule';
16
+ import { ScriptRuntimeFromJSON, ScriptRuntimeToJSON, } from './ScriptRuntime';
17
+ import { ScriptExportRunFromJSON, ScriptExportRunToJSON, } from './ScriptExportRun';
18
+ /**
19
+ * @export
20
+ */
21
+ export const ScriptExportLanguageEnum = {
22
+ Python: 'python',
23
+ Go: 'go',
24
+ Javascript: 'javascript'
25
+ };
26
+ /**
27
+ * @export
28
+ */
29
+ export const ScriptExportTypeEnum = {
30
+ Integration: 'integration'
31
+ };
32
+ /**
33
+ * Check if a given object implements the ScriptExport interface.
34
+ */
35
+ export function instanceOfScriptExport(value) {
36
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
37
+ return false;
38
+ if (!('createdBy' in value) || value['createdBy'] === undefined)
39
+ return false;
40
+ if (!('enabled' in value) || value['enabled'] === undefined)
41
+ return false;
42
+ if (!('files' in value) || value['files'] === undefined)
43
+ return false;
44
+ if (!('id' in value) || value['id'] === undefined)
45
+ return false;
46
+ if (!('key' in value) || value['key'] === undefined)
47
+ return false;
48
+ if (!('language' in value) || value['language'] === undefined)
49
+ return false;
50
+ if (!('name' in value) || value['name'] === undefined)
51
+ return false;
52
+ if (!('revision' in value) || value['revision'] === undefined)
53
+ return false;
54
+ if (!('runs' in value) || value['runs'] === undefined)
55
+ return false;
56
+ if (!('schedule' in value) || value['schedule'] === undefined)
57
+ return false;
58
+ if (!('secretNames' in value) || value['secretNames'] === undefined)
59
+ return false;
60
+ if (!('type' in value) || value['type'] === undefined)
61
+ return false;
62
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined)
63
+ return false;
64
+ if (!('webhook' in value) || value['webhook'] === undefined)
65
+ return false;
66
+ return true;
67
+ }
68
+ export function ScriptExportFromJSON(json) {
69
+ return ScriptExportFromJSONTyped(json, false);
70
+ }
71
+ export function ScriptExportFromJSONTyped(json, ignoreDiscriminator) {
72
+ if (json == null) {
73
+ return json;
74
+ }
75
+ return {
76
+ 'createdAt': (new Date(json['createdAt'])),
77
+ 'createdBy': json['createdBy'],
78
+ 'description': json['description'] == null ? undefined : json['description'],
79
+ 'enabled': json['enabled'],
80
+ 'files': json['files'],
81
+ 'id': json['id'],
82
+ 'key': ScriptKeyFromJSON(json['key']),
83
+ 'language': json['language'],
84
+ 'manifest': json['manifest'] == null ? undefined : json['manifest'],
85
+ 'name': json['name'],
86
+ 'project': json['project'] == null ? undefined : json['project'],
87
+ 'revision': json['revision'],
88
+ 'runs': (json['runs'].map(ScriptExportRunFromJSON)),
89
+ 'runsError': json['runsError'] == null ? undefined : json['runsError'],
90
+ 'runtime': json['runtime'] == null ? undefined : ScriptRuntimeFromJSON(json['runtime']),
91
+ 'schedule': ScriptScheduleFromJSON(json['schedule']),
92
+ 'secretNames': json['secretNames'],
93
+ 'type': json['type'],
94
+ 'updatedAt': (new Date(json['updatedAt'])),
95
+ 'webhook': json['webhook'],
96
+ 'webhookUrl': json['webhookUrl'] == null ? undefined : json['webhookUrl'],
97
+ };
98
+ }
99
+ export function ScriptExportToJSON(json) {
100
+ return ScriptExportToJSONTyped(json, false);
101
+ }
102
+ export function ScriptExportToJSONTyped(value, ignoreDiscriminator = false) {
103
+ if (value == null) {
104
+ return value;
105
+ }
106
+ return {
107
+ 'createdAt': ((value['createdAt']).toISOString()),
108
+ 'createdBy': value['createdBy'],
109
+ 'description': value['description'],
110
+ 'enabled': value['enabled'],
111
+ 'files': value['files'],
112
+ 'id': value['id'],
113
+ 'key': ScriptKeyToJSON(value['key']),
114
+ 'language': value['language'],
115
+ 'manifest': value['manifest'],
116
+ 'name': value['name'],
117
+ 'project': value['project'],
118
+ 'revision': value['revision'],
119
+ 'runs': (value['runs'].map(ScriptExportRunToJSON)),
120
+ 'runsError': value['runsError'],
121
+ 'runtime': ScriptRuntimeToJSON(value['runtime']),
122
+ 'schedule': ScriptScheduleToJSON(value['schedule']),
123
+ 'secretNames': value['secretNames'],
124
+ 'type': value['type'],
125
+ 'updatedAt': ((value['updatedAt']).toISOString()),
126
+ 'webhook': value['webhook'],
127
+ 'webhookUrl': value['webhookUrl'],
128
+ };
129
+ }
@@ -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 { ScriptExport } from './ScriptExport';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ScriptExportResBody
17
+ */
18
+ export interface ScriptExportResBody {
19
+ /**
20
+ *
21
+ * @type {Date}
22
+ * @memberof ScriptExportResBody
23
+ */
24
+ exportedAt: Date;
25
+ /**
26
+ *
27
+ * @type {Array<ScriptExport>}
28
+ * @memberof ScriptExportResBody
29
+ */
30
+ scripts: Array<ScriptExport>;
31
+ }
32
+ /**
33
+ * Check if a given object implements the ScriptExportResBody interface.
34
+ */
35
+ export declare function instanceOfScriptExportResBody(value: object): value is ScriptExportResBody;
36
+ export declare function ScriptExportResBodyFromJSON(json: any): ScriptExportResBody;
37
+ export declare function ScriptExportResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptExportResBody;
38
+ export declare function ScriptExportResBodyToJSON(json: any): ScriptExportResBody;
39
+ export declare function ScriptExportResBodyToJSONTyped(value?: ScriptExportResBody | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,48 @@
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
+ import { ScriptExportFromJSON, ScriptExportToJSON, } from './ScriptExport';
15
+ /**
16
+ * Check if a given object implements the ScriptExportResBody interface.
17
+ */
18
+ export function instanceOfScriptExportResBody(value) {
19
+ if (!('exportedAt' in value) || value['exportedAt'] === undefined)
20
+ return false;
21
+ if (!('scripts' in value) || value['scripts'] === undefined)
22
+ return false;
23
+ return true;
24
+ }
25
+ export function ScriptExportResBodyFromJSON(json) {
26
+ return ScriptExportResBodyFromJSONTyped(json, false);
27
+ }
28
+ export function ScriptExportResBodyFromJSONTyped(json, ignoreDiscriminator) {
29
+ if (json == null) {
30
+ return json;
31
+ }
32
+ return {
33
+ 'exportedAt': (new Date(json['exportedAt'])),
34
+ 'scripts': (json['scripts'].map(ScriptExportFromJSON)),
35
+ };
36
+ }
37
+ export function ScriptExportResBodyToJSON(json) {
38
+ return ScriptExportResBodyToJSONTyped(json, false);
39
+ }
40
+ export function ScriptExportResBodyToJSONTyped(value, ignoreDiscriminator = false) {
41
+ if (value == null) {
42
+ return value;
43
+ }
44
+ return {
45
+ 'exportedAt': ((value['exportedAt']).toISOString()),
46
+ 'scripts': (value['scripts'].map(ScriptExportToJSON)),
47
+ };
48
+ }
@@ -0,0 +1,92 @@
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 ScriptExportRun
16
+ */
17
+ export interface ScriptExportRun {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof ScriptExportRun
22
+ */
23
+ durationMs?: number;
24
+ /**
25
+ *
26
+ * @type {Date}
27
+ * @memberof ScriptExportRun
28
+ */
29
+ endedAt?: Date;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof ScriptExportRun
34
+ */
35
+ exitCode: number;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof ScriptExportRun
40
+ */
41
+ id: string;
42
+ /**
43
+ * "build" for a dependency build, "run" for an execution.
44
+ * @type {string}
45
+ * @memberof ScriptExportRun
46
+ */
47
+ kind: string;
48
+ /**
49
+ * API path that returns the run's logs while the run is kept.
50
+ * @type {string}
51
+ * @memberof ScriptExportRun
52
+ */
53
+ logsPath: string;
54
+ /**
55
+ *
56
+ * @type {string}
57
+ * @memberof ScriptExportRun
58
+ */
59
+ message?: string;
60
+ /**
61
+ *
62
+ * @type {Date}
63
+ * @memberof ScriptExportRun
64
+ */
65
+ queuedAt?: Date;
66
+ /**
67
+ *
68
+ * @type {Date}
69
+ * @memberof ScriptExportRun
70
+ */
71
+ startedAt?: Date;
72
+ /**
73
+ *
74
+ * @type {string}
75
+ * @memberof ScriptExportRun
76
+ */
77
+ status: string;
78
+ /**
79
+ *
80
+ * @type {string}
81
+ * @memberof ScriptExportRun
82
+ */
83
+ trigger: string;
84
+ }
85
+ /**
86
+ * Check if a given object implements the ScriptExportRun interface.
87
+ */
88
+ export declare function instanceOfScriptExportRun(value: object): value is ScriptExportRun;
89
+ export declare function ScriptExportRunFromJSON(json: any): ScriptExportRun;
90
+ export declare function ScriptExportRunFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptExportRun;
91
+ export declare function ScriptExportRunToJSON(json: any): ScriptExportRun;
92
+ export declare function ScriptExportRunToJSONTyped(value?: ScriptExportRun | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,73 @@
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
+ * Check if a given object implements the ScriptExportRun interface.
16
+ */
17
+ export function instanceOfScriptExportRun(value) {
18
+ if (!('exitCode' in value) || value['exitCode'] === undefined)
19
+ return false;
20
+ if (!('id' in value) || value['id'] === undefined)
21
+ return false;
22
+ if (!('kind' in value) || value['kind'] === undefined)
23
+ return false;
24
+ if (!('logsPath' in value) || value['logsPath'] === undefined)
25
+ return false;
26
+ if (!('status' in value) || value['status'] === undefined)
27
+ return false;
28
+ if (!('trigger' in value) || value['trigger'] === undefined)
29
+ return false;
30
+ return true;
31
+ }
32
+ export function ScriptExportRunFromJSON(json) {
33
+ return ScriptExportRunFromJSONTyped(json, false);
34
+ }
35
+ export function ScriptExportRunFromJSONTyped(json, ignoreDiscriminator) {
36
+ if (json == null) {
37
+ return json;
38
+ }
39
+ return {
40
+ 'durationMs': json['durationMs'] == null ? undefined : json['durationMs'],
41
+ 'endedAt': json['endedAt'] == null ? undefined : (new Date(json['endedAt'])),
42
+ 'exitCode': json['exitCode'],
43
+ 'id': json['id'],
44
+ 'kind': json['kind'],
45
+ 'logsPath': json['logsPath'],
46
+ 'message': json['message'] == null ? undefined : json['message'],
47
+ 'queuedAt': json['queuedAt'] == null ? undefined : (new Date(json['queuedAt'])),
48
+ 'startedAt': json['startedAt'] == null ? undefined : (new Date(json['startedAt'])),
49
+ 'status': json['status'],
50
+ 'trigger': json['trigger'],
51
+ };
52
+ }
53
+ export function ScriptExportRunToJSON(json) {
54
+ return ScriptExportRunToJSONTyped(json, false);
55
+ }
56
+ export function ScriptExportRunToJSONTyped(value, ignoreDiscriminator = false) {
57
+ if (value == null) {
58
+ return value;
59
+ }
60
+ return {
61
+ 'durationMs': value['durationMs'],
62
+ 'endedAt': value['endedAt'] == null ? undefined : ((value['endedAt']).toISOString()),
63
+ 'exitCode': value['exitCode'],
64
+ 'id': value['id'],
65
+ 'kind': value['kind'],
66
+ 'logsPath': value['logsPath'],
67
+ 'message': value['message'],
68
+ 'queuedAt': value['queuedAt'] == null ? undefined : ((value['queuedAt']).toISOString()),
69
+ 'startedAt': value['startedAt'] == null ? undefined : ((value['startedAt']).toISOString()),
70
+ 'status': value['status'],
71
+ 'trigger': value['trigger'],
72
+ };
73
+ }
@@ -0,0 +1,64 @@
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 ScriptKey
16
+ */
17
+ export interface ScriptKey {
18
+ /**
19
+ *
20
+ * @type {Date}
21
+ * @memberof ScriptKey
22
+ */
23
+ expiresAt?: Date;
24
+ /**
25
+ * Why the last automatic rotation failed or why the key needs re-authorising.
26
+ * @type {string}
27
+ * @memberof ScriptKey
28
+ */
29
+ lastError?: string;
30
+ /**
31
+ * User whose permissions the key acts with.
32
+ * @type {number}
33
+ * @memberof ScriptKey
34
+ */
35
+ ownerUserId?: number;
36
+ /**
37
+ * When the key is next replaced automatically.
38
+ * @type {Date}
39
+ * @memberof ScriptKey
40
+ */
41
+ rotateAt?: Date;
42
+ /**
43
+ * Whether the script's Spaciv API key is usable. While "needs_reauthorisation", runs are paused until someone with *Manage my account* re-authorises it.
44
+ * @type {string}
45
+ * @memberof ScriptKey
46
+ */
47
+ status: ScriptKeyStatusEnum;
48
+ }
49
+ /**
50
+ * @export
51
+ */
52
+ export declare const ScriptKeyStatusEnum: {
53
+ readonly Active: "active";
54
+ readonly NeedsReauthorisation: "needs_reauthorisation";
55
+ };
56
+ export type ScriptKeyStatusEnum = typeof ScriptKeyStatusEnum[keyof typeof ScriptKeyStatusEnum];
57
+ /**
58
+ * Check if a given object implements the ScriptKey interface.
59
+ */
60
+ export declare function instanceOfScriptKey(value: object): value is ScriptKey;
61
+ export declare function ScriptKeyFromJSON(json: any): ScriptKey;
62
+ export declare function ScriptKeyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptKey;
63
+ export declare function ScriptKeyToJSON(json: any): ScriptKey;
64
+ export declare function ScriptKeyToJSONTyped(value?: ScriptKey | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,58 @@
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
+ * @export
16
+ */
17
+ export const ScriptKeyStatusEnum = {
18
+ Active: 'active',
19
+ NeedsReauthorisation: 'needs_reauthorisation'
20
+ };
21
+ /**
22
+ * Check if a given object implements the ScriptKey interface.
23
+ */
24
+ export function instanceOfScriptKey(value) {
25
+ if (!('status' in value) || value['status'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ export function ScriptKeyFromJSON(json) {
30
+ return ScriptKeyFromJSONTyped(json, false);
31
+ }
32
+ export function ScriptKeyFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'expiresAt': json['expiresAt'] == null ? undefined : (new Date(json['expiresAt'])),
38
+ 'lastError': json['lastError'] == null ? undefined : json['lastError'],
39
+ 'ownerUserId': json['ownerUserId'] == null ? undefined : json['ownerUserId'],
40
+ 'rotateAt': json['rotateAt'] == null ? undefined : (new Date(json['rotateAt'])),
41
+ 'status': json['status'],
42
+ };
43
+ }
44
+ export function ScriptKeyToJSON(json) {
45
+ return ScriptKeyToJSONTyped(json, false);
46
+ }
47
+ export function ScriptKeyToJSONTyped(value, ignoreDiscriminator = false) {
48
+ if (value == null) {
49
+ return value;
50
+ }
51
+ return {
52
+ 'expiresAt': value['expiresAt'] == null ? undefined : ((value['expiresAt']).toISOString()),
53
+ 'lastError': value['lastError'],
54
+ 'ownerUserId': value['ownerUserId'],
55
+ 'rotateAt': value['rotateAt'] == null ? undefined : ((value['rotateAt']).toISOString()),
56
+ 'status': value['status'],
57
+ };
58
+ }
@@ -0,0 +1,33 @@
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 { ScriptSummary } from './ScriptSummary';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ScriptListResBody
17
+ */
18
+ export interface ScriptListResBody {
19
+ /**
20
+ *
21
+ * @type {Array<ScriptSummary>}
22
+ * @memberof ScriptListResBody
23
+ */
24
+ scripts: Array<ScriptSummary>;
25
+ }
26
+ /**
27
+ * Check if a given object implements the ScriptListResBody interface.
28
+ */
29
+ export declare function instanceOfScriptListResBody(value: object): value is ScriptListResBody;
30
+ export declare function ScriptListResBodyFromJSON(json: any): ScriptListResBody;
31
+ export declare function ScriptListResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptListResBody;
32
+ export declare function ScriptListResBodyToJSON(json: any): ScriptListResBody;
33
+ export declare function ScriptListResBodyToJSONTyped(value?: ScriptListResBody | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,44 @@
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
+ import { ScriptSummaryFromJSON, ScriptSummaryToJSON, } from './ScriptSummary';
15
+ /**
16
+ * Check if a given object implements the ScriptListResBody interface.
17
+ */
18
+ export function instanceOfScriptListResBody(value) {
19
+ if (!('scripts' in value) || value['scripts'] === undefined)
20
+ return false;
21
+ return true;
22
+ }
23
+ export function ScriptListResBodyFromJSON(json) {
24
+ return ScriptListResBodyFromJSONTyped(json, false);
25
+ }
26
+ export function ScriptListResBodyFromJSONTyped(json, ignoreDiscriminator) {
27
+ if (json == null) {
28
+ return json;
29
+ }
30
+ return {
31
+ 'scripts': (json['scripts'].map(ScriptSummaryFromJSON)),
32
+ };
33
+ }
34
+ export function ScriptListResBodyToJSON(json) {
35
+ return ScriptListResBodyToJSONTyped(json, false);
36
+ }
37
+ export function ScriptListResBodyToJSONTyped(value, ignoreDiscriminator = false) {
38
+ if (value == null) {
39
+ return value;
40
+ }
41
+ return {
42
+ 'scripts': (value['scripts'].map(ScriptSummaryToJSON)),
43
+ };
44
+ }
@@ -0,0 +1,38 @@
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 ScriptLogLine
16
+ */
17
+ export interface ScriptLogLine {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof ScriptLogLine
22
+ */
23
+ message: string;
24
+ /**
25
+ *
26
+ * @type {Date}
27
+ * @memberof ScriptLogLine
28
+ */
29
+ timestamp: Date;
30
+ }
31
+ /**
32
+ * Check if a given object implements the ScriptLogLine interface.
33
+ */
34
+ export declare function instanceOfScriptLogLine(value: object): value is ScriptLogLine;
35
+ export declare function ScriptLogLineFromJSON(json: any): ScriptLogLine;
36
+ export declare function ScriptLogLineFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptLogLine;
37
+ export declare function ScriptLogLineToJSON(json: any): ScriptLogLine;
38
+ export declare function ScriptLogLineToJSONTyped(value?: ScriptLogLine | null, ignoreDiscriminator?: boolean): any;