@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,134 @@
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
+ /**
15
+ *
16
+ * @export
17
+ * @interface ScriptSecretsResBody
18
+ */
19
+ export interface ScriptSecretsResBody {
20
+ /**
21
+ *
22
+ * @type {Date}
23
+ * @memberof ScriptSecretsResBody
24
+ */
25
+ createdAt: Date;
26
+ /**
27
+ *
28
+ * @type {number}
29
+ * @memberof ScriptSecretsResBody
30
+ */
31
+ createdBy: number;
32
+ /**
33
+ *
34
+ * @type {string}
35
+ * @memberof ScriptSecretsResBody
36
+ */
37
+ description?: string;
38
+ /**
39
+ *
40
+ * @type {boolean}
41
+ * @memberof ScriptSecretsResBody
42
+ */
43
+ enabled: boolean;
44
+ /**
45
+ *
46
+ * @type {string}
47
+ * @memberof ScriptSecretsResBody
48
+ */
49
+ id: string;
50
+ /**
51
+ *
52
+ * @type {ScriptKey}
53
+ * @memberof ScriptSecretsResBody
54
+ */
55
+ key: ScriptKey;
56
+ /**
57
+ *
58
+ * @type {string}
59
+ * @memberof ScriptSecretsResBody
60
+ */
61
+ language: ScriptSecretsResBodyLanguageEnum;
62
+ /**
63
+ *
64
+ * @type {string}
65
+ * @memberof ScriptSecretsResBody
66
+ */
67
+ name: string;
68
+ /**
69
+ * Project the script's API key is scoped to. Absent when it acts across the account.
70
+ * @type {number}
71
+ * @memberof ScriptSecretsResBody
72
+ */
73
+ project?: number;
74
+ /**
75
+ * Pass back when updating, so a concurrent change is reported rather than overwritten.
76
+ * @type {number}
77
+ * @memberof ScriptSecretsResBody
78
+ */
79
+ revision: number;
80
+ /**
81
+ *
82
+ * @type {ScriptSchedule}
83
+ * @memberof ScriptSecretsResBody
84
+ */
85
+ schedule: ScriptSchedule;
86
+ /**
87
+ *
88
+ * @type {Array<string>}
89
+ * @memberof ScriptSecretsResBody
90
+ */
91
+ secretNames: Array<string>;
92
+ /**
93
+ * The handler signature the script implements.
94
+ * @type {string}
95
+ * @memberof ScriptSecretsResBody
96
+ */
97
+ type: ScriptSecretsResBodyTypeEnum;
98
+ /**
99
+ *
100
+ * @type {Date}
101
+ * @memberof ScriptSecretsResBody
102
+ */
103
+ updatedAt: Date;
104
+ /**
105
+ *
106
+ * @type {boolean}
107
+ * @memberof ScriptSecretsResBody
108
+ */
109
+ webhook: boolean;
110
+ }
111
+ /**
112
+ * @export
113
+ */
114
+ export declare const ScriptSecretsResBodyLanguageEnum: {
115
+ readonly Python: "python";
116
+ readonly Go: "go";
117
+ readonly Javascript: "javascript";
118
+ };
119
+ export type ScriptSecretsResBodyLanguageEnum = typeof ScriptSecretsResBodyLanguageEnum[keyof typeof ScriptSecretsResBodyLanguageEnum];
120
+ /**
121
+ * @export
122
+ */
123
+ export declare const ScriptSecretsResBodyTypeEnum: {
124
+ readonly Integration: "integration";
125
+ };
126
+ export type ScriptSecretsResBodyTypeEnum = typeof ScriptSecretsResBodyTypeEnum[keyof typeof ScriptSecretsResBodyTypeEnum];
127
+ /**
128
+ * Check if a given object implements the ScriptSecretsResBody interface.
129
+ */
130
+ export declare function instanceOfScriptSecretsResBody(value: object): value is ScriptSecretsResBody;
131
+ export declare function ScriptSecretsResBodyFromJSON(json: any): ScriptSecretsResBody;
132
+ export declare function ScriptSecretsResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptSecretsResBody;
133
+ export declare function ScriptSecretsResBodyToJSON(json: any): ScriptSecretsResBody;
134
+ export declare function ScriptSecretsResBodyToJSONTyped(value?: ScriptSecretsResBody | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,111 @@
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
+ /**
17
+ * @export
18
+ */
19
+ export const ScriptSecretsResBodyLanguageEnum = {
20
+ Python: 'python',
21
+ Go: 'go',
22
+ Javascript: 'javascript'
23
+ };
24
+ /**
25
+ * @export
26
+ */
27
+ export const ScriptSecretsResBodyTypeEnum = {
28
+ Integration: 'integration'
29
+ };
30
+ /**
31
+ * Check if a given object implements the ScriptSecretsResBody interface.
32
+ */
33
+ export function instanceOfScriptSecretsResBody(value) {
34
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
35
+ return false;
36
+ if (!('createdBy' in value) || value['createdBy'] === undefined)
37
+ return false;
38
+ if (!('enabled' in value) || value['enabled'] === undefined)
39
+ return false;
40
+ if (!('id' in value) || value['id'] === undefined)
41
+ return false;
42
+ if (!('key' in value) || value['key'] === undefined)
43
+ return false;
44
+ if (!('language' in value) || value['language'] === undefined)
45
+ return false;
46
+ if (!('name' in value) || value['name'] === undefined)
47
+ return false;
48
+ if (!('revision' in value) || value['revision'] === undefined)
49
+ return false;
50
+ if (!('schedule' in value) || value['schedule'] === undefined)
51
+ return false;
52
+ if (!('secretNames' in value) || value['secretNames'] === undefined)
53
+ return false;
54
+ if (!('type' in value) || value['type'] === undefined)
55
+ return false;
56
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined)
57
+ return false;
58
+ if (!('webhook' in value) || value['webhook'] === undefined)
59
+ return false;
60
+ return true;
61
+ }
62
+ export function ScriptSecretsResBodyFromJSON(json) {
63
+ return ScriptSecretsResBodyFromJSONTyped(json, false);
64
+ }
65
+ export function ScriptSecretsResBodyFromJSONTyped(json, ignoreDiscriminator) {
66
+ if (json == null) {
67
+ return json;
68
+ }
69
+ return {
70
+ 'createdAt': (new Date(json['createdAt'])),
71
+ 'createdBy': json['createdBy'],
72
+ 'description': json['description'] == null ? undefined : json['description'],
73
+ 'enabled': json['enabled'],
74
+ 'id': json['id'],
75
+ 'key': ScriptKeyFromJSON(json['key']),
76
+ 'language': json['language'],
77
+ 'name': json['name'],
78
+ 'project': json['project'] == null ? undefined : json['project'],
79
+ 'revision': json['revision'],
80
+ 'schedule': ScriptScheduleFromJSON(json['schedule']),
81
+ 'secretNames': json['secretNames'],
82
+ 'type': json['type'],
83
+ 'updatedAt': (new Date(json['updatedAt'])),
84
+ 'webhook': json['webhook'],
85
+ };
86
+ }
87
+ export function ScriptSecretsResBodyToJSON(json) {
88
+ return ScriptSecretsResBodyToJSONTyped(json, false);
89
+ }
90
+ export function ScriptSecretsResBodyToJSONTyped(value, ignoreDiscriminator = false) {
91
+ if (value == null) {
92
+ return value;
93
+ }
94
+ return {
95
+ 'createdAt': ((value['createdAt']).toISOString()),
96
+ 'createdBy': value['createdBy'],
97
+ 'description': value['description'],
98
+ 'enabled': value['enabled'],
99
+ 'id': value['id'],
100
+ 'key': ScriptKeyToJSON(value['key']),
101
+ 'language': value['language'],
102
+ 'name': value['name'],
103
+ 'project': value['project'],
104
+ 'revision': value['revision'],
105
+ 'schedule': ScriptScheduleToJSON(value['schedule']),
106
+ 'secretNames': value['secretNames'],
107
+ 'type': value['type'],
108
+ 'updatedAt': ((value['updatedAt']).toISOString()),
109
+ 'webhook': value['webhook'],
110
+ };
111
+ }
@@ -0,0 +1,128 @@
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
+ /**
15
+ *
16
+ * @export
17
+ * @interface ScriptSummary
18
+ */
19
+ export interface ScriptSummary {
20
+ /**
21
+ *
22
+ * @type {Date}
23
+ * @memberof ScriptSummary
24
+ */
25
+ createdAt: Date;
26
+ /**
27
+ *
28
+ * @type {number}
29
+ * @memberof ScriptSummary
30
+ */
31
+ createdBy: number;
32
+ /**
33
+ *
34
+ * @type {string}
35
+ * @memberof ScriptSummary
36
+ */
37
+ description?: string;
38
+ /**
39
+ *
40
+ * @type {boolean}
41
+ * @memberof ScriptSummary
42
+ */
43
+ enabled: boolean;
44
+ /**
45
+ *
46
+ * @type {string}
47
+ * @memberof ScriptSummary
48
+ */
49
+ id: string;
50
+ /**
51
+ *
52
+ * @type {ScriptKey}
53
+ * @memberof ScriptSummary
54
+ */
55
+ key: ScriptKey;
56
+ /**
57
+ *
58
+ * @type {string}
59
+ * @memberof ScriptSummary
60
+ */
61
+ language: ScriptSummaryLanguageEnum;
62
+ /**
63
+ *
64
+ * @type {string}
65
+ * @memberof ScriptSummary
66
+ */
67
+ name: string;
68
+ /**
69
+ * Project the script's API key is scoped to. Absent when it acts across the account.
70
+ * @type {number}
71
+ * @memberof ScriptSummary
72
+ */
73
+ project?: number;
74
+ /**
75
+ * Pass back when updating, so a concurrent change is reported rather than overwritten.
76
+ * @type {number}
77
+ * @memberof ScriptSummary
78
+ */
79
+ revision: number;
80
+ /**
81
+ *
82
+ * @type {ScriptSchedule}
83
+ * @memberof ScriptSummary
84
+ */
85
+ schedule: ScriptSchedule;
86
+ /**
87
+ * The handler signature the script implements.
88
+ * @type {string}
89
+ * @memberof ScriptSummary
90
+ */
91
+ type: ScriptSummaryTypeEnum;
92
+ /**
93
+ *
94
+ * @type {Date}
95
+ * @memberof ScriptSummary
96
+ */
97
+ updatedAt: Date;
98
+ /**
99
+ *
100
+ * @type {boolean}
101
+ * @memberof ScriptSummary
102
+ */
103
+ webhook: boolean;
104
+ }
105
+ /**
106
+ * @export
107
+ */
108
+ export declare const ScriptSummaryLanguageEnum: {
109
+ readonly Python: "python";
110
+ readonly Go: "go";
111
+ readonly Javascript: "javascript";
112
+ };
113
+ export type ScriptSummaryLanguageEnum = typeof ScriptSummaryLanguageEnum[keyof typeof ScriptSummaryLanguageEnum];
114
+ /**
115
+ * @export
116
+ */
117
+ export declare const ScriptSummaryTypeEnum: {
118
+ readonly Integration: "integration";
119
+ };
120
+ export type ScriptSummaryTypeEnum = typeof ScriptSummaryTypeEnum[keyof typeof ScriptSummaryTypeEnum];
121
+ /**
122
+ * Check if a given object implements the ScriptSummary interface.
123
+ */
124
+ export declare function instanceOfScriptSummary(value: object): value is ScriptSummary;
125
+ export declare function ScriptSummaryFromJSON(json: any): ScriptSummary;
126
+ export declare function ScriptSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptSummary;
127
+ export declare function ScriptSummaryToJSON(json: any): ScriptSummary;
128
+ export declare function ScriptSummaryToJSONTyped(value?: ScriptSummary | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,107 @@
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
+ /**
17
+ * @export
18
+ */
19
+ export const ScriptSummaryLanguageEnum = {
20
+ Python: 'python',
21
+ Go: 'go',
22
+ Javascript: 'javascript'
23
+ };
24
+ /**
25
+ * @export
26
+ */
27
+ export const ScriptSummaryTypeEnum = {
28
+ Integration: 'integration'
29
+ };
30
+ /**
31
+ * Check if a given object implements the ScriptSummary interface.
32
+ */
33
+ export function instanceOfScriptSummary(value) {
34
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
35
+ return false;
36
+ if (!('createdBy' in value) || value['createdBy'] === undefined)
37
+ return false;
38
+ if (!('enabled' in value) || value['enabled'] === undefined)
39
+ return false;
40
+ if (!('id' in value) || value['id'] === undefined)
41
+ return false;
42
+ if (!('key' in value) || value['key'] === undefined)
43
+ return false;
44
+ if (!('language' in value) || value['language'] === undefined)
45
+ return false;
46
+ if (!('name' in value) || value['name'] === undefined)
47
+ return false;
48
+ if (!('revision' in value) || value['revision'] === undefined)
49
+ return false;
50
+ if (!('schedule' in value) || value['schedule'] === undefined)
51
+ return false;
52
+ if (!('type' in value) || value['type'] === undefined)
53
+ return false;
54
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined)
55
+ return false;
56
+ if (!('webhook' in value) || value['webhook'] === undefined)
57
+ return false;
58
+ return true;
59
+ }
60
+ export function ScriptSummaryFromJSON(json) {
61
+ return ScriptSummaryFromJSONTyped(json, false);
62
+ }
63
+ export function ScriptSummaryFromJSONTyped(json, ignoreDiscriminator) {
64
+ if (json == null) {
65
+ return json;
66
+ }
67
+ return {
68
+ 'createdAt': (new Date(json['createdAt'])),
69
+ 'createdBy': json['createdBy'],
70
+ 'description': json['description'] == null ? undefined : json['description'],
71
+ 'enabled': json['enabled'],
72
+ 'id': json['id'],
73
+ 'key': ScriptKeyFromJSON(json['key']),
74
+ 'language': json['language'],
75
+ 'name': json['name'],
76
+ 'project': json['project'] == null ? undefined : json['project'],
77
+ 'revision': json['revision'],
78
+ 'schedule': ScriptScheduleFromJSON(json['schedule']),
79
+ 'type': json['type'],
80
+ 'updatedAt': (new Date(json['updatedAt'])),
81
+ 'webhook': json['webhook'],
82
+ };
83
+ }
84
+ export function ScriptSummaryToJSON(json) {
85
+ return ScriptSummaryToJSONTyped(json, false);
86
+ }
87
+ export function ScriptSummaryToJSONTyped(value, ignoreDiscriminator = false) {
88
+ if (value == null) {
89
+ return value;
90
+ }
91
+ return {
92
+ 'createdAt': ((value['createdAt']).toISOString()),
93
+ 'createdBy': value['createdBy'],
94
+ 'description': value['description'],
95
+ 'enabled': value['enabled'],
96
+ 'id': value['id'],
97
+ 'key': ScriptKeyToJSON(value['key']),
98
+ 'language': value['language'],
99
+ 'name': value['name'],
100
+ 'project': value['project'],
101
+ 'revision': value['revision'],
102
+ 'schedule': ScriptScheduleToJSON(value['schedule']),
103
+ 'type': value['type'],
104
+ 'updatedAt': ((value['updatedAt']).toISOString()),
105
+ 'webhook': value['webhook'],
106
+ };
107
+ }
@@ -0,0 +1,32 @@
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 ScriptWebhookResBody
16
+ */
17
+ export interface ScriptWebhookResBody {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof ScriptWebhookResBody
22
+ */
23
+ webhookUrl: string;
24
+ }
25
+ /**
26
+ * Check if a given object implements the ScriptWebhookResBody interface.
27
+ */
28
+ export declare function instanceOfScriptWebhookResBody(value: object): value is ScriptWebhookResBody;
29
+ export declare function ScriptWebhookResBodyFromJSON(json: any): ScriptWebhookResBody;
30
+ export declare function ScriptWebhookResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptWebhookResBody;
31
+ export declare function ScriptWebhookResBodyToJSON(json: any): ScriptWebhookResBody;
32
+ export declare function ScriptWebhookResBodyToJSONTyped(value?: ScriptWebhookResBody | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,43 @@
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 ScriptWebhookResBody interface.
16
+ */
17
+ export function instanceOfScriptWebhookResBody(value) {
18
+ if (!('webhookUrl' in value) || value['webhookUrl'] === undefined)
19
+ return false;
20
+ return true;
21
+ }
22
+ export function ScriptWebhookResBodyFromJSON(json) {
23
+ return ScriptWebhookResBodyFromJSONTyped(json, false);
24
+ }
25
+ export function ScriptWebhookResBodyFromJSONTyped(json, ignoreDiscriminator) {
26
+ if (json == null) {
27
+ return json;
28
+ }
29
+ return {
30
+ 'webhookUrl': json['webhookUrl'],
31
+ };
32
+ }
33
+ export function ScriptWebhookResBodyToJSON(json) {
34
+ return ScriptWebhookResBodyToJSONTyped(json, false);
35
+ }
36
+ export function ScriptWebhookResBodyToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ 'webhookUrl': value['webhookUrl'],
42
+ };
43
+ }
@@ -292,6 +292,28 @@ export * from './ScenarioListEntry';
292
292
  export * from './ScenarioListRes';
