@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,383 @@
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 * as runtime from '../runtime';
13
+ import type { ScriptAuditResBody, ScriptDetail, ScriptExportResBody, ScriptListResBody, ScriptPatchReqBody, ScriptPostReqBody, ScriptRunLogsResBody, ScriptRunsResBody, ScriptSchedulePreviewReqBody, ScriptSchedulePreviewResBody, ScriptSecretsReqBody, ScriptSecretsResBody, ScriptWebhookResBody } from '../models/index';
14
+ export interface ScriptsApiCreateRequest {
15
+ scriptPostReqBody: ScriptPostReqBody;
16
+ }
17
+ export interface ScriptsApiCreateReauthoriseRequest {
18
+ id: string;
19
+ }
20
+ export interface ScriptsApiCreateRegenerateWebhookRequest {
21
+ id: string;
22
+ }
23
+ export interface ScriptsApiCreateSchedulePreviewRequest {
24
+ scriptSchedulePreviewReqBody: ScriptSchedulePreviewReqBody;
25
+ }
26
+ export interface ScriptsApiDeleteRequest {
27
+ id: string;
28
+ }
29
+ export interface ScriptsApiGetRequest {
30
+ id: string;
31
+ }
32
+ export interface ScriptsApiGetAuditRequest {
33
+ id: string;
34
+ limit?: number;
35
+ cursor?: string;
36
+ }
37
+ export interface ScriptsApiListRunsRequest {
38
+ id: string;
39
+ limit?: number;
40
+ cursor?: string;
41
+ }
42
+ export interface ScriptsApiListRunsLogsRequest {
43
+ id: string;
44
+ runId: string;
45
+ }
46
+ export interface ScriptsApiUpdateRequest {
47
+ id: string;
48
+ scriptPatchReqBody: ScriptPatchReqBody;
49
+ }
50
+ export interface ScriptsApiUpdateSecretsRequest {
51
+ id: string;
52
+ scriptSecretsReqBody: ScriptSecretsReqBody;
53
+ }
54
+ /**
55
+ * ScriptsApi - interface
56
+ *
57
+ * @export
58
+ * @interface ScriptsApiInterface
59
+ */
60
+ export interface ScriptsApiInterface {
61
+ /**
62
+ * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
63
+ * @summary Create a script
64
+ * @param {ScriptPostReqBody} scriptPostReqBody
65
+ * @param {*} [options] Override http request option.
66
+ * @throws {RequiredError}
67
+ * @memberof ScriptsApiInterface
68
+ */
69
+ createRaw(requestParameters: ScriptsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>>;
70
+ /**
71
+ * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
72
+ * Create a script
73
+ */
74
+ create(requestParameters: ScriptsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail>;
75
+ /**
76
+ * Replaces the script\'s API key with a new one acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, and revokes the old one. Use it when the key needs re-authorising because its owner lost access, or to hand the script to another user. Requires the *Manage my account* permission.
77
+ * @summary Re-authorise a script
78
+ * @param {string} id
79
+ * @param {*} [options] Override http request option.
80
+ * @throws {RequiredError}
81
+ * @memberof ScriptsApiInterface
82
+ */
83
+ createReauthoriseRaw(requestParameters: ScriptsApiCreateReauthoriseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>>;
84
+ /**
85
+ * Replaces the script\'s API key with a new one acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, and revokes the old one. Use it when the key needs re-authorising because its owner lost access, or to hand the script to another user. Requires the *Manage my account* permission.
86
+ * Re-authorise a script
87
+ */
88
+ createReauthorise(requestParameters: ScriptsApiCreateReauthoriseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail>;
89
+ /**
90
+ * Issues a new webhook URL and immediately invalidates the previous one. The URL is returned only in this response. Rejected with `409` when the script\'s webhook is turned off, or when another request regenerated it at the same time; the URL returned to that request is the valid one. Requires the *Manage my account* permission.
91
+ * @summary Regenerate a script\'s webhook URL
92
+ * @param {string} id
93
+ * @param {*} [options] Override http request option.
94
+ * @throws {RequiredError}
95
+ * @memberof ScriptsApiInterface
96
+ */
97
+ createRegenerateWebhookRaw(requestParameters: ScriptsApiCreateRegenerateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptWebhookResBody>>;
98
+ /**
99
+ * Issues a new webhook URL and immediately invalidates the previous one. The URL is returned only in this response. Rejected with `409` when the script\'s webhook is turned off, or when another request regenerated it at the same time; the URL returned to that request is the valid one. Requires the *Manage my account* permission.
100
+ * Regenerate a script\'s webhook URL
101
+ */
102
+ createRegenerateWebhook(requestParameters: ScriptsApiCreateRegenerateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptWebhookResBody>;
103
+ /**
104
+ * Checks a cron expression and time zone and returns the next times it would run, so a schedule can be confirmed before saving. An invalid schedule is reported in `error` with `valid` false rather than as an error response. Requires the *Manage my account* permission.
105
+ * @summary Preview a script schedule
106
+ * @param {ScriptSchedulePreviewReqBody} scriptSchedulePreviewReqBody
107
+ * @param {*} [options] Override http request option.
108
+ * @throws {RequiredError}
109
+ * @memberof ScriptsApiInterface
110
+ */
111
+ createSchedulePreviewRaw(requestParameters: ScriptsApiCreateSchedulePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptSchedulePreviewResBody>>;
112
+ /**
113
+ * Checks a cron expression and time zone and returns the next times it would run, so a schedule can be confirmed before saving. An invalid schedule is reported in `error` with `valid` false rather than as an error response. Requires the *Manage my account* permission.
114
+ * Preview a script schedule
115
+ */
116
+ createSchedulePreview(requestParameters: ScriptsApiCreateSchedulePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptSchedulePreviewResBody>;
117
+ /**
118
+ * Stops any active runs, deletes the script with its secrets and run history, and revokes its API keys. Requires the *Manage my account* permission.
119
+ * @summary Delete a script
120
+ * @param {string} id
121
+ * @param {*} [options] Override http request option.
122
+ * @throws {RequiredError}
123
+ * @memberof ScriptsApiInterface
124
+ */
125
+ deleteRaw(requestParameters: ScriptsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
126
+ /**
127
+ * Stops any active runs, deletes the script with its secrets and run history, and revokes its API keys. Requires the *Manage my account* permission.
128
+ * Delete a script
129
+ */
130
+ delete(requestParameters: ScriptsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
131
+ /**
132
+ * Returns a script with its source, the names of its secrets (never their values), its API key\'s status and, when the runner can be reached, its build state, next scheduled run and resource limits. Requires the *Manage my account* permission.
133
+ * @summary Get a script
134
+ * @param {string} id
135
+ * @param {*} [options] Override http request option.
136
+ * @throws {RequiredError}
137
+ * @memberof ScriptsApiInterface
138
+ */
139
+ getRaw(requestParameters: ScriptsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>>;
140
+ /**
141
+ * Returns a script with its source, the names of its secrets (never their values), its API key\'s status and, when the runner can be reached, its build state, next scheduled run and resource limits. Requires the *Manage my account* permission.
142
+ * Get a script
143
+ */
144
+ get(requestParameters: ScriptsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail>;
145
+ /**
146
+ * Lists changes to the script and its API key, newest first. Requires the *Manage my account* permission.
147
+ * @summary List a script\'s activity
148
+ * @param {string} id
149
+ * @param {number} [limit]
150
+ * @param {string} [cursor] nextCursor from the previous page.
151
+ * @param {*} [options] Override http request option.
152
+ * @throws {RequiredError}
153
+ * @memberof ScriptsApiInterface
154
+ */
155
+ getAuditRaw(requestParameters: ScriptsApiGetAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptAuditResBody>>;
156
+ /**
157
+ * Lists changes to the script and its API key, newest first. Requires the *Manage my account* permission.
158
+ * List a script\'s activity
159
+ */
160
+ getAudit(requestParameters: ScriptsApiGetAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptAuditResBody>;
161
+ /**
162
+ * Returns every script in the account with its settings, source, dependency manifest and secret names (never their values), and each script\'s run history: every build and run still kept, with the API path of its logs. A history too long to read within the request keeps its newest runs and sets runsError; page through the script\'s runs for the rest. Webhook URLs are not included. Requires the *Manage my account* permission.
163
+ * @summary Export scripts
164
+ * @param {*} [options] Override http request option.
165
+ * @throws {RequiredError}
166
+ * @memberof ScriptsApiInterface
167
+ */
168
+ getExportRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptExportResBody>>;
169
+ /**
170
+ * Returns every script in the account with its settings, source, dependency manifest and secret names (never their values), and each script\'s run history: every build and run still kept, with the API path of its logs. A history too long to read within the request keeps its newest runs and sets runsError; page through the script\'s runs for the rest. Webhook URLs are not included. Requires the *Manage my account* permission.
171
+ * Export scripts
172
+ */
173
+ getExport(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptExportResBody>;
174
+ /**
175
+ * Lists the account\'s scripts, sorted by name, without their source code. Requires the *Manage my account* permission.
176
+ * @summary List scripts
177
+ * @param {*} [options] Override http request option.
178
+ * @throws {RequiredError}
179
+ * @memberof ScriptsApiInterface
180
+ */
181
+ listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptListResBody>>;
182
+ /**
183
+ * Lists the account\'s scripts, sorted by name, without their source code. Requires the *Manage my account* permission.
184
+ * List scripts
185
+ */
186
+ list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptListResBody>;
187
+ /**
188
+ * Lists the script\'s builds and runs, newest first. Requires the *Manage my account* permission.
189
+ * @summary List a script\'s runs
190
+ * @param {string} id
191
+ * @param {number} [limit]
192
+ * @param {string} [cursor] nextCursor from the previous page.
193
+ * @param {*} [options] Override http request option.
194
+ * @throws {RequiredError}
195
+ * @memberof ScriptsApiInterface
196
+ */
197
+ listRunsRaw(requestParameters: ScriptsApiListRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptRunsResBody>>;
198
+ /**
199
+ * Lists the script\'s builds and runs, newest first. Requires the *Manage my account* permission.
200
+ * List a script\'s runs
201
+ */
202
+ listRuns(requestParameters: ScriptsApiListRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptRunsResBody>;
203
+ /**
204
+ * Returns the output the run or build wrote to stdout and stderr. Requires the *Manage my account* permission.
205
+ * @summary Get a script run\'s logs
206
+ * @param {string} id
207
+ * @param {string} runId
208
+ * @param {*} [options] Override http request option.
209
+ * @throws {RequiredError}
210
+ * @memberof ScriptsApiInterface
211
+ */
212
+ listRunsLogsRaw(requestParameters: ScriptsApiListRunsLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptRunLogsResBody>>;
213
+ /**
214
+ * Returns the output the run or build wrote to stdout and stderr. Requires the *Manage my account* permission.
215
+ * Get a script run\'s logs
216
+ */
217
+ listRunsLogs(requestParameters: ScriptsApiListRunsLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptRunLogsResBody>;
218
+ /**
219
+ * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, or when enabling a script whose key needs re-authorising; with `422` when the result is invalid. Requires the *Manage my account* permission.
220
+ * @summary Update a script
221
+ * @param {string} id
222
+ * @param {ScriptPatchReqBody} scriptPatchReqBody
223
+ * @param {*} [options] Override http request option.
224
+ * @throws {RequiredError}
225
+ * @memberof ScriptsApiInterface
226
+ */
227
+ updateRaw(requestParameters: ScriptsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>>;
228
+ /**
229
+ * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, or when enabling a script whose key needs re-authorising; with `422` when the result is invalid. Requires the *Manage my account* permission.
230
+ * Update a script
231
+ */
232
+ update(requestParameters: ScriptsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail>;
233
+ /**
234
+ * Adds, replaces or removes the script\'s secrets; secrets not named are left unchanged. Values are write-only and are never returned; the response has the script\'s new `revision`. When someone other than the key\'s owner sets secrets, the script\'s API key is replaced with one acting as them. Names must be upper-case environment variable names and must not start with `SPACIV_`, which is reserved for the values Spaciv provides. Requires the *Manage my account* permission.
235
+ * @summary Set script secrets
236
+ * @param {string} id
237
+ * @param {ScriptSecretsReqBody} scriptSecretsReqBody
238
+ * @param {*} [options] Override http request option.
239
+ * @throws {RequiredError}
240
+ * @memberof ScriptsApiInterface
241
+ */
242
+ updateSecretsRaw(requestParameters: ScriptsApiUpdateSecretsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptSecretsResBody>>;
243
+ /**
244
+ * Adds, replaces or removes the script\'s secrets; secrets not named are left unchanged. Values are write-only and are never returned; the response has the script\'s new `revision`. When someone other than the key\'s owner sets secrets, the script\'s API key is replaced with one acting as them. Names must be upper-case environment variable names and must not start with `SPACIV_`, which is reserved for the values Spaciv provides. Requires the *Manage my account* permission.
245
+ * Set script secrets
246
+ */
247
+ updateSecrets(requestParameters: ScriptsApiUpdateSecretsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptSecretsResBody>;
248
+ }
249
+ /**
250
+ *
251
+ */
252
+ export declare class ScriptsApi extends runtime.BaseAPI implements ScriptsApiInterface {
253
+ /**
254
+ * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
255
+ * Create a script
256
+ */
257
+ createRaw(requestParameters: ScriptsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>>;
258
+ /**
259
+ * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
260
+ * Create a script
261
+ */
262
+ create(requestParameters: ScriptsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail>;
263
+ /**
264
+ * Replaces the script\'s API key with a new one acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, and revokes the old one. Use it when the key needs re-authorising because its owner lost access, or to hand the script to another user. Requires the *Manage my account* permission.
265
+ * Re-authorise a script
266
+ */
267
+ createReauthoriseRaw(requestParameters: ScriptsApiCreateReauthoriseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>>;
268
+ /**
269
+ * Replaces the script\'s API key with a new one acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, and revokes the old one. Use it when the key needs re-authorising because its owner lost access, or to hand the script to another user. Requires the *Manage my account* permission.
270
+ * Re-authorise a script
271
+ */
272
+ createReauthorise(requestParameters: ScriptsApiCreateReauthoriseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail>;
273
+ /**
274
+ * Issues a new webhook URL and immediately invalidates the previous one. The URL is returned only in this response. Rejected with `409` when the script\'s webhook is turned off, or when another request regenerated it at the same time; the URL returned to that request is the valid one. Requires the *Manage my account* permission.
275
+ * Regenerate a script\'s webhook URL
276
+ */
277
+ createRegenerateWebhookRaw(requestParameters: ScriptsApiCreateRegenerateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptWebhookResBody>>;
278
+ /**
279
+ * Issues a new webhook URL and immediately invalidates the previous one. The URL is returned only in this response. Rejected with `409` when the script\'s webhook is turned off, or when another request regenerated it at the same time; the URL returned to that request is the valid one. Requires the *Manage my account* permission.
280
+ * Regenerate a script\'s webhook URL
281
+ */
282
+ createRegenerateWebhook(requestParameters: ScriptsApiCreateRegenerateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptWebhookResBody>;
283
+ /**
284
+ * Checks a cron expression and time zone and returns the next times it would run, so a schedule can be confirmed before saving. An invalid schedule is reported in `error` with `valid` false rather than as an error response. Requires the *Manage my account* permission.
285
+ * Preview a script schedule
286
+ */
287
+ createSchedulePreviewRaw(requestParameters: ScriptsApiCreateSchedulePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptSchedulePreviewResBody>>;
288
+ /**
289
+ * Checks a cron expression and time zone and returns the next times it would run, so a schedule can be confirmed before saving. An invalid schedule is reported in `error` with `valid` false rather than as an error response. Requires the *Manage my account* permission.
290
+ * Preview a script schedule
291
+ */
292
+ createSchedulePreview(requestParameters: ScriptsApiCreateSchedulePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptSchedulePreviewResBody>;
293
+ /**
294
+ * Stops any active runs, deletes the script with its secrets and run history, and revokes its API keys. Requires the *Manage my account* permission.
295
+ * Delete a script
296
+ */
297
+ deleteRaw(requestParameters: ScriptsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
298
+ /**
299
+ * Stops any active runs, deletes the script with its secrets and run history, and revokes its API keys. Requires the *Manage my account* permission.
300
+ * Delete a script
301
+ */
302
+ delete(requestParameters: ScriptsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
303
+ /**
304
+ * Returns a script with its source, the names of its secrets (never their values), its API key\'s status and, when the runner can be reached, its build state, next scheduled run and resource limits. Requires the *Manage my account* permission.
305
+ * Get a script
306
+ */
307
+ getRaw(requestParameters: ScriptsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>>;
308
+ /**
309
+ * Returns a script with its source, the names of its secrets (never their values), its API key\'s status and, when the runner can be reached, its build state, next scheduled run and resource limits. Requires the *Manage my account* permission.
310
+ * Get a script
311
+ */
312
+ get(requestParameters: ScriptsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail>;
313
+ /**
314
+ * Lists changes to the script and its API key, newest first. Requires the *Manage my account* permission.
315
+ * List a script\'s activity
316
+ */
317
+ getAuditRaw(requestParameters: ScriptsApiGetAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptAuditResBody>>;
318
+ /**
319
+ * Lists changes to the script and its API key, newest first. Requires the *Manage my account* permission.
320
+ * List a script\'s activity
321
+ */
322
+ getAudit(requestParameters: ScriptsApiGetAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptAuditResBody>;
323
+ /**
324
+ * Returns every script in the account with its settings, source, dependency manifest and secret names (never their values), and each script\'s run history: every build and run still kept, with the API path of its logs. A history too long to read within the request keeps its newest runs and sets runsError; page through the script\'s runs for the rest. Webhook URLs are not included. Requires the *Manage my account* permission.
325
+ * Export scripts
326
+ */
327
+ getExportRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptExportResBody>>;
328
+ /**
329
+ * Returns every script in the account with its settings, source, dependency manifest and secret names (never their values), and each script\'s run history: every build and run still kept, with the API path of its logs. A history too long to read within the request keeps its newest runs and sets runsError; page through the script\'s runs for the rest. Webhook URLs are not included. Requires the *Manage my account* permission.
330
+ * Export scripts
331
+ */
332
+ getExport(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptExportResBody>;
333
+ /**
334
+ * Lists the account\'s scripts, sorted by name, without their source code. Requires the *Manage my account* permission.
335
+ * List scripts
336
+ */
337
+ listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptListResBody>>;
338
+ /**
339
+ * Lists the account\'s scripts, sorted by name, without their source code. Requires the *Manage my account* permission.
340
+ * List scripts
341
+ */
342
+ list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptListResBody>;
343
+ /**
344
+ * Lists the script\'s builds and runs, newest first. Requires the *Manage my account* permission.
345
+ * List a script\'s runs
346
+ */
347
+ listRunsRaw(requestParameters: ScriptsApiListRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptRunsResBody>>;
348
+ /**
349
+ * Lists the script\'s builds and runs, newest first. Requires the *Manage my account* permission.
350
+ * List a script\'s runs
351
+ */
352
+ listRuns(requestParameters: ScriptsApiListRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptRunsResBody>;
353
+ /**
354
+ * Returns the output the run or build wrote to stdout and stderr. Requires the *Manage my account* permission.
355
+ * Get a script run\'s logs
356
+ */
357
+ listRunsLogsRaw(requestParameters: ScriptsApiListRunsLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptRunLogsResBody>>;
358
+ /**
359
+ * Returns the output the run or build wrote to stdout and stderr. Requires the *Manage my account* permission.
360
+ * Get a script run\'s logs
361
+ */
362
+ listRunsLogs(requestParameters: ScriptsApiListRunsLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptRunLogsResBody>;
363
+ /**
364
+ * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, or when enabling a script whose key needs re-authorising; with `422` when the result is invalid. Requires the *Manage my account* permission.
365
+ * Update a script
366
+ */
367
+ updateRaw(requestParameters: ScriptsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>>;
368
+ /**
369
+ * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, or when enabling a script whose key needs re-authorising; with `422` when the result is invalid. Requires the *Manage my account* permission.
370
+ * Update a script
371
+ */
372
+ update(requestParameters: ScriptsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail>;
373
+ /**
374
+ * Adds, replaces or removes the script\'s secrets; secrets not named are left unchanged. Values are write-only and are never returned; the response has the script\'s new `revision`. When someone other than the key\'s owner sets secrets, the script\'s API key is replaced with one acting as them. Names must be upper-case environment variable names and must not start with `SPACIV_`, which is reserved for the values Spaciv provides. Requires the *Manage my account* permission.
375
+ * Set script secrets
376
+ */
377
+ updateSecretsRaw(requestParameters: ScriptsApiUpdateSecretsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptSecretsResBody>>;
378
+ /**
379
+ * Adds, replaces or removes the script\'s secrets; secrets not named are left unchanged. Values are write-only and are never returned; the response has the script\'s new `revision`. When someone other than the key\'s owner sets secrets, the script\'s API key is replaced with one acting as them. Names must be upper-case environment variable names and must not start with `SPACIV_`, which is reserved for the values Spaciv provides. Requires the *Manage my account* permission.
380
+ * Set script secrets
381
+ */
382
+ updateSecrets(requestParameters: ScriptsApiUpdateSecretsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptSecretsResBody>;
383
+ }