@spaciv/sdk 0.1.5 → 0.1.6

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 (58) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +2 -2
  3. package/dist/apis/AccountsApi.d.ts +4 -4
  4. package/dist/apis/AccountsApi.js +2 -2
  5. package/dist/apis/InternalApi.d.ts +57 -1
  6. package/dist/apis/InternalApi.js +83 -0
  7. package/dist/apis/ScriptsApi.d.ts +32 -9
  8. package/dist/apis/ScriptsApi.js +39 -4
  9. package/dist/esm/apis/AccountsApi.d.ts +4 -4
  10. package/dist/esm/apis/AccountsApi.js +2 -2
  11. package/dist/esm/apis/InternalApi.d.ts +57 -1
  12. package/dist/esm/apis/InternalApi.js +84 -1
  13. package/dist/esm/apis/ScriptsApi.d.ts +32 -9
  14. package/dist/esm/apis/ScriptsApi.js +40 -5
  15. package/dist/esm/models/AccountCalculationUsageDay.d.ts +6 -0
  16. package/dist/esm/models/AccountCalculationUsageDay.js +4 -0
  17. package/dist/esm/models/ScriptLimitOverrides.d.ts +62 -0
  18. package/dist/esm/models/ScriptLimitOverrides.js +51 -0
  19. package/dist/esm/models/ScriptLimitValues.d.ts +62 -0
  20. package/dist/esm/models/ScriptLimitValues.js +63 -0
  21. package/dist/esm/models/ScriptLimits.d.ts +62 -0
  22. package/dist/esm/models/ScriptLimits.js +63 -0
  23. package/dist/esm/models/ScriptLimitsResBody.d.ts +46 -0
  24. package/dist/esm/models/ScriptLimitsResBody.js +53 -0
  25. package/dist/esm/models/ScriptUsage.d.ts +50 -0
  26. package/dist/esm/models/ScriptUsage.js +55 -0
  27. package/dist/esm/models/ScriptUsageResBody.d.ts +103 -0
  28. package/dist/esm/models/ScriptUsageResBody.js +93 -0
  29. package/dist/esm/models/index.d.ts +6 -0
  30. package/dist/esm/models/index.js +6 -0
  31. package/dist/models/AccountCalculationUsageDay.d.ts +6 -0
  32. package/dist/models/AccountCalculationUsageDay.js +4 -0
  33. package/dist/models/ScriptLimitOverrides.d.ts +62 -0
  34. package/dist/models/ScriptLimitOverrides.js +58 -0
  35. package/dist/models/ScriptLimitValues.d.ts +62 -0
  36. package/dist/models/ScriptLimitValues.js +70 -0
  37. package/dist/models/ScriptLimits.d.ts +62 -0
  38. package/dist/models/ScriptLimits.js +70 -0
  39. package/dist/models/ScriptLimitsResBody.d.ts +46 -0
  40. package/dist/models/ScriptLimitsResBody.js +60 -0
  41. package/dist/models/ScriptUsage.d.ts +50 -0
  42. package/dist/models/ScriptUsage.js +62 -0
  43. package/dist/models/ScriptUsageResBody.d.ts +103 -0
  44. package/dist/models/ScriptUsageResBody.js +101 -0
  45. package/dist/models/index.d.ts +6 -0
  46. package/dist/models/index.js +6 -0
  47. package/package.json +1 -1
  48. package/src/apis/AccountsApi.ts +4 -4
  49. package/src/apis/InternalApi.ts +152 -0
  50. package/src/apis/ScriptsApi.ts +65 -8
  51. package/src/models/AccountCalculationUsageDay.ts +9 -0
  52. package/src/models/ScriptLimitOverrides.ts +105 -0
  53. package/src/models/ScriptLimitValues.ts +111 -0
  54. package/src/models/ScriptLimits.ts +111 -0
  55. package/src/models/ScriptLimitsResBody.ts +99 -0
  56. package/src/models/ScriptUsage.ts +93 -0
  57. package/src/models/ScriptUsageResBody.ts +183 -0
  58. package/src/models/index.ts +6 -0
