@spaciv/sdk 0.1.1 → 0.1.3

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 (191) hide show
  1. package/.openapi-generator/FILES +25 -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/VariableData.d.ts +2 -1
  72. package/dist/esm/models/VariableData.js +7 -0
  73. package/dist/esm/models/VariableDataOneOf2.d.ts +3 -3
  74. package/dist/esm/models/VariableDataOneOf2.js +4 -4
  75. package/dist/esm/models/VariableDataOneOf3.d.ts +3 -3
  76. package/dist/esm/models/VariableDataOneOf3.js +4 -4
  77. package/dist/esm/models/VariableDataOneOf4.d.ts +3 -3
  78. package/dist/esm/models/VariableDataOneOf4.js +4 -4
  79. package/dist/esm/models/VariableDataOneOf5.d.ts +3 -2
  80. package/dist/esm/models/VariableDataOneOf5.js +4 -3
  81. package/dist/esm/models/VariableDataOneOf6.d.ts +1 -1
  82. package/dist/esm/models/VariableDataOneOf6.js +3 -3
  83. package/dist/esm/models/VariableDataOneOf7.d.ts +32 -0
  84. package/dist/esm/models/VariableDataOneOf7.js +43 -0
  85. package/dist/esm/models/VariableDate.d.ts +50 -0
  86. package/dist/esm/models/VariableDate.js +55 -0
  87. package/dist/esm/models/index.d.ts +24 -0
  88. package/dist/esm/models/index.js +24 -0
  89. package/dist/models/APIKey.d.ts +6 -0
  90. package/dist/models/APIKey.js +2 -0
  91. package/dist/models/ScriptAuditEntry.d.ts +67 -0
  92. package/dist/models/ScriptAuditEntry.js +71 -0
  93. package/dist/models/ScriptAuditResBody.d.ts +39 -0
  94. package/dist/models/ScriptAuditResBody.js +53 -0
  95. package/dist/models/ScriptDetail.d.ts +161 -0
  96. package/dist/models/ScriptDetail.js +130 -0
  97. package/dist/models/ScriptExport.d.ts +174 -0
  98. package/dist/models/ScriptExport.js +137 -0
  99. package/dist/models/ScriptExportResBody.d.ts +39 -0
  100. package/dist/models/ScriptExportResBody.js +55 -0
  101. package/dist/models/ScriptExportRun.d.ts +92 -0
  102. package/dist/models/ScriptExportRun.js +80 -0
  103. package/dist/models/ScriptKey.d.ts +64 -0
  104. package/dist/models/ScriptKey.js +66 -0
  105. package/dist/models/ScriptListResBody.d.ts +33 -0
  106. package/dist/models/ScriptListResBody.js +51 -0
  107. package/dist/models/ScriptLogLine.d.ts +38 -0
  108. package/dist/models/ScriptLogLine.js +54 -0
  109. package/dist/models/ScriptPatchReqBody.d.ts +98 -0
  110. package/dist/models/ScriptPatchReqBody.js +78 -0
  111. package/dist/models/ScriptPostReqBody.d.ts +113 -0
  112. package/dist/models/ScriptPostReqBody.js +90 -0
  113. package/dist/models/ScriptRun.d.ts +86 -0
  114. package/dist/models/ScriptRun.js +76 -0
  115. package/dist/models/ScriptRunLogsResBody.d.ts +39 -0
  116. package/dist/models/ScriptRunLogsResBody.js +55 -0
  117. package/dist/models/ScriptRunsResBody.d.ts +39 -0
  118. package/dist/models/ScriptRunsResBody.js +53 -0
  119. package/dist/models/ScriptRuntime.d.ts +62 -0
  120. package/dist/models/ScriptRuntime.js +58 -0
  121. package/dist/models/ScriptSchedule.d.ts +38 -0
  122. package/dist/models/ScriptSchedule.js +50 -0
  123. package/dist/models/ScriptSchedulePreviewReqBody.d.ts +44 -0
  124. package/dist/models/ScriptSchedulePreviewReqBody.js +52 -0
  125. package/dist/models/ScriptSchedulePreviewResBody.d.ts +44 -0
  126. package/dist/models/ScriptSchedulePreviewResBody.js +56 -0
  127. package/dist/models/ScriptSecretsReqBody.d.ts +40 -0
  128. package/dist/models/ScriptSecretsReqBody.js +50 -0
  129. package/dist/models/ScriptSecretsResBody.d.ts +134 -0
  130. package/dist/models/ScriptSecretsResBody.js +119 -0
  131. package/dist/models/ScriptSummary.d.ts +128 -0
  132. package/dist/models/ScriptSummary.js +115 -0
  133. package/dist/models/ScriptWebhookResBody.d.ts +32 -0
  134. package/dist/models/ScriptWebhookResBody.js +50 -0
  135. package/dist/models/VariableData.d.ts +2 -1
  136. package/dist/models/VariableData.js +7 -0
  137. package/dist/models/VariableDataOneOf2.d.ts +3 -3
  138. package/dist/models/VariableDataOneOf2.js +4 -4
  139. package/dist/models/VariableDataOneOf3.d.ts +3 -3
  140. package/dist/models/VariableDataOneOf3.js +4 -4
  141. package/dist/models/VariableDataOneOf4.d.ts +3 -3
  142. package/dist/models/VariableDataOneOf4.js +4 -4
  143. package/dist/models/VariableDataOneOf5.d.ts +3 -2
  144. package/dist/models/VariableDataOneOf5.js +4 -3
  145. package/dist/models/VariableDataOneOf6.d.ts +1 -1
  146. package/dist/models/VariableDataOneOf6.js +3 -3
  147. package/dist/models/VariableDataOneOf7.d.ts +32 -0
  148. package/dist/models/VariableDataOneOf7.js +50 -0
  149. package/dist/models/VariableDate.d.ts +50 -0
  150. package/dist/models/VariableDate.js +62 -0
  151. package/dist/models/index.d.ts +24 -0
  152. package/dist/models/index.js +24 -0
  153. package/package.json +1 -1
  154. package/src/apis/AccountsApi.ts +24 -24
  155. package/src/apis/AuditLogApi.ts +1 -1
  156. package/src/apis/AuthenticationApi.ts +8 -8
  157. package/src/apis/ScriptsApi.ts +984 -0
  158. package/src/apis/UsersApi.ts +4 -4
  159. package/src/apis/index.ts +1 -0
  160. package/src/models/APIKey.ts +8 -0
  161. package/src/models/ScriptAuditEntry.ts +112 -0
  162. package/src/models/ScriptAuditResBody.ts +82 -0
  163. package/src/models/ScriptDetail.ts +265 -0
  164. package/src/models/ScriptExport.ts +289 -0
  165. package/src/models/ScriptExportResBody.ts +83 -0
  166. package/src/models/ScriptExportRun.ts +151 -0
  167. package/src/models/ScriptKey.ts +109 -0
  168. package/src/models/ScriptListResBody.ts +74 -0
  169. package/src/models/ScriptLogLine.ts +75 -0
  170. package/src/models/ScriptPatchReqBody.ts +158 -0
  171. package/src/models/ScriptPostReqBody.ts +176 -0
  172. package/src/models/ScriptRun.ts +142 -0
  173. package/src/models/ScriptRunLogsResBody.ts +83 -0
  174. package/src/models/ScriptRunsResBody.ts +82 -0
  175. package/src/models/ScriptRuntime.ts +105 -0
  176. package/src/models/ScriptSchedule.ts +73 -0
  177. package/src/models/ScriptSchedulePreviewReqBody.ts +81 -0
  178. package/src/models/ScriptSchedulePreviewResBody.ts +83 -0
  179. package/src/models/ScriptSecretsReqBody.ts +73 -0
  180. package/src/models/ScriptSecretsResBody.ts +225 -0
  181. package/src/models/ScriptSummary.ts +216 -0
  182. package/src/models/ScriptWebhookResBody.ts +66 -0
  183. package/src/models/VariableData.ts +14 -1
  184. package/src/models/VariableDataOneOf2.ts +11 -11
  185. package/src/models/VariableDataOneOf3.ts +11 -11
  186. package/src/models/VariableDataOneOf4.ts +11 -11
  187. package/src/models/VariableDataOneOf5.ts +13 -5
  188. package/src/models/VariableDataOneOf6.ts +4 -4
  189. package/src/models/VariableDataOneOf7.ts +66 -0
  190. package/src/models/VariableDate.ts +93 -0
  191. package/src/models/index.ts +24 -0