293
293
  export * from './ScenarioNotFoundDetail';
294
294
  export * from './ScenarioPatch';
295
+ export * from './ScriptAuditEntry';
296
+ export * from './ScriptAuditResBody';
297
+ export * from './ScriptDetail';
298
+ export * from './ScriptExport';
299
+ export * from './ScriptExportResBody';
300
+ export * from './ScriptExportRun';
301
+ export * from './ScriptKey';
302
+ export * from './ScriptListResBody';
303
+ export * from './ScriptLogLine';
304
+ export * from './ScriptPatchReqBody';
305
+ export * from './ScriptPostReqBody';
306
+ export * from './ScriptRun';
307
+ export * from './ScriptRunLogsResBody';
308
+ export * from './ScriptRunsResBody';
309
+ export * from './ScriptRuntime';
310
+ export * from './ScriptSchedule';
311
+ export * from './ScriptSchedulePreviewReqBody';
312
+ export * from './ScriptSchedulePreviewResBody';
313
+ export * from './ScriptSecretsReqBody';
314
+ export * from './ScriptSecretsResBody';
315
+ export * from './ScriptSummary';
316
+ export * from './ScriptWebhookResBody';
295
317
  export * from './SendPasswordPutReqBody';
296
318
  export * from './SerializedEvent';