@@ -299,6 +299,10 @@ export * from './ScriptExport';
299
299
  export * from './ScriptExportResBody';
300
300
  export * from './ScriptExportRun';
301
301
  export * from './ScriptKey';
302
+ export * from './ScriptLimitOverrides';
303
+ export * from './ScriptLimitValues';
304
+ export * from './ScriptLimits';
305
+ export * from './ScriptLimitsResBody';
302
306
  export * from './ScriptListResBody';
303
307
  export * from './ScriptLogLine';
304
308
  export * from './ScriptPatchReqBody';
@@ -313,6 +317,8 @@ export * from './ScriptSchedulePreviewResBody';
313
317
  export * from './ScriptSecretsReqBody';
314
318
  export * from './ScriptSecretsResBody';
315
319
  export * from './ScriptSummary';
320
+ export * from './ScriptUsage';
321
+ export * from './ScriptUsageResBody';
316
322
  export * from './ScriptWebhookResBody';
317
323
  export * from './SendPasswordPutReqBody';
318
324
  export * from './SerializedEvent';
@@ -301,6 +301,10 @@ export * from './ScriptExport';
301
301
  export * from './ScriptExportResBody';
302
302
  export * from './ScriptExportRun';
303
303
  export * from './ScriptKey';
304
+ export * from './ScriptLimitOverrides';
305
+ export * from './ScriptLimitValues';
306
+ export * from './ScriptLimits';
307
+ export * from './ScriptLimitsResBody';
304
308
  export * from './ScriptListResBody';
305
309
  export * from './ScriptLogLine';
306
310
  export * from './ScriptPatchReqBody';
@@ -315,6 +319,8 @@ export * from './ScriptSchedulePreviewResBody';
315
319
  export * from './ScriptSecretsReqBody';
316
320
  export * from './ScriptSecretsResBody';
317
321
  export * from './ScriptSummary';
322
+ export * from './ScriptUsage';
323
+ export * from './ScriptUsageResBody';
318
324
  export * from './ScriptWebhookResBody';
319
325
  export * from './SendPasswordPutReqBody';
320
326
  export * from './SerializedEvent';
@@ -39,6 +39,12 @@ export interface AccountCalculationUsageDay {
39
39
  * @memberof AccountCalculationUsageDay
40
40
  */
41
41
  date: Date;
42
+ /**
43
+ * Credits used running scripts: one per started minute of each run.
44
+ * @type {number}
45
+ * @memberof AccountCalculationUsageDay
46
+ */
47
+ scripts: number;
42
48
  }