@@ -0,0 +1,67 @@
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 ScriptAuditEntry
16
+ */
17
+ export interface ScriptAuditEntry {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof ScriptAuditEntry
22
+ */
23
+ actorType: ScriptAuditEntryActorTypeEnum;
24
+ /**
25
+ * What changed, for example created, updated, api-key-rotated or needs-reauthorisation.
26
+ * @type {string}
27
+ * @memberof ScriptAuditEntry
28
+ */
29
+ kind: string;
30
+ /**
31
+ *
32
+ * @type {Date}
33
+ * @memberof ScriptAuditEntry
34
+ */
35
+ modifiedAt: Date;
36
+ /**
37
+ * User who made the change, when actorType is user.
38
+ * @type {number}
39
+ * @memberof ScriptAuditEntry
40
+ */
41
+ modifiedBy?: number;
42
+ /**
43
+ *
44
+ * @type {{ [key: string]: string; }}
45
+ * @memberof ScriptAuditEntry
46
+ */
47
+ params?: {
48
+ [key: string]: string;
49
+ };
50
+ }
51
+ /**
52
+ * @export
53
+ */
54
+ export declare const ScriptAuditEntryActorTypeEnum: {
55
+ readonly User: "user";
56
+ readonly System: "system";
57
+ readonly Anonymous: "anonymous";
58
+ };
59
+ export type ScriptAuditEntryActorTypeEnum = typeof ScriptAuditEntryActorTypeEnum[keyof typeof ScriptAuditEntryActorTypeEnum];
60
+ /**
61
+ * Check if a given object implements the ScriptAuditEntry interface.
62
+ */
63
+ export declare function instanceOfScriptAuditEntry(value: object): value is ScriptAuditEntry;
64
+ export declare function ScriptAuditEntryFromJSON(json: any): ScriptAuditEntry;
65
+ export declare function ScriptAuditEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptAuditEntry;
66
+ export declare function ScriptAuditEntryToJSON(json: any): ScriptAuditEntry;
67
+ export declare function ScriptAuditEntryToJSONTyped(value?: ScriptAuditEntry | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,63 @@
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 ScriptAuditEntryActorTypeEnum = {
18
+ User: 'user',
19
+ System: 'system',
20
+ Anonymous: 'anonymous'
21
+ };
22
+ /**
23
+ * Check if a given object implements the ScriptAuditEntry interface.
24
+ */
25
+ export function instanceOfScriptAuditEntry(value) {
26
+ if (!('actorType' in value) || value['actorType'] === undefined)
27
+ return false;
28
+ if (!('kind' in value) || value['kind'] === undefined)
29
+ return false;
30
+ if (!('modifiedAt' in value) || value['modifiedAt'] === undefined)
31
+ return false;
32
+ return true;
33
+ }
34
+ export function ScriptAuditEntryFromJSON(json) {
35
+ return ScriptAuditEntryFromJSONTyped(json, false);
36
+ }
37
+ export function ScriptAuditEntryFromJSONTyped(json, ignoreDiscriminator) {
38
+ if (json == null) {
39
+ return json;
40
+ }
41
+ return {
42
+ 'actorType': json['actorType'],
43
+ 'kind': json['kind'],
44
+ 'modifiedAt': (new Date(json['modifiedAt'])),
45
+ 'modifiedBy': json['modifiedBy'] == null ? undefined : json['modifiedBy'],
46
+ 'params': json['params'] == null ? undefined : json['params'],
47
+ };
48
+ }
49
+ export function ScriptAuditEntryToJSON(json) {
50
+ return ScriptAuditEntryToJSONTyped(json, false);
51
+ }
52
+ export function ScriptAuditEntryToJSONTyped(value, ignoreDiscriminator = false) {
53
+ if (value == null) {
54
+ return value;
55
+ }
56
+ return {
57
+ 'actorType': value['actorType'],
58
+ 'kind': value['kind'],
59
+ 'modifiedAt': ((value['modifiedAt']).toISOString()),
60
+ 'modifiedBy': value['modifiedBy'],
61
+ 'params': value['params'],
62
+ };
63
+ }
@@ -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 { ScriptAuditEntry } from './ScriptAuditEntry';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ScriptAuditResBody
17
+ */
18
+ export interface ScriptAuditResBody {
19
+ /**
20
+ *
21
+ * @type {Array<ScriptAuditEntry>}
22
+ * @memberof ScriptAuditResBody
23
+ */
24
+ entries: Array<ScriptAuditEntry>;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof ScriptAuditResBody
29
+ */
30
+ nextCursor?: string;
31
+ }
32
+ /**
33
+ * Check if a given object implements the ScriptAuditResBody interface.
34
+ */
35
+ export declare function instanceOfScriptAuditResBody(value: object): value is ScriptAuditResBody;
36
+ export declare function ScriptAuditResBodyFromJSON(json: any): ScriptAuditResBody;
37
+ export declare function ScriptAuditResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptAuditResBody;
38
+ export declare function ScriptAuditResBodyToJSON(json: any): ScriptAuditResBody;
39
+ export declare function ScriptAuditResBodyToJSONTyped(value?: ScriptAuditResBody | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,46 @@
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 { ScriptAuditEntryFromJSON, ScriptAuditEntryToJSON, } from './ScriptAuditEntry';
15
+ /**
16
+ * Check if a given object implements the ScriptAuditResBody interface.
17
+ */
18
+ export function instanceOfScriptAuditResBody(value) {
19
+ if (!('entries' in value) || value['entries'] === undefined)
20
+ return false;
21
+ return true;
22
+ }
23
+ export function ScriptAuditResBodyFromJSON(json) {
24
+ return ScriptAuditResBodyFromJSONTyped(json, false);
25
+ }
26
+ export function ScriptAuditResBodyFromJSONTyped(json, ignoreDiscriminator) {
27
+ if (json == null) {
28
+ return json;
29
+ }
30
+ return {
31
+ 'entries': (json['entries'].map(ScriptAuditEntryFromJSON)),
32
+ 'nextCursor': json['nextCursor'] == null ? undefined : json['nextCursor'],
33
+ };
34
+ }
35
+ export function ScriptAuditResBodyToJSON(json) {
36
+ return ScriptAuditResBodyToJSONTyped(json, false);
37
+ }
38
+ export function ScriptAuditResBodyToJSONTyped(value, ignoreDiscriminator = false) {
39
+ if (value == null) {
40
+ return value;
41
+ }
42
+ return {
43
+ 'entries': (value['entries'].map(ScriptAuditEntryToJSON)),
44
+ 'nextCursor': value['nextCursor'],
45
+ };
46
+ }
@@ -0,0 +1,161 @@
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 { ScriptKey } from './ScriptKey';
13
+ import type { ScriptSchedule } from './ScriptSchedule';
14
+ import type { ScriptRuntime } from './ScriptRuntime';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface ScriptDetail
19
+ */
20
+ export interface ScriptDetail {
21
+ /**
22
+ *
23
+ * @type {Date}
24
+ * @memberof ScriptDetail
25
+ */
26
+ createdAt: Date;
27
+ /**
28
+ *
29
+ * @type {number}
30
+ * @memberof ScriptDetail
31
+ */
32
+ createdBy: number;
33
+ /**
34
+ *
35
+ * @type {string}
36
+ * @memberof ScriptDetail
37
+ */
38
+ description?: string;
39
+ /**
40
+ *
41
+ * @type {boolean}
42
+ * @memberof ScriptDetail
43
+ */
44
+ enabled: boolean;
45
+ /**
46
+ * Source files keyed by path.
47
+ * @type {{ [key: string]: string; }}
48
+ * @memberof ScriptDetail
49
+ */
50
+ files: {
51
+ [key: string]: string;
52
+ };
53
+ /**
54
+ *
55
+ * @type {string}
56
+ * @memberof ScriptDetail
57
+ */
58
+ id: string;
59
+ /**
60
+ *
61
+ * @type {ScriptKey}
62
+ * @memberof ScriptDetail
63
+ */
64
+ key: ScriptKey;
65
+ /**
66
+ *
67
+ * @type {string}
68
+ * @memberof ScriptDetail
69
+ */
70
+ language: ScriptDetailLanguageEnum;
71
+ /**
72
+ * Dependency manifest: requirements.txt for Python, go.mod for Go, package.json for JavaScript.
73
+ * @type {string}
74
+ * @memberof ScriptDetail
75
+ */
76
+ manifest?: string;
77
+ /**
78
+ *
79
+ * @type {string}
80
+ * @memberof ScriptDetail
81
+ */
82
+ name: string;
83
+ /**
84
+ * Project the script's API key is scoped to. Absent when it acts across the account.
85
+ * @type {number}
86
+ * @memberof ScriptDetail
87
+ */
88
+ project?: number;
89
+ /**
90
+ * Pass back when updating, so a concurrent change is reported rather than overwritten.
91
+ * @type {number}
92
+ * @memberof ScriptDetail
93
+ */
94
+ revision: number;
95
+ /**
96
+ * Live state from the runner; absent if the runner could not be reached.
97
+ * @type {ScriptRuntime}
98
+ * @memberof ScriptDetail
99
+ */
100
+ runtime?: ScriptRuntime;
101
+ /**
102
+ *
103
+ * @type {ScriptSchedule}
104
+ * @memberof ScriptDetail
105
+ */
106
+ schedule: ScriptSchedule;
107
+ /**
108
+ * Names of the secrets set on the script. Values are never returned.
109
+ * @type {Array<string>}
110
+ * @memberof ScriptDetail
111
+ */
112
+ secretNames: Array<string>;
113
+ /**
114
+ * The handler signature the script implements.
115
+ * @type {string}
116
+ * @memberof ScriptDetail
117
+ */
118
+ type: ScriptDetailTypeEnum;
119
+ /**
120
+ *
121
+ * @type {Date}
122
+ * @memberof ScriptDetail
123
+ */
124
+ updatedAt: Date;
125
+ /**
126
+ *
127
+ * @type {boolean}
128
+ * @memberof ScriptDetail
129
+ */
130
+ webhook: boolean;
131
+ /**
132
+ * Returned only when a webhook URL is first issued; it cannot be retrieved later.
133
+ * @type {string}
134
+ * @memberof ScriptDetail
135
+ */
136
+ webhookUrl?: string;
137
+ }
138
+ /**
139
+ * @export
140
+ */
141
+ export declare const ScriptDetailLanguageEnum: {
142
+ readonly Python: "python";
143
+ readonly Go: "go";
144
+ readonly Javascript: "javascript";
145
+ };
146
+ export type ScriptDetailLanguageEnum = typeof ScriptDetailLanguageEnum[keyof typeof ScriptDetailLanguageEnum];
147
+ /**
148
+ * @export
149
+ */
150
+ export declare const ScriptDetailTypeEnum: {
151
+ readonly Integration: "integration";
152
+ };
153
+ export type ScriptDetailTypeEnum = typeof ScriptDetailTypeEnum[keyof typeof ScriptDetailTypeEnum];
154
+ /**
155
+ * Check if a given object implements the ScriptDetail interface.
156
+ */
157
+ export declare function instanceOfScriptDetail(value: object): value is ScriptDetail;
158
+ export declare function ScriptDetailFromJSON(json: any): ScriptDetail;
159
+ export declare function ScriptDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptDetail;
160
+ export declare function ScriptDetailToJSON(json: any): ScriptDetail;
161
+ export declare function ScriptDetailToJSONTyped(value?: ScriptDetail | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,122 @@
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
+ /**
18
+ * @export
19
+ */
20
+ export const ScriptDetailLanguageEnum = {
21
+ Python: 'python',
22
+ Go: 'go',
23
+ Javascript: 'javascript'
24
+ };
25
+ /**
26
+ * @export
27
+ */
28
+ export const ScriptDetailTypeEnum = {
29
+ Integration: 'integration'
30
+ };
31
+ /**
32
+ * Check if a given object implements the ScriptDetail interface.
33
+ */
34
+ export function instanceOfScriptDetail(value) {
35
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
36
+ return false;
37
+ if (!('createdBy' in value) || value['createdBy'] === undefined)
38
+ return false;
39
+ if (!('enabled' in value) || value['enabled'] === undefined)
40
+ return false;
41
+ if (!('files' in value) || value['files'] === undefined)
42
+ return false;
43
+ if (!('id' in value) || value['id'] === undefined)
44
+ return false;
45
+ if (!('key' in value) || value['key'] === undefined)
46
+ return false;
47
+ if (!('language' in value) || value['language'] === undefined)
48
+ return false;
49
+ if (!('name' in value) || value['name'] === undefined)
50
+ return false;
51
+ if (!('revision' in value) || value['revision'] === undefined)
52
+ return false;
53
+ if (!('schedule' in value) || value['schedule'] === undefined)
54
+ return false;
55
+ if (!('secretNames' in value) || value['secretNames'] === undefined)
56
+ return false;
57
+ if (!('type' in value) || value['type'] === undefined)
58
+ return false;
59
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined)
60
+ return false;
61
+ if (!('webhook' in value) || value['webhook'] === undefined)
62
+ return false;
63
+ return true;
64
+ }
65
+ export function ScriptDetailFromJSON(json) {
66
+ return ScriptDetailFromJSONTyped(json, false);
67
+ }
68
+ export function ScriptDetailFromJSONTyped(json, ignoreDiscriminator) {
69
+ if (json == null) {
70
+ return json;
71
+ }
72
+ return {
73
+ 'createdAt': (new Date(json['createdAt'])),
74
+ 'createdBy': json['createdBy'],
75
+ 'description': json['description'] == null ? undefined : json['description'],
76
+ 'enabled': json['enabled'],
77
+ 'files': json['files'],
78
+ 'id': json['id'],
79
+ 'key': ScriptKeyFromJSON(json['key']),
80
+ 'language': json['language'],
81
+ 'manifest': json['manifest'] == null ? undefined : json['manifest'],
82
+ 'name': json['name'],
83
+ 'project': json['project'] == null ? undefined : json['project'],
84
+ 'revision': json['revision'],
85
+ 'runtime': json['runtime'] == null ? undefined : ScriptRuntimeFromJSON(json['runtime']),
86
+ 'schedule': ScriptScheduleFromJSON(json['schedule']),
87
+ 'secretNames': json['secretNames'],
88
+ 'type': json['type'],
89
+ 'updatedAt': (new Date(json['updatedAt'])),
90
+ 'webhook': json['webhook'],
91
+ 'webhookUrl': json['webhookUrl'] == null ? undefined : json['webhookUrl'],
92
+ };
93
+ }
94
+ export function ScriptDetailToJSON(json) {
95
+ return ScriptDetailToJSONTyped(json, false);
96
+ }
97
+ export function ScriptDetailToJSONTyped(value, ignoreDiscriminator = false) {
98
+ if (value == null) {
99
+ return value;
100
+ }
101
+ return {
102
+ 'createdAt': ((value['createdAt']).toISOString()),
103
+ 'createdBy': value['createdBy'],
104
+ 'description': value['description'],
105
+ 'enabled': value['enabled'],
106
+ 'files': value['files'],
107
+ 'id': value['id'],
108
+ 'key': ScriptKeyToJSON(value['key']),
109
+ 'language': value['language'],
110
+ 'manifest': value['manifest'],
111
+ 'name': value['name'],
112
+ 'project': value['project'],
113
+ 'revision': value['revision'],
114
+ 'runtime': ScriptRuntimeToJSON(value['runtime']),
115
+ 'schedule': ScriptScheduleToJSON(value['schedule']),
116
+ 'secretNames': value['secretNames'],
117
+ 'type': value['type'],
118
+ 'updatedAt': ((value['updatedAt']).toISOString()),
119
+ 'webhook': value['webhook'],
120
+ 'webhookUrl': value['webhookUrl'],
121
+ };
122
+ }
@@ -0,0 +1,174 @@
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 { ScriptKey } from './ScriptKey';
13
+ import type { ScriptSchedule } from './ScriptSchedule';
14
+ import type { ScriptRuntime } from './ScriptRuntime';
15
+ import type { ScriptExportRun } from './ScriptExportRun';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface ScriptExport
20
+ */
21
+ export interface ScriptExport {
22
+ /**
23
+ *
24
+ * @type {Date}
25
+ * @memberof ScriptExport
26
+ */
27
+ createdAt: Date;
28
+ /**
29
+ *
30
+ * @type {number}
31
+ * @memberof ScriptExport
32
+ */
33
+ createdBy: number;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof ScriptExport
38
+ */
39
+ description?: string;
40
+ /**
41
+ *
42
+ * @type {boolean}
43
+ * @memberof ScriptExport
44
+ */
45
+ enabled: boolean;
46
+ /**
47
+ * Source files keyed by path.
48
+ * @type {{ [key: string]: string; }}
49
+ * @memberof ScriptExport
50
+ */
51
+ files: {
52
+ [key: string]: string;
53
+ };
54
+ /**
55
+ *
56
+ * @type {string}
57
+ * @memberof ScriptExport
58
+ */
59
+ id: string;
60
+ /**
61
+ *
62
+ * @type {ScriptKey}
63
+ * @memberof ScriptExport
64
+ */
65
+ key: ScriptKey;
66
+ /**
67
+ *
68
+ * @type {string}
69
+ * @memberof ScriptExport
70
+ */
71
+ language: ScriptExportLanguageEnum;
72
+ /**
73
+ * Dependency manifest: requirements.txt for Python, go.mod for Go, package.json for JavaScript.
74
+ * @type {string}
75
+ * @memberof ScriptExport
76
+ */
77
+ manifest?: string;
78
+ /**
79
+ *
80
+ * @type {string}
81
+ * @memberof ScriptExport
82
+ */
83
+ name: string;
84
+ /**
85
+ * Project the script's API key is scoped to. Absent when it acts across the account.
86
+ * @type {number}
87
+ * @memberof ScriptExport
88
+ */
89
+ project?: number;
90
+ /**
91
+ * Pass back when updating, so a concurrent change is reported rather than overwritten.
92
+ * @type {number}
93
+ * @memberof ScriptExport
94
+ */
95
+ revision: number;
96
+ /**
97
+ * Every build and run still kept, newest first.
98
+ * @type {Array<ScriptExportRun>}
99
+ * @memberof ScriptExport
100
+ */
101
+ runs: Array<ScriptExportRun>;
102
+ /**
103
+ * Set when the run history could not be read in full, in which case runs holds only the newest part that was read. Page through the script's runs endpoint for the rest.
104
+ * @type {string}
105
+ * @memberof ScriptExport
106
+ */
107
+ runsError?: string;
108
+ /**
109
+ * Live state from the runner; absent if the runner could not be reached.
110
+ * @type {ScriptRuntime}
111
+ * @memberof ScriptExport
112
+ */
113
+ runtime?: ScriptRuntime;
114
+ /**
115
+ *
116
+ * @type {ScriptSchedule}
117
+ * @memberof ScriptExport
118
+ */
119
+ schedule: ScriptSchedule;
120
+ /**
121
+ * Names of the secrets set on the script. Values are never returned.
122
+ * @type {Array<string>}
123
+ * @memberof ScriptExport
124
+ */
125
+ secretNames: Array<string>;
126
+ /**
127
+ * The handler signature the script implements.
128
+ * @type {string}
129
+ * @memberof ScriptExport
130
+ */
131
+ type: ScriptExportTypeEnum;
132
+ /**
133
+ *
134
+ * @type {Date}
135
+ * @memberof ScriptExport
136
+ */
137
+ updatedAt: Date;
138
+ /**
139
+ *
140
+ * @type {boolean}
141
+ * @memberof ScriptExport
142
+ */
143
+ webhook: boolean;
144
+ /**
145
+ * Returned only when a webhook URL is first issued; it cannot be retrieved later.
146
+ * @type {string}
147
+ * @memberof ScriptExport
148
+ */
149
+ webhookUrl?: string;
150
+ }
151
+ /**
152
+ * @export
153
+ */
154
+ export declare const ScriptExportLanguageEnum: {
155
+ readonly Python: "python";
156
+ readonly Go: "go";
157
+ readonly Javascript: "javascript";
158
+ };
159
+ export type ScriptExportLanguageEnum = typeof ScriptExportLanguageEnum[keyof typeof ScriptExportLanguageEnum];
160
+ /**
161
+ * @export
162
+ */
163
+ export declare const ScriptExportTypeEnum: {
164
+ readonly Integration: "integration";
165
+ };
166
+ export type ScriptExportTypeEnum = typeof ScriptExportTypeEnum[keyof typeof ScriptExportTypeEnum];
167
+ /**
168
+ * Check if a given object implements the ScriptExport interface.
169
+ */
170
+ export declare function instanceOfScriptExport(value: object): value is ScriptExport;
171
+ export declare function ScriptExportFromJSON(json: any): ScriptExport;
172
+ export declare function ScriptExportFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptExport;
173
+ export declare function ScriptExportToJSON(json: any): ScriptExport;
174
+ export declare function ScriptExportToJSONTyped(value?: ScriptExport | null, ignoreDiscriminator?: boolean): any;