297
319
  export * from './SingleSelectChangelogData';
@@ -294,6 +294,28 @@ export * from './ScenarioListEntry';
294
294
  export * from './ScenarioListRes';
295
295
  export * from './ScenarioNotFoundDetail';
296
296
  export * from './ScenarioPatch';
297
+ export * from './ScriptAuditEntry';
298
+ export * from './ScriptAuditResBody';
299
+ export * from './ScriptDetail';
300
+ export * from './ScriptExport';
301
+ export * from './ScriptExportResBody';
302
+ export * from './ScriptExportRun';
303
+ export * from './ScriptKey';
304
+ export * from './ScriptListResBody';
305
+ export * from './ScriptLogLine';
306
+ export * from './ScriptPatchReqBody';
307
+ export * from './ScriptPostReqBody';
308
+ export * from './ScriptRun';
309
+ export * from './ScriptRunLogsResBody';
310
+ export * from './ScriptRunsResBody';
311
+ export * from './ScriptRuntime';
312
+ export * from './ScriptSchedule';
313
+ export * from './ScriptSchedulePreviewReqBody';
314
+ export * from './ScriptSchedulePreviewResBody';
315
+ export * from './ScriptSecretsReqBody';
316
+ export * from './ScriptSecretsResBody';
317
+ export * from './ScriptSummary';
318
+ export * from './ScriptWebhookResBody';
297
319
  export * from './SendPasswordPutReqBody';