43
49
  /**
44
50
  * Check if a given object implements the AccountCalculationUsageDay interface.
@@ -30,6 +30,8 @@ function instanceOfAccountCalculationUsageDay(value) {
30
30
  return false;
31
31
  if (!('date' in value) || value['date'] === undefined)
32
32
  return false;
33
+ if (!('scripts' in value) || value['scripts'] === undefined)
34
+ return false;
33
35
  return true;
34
36
  }
35
37
  function AccountCalculationUsageDayFromJSON(json) {
@@ -44,6 +46,7 @@ function AccountCalculationUsageDayFromJSONTyped(json, ignoreDiscriminator) {
44
46
  'ai': json['ai'],
45
47
  'build': json['build'],
46
48
  'date': (new Date(json['date'])),
49
+ 'scripts': json['scripts'],
47
50
  };
48
51
  }
49
52
  function AccountCalculationUsageDayToJSON(json) {
@@ -58,5 +61,6 @@ function AccountCalculationUsageDayToJSONTyped(value, ignoreDiscriminator = fals
58
61
  'ai': value['ai'],
59
62
  'build': value['build'],
60
63
  'date': ((value['date']).toISOString().substring(0, 10)),
64
+ 'scripts': value['scripts'],
61
65
  };
62
66
  }
@@ -0,0 +1,62 @@
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 ScriptLimitOverrides
16
+ */
17
+ export interface ScriptLimitOverrides {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof ScriptLimitOverrides
22
+ */
23
+ maxConcurrentRuns?: number;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof ScriptLimitOverrides
28
+ */
29
+ maxCreditsPerMonth?: number;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof ScriptLimitOverrides
34
+ */
35
+ maxEnabledScripts?: number;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof ScriptLimitOverrides
40
+ */
41
+ maxRunSeconds?: number;
42
+ /**
43
+ *
44
+ * @type {number}
45
+ * @memberof ScriptLimitOverrides
46
+ */
47
+ minCronIntervalSeconds?: number;
48
+ /**
49
+ *
50
+ * @type {number}
51
+ * @memberof ScriptLimitOverrides
52
+ */
53
+ webhookRequestsPerMinute?: number;
54
+ }
55
+ /**
56
+ * Check if a given object implements the ScriptLimitOverrides interface.
57
+ */
58
+ export declare function instanceOfScriptLimitOverrides(value: object): value is ScriptLimitOverrides;
59
+ export declare function ScriptLimitOverridesFromJSON(json: any): ScriptLimitOverrides;
60
+ export declare function ScriptLimitOverridesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptLimitOverrides;
61
+ export declare function ScriptLimitOverridesToJSON(json: any): ScriptLimitOverrides;
62
+ export declare function ScriptLimitOverridesToJSONTyped(value?: ScriptLimitOverrides | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,58 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * spaciv API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: support@spaciv.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfScriptLimitOverrides = instanceOfScriptLimitOverrides;
17
+ exports.ScriptLimitOverridesFromJSON = ScriptLimitOverridesFromJSON;
18
+ exports.ScriptLimitOverridesFromJSONTyped = ScriptLimitOverridesFromJSONTyped;
19
+ exports.ScriptLimitOverridesToJSON = ScriptLimitOverridesToJSON;
20
+ exports.ScriptLimitOverridesToJSONTyped = ScriptLimitOverridesToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the ScriptLimitOverrides interface.
23
+ */
24
+ function instanceOfScriptLimitOverrides(value) {
25
+ return true;
26
+ }
27
+ function ScriptLimitOverridesFromJSON(json) {
28
+ return ScriptLimitOverridesFromJSONTyped(json, false);
29
+ }
30
+ function ScriptLimitOverridesFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'maxConcurrentRuns': json['maxConcurrentRuns'] == null ? undefined : json['maxConcurrentRuns'],
36
+ 'maxCreditsPerMonth': json['maxCreditsPerMonth'] == null ? undefined : json['maxCreditsPerMonth'],
37
+ 'maxEnabledScripts': json['maxEnabledScripts'] == null ? undefined : json['maxEnabledScripts'],
38
+ 'maxRunSeconds': json['maxRunSeconds'] == null ? undefined : json['maxRunSeconds'],
39
+ 'minCronIntervalSeconds': json['minCronIntervalSeconds'] == null ? undefined : json['minCronIntervalSeconds'],
40
+ 'webhookRequestsPerMinute': json['webhookRequestsPerMinute'] == null ? undefined : json['webhookRequestsPerMinute'],
41
+ };
42
+ }
43
+ function ScriptLimitOverridesToJSON(json) {
44
+ return ScriptLimitOverridesToJSONTyped(json, false);
45
+ }
46
+ function ScriptLimitOverridesToJSONTyped(value, ignoreDiscriminator = false) {
47
+ if (value == null) {
48
+ return value;
49
+ }
50
+ return {
51
+ 'maxConcurrentRuns': value['maxConcurrentRuns'],
52
+ 'maxCreditsPerMonth': value['maxCreditsPerMonth'],
53
+ 'maxEnabledScripts': value['maxEnabledScripts'],
54
+ 'maxRunSeconds': value['maxRunSeconds'],
55
+ 'minCronIntervalSeconds': value['minCronIntervalSeconds'],
56
+ 'webhookRequestsPerMinute': value['webhookRequestsPerMinute'],
57
+ };
58
+ }
@@ -0,0 +1,62 @@
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 ScriptLimitValues
16
+ */
17
+ export interface ScriptLimitValues {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof ScriptLimitValues
22
+ */
23
+ maxConcurrentRuns: number;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof ScriptLimitValues
28
+ */
29
+ maxCreditsPerMonth: number;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof ScriptLimitValues
34
+ */
35
+ maxEnabledScripts: number;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof ScriptLimitValues
40
+ */
41
+ maxRunSeconds: number;
42
+ /**
43
+ *
44
+ * @type {number}
45
+ * @memberof ScriptLimitValues
46
+ */
47
+ minCronIntervalSeconds: number;
48
+ /**
49
+ *
50
+ * @type {number}
51
+ * @memberof ScriptLimitValues
52
+ */
53
+ webhookRequestsPerMinute: number;
54
+ }
55
+ /**
56
+ * Check if a given object implements the ScriptLimitValues interface.
57
+ */
58
+ export declare function instanceOfScriptLimitValues(value: object): value is ScriptLimitValues;
59
+ export declare function ScriptLimitValuesFromJSON(json: any): ScriptLimitValues;
60
+ export declare function ScriptLimitValuesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptLimitValues;
61
+ export declare function ScriptLimitValuesToJSON(json: any): ScriptLimitValues;
62
+ export declare function ScriptLimitValuesToJSONTyped(value?: ScriptLimitValues | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * spaciv API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: support@spaciv.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfScriptLimitValues = instanceOfScriptLimitValues;
17
+ exports.ScriptLimitValuesFromJSON = ScriptLimitValuesFromJSON;
18
+ exports.ScriptLimitValuesFromJSONTyped = ScriptLimitValuesFromJSONTyped;
19
+ exports.ScriptLimitValuesToJSON = ScriptLimitValuesToJSON;
20
+ exports.ScriptLimitValuesToJSONTyped = ScriptLimitValuesToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the ScriptLimitValues interface.
23
+ */
24
+ function instanceOfScriptLimitValues(value) {
25
+ if (!('maxConcurrentRuns' in value) || value['maxConcurrentRuns'] === undefined)
26
+ return false;
27
+ if (!('maxCreditsPerMonth' in value) || value['maxCreditsPerMonth'] === undefined)
28
+ return false;
29
+ if (!('maxEnabledScripts' in value) || value['maxEnabledScripts'] === undefined)
30
+ return false;
31
+ if (!('maxRunSeconds' in value) || value['maxRunSeconds'] === undefined)
32
+ return false;
33
+ if (!('minCronIntervalSeconds' in value) || value['minCronIntervalSeconds'] === undefined)
34
+ return false;
35
+ if (!('webhookRequestsPerMinute' in value) || value['webhookRequestsPerMinute'] === undefined)
36
+ return false;
37
+ return true;
38
+ }
39
+ function ScriptLimitValuesFromJSON(json) {
40
+ return ScriptLimitValuesFromJSONTyped(json, false);
41
+ }
42
+ function ScriptLimitValuesFromJSONTyped(json, ignoreDiscriminator) {
43
+ if (json == null) {
44
+ return json;
45
+ }
46
+ return {
47
+ 'maxConcurrentRuns': json['maxConcurrentRuns'],
48
+ 'maxCreditsPerMonth': json['maxCreditsPerMonth'],
49
+ 'maxEnabledScripts': json['maxEnabledScripts'],
50
+ 'maxRunSeconds': json['maxRunSeconds'],
51
+ 'minCronIntervalSeconds': json['minCronIntervalSeconds'],
52
+ 'webhookRequestsPerMinute': json['webhookRequestsPerMinute'],
53
+ };
54
+ }
55
+ function ScriptLimitValuesToJSON(json) {
56
+ return ScriptLimitValuesToJSONTyped(json, false);
57
+ }
58
+ function ScriptLimitValuesToJSONTyped(value, ignoreDiscriminator = false) {
59
+ if (value == null) {
60
+ return value;
61
+ }
62
+ return {
63
+ 'maxConcurrentRuns': value['maxConcurrentRuns'],
64
+ 'maxCreditsPerMonth': value['maxCreditsPerMonth'],
65
+ 'maxEnabledScripts': value['maxEnabledScripts'],
66
+ 'maxRunSeconds': value['maxRunSeconds'],
67
+ 'minCronIntervalSeconds': value['minCronIntervalSeconds'],
68
+ 'webhookRequestsPerMinute': value['webhookRequestsPerMinute'],
69
+ };
70
+ }
@@ -0,0 +1,62 @@
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 ScriptLimits
16
+ */
17
+ export interface ScriptLimits {
18
+ /**
19
+ * Runs the account may have in progress at once.
20
+ * @type {number}
21
+ * @memberof ScriptLimits
22
+ */
23
+ maxConcurrentRuns: number;
24
+ /**
25
+ * Credits the account's script runs may be charged in a calendar month (UTC). Once they are used, further runs are recorded as quota_exceeded and do not start.
26
+ * @type {number}
27
+ * @memberof ScriptLimits
28
+ */
29
+ maxCreditsPerMonth: number;
30
+ /**
31
+ * Scripts the account may have enabled at once.
32
+ * @type {number}
33
+ * @memberof ScriptLimits
34
+ */
35
+ maxEnabledScripts: number;
36
+ /**
37
+ * Longest a single run may take; a script's own timeout is capped to it.
38
+ * @type {number}
39
+ * @memberof ScriptLimits
40
+ */
41
+ maxRunSeconds: number;
42
+ /**
43
+ * Shortest time allowed between two scheduled runs of a script.
44
+ * @type {number}
45
+ * @memberof ScriptLimits
46
+ */
47
+ minCronIntervalSeconds: number;
48
+ /**
49
+ * Webhook calls each script accepts per minute, and at most in a burst.
50
+ * @type {number}
51
+ * @memberof ScriptLimits
52
+ */
53
+ webhookRequestsPerMinute: number;
54
+ }
55
+ /**
56
+ * Check if a given object implements the ScriptLimits interface.
57
+ */
58
+ export declare function instanceOfScriptLimits(value: object): value is ScriptLimits;
59
+ export declare function ScriptLimitsFromJSON(json: any): ScriptLimits;
60
+ export declare function ScriptLimitsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptLimits;
61
+ export declare function ScriptLimitsToJSON(json: any): ScriptLimits;
62
+ export declare function ScriptLimitsToJSONTyped(value?: ScriptLimits | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * spaciv API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: support@spaciv.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfScriptLimits = instanceOfScriptLimits;
17
+ exports.ScriptLimitsFromJSON = ScriptLimitsFromJSON;
18
+ exports.ScriptLimitsFromJSONTyped = ScriptLimitsFromJSONTyped;
19
+ exports.ScriptLimitsToJSON = ScriptLimitsToJSON;
20
+ exports.ScriptLimitsToJSONTyped = ScriptLimitsToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the ScriptLimits interface.
23
+ */
24
+ function instanceOfScriptLimits(value) {
25
+ if (!('maxConcurrentRuns' in value) || value['maxConcurrentRuns'] === undefined)
26
+ return false;
27
+ if (!('maxCreditsPerMonth' in value) || value['maxCreditsPerMonth'] === undefined)
28
+ return false;
29
+ if (!('maxEnabledScripts' in value) || value['maxEnabledScripts'] === undefined)
30
+ return false;
31
+ if (!('maxRunSeconds' in value) || value['maxRunSeconds'] === undefined)
32
+ return false;
33
+ if (!('minCronIntervalSeconds' in value) || value['minCronIntervalSeconds'] === undefined)
34
+ return false;
35
+ if (!('webhookRequestsPerMinute' in value) || value['webhookRequestsPerMinute'] === undefined)
36
+ return false;
37
+ return true;
38
+ }
39
+ function ScriptLimitsFromJSON(json) {
40
+ return ScriptLimitsFromJSONTyped(json, false);
41
+ }
42
+ function ScriptLimitsFromJSONTyped(json, ignoreDiscriminator) {
43
+ if (json == null) {
44
+ return json;
45
+ }
46
+ return {
47
+ 'maxConcurrentRuns': json['maxConcurrentRuns'],
48
+ 'maxCreditsPerMonth': json['maxCreditsPerMonth'],
49
+ 'maxEnabledScripts': json['maxEnabledScripts'],
50
+ 'maxRunSeconds': json['maxRunSeconds'],
51
+ 'minCronIntervalSeconds': json['minCronIntervalSeconds'],
52
+ 'webhookRequestsPerMinute': json['webhookRequestsPerMinute'],
53
+ };
54
+ }
55
+ function ScriptLimitsToJSON(json) {
56
+ return ScriptLimitsToJSONTyped(json, false);
57
+ }
58
+ function ScriptLimitsToJSONTyped(value, ignoreDiscriminator = false) {
59
+ if (value == null) {
60
+ return value;
61
+ }
62
+ return {
63
+ 'maxConcurrentRuns': value['maxConcurrentRuns'],
64
+ 'maxCreditsPerMonth': value['maxCreditsPerMonth'],
65
+ 'maxEnabledScripts': value['maxEnabledScripts'],
66
+ 'maxRunSeconds': value['maxRunSeconds'],
67
+ 'minCronIntervalSeconds': value['minCronIntervalSeconds'],
68
+ 'webhookRequestsPerMinute': value['webhookRequestsPerMinute'],
69
+ };
70
+ }
@@ -0,0 +1,46 @@
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 { ScriptLimitValues } from './ScriptLimitValues';
13
+ import type { ScriptLimitOverrides } from './ScriptLimitOverrides';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface ScriptLimitsResBody
18
+ */
19
+ export interface ScriptLimitsResBody {
20
+ /**
21
+ * The code defaults for scripts.
22
+ * @type {ScriptLimitValues}
23
+ * @memberof ScriptLimitsResBody
24
+ */
25
+ defaults: ScriptLimitValues;
26
+ /**
27
+ * The limits that apply to the account.
28
+ * @type {ScriptLimitValues}
29
+ * @memberof ScriptLimitsResBody
30
+ */
31
+ effective: ScriptLimitValues;
32
+ /**
33
+ * This account's overrides; an absent field uses the default.
34
+ * @type {ScriptLimitOverrides}
35
+ * @memberof ScriptLimitsResBody
36
+ */
37
+ overrides: ScriptLimitOverrides;
38
+ }
39
+ /**
40
+ * Check if a given object implements the ScriptLimitsResBody interface.
41
+ */
42
+ export declare function instanceOfScriptLimitsResBody(value: object): value is ScriptLimitsResBody;
43
+ export declare function ScriptLimitsResBodyFromJSON(json: any): ScriptLimitsResBody;
44
+ export declare function ScriptLimitsResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptLimitsResBody;
45
+ export declare function ScriptLimitsResBodyToJSON(json: any): ScriptLimitsResBody;
46
+ export declare function ScriptLimitsResBodyToJSONTyped(value?: ScriptLimitsResBody | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,60 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * spaciv API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: support@spaciv.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfScriptLimitsResBody = instanceOfScriptLimitsResBody;
17
+ exports.ScriptLimitsResBodyFromJSON = ScriptLimitsResBodyFromJSON;
18
+ exports.ScriptLimitsResBodyFromJSONTyped = ScriptLimitsResBodyFromJSONTyped;
19
+ exports.ScriptLimitsResBodyToJSON = ScriptLimitsResBodyToJSON;
20
+ exports.ScriptLimitsResBodyToJSONTyped = ScriptLimitsResBodyToJSONTyped;
21
+ const ScriptLimitValues_1 = require("./ScriptLimitValues");
22
+ const ScriptLimitOverrides_1 = require("./ScriptLimitOverrides");
23
+ /**
24
+ * Check if a given object implements the ScriptLimitsResBody interface.
25
+ */
26
+ function instanceOfScriptLimitsResBody(value) {
27
+ if (!('defaults' in value) || value['defaults'] === undefined)
28
+ return false;
29
+ if (!('effective' in value) || value['effective'] === undefined)
30
+ return false;
31
+ if (!('overrides' in value) || value['overrides'] === undefined)
32
+ return false;
33
+ return true;
34
+ }
35
+ function ScriptLimitsResBodyFromJSON(json) {
36
+ return ScriptLimitsResBodyFromJSONTyped(json, false);
37
+ }
38
+ function ScriptLimitsResBodyFromJSONTyped(json, ignoreDiscriminator) {
39
+ if (json == null) {
40
+ return json;
41
+ }
42
+ return {
43
+ 'defaults': (0, ScriptLimitValues_1.ScriptLimitValuesFromJSON)(json['defaults']),
44
+ 'effective': (0, ScriptLimitValues_1.ScriptLimitValuesFromJSON)(json['effective']),
45
+ 'overrides': (0, ScriptLimitOverrides_1.ScriptLimitOverridesFromJSON)(json['overrides']),
46
+ };
47
+ }
48
+ function ScriptLimitsResBodyToJSON(json) {
49
+ return ScriptLimitsResBodyToJSONTyped(json, false);
50
+ }
51
+ function ScriptLimitsResBodyToJSONTyped(value, ignoreDiscriminator = false) {
52
+ if (value == null) {
53
+ return value;
54
+ }
55
+ return {
56
+ 'defaults': (0, ScriptLimitValues_1.ScriptLimitValuesToJSON)(value['defaults']),
57
+ 'effective': (0, ScriptLimitValues_1.ScriptLimitValuesToJSON)(value['effective']),
58
+ 'overrides': (0, ScriptLimitOverrides_1.ScriptLimitOverridesToJSON)(value['overrides']),
59
+ };
60
+ }
@@ -0,0 +1,50 @@
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 ScriptUsage
16
+ */
17
+ export interface ScriptUsage {
18
+ /**
19
+ * Runs that ended in error, timeout or killed.
20
+ * @type {number}
21
+ * @memberof ScriptUsage
22
+ */
23
+ failedRuns: number;
24
+ /**
25
+ * Runs that did not start because a limit was reached.
26
+ * @type {number}
27
+ * @memberof ScriptUsage
28
+ */
29
+ quotaExceededRuns: number;
30
+ /**
31
+ * Runs that were not refused by a limit, whatever their outcome, including runs that failed before their sandbox started.
32
+ * @type {number}
33
+ * @memberof ScriptUsage
34
+ */
35
+ runs: number;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof ScriptUsage
40
+ */
41
+ scriptId: string;
42
+ }
43
+ /**
44
+ * Check if a given object implements the ScriptUsage interface.
45
+ */
46
+ export declare function instanceOfScriptUsage(value: object): value is ScriptUsage;
47
+ export declare function ScriptUsageFromJSON(json: any): ScriptUsage;
48
+ export declare function ScriptUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptUsage;
49
+ export declare function ScriptUsageToJSON(json: any): ScriptUsage;
50
+ export declare function ScriptUsageToJSONTyped(value?: ScriptUsage | null, ignoreDiscriminator?: boolean): any;