hcloud-sdk 16.0.0 → 18.0.0
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.
- package/changelog.md +178 -51
- package/lib/Base.d.ts +2 -1
- package/lib/Hcloud.d.ts +6 -0
- package/lib/Hcloud.js +18 -0
- package/lib/helper/ValidationHelper.d.ts +74 -0
- package/lib/helper/ValidationHelper.js +360 -0
- package/lib/interfaces/auditor/index.d.ts +17 -2
- package/lib/interfaces/auditor/index.js +12 -0
- package/lib/interfaces/cosmo/asset/index.d.ts +185 -0
- package/lib/interfaces/cosmo/asset/index.js +82 -0
- package/lib/interfaces/cosmo/comment/index.d.ts +38 -0
- package/lib/interfaces/cosmo/comment/index.js +8 -0
- package/lib/interfaces/cosmo/event/index.d.ts +31 -0
- package/lib/interfaces/cosmo/event/index.js +17 -0
- package/lib/interfaces/cosmo/location/index.d.ts +4 -0
- package/lib/interfaces/cosmo/location/index.js +2 -0
- package/lib/interfaces/cosmo/namespace/index.d.ts +9 -0
- package/lib/interfaces/cosmo/namespace/index.js +9 -0
- package/lib/interfaces/cosmo/permissions.d.ts +96 -0
- package/lib/interfaces/cosmo/permissions.js +58 -0
- package/lib/interfaces/cosmo/share/index.d.ts +28 -0
- package/lib/interfaces/cosmo/share/index.js +2 -0
- package/lib/interfaces/cosmo/space/index.d.ts +25 -0
- package/lib/interfaces/cosmo/space/index.js +2 -0
- package/lib/interfaces/cosmo/tag/tag.d.ts +12 -0
- package/lib/interfaces/cosmo/tag/tag.js +2 -0
- package/lib/interfaces/frontend/config/index.d.ts +1 -0
- package/lib/interfaces/fuse/space/index.d.ts +1 -0
- package/lib/interfaces/global/Products.d.ts +3 -1
- package/lib/interfaces/global/Products.js +2 -0
- package/lib/interfaces/global/Views.d.ts +2 -1
- package/lib/interfaces/global/Views.js +1 -0
- package/lib/interfaces/high5/execution/index.d.ts +23 -2
- package/lib/interfaces/high5/execution/index.js +2 -0
- package/lib/interfaces/high5/index.d.ts +7 -7
- package/lib/interfaces/high5/index.js +7 -7
- package/lib/interfaces/high5/space/database/document/index.d.ts +34 -0
- package/lib/interfaces/high5/space/database/document/index.js +14 -0
- package/lib/interfaces/high5/space/database/index.d.ts +12 -0
- package/lib/interfaces/high5/space/database/index.js +2 -0
- package/lib/interfaces/high5/space/event/stream/design/StreamDesign.d.ts +9 -2
- package/lib/interfaces/high5/space/event/stream/node/index.d.ts +10 -2
- package/lib/interfaces/high5/space/event/stream/node/index.js +6 -1
- package/lib/interfaces/high5/space/execution/index.d.ts +56 -2
- package/lib/interfaces/high5/space/execution/index.js +8 -0
- package/lib/interfaces/high5/space/index.d.ts +2 -0
- package/lib/interfaces/high5/space/job/JobLog.d.ts +16 -0
- package/lib/interfaces/high5/space/job/JobLog.js +2 -0
- package/lib/interfaces/high5/space/job/index.d.ts +38 -0
- package/lib/interfaces/high5/space/job/index.js +8 -0
- package/lib/interfaces/high5/space/pool/index.d.ts +5 -7
- package/lib/interfaces/high5/space/pool/index.js +0 -7
- package/lib/interfaces/high5/space/webhook/index.d.ts +3 -1
- package/lib/interfaces/high5/stats.d.ts +21 -0
- package/lib/interfaces/high5/stats.js +2 -0
- package/lib/interfaces/high5/wave/index.d.ts +8 -3
- package/lib/interfaces/idp/index.d.ts +1 -0
- package/lib/interfaces/idp/index.js +1 -0
- package/lib/interfaces/idp/oauth/index.d.ts +4 -3
- package/lib/interfaces/idp/organization/index.d.ts +1 -0
- package/lib/interfaces/idp/organization/index.js +1 -0
- package/lib/interfaces/idp/organization/license/index.d.ts +13 -0
- package/lib/interfaces/idp/organization/member/index.d.ts +2 -0
- package/lib/interfaces/idp/organization/service-accounts.d.ts +8 -0
- package/lib/interfaces/idp/organization/service-accounts.js +2 -0
- package/lib/interfaces/idp/organization/stats.d.ts +7 -0
- package/lib/interfaces/idp/organization/stats.js +2 -0
- package/lib/interfaces/idp/organization/team/index.d.ts +0 -1
- package/lib/interfaces/idp/user/GeneralSettings.d.ts +1 -0
- package/lib/interfaces/idp/user/GeneralSettings.js +1 -0
- package/lib/interfaces/idp/user/Message.d.ts +21 -0
- package/lib/interfaces/idp/user/Message.js +14 -0
- package/lib/interfaces/idp/user/NotificationSettings.d.ts +1 -0
- package/lib/interfaces/idp/user/Scopes.d.ts +8 -2
- package/lib/interfaces/idp/user/Scopes.js +9 -0
- package/lib/interfaces/idp/user/index.d.ts +2 -1
- package/lib/interfaces/mailer/index.d.ts +30 -1
- package/lib/interfaces/mailer/index.js +87 -1
- package/lib/interfaces/mothership/index.d.ts +3 -1
- package/lib/interfaces/mothership/index.js +15 -0
- package/lib/interfaces/mothership/stats.d.ts +4 -0
- package/lib/interfaces/mothership/stats.js +2 -0
- package/lib/interfaces/nats/index.d.ts +98 -9
- package/lib/interfaces/nats/index.js +136 -19
- package/lib/interfaces/shorts/index.d.ts +10 -0
- package/lib/interfaces/shorts/index.js +2 -0
- package/lib/service/agent/bundle/dev/index.d.ts +16 -6
- package/lib/service/agent/bundle/dev/index.js +12 -10
- package/lib/service/agent/bundle/index.d.ts +10 -4
- package/lib/service/agent/bundle/index.js +6 -6
- package/lib/service/agent/context/index.d.ts +26 -7
- package/lib/service/agent/context/index.js +27 -12
- package/lib/service/auditor/index.d.ts +8 -4
- package/lib/service/auditor/index.js +5 -5
- package/lib/service/auditor/internal/index.d.ts +27 -3
- package/lib/service/auditor/internal/index.js +34 -5
- package/lib/service/bouncer/features/index.d.ts +4 -2
- package/lib/service/bouncer/features/index.js +2 -2
- package/lib/service/cosmo/asset/index.d.ts +219 -0
- package/lib/service/cosmo/asset/index.js +314 -0
- package/lib/service/cosmo/comment/index.d.ts +122 -0
- package/lib/service/cosmo/comment/index.js +161 -0
- package/lib/service/cosmo/event/index.d.ts +23 -0
- package/lib/service/cosmo/event/index.js +40 -0
- package/lib/service/cosmo/folder/index.d.ts +27 -0
- package/lib/service/cosmo/folder/index.js +47 -0
- package/lib/service/cosmo/index.d.ts +49 -0
- package/lib/service/cosmo/index.js +119 -0
- package/lib/service/cosmo/internal/index.d.ts +7 -0
- package/lib/service/cosmo/internal/index.js +17 -0
- package/lib/service/cosmo/internal/space/index.d.ts +15 -0
- package/lib/service/cosmo/internal/space/index.js +34 -0
- package/lib/service/cosmo/location/index.d.ts +40 -0
- package/lib/service/cosmo/location/index.js +63 -0
- package/lib/service/cosmo/namespace/index.d.ts +42 -0
- package/lib/service/cosmo/namespace/index.js +65 -0
- package/lib/service/cosmo/organization/index.d.ts +47 -0
- package/lib/service/cosmo/organization/index.js +64 -0
- package/lib/service/cosmo/permissions/index.d.ts +131 -0
- package/lib/service/cosmo/permissions/index.js +181 -0
- package/lib/service/cosmo/production/index.d.ts +26 -0
- package/lib/service/cosmo/production/index.js +45 -0
- package/lib/service/cosmo/share/index.d.ts +161 -0
- package/lib/service/cosmo/share/index.js +215 -0
- package/lib/service/cosmo/space/index.d.ts +104 -0
- package/lib/service/cosmo/space/index.js +146 -0
- package/lib/service/cosmo/tag/index.d.ts +67 -0
- package/lib/service/cosmo/tag/index.js +93 -0
- package/lib/service/dali/DaliAvatar.d.ts +12 -0
- package/lib/service/dali/DaliAvatar.js +20 -0
- package/lib/service/dali/avatar/DaliCosmoSpace.d.ts +32 -0
- package/lib/service/dali/avatar/DaliCosmoSpace.js +59 -0
- package/lib/service/dali/avatar/DaliFuseSpace.d.ts +10 -4
- package/lib/service/dali/avatar/DaliFuseSpace.js +7 -6
- package/lib/service/dali/avatar/DaliHigh5Pool.d.ts +10 -4
- package/lib/service/dali/avatar/DaliHigh5Pool.js +7 -6
- package/lib/service/dali/avatar/DaliHigh5Space.d.ts +10 -4
- package/lib/service/dali/avatar/DaliHigh5Space.js +7 -6
- package/lib/service/dali/avatar/DaliOAuthApp.d.ts +10 -4
- package/lib/service/dali/avatar/DaliOAuthApp.js +7 -6
- package/lib/service/dali/avatar/DaliOrganization.d.ts +10 -4
- package/lib/service/dali/avatar/DaliOrganization.js +7 -6
- package/lib/service/dali/avatar/DaliServiceAccount.d.ts +32 -0
- package/lib/service/dali/avatar/DaliServiceAccount.js +59 -0
- package/lib/service/dali/avatar/DaliTeam.d.ts +10 -4
- package/lib/service/dali/avatar/DaliTeam.js +7 -6
- package/lib/service/dali/avatar/DaliUser.d.ts +10 -4
- package/lib/service/dali/avatar/DaliUser.js +7 -6
- package/lib/service/dali/index.d.ts +4 -5
- package/lib/service/dali/index.js +2 -5
- package/lib/service/fuse/index.d.ts +4 -2
- package/lib/service/fuse/index.js +2 -2
- package/lib/service/fuse/internal/index.d.ts +4 -2
- package/lib/service/fuse/internal/index.js +3 -2
- package/lib/service/fuse/internal/space/cronjob/log/index.d.ts +4 -2
- package/lib/service/fuse/internal/space/cronjob/log/index.js +2 -2
- package/lib/service/fuse/internal/space/index.d.ts +7 -3
- package/lib/service/fuse/internal/space/index.js +6 -4
- package/lib/service/fuse/space/cronjob/index.d.ts +35 -13
- package/lib/service/fuse/space/cronjob/index.js +48 -50
- package/lib/service/fuse/space/cronjob/log/index.d.ts +8 -4
- package/lib/service/fuse/space/cronjob/log/index.js +5 -5
- package/lib/service/fuse/space/index.d.ts +27 -11
- package/lib/service/fuse/space/index.js +19 -18
- package/lib/service/high5/execution/index.d.ts +4 -2
- package/lib/service/high5/execution/index.js +3 -2
- package/lib/service/high5/execution/status/index.d.ts +5 -3
- package/lib/service/high5/execution/status/index.js +3 -3
- package/lib/service/high5/index.d.ts +7 -2
- package/lib/service/high5/index.js +9 -2
- package/lib/service/high5/internal/index.d.ts +4 -2
- package/lib/service/high5/internal/index.js +3 -2
- package/lib/service/high5/internal/space/index.d.ts +10 -3
- package/lib/service/high5/internal/space/index.js +13 -4
- package/lib/service/high5/internal/space/job/index.d.ts +7 -0
- package/lib/service/high5/internal/space/job/index.js +17 -0
- package/lib/service/high5/internal/space/job/log/index.d.ts +17 -0
- package/lib/service/high5/internal/space/job/log/index.js +34 -0
- package/lib/service/high5/joinToken/index.d.ts +14 -6
- package/lib/service/high5/joinToken/index.js +10 -9
- package/lib/service/high5/space/database/document/array/index.d.ts +73 -0
- package/lib/service/high5/space/database/document/array/index.js +102 -0
- package/lib/service/high5/space/database/document/index.d.ts +74 -0
- package/lib/service/high5/space/database/document/index.js +112 -0
- package/lib/service/high5/space/database/document/number/index.d.ts +51 -0
- package/lib/service/high5/space/database/document/number/index.js +77 -0
- package/lib/service/high5/space/database/index.d.ts +65 -0
- package/lib/service/high5/space/database/index.js +102 -0
- package/lib/service/high5/space/event/index.d.ts +17 -7
- package/lib/service/high5/space/event/index.js +12 -11
- package/lib/service/high5/space/event/stream/design/DesignOperations.d.ts +4 -2
- package/lib/service/high5/space/event/stream/design/DesignOperations.js +5 -3
- package/lib/service/high5/space/event/stream/design/index.d.ts +10 -4
- package/lib/service/high5/space/event/stream/design/index.js +7 -6
- package/lib/service/high5/space/event/stream/design/snapshot/index.d.ts +16 -6
- package/lib/service/high5/space/event/stream/design/snapshot/index.js +12 -10
- package/lib/service/high5/space/event/stream/index.d.ts +32 -12
- package/lib/service/high5/space/event/stream/index.js +22 -21
- package/lib/service/high5/space/execution/index.d.ts +22 -7
- package/lib/service/high5/space/execution/index.js +23 -12
- package/lib/service/high5/space/execution/log/index.d.ts +8 -4
- package/lib/service/high5/space/execution/log/index.js +5 -5
- package/lib/service/high5/space/execution/status/index.d.ts +18 -7
- package/lib/service/high5/space/execution/status/index.js +20 -8
- package/lib/service/high5/space/index.d.ts +56 -18
- package/lib/service/high5/space/index.js +65 -27
- package/lib/service/high5/space/job/index.d.ts +145 -0
- package/lib/service/high5/space/job/index.js +201 -0
- package/lib/service/high5/space/job/log/index.d.ts +35 -0
- package/lib/service/high5/space/job/log/index.js +58 -0
- package/lib/service/high5/space/node/index.d.ts +20 -8
- package/lib/service/high5/space/node/index.js +14 -13
- package/lib/service/high5/space/pool/index.d.ts +27 -11
- package/lib/service/high5/space/pool/index.js +19 -18
- package/lib/service/high5/space/secret/index.d.ts +17 -7
- package/lib/service/high5/space/secret/index.js +12 -11
- package/lib/service/high5/space/stat/index.d.ts +12 -0
- package/lib/service/high5/space/stat/index.js +31 -0
- package/lib/service/high5/space/wave/index.d.ts +16 -6
- package/lib/service/high5/space/wave/index.js +11 -10
- package/lib/service/high5/space/webhook/index.d.ts +32 -12
- package/lib/service/high5/space/webhook/index.js +25 -21
- package/lib/service/high5/space/webhook/log/index.d.ts +4 -2
- package/lib/service/high5/space/webhook/log/index.js +2 -2
- package/lib/service/high5/stat/index.d.ts +11 -0
- package/lib/service/high5/stat/index.js +30 -0
- package/lib/service/high5/wave/s3/index.d.ts +31 -8
- package/lib/service/high5/wave/s3/index.js +52 -24
- package/lib/service/idp/guest/index.d.ts +42 -0
- package/lib/service/idp/guest/index.js +66 -0
- package/lib/service/idp/index.d.ts +25 -7
- package/lib/service/idp/index.js +23 -12
- package/lib/service/idp/internal/index.d.ts +5 -3
- package/lib/service/idp/internal/index.js +5 -3
- package/lib/service/idp/oauth/index.d.ts +16 -6
- package/lib/service/idp/oauth/index.js +15 -15
- package/lib/service/idp/organization/index.d.ts +25 -5
- package/lib/service/idp/organization/index.js +29 -8
- package/lib/service/idp/organization/license/index.d.ts +7 -3
- package/lib/service/idp/organization/license/index.js +4 -4
- package/lib/service/idp/organization/member/index.d.ts +21 -8
- package/lib/service/idp/organization/member/index.js +16 -13
- package/lib/service/idp/organization/member/invitations/index.d.ts +23 -9
- package/lib/service/idp/organization/member/invitations/index.js +72 -59
- package/lib/service/idp/organization/service-accounts/index.d.ts +76 -0
- package/lib/service/idp/organization/service-accounts/index.js +109 -0
- package/lib/service/idp/organization/settings/domain/index.d.ts +13 -5
- package/lib/service/idp/organization/settings/domain/index.js +9 -8
- package/lib/service/idp/organization/settings/domain/saml/index.d.ts +16 -6
- package/lib/service/idp/organization/settings/domain/saml/index.js +19 -18
- package/lib/service/idp/organization/settings/oauth/index.d.ts +23 -9
- package/lib/service/idp/organization/settings/oauth/index.js +16 -15
- package/lib/service/idp/organization/stat/index.d.ts +11 -0
- package/lib/service/idp/organization/stat/index.js +30 -0
- package/lib/service/idp/organization/team/index.d.ts +22 -10
- package/lib/service/idp/organization/team/index.js +14 -13
- package/lib/service/idp/registration/index.d.ts +10 -4
- package/lib/service/idp/registration/index.js +15 -9
- package/lib/service/idp/user/index.d.ts +33 -11
- package/lib/service/idp/user/index.js +30 -16
- package/lib/service/idp/user/license/index.d.ts +7 -3
- package/lib/service/idp/user/license/index.js +4 -4
- package/lib/service/idp/user/message/index.d.ts +61 -0
- package/lib/service/idp/user/message/index.js +92 -0
- package/lib/service/idp/user/password/index.d.ts +4 -2
- package/lib/service/idp/user/password/index.js +3 -3
- package/lib/service/idp/user/settings/connections/index.d.ts +4 -2
- package/lib/service/idp/user/settings/connections/index.js +2 -2
- package/lib/service/idp/user/settings/general/index.d.ts +10 -4
- package/lib/service/idp/user/settings/general/index.js +6 -6
- package/lib/service/idp/user/settings/notifications/index.d.ts +7 -3
- package/lib/service/idp/user/settings/notifications/index.js +4 -4
- package/lib/service/idp/user/settings/oauthApps/index.d.ts +7 -3
- package/lib/service/idp/user/settings/oauthApps/index.js +6 -5
- package/lib/service/idp/user/settings/pats/index.d.ts +22 -8
- package/lib/service/idp/user/settings/pats/index.js +17 -15
- package/lib/service/idp/user/settings/twoFactor/totp/index.d.ts +16 -6
- package/lib/service/idp/user/settings/twoFactor/totp/index.js +13 -10
- package/lib/service/mailer/index.d.ts +4 -2
- package/lib/service/mailer/index.js +2 -2
- package/lib/service/mailer/internal/index.d.ts +13 -5
- package/lib/service/mailer/internal/index.js +8 -8
- package/lib/service/mothership/index.d.ts +35 -13
- package/lib/service/mothership/index.js +32 -18
- package/lib/service/nats/index.js +58 -44
- package/lib/service/shorts/index.d.ts +18 -0
- package/lib/service/shorts/index.js +38 -0
- package/lib/service/shorts/internal/index.d.ts +72 -0
- package/lib/service/shorts/internal/index.js +104 -0
- package/lib/utils/bouncer/features/Provider.js +0 -3
- package/package.json +22 -24
|
@@ -1,12 +1,15 @@
|
|
|
1
|
-
import Base from "../../../Base";
|
|
1
|
+
import Base, { MaybeRaw } from "../../../Base";
|
|
2
2
|
import { PaginatedResponse, SearchParams } from "../../../interfaces/global";
|
|
3
3
|
import { Stream } from "../../../interfaces/high5";
|
|
4
4
|
import { High5Space as Space, High5SpaceEntityPermission as SpaceEntityPermission, High5SpacePermission as SpacePermission } from "../../../interfaces/high5/space";
|
|
5
|
+
import { High5Database } from "./database";
|
|
5
6
|
import { High5Event } from "./event";
|
|
6
7
|
import { High5SpaceExecute } from "./execution";
|
|
8
|
+
import { High5Job } from "./job";
|
|
7
9
|
import High5Node from "./node";
|
|
8
10
|
import High5Pool from "./pool";
|
|
9
11
|
import High5Secret from "./secret";
|
|
12
|
+
import { High5SpaceStat } from "./stat";
|
|
10
13
|
import High5Wave from "./wave";
|
|
11
14
|
import { High5Webhook } from "./webhook";
|
|
12
15
|
export declare class High5Space extends Base {
|
|
@@ -24,6 +27,12 @@ export declare class High5Space extends Base {
|
|
|
24
27
|
private _wave?;
|
|
25
28
|
get node(): High5Node;
|
|
26
29
|
private _node?;
|
|
30
|
+
get database(): High5Database;
|
|
31
|
+
private _database?;
|
|
32
|
+
get job(): High5Job;
|
|
33
|
+
private _job?;
|
|
34
|
+
get stat(): High5SpaceStat;
|
|
35
|
+
private _stat?;
|
|
27
36
|
/**
|
|
28
37
|
* Retrieves all High5 Spaces of the specified Organization matching the search filter(s). Will return all Spaces if no search filter is provided.
|
|
29
38
|
* @param orgName Name of the organization
|
|
@@ -33,43 +42,54 @@ export declare class High5Space extends Base {
|
|
|
33
42
|
* @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
|
|
34
43
|
* @returns Object containing an array of High5 Spaces and the total number of results found in the database (independent of limit and page)
|
|
35
44
|
*/
|
|
36
|
-
searchSpaces({ orgName, filters, sorting, limit, page }: SearchParams & {
|
|
45
|
+
searchSpaces<R extends boolean = false>({ orgName, filters, sorting, limit, page }: SearchParams & {
|
|
37
46
|
orgName: string;
|
|
38
|
-
}
|
|
47
|
+
}, raw?: {
|
|
48
|
+
raw: R;
|
|
49
|
+
}): Promise<MaybeRaw<R, PaginatedResponse<Space>>>;
|
|
39
50
|
/**
|
|
40
51
|
* Retrieves permissions of a space matching the search filter(s). Will return all permissions of the space if no search filter is provided.
|
|
41
52
|
* @param orgName Name of the organization
|
|
42
|
-
* @param spaceName Name of the
|
|
53
|
+
* @param spaceName Name of the Space
|
|
43
54
|
* @param filters (optional) Array of search filters
|
|
44
55
|
* @param sorting (optional) Sorting object
|
|
45
56
|
* @param limit (optional) Max number of results (1-100; defaults to 25)
|
|
46
57
|
* @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
|
|
47
58
|
* @returns Object containing an array of High5 Space Permissions and the total number of results found in the database (independent of limit and page)
|
|
48
59
|
*/
|
|
49
|
-
searchSpacePermissions({ orgName, spaceName, filters, sorting, limit, page
|
|
60
|
+
searchSpacePermissions<R extends boolean = false>({ orgName, spaceName, filters, sorting, limit, page }: SearchParams & {
|
|
50
61
|
orgName: string;
|
|
51
62
|
spaceName: string;
|
|
52
|
-
}
|
|
63
|
+
}, raw?: {
|
|
64
|
+
raw: R;
|
|
65
|
+
}): Promise<MaybeRaw<R, PaginatedResponse<SpaceEntityPermission>>>;
|
|
53
66
|
/**
|
|
54
67
|
* Retrieves a High5 Space by its name.
|
|
55
68
|
* @param orgName Name of the Organization
|
|
56
|
-
* @param
|
|
69
|
+
* @param spaceName Name of the space
|
|
57
70
|
* @returns The requested Space
|
|
58
71
|
*/
|
|
59
|
-
getSpace(orgName: string, spaceName: string
|
|
72
|
+
getSpace<R extends boolean = false>(orgName: string, spaceName: string, raw?: {
|
|
73
|
+
raw: R;
|
|
74
|
+
}): Promise<MaybeRaw<R, Space>>;
|
|
60
75
|
/**
|
|
61
76
|
* Creates a new High5 Space in the specified Organization.
|
|
62
77
|
* @param orgName Name of the Organization
|
|
63
78
|
* @param name Name for the new Space
|
|
79
|
+
* @param enableDev (optional) Specifies to the front-end whether to display the versions in the development of Wave Engines and Node Catalogs
|
|
64
80
|
* @returns The created Space
|
|
65
81
|
*/
|
|
66
|
-
createSpace(orgName: string, name: string
|
|
82
|
+
createSpace<R extends boolean = false>(orgName: string, name: string, enableDev?: boolean, raw?: {
|
|
83
|
+
raw: R;
|
|
84
|
+
}): Promise<MaybeRaw<R, Space>>;
|
|
67
85
|
/**
|
|
68
86
|
* Delete a space by its name.
|
|
69
87
|
* @param orgName Name of the Organization
|
|
70
88
|
* @param spaceName Name of the Space
|
|
71
89
|
*/
|
|
72
|
-
deleteSpace(orgName: string, spaceName: string
|
|
90
|
+
deleteSpace<R extends boolean = false>(orgName: string, spaceName: string, raw?: {
|
|
91
|
+
raw: R;
|
|
92
|
+
}): Promise<MaybeRaw<R, void>>;
|
|
73
93
|
/**
|
|
74
94
|
* Adds/Updates/Removes the permission a user has in the specified space.
|
|
75
95
|
* @param orgName Name of the Organization
|
|
@@ -78,7 +98,9 @@ export declare class High5Space extends Base {
|
|
|
78
98
|
* @param permission New permission
|
|
79
99
|
* @returns The Space with updated permissions
|
|
80
100
|
*/
|
|
81
|
-
updateUserSpacePermission(orgName: string, spaceName: string, userId: string, permission: SpacePermission
|
|
101
|
+
updateUserSpacePermission<R extends boolean = false>(orgName: string, spaceName: string, userId: string, permission: SpacePermission, raw?: {
|
|
102
|
+
raw: R;
|
|
103
|
+
}): Promise<MaybeRaw<R, SpaceEntityPermission>>;
|
|
82
104
|
/**
|
|
83
105
|
* Adds/Updates/Removes the permission a team has in the specified space. Note: A team cannot be an owner of a Space.
|
|
84
106
|
* @param orgName Name of the Organization
|
|
@@ -87,28 +109,44 @@ export declare class High5Space extends Base {
|
|
|
87
109
|
* @param permission New permission
|
|
88
110
|
* @returns The Space with updated permissions
|
|
89
111
|
*/
|
|
90
|
-
updateTeamSpacePermission(orgName: string, spaceName: string, teamName: string, permission: SpacePermission
|
|
112
|
+
updateTeamSpacePermission<R extends boolean = false>(orgName: string, spaceName: string, teamName: string, permission: SpacePermission, raw?: {
|
|
113
|
+
raw: R;
|
|
114
|
+
}): Promise<MaybeRaw<R, SpaceEntityPermission>>;
|
|
91
115
|
/**
|
|
92
116
|
* Retrieves all streams of a space matching the search filter(s). Will return all streams if no search filter is provided.
|
|
93
117
|
* @param orgName Name of the organization
|
|
94
|
-
* @param
|
|
118
|
+
* @param spaceName Name of the space
|
|
95
119
|
* @param filters (optional) Array of search filters
|
|
96
120
|
* @param sorting (optional) Sorting object
|
|
97
121
|
* @param limit (optional) Max number of results (1-100; defaults to 25)
|
|
98
122
|
* @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
|
|
99
123
|
* @returns Object containing an array of streams and the total number of results found in the database (independent of limit and page)
|
|
100
124
|
*/
|
|
101
|
-
searchStreamsOfSpace({ orgName, spaceName, filters, sorting, limit, page
|
|
125
|
+
searchStreamsOfSpace<R extends boolean = false>({ orgName, spaceName, filters, sorting, limit, page }: SearchParams & {
|
|
102
126
|
orgName: string;
|
|
103
127
|
spaceName: string;
|
|
104
|
-
}
|
|
128
|
+
}, raw?: {
|
|
129
|
+
raw: R;
|
|
130
|
+
}): Promise<MaybeRaw<R, PaginatedResponse<Stream>>>;
|
|
105
131
|
/**
|
|
106
132
|
* Updates the name of a space.
|
|
107
133
|
* @param orgName Name of the organization
|
|
108
|
-
* @param
|
|
109
|
-
* @param
|
|
134
|
+
* @param spaceName Current name of the space
|
|
135
|
+
* @param newSpaceName New name for the space
|
|
136
|
+
* @returns The updated space
|
|
137
|
+
*/
|
|
138
|
+
renameSpace<R extends boolean = false>(orgName: string, spaceName: string, newSpaceName: string, raw?: {
|
|
139
|
+
raw: R;
|
|
140
|
+
}): Promise<MaybeRaw<R, Space>>;
|
|
141
|
+
/**
|
|
142
|
+
* Specifies to the front-end whether to display the versions under development of Wave Engines and Node Catalogs.
|
|
143
|
+
* @param orgName Name of the organization
|
|
144
|
+
* @param spaceName Name of the space
|
|
145
|
+
* @param enableDev Specifies to the front-end whether to display the versions under development of Wave Engines and Node Catalogs
|
|
110
146
|
* @returns The updated space
|
|
111
147
|
*/
|
|
112
|
-
|
|
148
|
+
enableDev<R extends boolean = false>(orgName: string, spaceName: string, enableDev: boolean, raw?: {
|
|
149
|
+
raw: R;
|
|
150
|
+
}): Promise<MaybeRaw<R, Space>>;
|
|
113
151
|
protected getEndpoint(endpoint: string): string;
|
|
114
152
|
}
|
|
@@ -13,11 +13,14 @@ exports.High5Space = void 0;
|
|
|
13
13
|
const Base_1 = require("../../../Base");
|
|
14
14
|
const paginatedResponseHelper_1 = require("../../../helper/paginatedResponseHelper");
|
|
15
15
|
const searchFilter_1 = require("../../../helper/searchFilter");
|
|
16
|
+
const database_1 = require("./database");
|
|
16
17
|
const event_1 = require("./event");
|
|
17
18
|
const execution_1 = require("./execution");
|
|
19
|
+
const job_1 = require("./job");
|
|
18
20
|
const node_1 = require("./node");
|
|
19
21
|
const pool_1 = require("./pool");
|
|
20
22
|
const secret_1 = require("./secret");
|
|
23
|
+
const stat_1 = require("./stat");
|
|
21
24
|
const wave_1 = require("./wave");
|
|
22
25
|
const webhook_1 = require("./webhook");
|
|
23
26
|
class High5Space extends Base_1.default {
|
|
@@ -63,6 +66,24 @@ class High5Space extends Base_1.default {
|
|
|
63
66
|
}
|
|
64
67
|
return this._node;
|
|
65
68
|
}
|
|
69
|
+
get database() {
|
|
70
|
+
if (this._database === undefined) {
|
|
71
|
+
this._database = new database_1.High5Database(this.options, this.axios);
|
|
72
|
+
}
|
|
73
|
+
return this._database;
|
|
74
|
+
}
|
|
75
|
+
get job() {
|
|
76
|
+
if (this._job === undefined) {
|
|
77
|
+
this._job = new job_1.High5Job(this.options, this.axios);
|
|
78
|
+
}
|
|
79
|
+
return this._job;
|
|
80
|
+
}
|
|
81
|
+
get stat() {
|
|
82
|
+
if (this._stat === undefined) {
|
|
83
|
+
this._stat = new stat_1.High5SpaceStat(this.options, this.axios);
|
|
84
|
+
}
|
|
85
|
+
return this._stat;
|
|
86
|
+
}
|
|
66
87
|
/**
|
|
67
88
|
* Retrieves all High5 Spaces of the specified Organization matching the search filter(s). Will return all Spaces if no search filter is provided.
|
|
68
89
|
* @param orgName Name of the organization
|
|
@@ -72,58 +93,59 @@ class High5Space extends Base_1.default {
|
|
|
72
93
|
* @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
|
|
73
94
|
* @returns Object containing an array of High5 Spaces and the total number of results found in the database (independent of limit and page)
|
|
74
95
|
*/
|
|
75
|
-
searchSpaces(_a) {
|
|
76
|
-
return __awaiter(this, arguments, void 0, function* ({ orgName, filters, sorting, limit = 25, page = 0 }) {
|
|
96
|
+
searchSpaces(_a, raw_1) {
|
|
97
|
+
return __awaiter(this, arguments, void 0, function* ({ orgName, filters, sorting, limit = 25, page = 0 }, raw) {
|
|
77
98
|
const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => new searchFilter_1.SearchFilterDTO(f));
|
|
78
99
|
const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/search?page=${page}&limit=${limit}`), {
|
|
79
100
|
filters: filtersDTO,
|
|
80
101
|
sorting: sorting,
|
|
81
102
|
});
|
|
82
|
-
return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
|
|
103
|
+
return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data: (0, paginatedResponseHelper_1.createPaginatedResponse)(resp) }) : (0, paginatedResponseHelper_1.createPaginatedResponse)(resp));
|
|
83
104
|
});
|
|
84
105
|
}
|
|
85
106
|
/**
|
|
86
107
|
* Retrieves permissions of a space matching the search filter(s). Will return all permissions of the space if no search filter is provided.
|
|
87
108
|
* @param orgName Name of the organization
|
|
88
|
-
* @param spaceName Name of the
|
|
109
|
+
* @param spaceName Name of the Space
|
|
89
110
|
* @param filters (optional) Array of search filters
|
|
90
111
|
* @param sorting (optional) Sorting object
|
|
91
112
|
* @param limit (optional) Max number of results (1-100; defaults to 25)
|
|
92
113
|
* @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
|
|
93
114
|
* @returns Object containing an array of High5 Space Permissions and the total number of results found in the database (independent of limit and page)
|
|
94
115
|
*/
|
|
95
|
-
searchSpacePermissions(_a) {
|
|
96
|
-
return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, filters, sorting, limit = 25, page = 0,
|
|
116
|
+
searchSpacePermissions(_a, raw_1) {
|
|
117
|
+
return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, filters, sorting, limit = 25, page = 0 }, raw) {
|
|
97
118
|
const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => new searchFilter_1.SearchFilterDTO(f));
|
|
98
119
|
const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/permissions/search?page=${page}&limit=${limit}`), {
|
|
99
120
|
filters: filtersDTO,
|
|
100
121
|
sorting: sorting,
|
|
101
122
|
});
|
|
102
|
-
return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
|
|
123
|
+
return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data: (0, paginatedResponseHelper_1.createPaginatedResponse)(resp) }) : (0, paginatedResponseHelper_1.createPaginatedResponse)(resp));
|
|
103
124
|
});
|
|
104
125
|
}
|
|
105
126
|
/**
|
|
106
127
|
* Retrieves a High5 Space by its name.
|
|
107
128
|
* @param orgName Name of the Organization
|
|
108
|
-
* @param
|
|
129
|
+
* @param spaceName Name of the space
|
|
109
130
|
* @returns The requested Space
|
|
110
131
|
*/
|
|
111
|
-
getSpace(orgName, spaceName) {
|
|
132
|
+
getSpace(orgName, spaceName, raw) {
|
|
112
133
|
return __awaiter(this, void 0, void 0, function* () {
|
|
113
134
|
const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}`));
|
|
114
|
-
return resp.data;
|
|
135
|
+
return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
|
|
115
136
|
});
|
|
116
137
|
}
|
|
117
138
|
/**
|
|
118
139
|
* Creates a new High5 Space in the specified Organization.
|
|
119
140
|
* @param orgName Name of the Organization
|
|
120
141
|
* @param name Name for the new Space
|
|
142
|
+
* @param enableDev (optional) Specifies to the front-end whether to display the versions in the development of Wave Engines and Node Catalogs
|
|
121
143
|
* @returns The created Space
|
|
122
144
|
*/
|
|
123
|
-
createSpace(orgName, name) {
|
|
145
|
+
createSpace(orgName, name, enableDev, raw) {
|
|
124
146
|
return __awaiter(this, void 0, void 0, function* () {
|
|
125
|
-
const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces`), { name:
|
|
126
|
-
return resp.data;
|
|
147
|
+
const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces`), { name, enableDev: Boolean(enableDev) });
|
|
148
|
+
return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
|
|
127
149
|
});
|
|
128
150
|
}
|
|
129
151
|
/**
|
|
@@ -131,9 +153,10 @@ class High5Space extends Base_1.default {
|
|
|
131
153
|
* @param orgName Name of the Organization
|
|
132
154
|
* @param spaceName Name of the Space
|
|
133
155
|
*/
|
|
134
|
-
deleteSpace(orgName, spaceName) {
|
|
156
|
+
deleteSpace(orgName, spaceName, raw) {
|
|
135
157
|
return __awaiter(this, void 0, void 0, function* () {
|
|
136
|
-
yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}`));
|
|
158
|
+
const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}`));
|
|
159
|
+
return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
|
|
137
160
|
});
|
|
138
161
|
}
|
|
139
162
|
/**
|
|
@@ -144,13 +167,13 @@ class High5Space extends Base_1.default {
|
|
|
144
167
|
* @param permission New permission
|
|
145
168
|
* @returns The Space with updated permissions
|
|
146
169
|
*/
|
|
147
|
-
updateUserSpacePermission(orgName, spaceName, userId, permission) {
|
|
170
|
+
updateUserSpacePermission(orgName, spaceName, userId, permission, raw) {
|
|
148
171
|
return __awaiter(this, void 0, void 0, function* () {
|
|
149
172
|
const resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/permissions/user`), {
|
|
150
173
|
userId,
|
|
151
174
|
permission,
|
|
152
175
|
});
|
|
153
|
-
return resp.data;
|
|
176
|
+
return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
|
|
154
177
|
});
|
|
155
178
|
}
|
|
156
179
|
/**
|
|
@@ -161,48 +184,63 @@ class High5Space extends Base_1.default {
|
|
|
161
184
|
* @param permission New permission
|
|
162
185
|
* @returns The Space with updated permissions
|
|
163
186
|
*/
|
|
164
|
-
updateTeamSpacePermission(orgName, spaceName, teamName, permission) {
|
|
187
|
+
updateTeamSpacePermission(orgName, spaceName, teamName, permission, raw) {
|
|
165
188
|
return __awaiter(this, void 0, void 0, function* () {
|
|
166
189
|
const resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/permissions/team`), {
|
|
167
190
|
teamName,
|
|
168
191
|
permission,
|
|
169
192
|
});
|
|
170
|
-
return resp.data;
|
|
193
|
+
return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
|
|
171
194
|
});
|
|
172
195
|
}
|
|
173
196
|
/**
|
|
174
197
|
* Retrieves all streams of a space matching the search filter(s). Will return all streams if no search filter is provided.
|
|
175
198
|
* @param orgName Name of the organization
|
|
176
|
-
* @param
|
|
199
|
+
* @param spaceName Name of the space
|
|
177
200
|
* @param filters (optional) Array of search filters
|
|
178
201
|
* @param sorting (optional) Sorting object
|
|
179
202
|
* @param limit (optional) Max number of results (1-100; defaults to 25)
|
|
180
203
|
* @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
|
|
181
204
|
* @returns Object containing an array of streams and the total number of results found in the database (independent of limit and page)
|
|
182
205
|
*/
|
|
183
|
-
searchStreamsOfSpace(_a) {
|
|
184
|
-
return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, filters, sorting, limit = 25, page = 0,
|
|
206
|
+
searchStreamsOfSpace(_a, raw_1) {
|
|
207
|
+
return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, filters, sorting, limit = 25, page = 0 }, raw) {
|
|
185
208
|
const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => new searchFilter_1.SearchFilterDTO(f));
|
|
186
209
|
const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/streams/search?page=${page}&limit=${limit}`), {
|
|
187
210
|
filters: filtersDTO,
|
|
188
211
|
sorting: sorting,
|
|
189
212
|
});
|
|
190
|
-
return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
|
|
213
|
+
return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data: (0, paginatedResponseHelper_1.createPaginatedResponse)(resp) }) : (0, paginatedResponseHelper_1.createPaginatedResponse)(resp));
|
|
191
214
|
});
|
|
192
215
|
}
|
|
193
216
|
/**
|
|
194
217
|
* Updates the name of a space.
|
|
195
218
|
* @param orgName Name of the organization
|
|
196
|
-
* @param
|
|
197
|
-
* @param
|
|
219
|
+
* @param spaceName Current name of the space
|
|
220
|
+
* @param newSpaceName New name for the space
|
|
198
221
|
* @returns The updated space
|
|
199
222
|
*/
|
|
200
|
-
renameSpace(orgName, spaceName, newSpaceName) {
|
|
223
|
+
renameSpace(orgName, spaceName, newSpaceName, raw) {
|
|
201
224
|
return __awaiter(this, void 0, void 0, function* () {
|
|
202
225
|
const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/name`), {
|
|
203
226
|
newSpaceName,
|
|
204
227
|
});
|
|
205
|
-
return resp.data;
|
|
228
|
+
return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
|
|
229
|
+
});
|
|
230
|
+
}
|
|
231
|
+
/**
|
|
232
|
+
* Specifies to the front-end whether to display the versions under development of Wave Engines and Node Catalogs.
|
|
233
|
+
* @param orgName Name of the organization
|
|
234
|
+
* @param spaceName Name of the space
|
|
235
|
+
* @param enableDev Specifies to the front-end whether to display the versions under development of Wave Engines and Node Catalogs
|
|
236
|
+
* @returns The updated space
|
|
237
|
+
*/
|
|
238
|
+
enableDev(orgName, spaceName, enableDev, raw) {
|
|
239
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
240
|
+
const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/dev`), {
|
|
241
|
+
enableDev,
|
|
242
|
+
});
|
|
243
|
+
return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
|
|
206
244
|
});
|
|
207
245
|
}
|
|
208
246
|
getEndpoint(endpoint) {
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
import Base, { MaybeRaw } from "../../../../Base";
|
|
2
|
+
import { PaginatedResponse, SearchParams } from "../../../../interfaces/global";
|
|
3
|
+
import { Job, JobCreate } from "../../../../interfaces/high5/space/job";
|
|
4
|
+
import { High5JobLogInternal } from "../../internal/space/job/log";
|
|
5
|
+
import { High5JobLog } from "./log";
|
|
6
|
+
export declare class High5Job extends Base {
|
|
7
|
+
get jobLog(): High5JobLog;
|
|
8
|
+
private _jobLog?;
|
|
9
|
+
get jobLogInternal(): High5JobLogInternal;
|
|
10
|
+
private _jobLogInternal?;
|
|
11
|
+
/**
|
|
12
|
+
* Retrieves a cronjob by it's ID.
|
|
13
|
+
* @param orgName Name of the organization
|
|
14
|
+
* @param spaceName Name of the High5 space
|
|
15
|
+
* @param jobId ID of the cronjob
|
|
16
|
+
* @param exposeNextExecution (optional) Show the next execution as a Unix timestamp (in milliseconds) in the response object
|
|
17
|
+
* @returns The requested cronjob
|
|
18
|
+
*/
|
|
19
|
+
getJob<R extends boolean = false>(orgName: string, spaceName: string, jobId: string, exposeNextExecution?: boolean, raw?: {
|
|
20
|
+
raw: R;
|
|
21
|
+
}): Promise<MaybeRaw<R, Job>>;
|
|
22
|
+
/**
|
|
23
|
+
* Retrieves the next n cronjob executions as Unix timestamps (in milliseconds).
|
|
24
|
+
* @param orgName Name of the organization
|
|
25
|
+
* @param spaceName Name of the space
|
|
26
|
+
* @param jobId ID of the cronjob
|
|
27
|
+
* @returns Array of Unix timestamps
|
|
28
|
+
*/
|
|
29
|
+
getNextCronjobExecutions<R extends boolean = false>(orgName: string, spaceName: string, jobId: string, raw?: {
|
|
30
|
+
raw: R;
|
|
31
|
+
}): Promise<MaybeRaw<R, number[]>>;
|
|
32
|
+
/**
|
|
33
|
+
* Creates a new cronjob in the specified High5 space.
|
|
34
|
+
* @param orgName Name of the organisation
|
|
35
|
+
* @param spaceName Name of the High5 space
|
|
36
|
+
* @param createJob Cronjob to be created
|
|
37
|
+
* @param exposeNextExecution (optional) Show the next execution as a Unix timestamp (in milliseconds) in the response object
|
|
38
|
+
* @returns Created cronjob
|
|
39
|
+
*/
|
|
40
|
+
createJob<R extends boolean = false>(orgName: string, spaceName: string, createJob: JobCreate, exposeNextExecution?: boolean, raw?: {
|
|
41
|
+
raw: R;
|
|
42
|
+
}): Promise<MaybeRaw<R, Job>>;
|
|
43
|
+
/**
|
|
44
|
+
* Updates an existing cronjob.
|
|
45
|
+
* @param orgName Name of the organization
|
|
46
|
+
* @param spaceName Name of the space
|
|
47
|
+
* @param jobId ID of the cronjob
|
|
48
|
+
* @param createJob Cronjob to be updated
|
|
49
|
+
* @param exposeNextExecution (optional) Show the next execution as a Unix timestamp (in milliseconds) in the response object
|
|
50
|
+
* @returns Updated cronjob
|
|
51
|
+
*/
|
|
52
|
+
updateJob<R extends boolean = false>(orgName: string, spaceName: string, jobId: string, createJob: JobCreate, exposeNextExecution?: boolean, raw?: {
|
|
53
|
+
raw: R;
|
|
54
|
+
}): Promise<MaybeRaw<R, Job>>;
|
|
55
|
+
/**
|
|
56
|
+
* Change the cron expression of an existing cronjob
|
|
57
|
+
* @param orgName Name of the organization
|
|
58
|
+
* @param spaceName Name of the space
|
|
59
|
+
* @param jobId ID of the cronjob
|
|
60
|
+
* @param expression New cron expression
|
|
61
|
+
* @param exposeNextExecution (optional) Show the next execution as a Unix timestamp (in milliseconds) in the response object
|
|
62
|
+
* @returns The patched cronjob
|
|
63
|
+
*/
|
|
64
|
+
patchCronjobExpression<R extends boolean = false>(orgName: string, spaceName: string, jobId: string, expression: string, exposeNextExecution?: boolean, raw?: {
|
|
65
|
+
raw: R;
|
|
66
|
+
}): Promise<MaybeRaw<R, Job>>;
|
|
67
|
+
/**
|
|
68
|
+
* Change the enabled flag of an existing cronjob
|
|
69
|
+
* @param orgName Name of the organization
|
|
70
|
+
* @param spaceName Name of the space
|
|
71
|
+
* @param jobId ID of the cronjob
|
|
72
|
+
* @param enabled Boolean flag to set
|
|
73
|
+
* @param exposeNextExecution (optional) Show the next execution as a Unix timestamp (in milliseconds) in the response object
|
|
74
|
+
* @returns The patched cronjob
|
|
75
|
+
*/
|
|
76
|
+
patchCronjobEnabled<R extends boolean = false>(orgName: string, spaceName: string, jobId: string, enabled: boolean, exposeNextExecution?: boolean, raw?: {
|
|
77
|
+
raw: R;
|
|
78
|
+
}): Promise<MaybeRaw<R, Job>>;
|
|
79
|
+
/**
|
|
80
|
+
* Enable a cronjob.
|
|
81
|
+
*
|
|
82
|
+
* This is a wrapper around patchCronjobEnabled.
|
|
83
|
+
*
|
|
84
|
+
* @param orgName Name of the organization
|
|
85
|
+
* @param spaceName Name of the space
|
|
86
|
+
* @param jobId ID of the cronjob
|
|
87
|
+
* @param exposeNextExecution (optional) Show the next execution as a Unix timestamp (in milliseconds) in the response object
|
|
88
|
+
* @returns The patched cronjob
|
|
89
|
+
*/
|
|
90
|
+
enableCronjob<R extends boolean = false>(orgName: string, spaceName: string, jobId: string, exposeNextExecution?: boolean, raw?: {
|
|
91
|
+
raw: R;
|
|
92
|
+
}): Promise<MaybeRaw<R, Job>>;
|
|
93
|
+
/**
|
|
94
|
+
* Disable a cronjob.
|
|
95
|
+
*
|
|
96
|
+
* This is a wrapper around patchCronjobEnabled.
|
|
97
|
+
*
|
|
98
|
+
* @param orgName Name of the organization
|
|
99
|
+
* @param spaceName Name of the space
|
|
100
|
+
* @param jobId ID of the cronjob
|
|
101
|
+
* @param exposeNextExecution (optional) Show the next execution as a Unix timestamp (in milliseconds) in the response object
|
|
102
|
+
* @returns The patched cronjob
|
|
103
|
+
*/
|
|
104
|
+
disableCronjob<R extends boolean = false>(orgName: string, spaceName: string, jobId: string, exposeNextExecution?: boolean, raw?: {
|
|
105
|
+
raw: R;
|
|
106
|
+
}): Promise<MaybeRaw<R, Job>>;
|
|
107
|
+
/**
|
|
108
|
+
* Deletes a cronjob by its ID
|
|
109
|
+
* @param orgName Name of the organization
|
|
110
|
+
* @param spaceName Name of the space
|
|
111
|
+
* @param jobId ID of the cronjob
|
|
112
|
+
*/
|
|
113
|
+
deleteJob<R extends boolean = false>(orgName: string, spaceName: string, jobId: string, raw?: {
|
|
114
|
+
raw: R;
|
|
115
|
+
}): Promise<MaybeRaw<R, void>>;
|
|
116
|
+
/**
|
|
117
|
+
* Retrieves all cronjobs of a High5 space which match the provided search filter(s). Will return all cronjobs if no filter is provided.
|
|
118
|
+
* @param orgName Name of the organization
|
|
119
|
+
* @param spaceName Name of the space
|
|
120
|
+
* @param filters (optional) Array of search filters
|
|
121
|
+
* @param sorting (optional) Sorting object
|
|
122
|
+
* @param limit (optional) Max number of results (1-100; defaults to 25)
|
|
123
|
+
* @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
|
|
124
|
+
* @param exposeNextExecution (optional) Show the next execution as a Unix timestamp (in milliseconds) in the returned cronjob objects
|
|
125
|
+
* @returns Object containing an array of filtered cronjobs as well as the total number of results found in the database (independent of limit and page)
|
|
126
|
+
*/
|
|
127
|
+
searchJobs<R extends boolean = false>({ orgName, spaceName, filters, sorting, limit, page, exposeNextExecution, }: SearchParams & {
|
|
128
|
+
orgName: string;
|
|
129
|
+
spaceName: string;
|
|
130
|
+
exposeNextExecution?: boolean;
|
|
131
|
+
}, raw?: {
|
|
132
|
+
raw: R;
|
|
133
|
+
}): Promise<MaybeRaw<R, PaginatedResponse<Job>>>;
|
|
134
|
+
/**
|
|
135
|
+
* Resolve a cron pattern along with a timezone to get the next executions in mili-seconds.
|
|
136
|
+
* @param expression The cron expression
|
|
137
|
+
* @param timezone The target IANA timezone
|
|
138
|
+
* @param amount The amount of returned execution-dates (limited between 1 and 10, default is 3)
|
|
139
|
+
* @returns Array of Unix timestamps
|
|
140
|
+
*/
|
|
141
|
+
resolveCronPatternWithTimezone<R extends boolean = false>(expression: string, timezone: string, amount?: number, raw?: {
|
|
142
|
+
raw: R;
|
|
143
|
+
}): Promise<MaybeRaw<R, number[]>>;
|
|
144
|
+
protected getEndpoint(endpoint: string): string;
|
|
145
|
+
}
|