298
320
  export * from './SerializedEvent';
299
321
  export * from './SingleSelectChangelogData';
@@ -63,6 +63,12 @@ export interface APIKey {
63
63
  * @memberof APIKey
64
64
  */
65
65
  projectId: number;
66
+ /**
67
+ * Set when the key is created and rotated by a script; it can't be revoked here.
68
+ * @type {string}
69
+ * @memberof APIKey
70
+ */
71
+ scriptId?: string;
66
72
  }
67
73
  /**
68
74
  * Check if a given object implements the APIKey interface.
@@ -54,6 +54,7 @@ function APIKeyFromJSONTyped(json, ignoreDiscriminator) {
54
54
  'name': json['name'],
55
55
  'prefix': json['prefix'],
56
56
  'projectId': json['projectId'],
57
+ 'scriptId': json['scriptId'] == null ? undefined : json['scriptId'],
57
58
  };
58
59
  }
59
60
  function APIKeyToJSON(json) {
@@ -72,5 +73,6 @@ function APIKeyToJSONTyped(value, ignoreDiscriminator = false) {
72
73
  'name': value['name'],
73
74
  'prefix': value['prefix'],
74
75
  'projectId': value['projectId'],
76
+ 'scriptId': value['scriptId'],
75
77
  };
76
78
  }