@qlik/api 1.32.0 → 1.34.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.
Files changed (142) hide show
  1. package/api-keys.d.ts +13 -12
  2. package/api-keys.js +64 -50
  3. package/apps.d.ts +56 -56
  4. package/apps.js +392 -304
  5. package/assistants.d.ts +34 -34
  6. package/assistants.js +257 -201
  7. package/audits.d.ts +10 -10
  8. package/audits.js +48 -36
  9. package/{auth-types-DqfMuSRX.d.ts → auth-types-Cj5bM3Yk.d.ts} +29 -9
  10. package/auth.d.ts +17 -4
  11. package/auth.js +4 -2
  12. package/automation-connections.d.ts +12 -12
  13. package/automation-connections.js +75 -59
  14. package/automations.d.ts +29 -29
  15. package/automations.js +159 -123
  16. package/automl-deployments.d.ts +4 -4
  17. package/automl-deployments.js +14 -12
  18. package/automl-predictions.d.ts +13 -13
  19. package/automl-predictions.js +56 -44
  20. package/brands.d.ts +18 -18
  21. package/brands.js +107 -83
  22. package/chunks/{LY7RP2HA.js → 4V6T7Y4L.js} +26 -8
  23. package/chunks/{RCLKKVYB.js → 6C6WMV7V.js} +9 -2
  24. package/chunks/{VVD2DPKQ.js → 6WNP7HZQ.js} +3 -3
  25. package/chunks/7MMXU6EL.js +86 -0
  26. package/chunks/{6ZONDHRN.js → EEE42MLS.js} +11 -4
  27. package/chunks/{FKDGGR2O.js → I2HA7WJB.js} +1362 -1366
  28. package/chunks/{M64RLKVG.js → M7AINAXZ.js} +7 -5
  29. package/chunks/{LTNGXTXG.js → QAOVZB27.js} +3 -3
  30. package/chunks/{YTT2FEVE.js → QZKOA6VR.js} +1 -1
  31. package/chunks/{UZTIZ4H5.js → VUYZKBT5.js} +74 -74
  32. package/chunks/{3RGGGGAR.js → ZCTVPXGO.js} +1 -1
  33. package/collections.d.ts +16 -15
  34. package/collections.js +98 -76
  35. package/conditions.d.ts +13 -13
  36. package/conditions.js +97 -75
  37. package/consumption.d.ts +4 -4
  38. package/consumption.js +11 -9
  39. package/csp-origins.d.ts +9 -9
  40. package/csp-origins.js +53 -41
  41. package/csrf-token.d.ts +3 -3
  42. package/csrf-token.js +10 -8
  43. package/data-alerts.d.ts +22 -22
  44. package/data-alerts.js +139 -107
  45. package/data-assets.d.ts +8 -8
  46. package/data-assets.js +50 -40
  47. package/data-connections.d.ts +16 -16
  48. package/data-connections.js +87 -69
  49. package/data-credentials.d.ts +11 -11
  50. package/data-credentials.js +52 -42
  51. package/data-files.d.ts +18 -18
  52. package/data-files.js +107 -83
  53. package/data-qualities.d.ts +6 -6
  54. package/data-qualities.js +28 -22
  55. package/data-sets.d.ts +10 -10
  56. package/data-sets.js +59 -47
  57. package/data-sources.d.ts +7 -7
  58. package/data-sources.js +28 -22
  59. package/data-stores.d.ts +16 -16
  60. package/data-stores.js +92 -72
  61. package/dcaas.d.ts +6 -6
  62. package/dcaas.js +28 -22
  63. package/di-projects.d.ts +22 -22
  64. package/di-projects.js +148 -116
  65. package/direct-access-agents.d.ts +328 -0
  66. package/direct-access-agents.js +108 -0
  67. package/encryption.d.ts +12 -12
  68. package/encryption.js +82 -62
  69. package/extensions.d.ts +11 -11
  70. package/extensions.js +61 -47
  71. package/glossaries.d.ts +33 -33
  72. package/glossaries.js +221 -173
  73. package/groups.d.ts +12 -12
  74. package/groups.js +72 -56
  75. package/identity-providers.d.ts +11 -11
  76. package/identity-providers.js +67 -51
  77. package/index.d.ts +9 -4
  78. package/index.js +102 -67
  79. package/interceptors.d.ts +9 -2
  80. package/interceptors.js +2 -2
  81. package/invoke-fetch-types-BYCD4pc9.d.ts +98 -0
  82. package/items.d.ts +14 -13
  83. package/items.js +71 -55
  84. package/knowledgebases.d.ts +23 -23
  85. package/knowledgebases.js +153 -119
  86. package/licenses.d.ts +16 -14
  87. package/licenses.js +76 -58
  88. package/lineage-graphs.d.ts +17 -17
  89. package/lineage-graphs.js +76 -60
  90. package/ml.d.ts +238 -60
  91. package/ml.js +391 -286
  92. package/notes.d.ts +4 -4
  93. package/notes.js +19 -15
  94. package/notifications.d.ts +4 -4
  95. package/notifications.js +11 -9
  96. package/oauth-clients.d.ts +14 -14
  97. package/oauth-clients.js +96 -74
  98. package/oauth-tokens.d.ts +5 -5
  99. package/oauth-tokens.js +19 -15
  100. package/package.json +8 -6
  101. package/qix.d.ts +145 -4
  102. package/qix.js +2 -2
  103. package/questions.d.ts +5 -5
  104. package/questions.js +22 -18
  105. package/quotas.d.ts +6 -6
  106. package/quotas.js +20 -16
  107. package/reload-tasks.d.ts +8 -8
  108. package/reload-tasks.js +46 -36
  109. package/reloads.d.ts +7 -7
  110. package/reloads.js +36 -28
  111. package/report-templates.d.ts +10 -10
  112. package/report-templates.js +64 -50
  113. package/reports.d.ts +4 -4
  114. package/reports.js +20 -16
  115. package/roles.d.ts +8 -8
  116. package/roles.js +46 -36
  117. package/sharing-tasks.d.ts +14 -14
  118. package/sharing-tasks.js +89 -69
  119. package/spaces.d.ts +27 -23
  120. package/spaces.js +153 -119
  121. package/tasks.d.ts +17 -17
  122. package/tasks.js +90 -70
  123. package/temp-contents.d.ts +7 -7
  124. package/temp-contents.js +30 -24
  125. package/tenants.d.ts +8 -8
  126. package/tenants.js +57 -45
  127. package/themes.d.ts +11 -11
  128. package/themes.js +61 -47
  129. package/transports.d.ts +8 -8
  130. package/transports.js +49 -37
  131. package/ui-config.d.ts +9 -9
  132. package/ui-config.js +61 -47
  133. package/users.d.ts +15 -15
  134. package/users.js +81 -63
  135. package/web-integrations.d.ts +8 -8
  136. package/web-integrations.js +46 -36
  137. package/web-notifications.d.ts +9 -9
  138. package/web-notifications.js +53 -41
  139. package/webhooks.d.ts +14 -14
  140. package/webhooks.js +88 -68
  141. package/chunks/2ZQ3ZX7F.js +0 -33
  142. package/invoke-fetch-types-Cq7bjkqn.d.ts +0 -243
package/di-projects.js CHANGED
@@ -1,124 +1,156 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/VVD2DPKQ.js";
5
- import "./chunks/LTNGXTXG.js";
6
- import "./chunks/2ZQ3ZX7F.js";
4
+ } from "./chunks/6WNP7HZQ.js";
5
+ import "./chunks/QAOVZB27.js";
6
+ import "./chunks/7MMXU6EL.js";
7
7
 
8
8
  // src/public/rest/di-projects.ts
9
- var getDiProjects = async (query, options) => invokeFetch("di-projects", {
10
- method: "get",
11
- pathTemplate: "/api/v1/di-projects",
12
- query,
13
- options
14
- });
15
- var createDiProject = async (body, options) => invokeFetch("di-projects", {
16
- method: "post",
17
- pathTemplate: "/api/v1/di-projects",
18
- body,
19
- contentType: "application/json",
20
- options
21
- });
22
- var getDiProject = async (actionId, query, options) => invokeFetch("di-projects", {
23
- method: "get",
24
- pathTemplate: "/api/v1/di-projects/actions/{actionId}",
25
- pathVariables: { actionId },
26
- query,
27
- options
28
- });
29
- var exportDiProject = async (projectId, body, options) => invokeFetch("di-projects", {
30
- method: "post",
31
- pathTemplate: "/api/v1/di-projects/{projectId}/actions/export",
32
- pathVariables: { projectId },
33
- body,
34
- contentType: "application/json",
35
- options
36
- });
37
- var importDiProject = async (projectId, body, options) => invokeFetch("di-projects", {
38
- method: "post",
39
- pathTemplate: "/api/v1/di-projects/{projectId}/actions/import",
40
- pathVariables: { projectId },
41
- body,
42
- contentType: "multipart/form-data",
43
- options
44
- });
45
- var prepareDiProject = async (projectId, body, options) => invokeFetch("di-projects", {
46
- method: "post",
47
- pathTemplate: "/api/v1/di-projects/{projectId}/actions/prepare",
48
- pathVariables: { projectId },
49
- body,
50
- contentType: "application/json",
51
- options
52
- });
53
- var validateDiProject = async (projectId, body, options) => invokeFetch("di-projects", {
54
- method: "post",
55
- pathTemplate: "/api/v1/di-projects/{projectId}/actions/validate",
56
- pathVariables: { projectId },
57
- body,
58
- contentType: "application/json",
59
- options
60
- });
61
- var getDiProjectExportVariables = async (projectId, query, options) => invokeFetch("di-projects", {
62
- method: "get",
63
- pathTemplate: "/api/v1/di-projects/{projectId}/bindings",
64
- pathVariables: { projectId },
65
- query,
66
- options
67
- });
68
- var setDiProjectExportVariables = async (projectId, body, options) => invokeFetch("di-projects", {
69
- method: "put",
70
- pathTemplate: "/api/v1/di-projects/{projectId}/bindings",
71
- pathVariables: { projectId },
72
- body,
73
- contentType: "application/json",
74
- options
75
- });
76
- var getDiProjectDiTasks = async (projectId, options) => invokeFetch("di-projects", {
77
- method: "get",
78
- pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks",
79
- pathVariables: { projectId },
80
- options
81
- });
82
- var getDiProjectDiTask = async (projectId, dataTaskId, options) => invokeFetch("di-projects", {
83
- method: "get",
84
- pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}",
85
- pathVariables: { projectId, dataTaskId },
86
- options
87
- });
88
- var prepareDiProjectDiTask = async (projectId, dataTaskId, body, options) => invokeFetch("di-projects", {
89
- method: "post",
90
- pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/prepare",
91
- pathVariables: { projectId, dataTaskId },
92
- body,
93
- contentType: "application/json",
94
- options
95
- });
96
- var validateDiProjectDiTask = async (projectId, dataTaskId, body, options) => invokeFetch("di-projects", {
97
- method: "post",
98
- pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/validate",
99
- pathVariables: { projectId, dataTaskId },
100
- body,
101
- contentType: "application/json",
102
- options
103
- });
104
- var startDiProjectDiTaskRuntime = async (projectId, dataTaskId, options) => invokeFetch("di-projects", {
105
- method: "post",
106
- pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/start",
107
- pathVariables: { projectId, dataTaskId },
108
- options
109
- });
110
- var stopDiProjectDiTaskRuntime = async (projectId, dataTaskId, options) => invokeFetch("di-projects", {
111
- method: "post",
112
- pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/stop",
113
- pathVariables: { projectId, dataTaskId },
114
- options
115
- });
116
- var getDiProjectDiTaskRuntimeState = async (projectId, dataTaskId, options) => invokeFetch("di-projects", {
117
- method: "get",
118
- pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/state",
119
- pathVariables: { projectId, dataTaskId },
120
- options
121
- });
9
+ async function getDiProjects(query, options) {
10
+ return invokeFetch("di-projects", {
11
+ method: "get",
12
+ pathTemplate: "/api/v1/di-projects",
13
+ query,
14
+ options
15
+ });
16
+ }
17
+ async function createDiProject(body, options) {
18
+ return invokeFetch("di-projects", {
19
+ method: "post",
20
+ pathTemplate: "/api/v1/di-projects",
21
+ body,
22
+ contentType: "application/json",
23
+ options
24
+ });
25
+ }
26
+ async function getDiProject(actionId, query, options) {
27
+ return invokeFetch("di-projects", {
28
+ method: "get",
29
+ pathTemplate: "/api/v1/di-projects/actions/{actionId}",
30
+ pathVariables: { actionId },
31
+ query,
32
+ options
33
+ });
34
+ }
35
+ async function exportDiProject(projectId, body, options) {
36
+ return invokeFetch("di-projects", {
37
+ method: "post",
38
+ pathTemplate: "/api/v1/di-projects/{projectId}/actions/export",
39
+ pathVariables: { projectId },
40
+ body,
41
+ contentType: "application/json",
42
+ options
43
+ });
44
+ }
45
+ async function importDiProject(projectId, body, options) {
46
+ return invokeFetch("di-projects", {
47
+ method: "post",
48
+ pathTemplate: "/api/v1/di-projects/{projectId}/actions/import",
49
+ pathVariables: { projectId },
50
+ body,
51
+ contentType: "multipart/form-data",
52
+ options
53
+ });
54
+ }
55
+ async function prepareDiProject(projectId, body, options) {
56
+ return invokeFetch("di-projects", {
57
+ method: "post",
58
+ pathTemplate: "/api/v1/di-projects/{projectId}/actions/prepare",
59
+ pathVariables: { projectId },
60
+ body,
61
+ contentType: "application/json",
62
+ options
63
+ });
64
+ }
65
+ async function validateDiProject(projectId, body, options) {
66
+ return invokeFetch("di-projects", {
67
+ method: "post",
68
+ pathTemplate: "/api/v1/di-projects/{projectId}/actions/validate",
69
+ pathVariables: { projectId },
70
+ body,
71
+ contentType: "application/json",
72
+ options
73
+ });
74
+ }
75
+ async function getDiProjectExportVariables(projectId, query, options) {
76
+ return invokeFetch("di-projects", {
77
+ method: "get",
78
+ pathTemplate: "/api/v1/di-projects/{projectId}/bindings",
79
+ pathVariables: { projectId },
80
+ query,
81
+ options
82
+ });
83
+ }
84
+ async function setDiProjectExportVariables(projectId, body, options) {
85
+ return invokeFetch("di-projects", {
86
+ method: "put",
87
+ pathTemplate: "/api/v1/di-projects/{projectId}/bindings",
88
+ pathVariables: { projectId },
89
+ body,
90
+ contentType: "application/json",
91
+ options
92
+ });
93
+ }
94
+ async function getDiProjectDiTasks(projectId, options) {
95
+ return invokeFetch("di-projects", {
96
+ method: "get",
97
+ pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks",
98
+ pathVariables: { projectId },
99
+ options
100
+ });
101
+ }
102
+ async function getDiProjectDiTask(projectId, dataTaskId, options) {
103
+ return invokeFetch("di-projects", {
104
+ method: "get",
105
+ pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}",
106
+ pathVariables: { projectId, dataTaskId },
107
+ options
108
+ });
109
+ }
110
+ async function prepareDiProjectDiTask(projectId, dataTaskId, body, options) {
111
+ return invokeFetch("di-projects", {
112
+ method: "post",
113
+ pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/prepare",
114
+ pathVariables: { projectId, dataTaskId },
115
+ body,
116
+ contentType: "application/json",
117
+ options
118
+ });
119
+ }
120
+ async function validateDiProjectDiTask(projectId, dataTaskId, body, options) {
121
+ return invokeFetch("di-projects", {
122
+ method: "post",
123
+ pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/validate",
124
+ pathVariables: { projectId, dataTaskId },
125
+ body,
126
+ contentType: "application/json",
127
+ options
128
+ });
129
+ }
130
+ async function startDiProjectDiTaskRuntime(projectId, dataTaskId, options) {
131
+ return invokeFetch("di-projects", {
132
+ method: "post",
133
+ pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/start",
134
+ pathVariables: { projectId, dataTaskId },
135
+ options
136
+ });
137
+ }
138
+ async function stopDiProjectDiTaskRuntime(projectId, dataTaskId, options) {
139
+ return invokeFetch("di-projects", {
140
+ method: "post",
141
+ pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/stop",
142
+ pathVariables: { projectId, dataTaskId },
143
+ options
144
+ });
145
+ }
146
+ async function getDiProjectDiTaskRuntimeState(projectId, dataTaskId, options) {
147
+ return invokeFetch("di-projects", {
148
+ method: "get",
149
+ pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/state",
150
+ pathVariables: { projectId, dataTaskId },
151
+ options
152
+ });
153
+ }
122
154
  function clearCache() {
123
155
  return clearApiCache("di-projects");
124
156
  }
@@ -0,0 +1,328 @@
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BYCD4pc9.js';
2
+ import './auth-types-Cj5bM3Yk.js';
3
+
4
+ type ConfigurationLineBase = ConfigurationLineNumeric | ConfigurationLineString;
5
+ type ConfigurationLineNumeric = {
6
+ allowMultipleValues?: boolean;
7
+ apiActions?: ("Read" | "Write")[];
8
+ applyWithoutRestart?: boolean;
9
+ connector?: string;
10
+ defaultValue?: string;
11
+ description?: string;
12
+ displayName?: string;
13
+ name?: string;
14
+ pendingApplication?: boolean;
15
+ pendingValue?: string;
16
+ permittedRangeEnd?: number;
17
+ permittedRangeStart?: number;
18
+ uiActions?: ("Read" | "Write")[];
19
+ value?: string;
20
+ };
21
+ type ConfigurationLineString = {
22
+ allowMultipleValues?: boolean;
23
+ apiActions?: ("Read" | "Write")[];
24
+ applyWithoutRestart?: boolean;
25
+ connector?: string;
26
+ defaultValue?: string;
27
+ description?: string;
28
+ displayName?: string;
29
+ name?: string;
30
+ pendingApplication?: boolean;
31
+ pendingValue?: string;
32
+ permittedValues?: string[];
33
+ uiActions?: ("Read" | "Write")[];
34
+ value?: string;
35
+ };
36
+ type ConfigurationResponse = {
37
+ connectorAgentSettings?: ConfigurationLineBase[];
38
+ connectors?: ConnectorSettings[];
39
+ dcaasSettings?: ConfigurationLineBase[];
40
+ };
41
+ type ConnectorFlatFileConfigurationResponse = {
42
+ errorMessage?: ErrorResponse;
43
+ /** The list of configuration items from the connector's configuration file. */
44
+ result?: string[];
45
+ };
46
+ type ConnectorSettings = {
47
+ connectorName?: string;
48
+ settings?: ConfigurationLineBase[];
49
+ };
50
+ type ErrorMessage = {
51
+ code?: string;
52
+ detail?: string;
53
+ title?: string;
54
+ };
55
+ type ErrorResponse = {
56
+ errors?: ErrorMessage[];
57
+ readonly hasErrors?: boolean;
58
+ traceId?: string;
59
+ };
60
+ type Operation = {
61
+ op: "add" | "replace" | "remove";
62
+ path: "AGENT_LOG_LEVEL" | "AGENT_HEALTH_FAIL_MINUTES_LIMIT" | "AGENT_LOG_OPTIONS" | "EXTEND_FIRST_REQUEST_TIMEOUT" | "RELOAD_CACHE_MEMORY_MB" | "DCAAS_LOG_LEVEL" | "ODBC_LOG_LEVEL" | "ODBC_MAX_PROCESS_COUNT" | "ODBC_PROCESS_ISOLATION_MODE" | "ODBC_RELOAD_SESSION_LIFE" | "SAPBW_LOG_LEVEL" | "SAPBW_MAX_PROCESS_COUNT" | "SAPBW_PROCESS_ISOLATION_MODE" | "SAPSQL_LOG_LEVEL" | "SAPSQL_MAX_PROCESS_COUNT" | "SAPSQL_PROCESS_ISOLATION_MODE" | "SAPPACKAGE_LOG_LEVEL" | "SAPPACKAGE_MAX_PROCESS_COUNT" | "SAPPACKAGE_PROCESS_ISOLATION_MODE" | "FILE_LOG_LEVEL" | "FILE_MAX_PROCESS_COUNT" | "FILE_PROCESS_ISOLATION_MODE" | "REST_LOG_LEVEL" | "REST_MAX_PROCESS_COUNT" | "REST_PROCESS_ISOLATION_MODE" | "ODBC_TABLES_LIMIT_FOR_GENERICODBC" | "OVERRIDE_CHUNKS_CACHE_DIR" | "CHUNK_RECOVERY_RESUME_THRESHOLD_MINUTES";
63
+ value: string;
64
+ };
65
+ type PatchOperationResponse = {
66
+ data?: PatchOperationValidationResult[];
67
+ errorMessage?: string;
68
+ failedPatchError?: ErrorResponse;
69
+ httpStatusCode?: number;
70
+ };
71
+ type PatchOperationValidationResult = {
72
+ operation?: Operation;
73
+ valid?: boolean;
74
+ validationResult?: string;
75
+ };
76
+ /**
77
+ * The request to update a connector flat file
78
+ */
79
+ type UpdateConfigurationFlatFileRequest = {
80
+ contentsToSave?: string[];
81
+ };
82
+ /**
83
+ * Restarts the specified agent. If a reload is in `RELOADING` status the `restart` action will be ignored. Use `force-restart` to restart the agent even if a reload is in `RELOADING` status. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.2+.
84
+ *
85
+ * @param agentId The agent ID
86
+ * @param agentAction The type of action to perform. Permitted values are `restart` (will not restart the agent if a reload is in `RELOADING` status) and `force-restart` (will restart the agent even if a reload is in `RELOADING` status).
87
+ * @throws RestartDirectAccessAgentHttpError
88
+ */
89
+ declare function restartDirectAccessAgent(agentId: string, agentAction: string, options?: ApiCallOptions): Promise<RestartDirectAccessAgentHttpResponse>;
90
+ type RestartDirectAccessAgentHttpResponse = {
91
+ data: void;
92
+ headers: Headers;
93
+ status: 204;
94
+ };
95
+ type RestartDirectAccessAgentHttpError = {
96
+ data: ErrorResponse;
97
+ headers: Headers;
98
+ status: 400 | 403 | 404 | 409 | 500;
99
+ };
100
+ /**
101
+ * Retrieves the connector agent configuration from the specified agent. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.2+.
102
+ *
103
+ * @param agentId The agent ID
104
+ * @param query an object with query parameters
105
+ * @throws GetDirectAccessAgentConfigurationHttpError
106
+ */
107
+ declare function getDirectAccessAgentConfiguration(agentId: string, query: {
108
+ /** Individual properties within the agent configuration */
109
+ queryProperties?: string[];
110
+ }, options?: ApiCallOptions): Promise<GetDirectAccessAgentConfigurationHttpResponse>;
111
+ type GetDirectAccessAgentConfigurationHttpResponse = {
112
+ data: ConfigurationResponse;
113
+ headers: Headers;
114
+ status: 200;
115
+ };
116
+ type GetDirectAccessAgentConfigurationHttpError = {
117
+ data: ErrorResponse;
118
+ headers: Headers;
119
+ status: 403 | 404;
120
+ };
121
+ /**
122
+ * Makes changes to the local agent configuration using JSON Patch. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.2+.
123
+ *
124
+ * @param agentId The agent ID
125
+ * @param body an object with the body content
126
+ * @throws PatchDirectAccessAgentConfigurationHttpError
127
+ */
128
+ declare function patchDirectAccessAgentConfiguration(agentId: string, body: Operation[], options?: ApiCallOptions): Promise<PatchDirectAccessAgentConfigurationHttpResponse>;
129
+ type PatchDirectAccessAgentConfigurationHttpResponse = PatchDirectAccessAgentConfiguration204HttpResponse | PatchDirectAccessAgentConfiguration207HttpResponse;
130
+ type PatchDirectAccessAgentConfiguration204HttpResponse = {
131
+ data: void;
132
+ headers: Headers;
133
+ status: 204;
134
+ };
135
+ type PatchDirectAccessAgentConfiguration207HttpResponse = {
136
+ data: PatchOperationResponse;
137
+ headers: Headers;
138
+ status: 207;
139
+ };
140
+ type PatchDirectAccessAgentConfigurationHttpError = {
141
+ data: ErrorResponse;
142
+ headers: Headers;
143
+ status: 400 | 403 | 404 | 415;
144
+ };
145
+ /**
146
+ * Retrieves the configuration files associated with the connector. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
147
+ *
148
+ * @param agentId The agent ID
149
+ * @param connectorType The connector to retrieve the list of files for
150
+ * @param query an object with query parameters
151
+ * @throws GetDirectAccessAgentConnectorFilesHttpError
152
+ */
153
+ declare function getDirectAccessAgentConnectorFiles(agentId: string, connectorType: string, query: Record<string, unknown>, options?: ApiCallOptions): Promise<GetDirectAccessAgentConnectorFilesHttpResponse>;
154
+ type GetDirectAccessAgentConnectorFilesHttpResponse = {
155
+ data: ConnectorFlatFileConfigurationResponse;
156
+ headers: Headers;
157
+ status: 200;
158
+ };
159
+ type GetDirectAccessAgentConnectorFilesHttpError = {
160
+ data: ErrorResponse;
161
+ headers: Headers;
162
+ status: 403 | 404;
163
+ };
164
+ /**
165
+ * Retrieves the configuration files associated with the connector. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
166
+ *
167
+ * @param agentId The agent ID
168
+ * @param connectorType The connector to retrieve the list of files for
169
+ * @throws GetDirectAccessAgentConnectorFilesWithoutQueryHttpError
170
+ */
171
+ declare function getDirectAccessAgentConnectorFilesWithoutQuery(agentId: string, connectorType: string, options?: ApiCallOptions): Promise<GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse>;
172
+ type GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse = {
173
+ data: ConnectorFlatFileConfigurationResponse;
174
+ headers: Headers;
175
+ status: 200;
176
+ };
177
+ type GetDirectAccessAgentConnectorFilesWithoutQueryHttpError = {
178
+ data: ErrorResponse;
179
+ headers: Headers;
180
+ status: 403 | 404;
181
+ };
182
+ /**
183
+ * Retrieves the configuration items in the flat file for the specified connector. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
184
+ *
185
+ * @param agentId The agent ID
186
+ * @param connectorType The connector type to retrieve
187
+ * @param fileType The type of file to retrieve
188
+ * @throws GetDirectAccessAgentConnectorFileHttpError
189
+ */
190
+ declare function getDirectAccessAgentConnectorFile(agentId: string, connectorType: string, fileType: string, options?: ApiCallOptions): Promise<GetDirectAccessAgentConnectorFileHttpResponse>;
191
+ type GetDirectAccessAgentConnectorFileHttpResponse = {
192
+ data: ConnectorFlatFileConfigurationResponse;
193
+ headers: Headers;
194
+ status: 200;
195
+ };
196
+ type GetDirectAccessAgentConnectorFileHttpError = {
197
+ data: ErrorResponse;
198
+ headers: Headers;
199
+ status: 403 | 404;
200
+ };
201
+ /**
202
+ * Completely replaces the contents of the connector's configuration file. Partial updates are not supported. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
203
+ *
204
+ * @param agentId The agent ID
205
+ * @param connectorType The connector type to update
206
+ * @param fileType The file type to update
207
+ * @param query an object with query parameters
208
+ * @param body an object with the body content
209
+ * @throws UpdateDirectAccessAgentConnectorFileHttpError
210
+ */
211
+ declare function updateDirectAccessAgentConnectorFile(agentId: string, connectorType: string, fileType: string, query: Record<string, unknown>, body: UpdateConfigurationFlatFileRequest, options?: ApiCallOptions): Promise<UpdateDirectAccessAgentConnectorFileHttpResponse>;
212
+ type UpdateDirectAccessAgentConnectorFileHttpResponse = {
213
+ data: void;
214
+ headers: Headers;
215
+ status: 204;
216
+ };
217
+ type UpdateDirectAccessAgentConnectorFileHttpError = {
218
+ data: ErrorResponse;
219
+ headers: Headers;
220
+ status: 400 | 404 | 409;
221
+ };
222
+ /**
223
+ * Completely replaces the contents of the connector's configuration file. Partial updates are not supported. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
224
+ *
225
+ * @param agentId The agent ID
226
+ * @param connectorType The connector type to update
227
+ * @param fileType The file type to update
228
+ * @param body an object with the body content
229
+ * @throws UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError
230
+ */
231
+ declare function updateDirectAccessAgentConnectorFileWithoutQuery(agentId: string, connectorType: string, fileType: string, body: UpdateConfigurationFlatFileRequest, options?: ApiCallOptions): Promise<UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse>;
232
+ type UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse = {
233
+ data: void;
234
+ headers: Headers;
235
+ status: 204;
236
+ };
237
+ type UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError = {
238
+ data: ErrorResponse;
239
+ headers: Headers;
240
+ status: 400 | 404 | 409;
241
+ };
242
+ /**
243
+ * Clears the cache for direct-access-agents api requests.
244
+ */
245
+ declare function clearCache(): void;
246
+ interface DirectAccessAgentsAPI {
247
+ /**
248
+ * Restarts the specified agent. If a reload is in `RELOADING` status the `restart` action will be ignored. Use `force-restart` to restart the agent even if a reload is in `RELOADING` status. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.2+.
249
+ *
250
+ * @param agentId The agent ID
251
+ * @param agentAction The type of action to perform. Permitted values are `restart` (will not restart the agent if a reload is in `RELOADING` status) and `force-restart` (will restart the agent even if a reload is in `RELOADING` status).
252
+ * @throws RestartDirectAccessAgentHttpError
253
+ */
254
+ restartDirectAccessAgent: typeof restartDirectAccessAgent;
255
+ /**
256
+ * Retrieves the connector agent configuration from the specified agent. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.2+.
257
+ *
258
+ * @param agentId The agent ID
259
+ * @param query an object with query parameters
260
+ * @throws GetDirectAccessAgentConfigurationHttpError
261
+ */
262
+ getDirectAccessAgentConfiguration: typeof getDirectAccessAgentConfiguration;
263
+ /**
264
+ * Makes changes to the local agent configuration using JSON Patch. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.2+.
265
+ *
266
+ * @param agentId The agent ID
267
+ * @param body an object with the body content
268
+ * @throws PatchDirectAccessAgentConfigurationHttpError
269
+ */
270
+ patchDirectAccessAgentConfiguration: typeof patchDirectAccessAgentConfiguration;
271
+ /**
272
+ * Retrieves the configuration files associated with the connector. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
273
+ *
274
+ * @param agentId The agent ID
275
+ * @param connectorType The connector to retrieve the list of files for
276
+ * @param query an object with query parameters
277
+ * @throws GetDirectAccessAgentConnectorFilesHttpError
278
+ */
279
+ getDirectAccessAgentConnectorFiles: typeof getDirectAccessAgentConnectorFiles;
280
+ /**
281
+ * Retrieves the configuration files associated with the connector. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
282
+ *
283
+ * @param agentId The agent ID
284
+ * @param connectorType The connector to retrieve the list of files for
285
+ * @throws GetDirectAccessAgentConnectorFilesWithoutQueryHttpError
286
+ */
287
+ getDirectAccessAgentConnectorFilesWithoutQuery: typeof getDirectAccessAgentConnectorFilesWithoutQuery;
288
+ /**
289
+ * Retrieves the configuration items in the flat file for the specified connector. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
290
+ *
291
+ * @param agentId The agent ID
292
+ * @param connectorType The connector type to retrieve
293
+ * @param fileType The type of file to retrieve
294
+ * @throws GetDirectAccessAgentConnectorFileHttpError
295
+ */
296
+ getDirectAccessAgentConnectorFile: typeof getDirectAccessAgentConnectorFile;
297
+ /**
298
+ * Completely replaces the contents of the connector's configuration file. Partial updates are not supported. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
299
+ *
300
+ * @param agentId The agent ID
301
+ * @param connectorType The connector type to update
302
+ * @param fileType The file type to update
303
+ * @param query an object with query parameters
304
+ * @param body an object with the body content
305
+ * @throws UpdateDirectAccessAgentConnectorFileHttpError
306
+ */
307
+ updateDirectAccessAgentConnectorFile: typeof updateDirectAccessAgentConnectorFile;
308
+ /**
309
+ * Completely replaces the contents of the connector's configuration file. Partial updates are not supported. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
310
+ *
311
+ * @param agentId The agent ID
312
+ * @param connectorType The connector type to update
313
+ * @param fileType The file type to update
314
+ * @param body an object with the body content
315
+ * @throws UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError
316
+ */
317
+ updateDirectAccessAgentConnectorFileWithoutQuery: typeof updateDirectAccessAgentConnectorFileWithoutQuery;
318
+ /**
319
+ * Clears the cache for direct-access-agents api requests.
320
+ */
321
+ clearCache: typeof clearCache;
322
+ }
323
+ /**
324
+ * Functions for the direct-access-agents api
325
+ */
326
+ declare const directAccessAgentsExport: DirectAccessAgentsAPI;
327
+
328
+ export { type ConfigurationLineBase, type ConfigurationLineNumeric, type ConfigurationLineString, type ConfigurationResponse, type ConnectorFlatFileConfigurationResponse, type ConnectorSettings, type DirectAccessAgentsAPI, type ErrorMessage, type ErrorResponse, type GetDirectAccessAgentConfigurationHttpError, type GetDirectAccessAgentConfigurationHttpResponse, type GetDirectAccessAgentConnectorFileHttpError, type GetDirectAccessAgentConnectorFileHttpResponse, type GetDirectAccessAgentConnectorFilesHttpError, type GetDirectAccessAgentConnectorFilesHttpResponse, type GetDirectAccessAgentConnectorFilesWithoutQueryHttpError, type GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse, type Operation, type PatchDirectAccessAgentConfiguration204HttpResponse, type PatchDirectAccessAgentConfiguration207HttpResponse, type PatchDirectAccessAgentConfigurationHttpError, type PatchDirectAccessAgentConfigurationHttpResponse, type PatchOperationResponse, type PatchOperationValidationResult, type RestartDirectAccessAgentHttpError, type RestartDirectAccessAgentHttpResponse, type UpdateConfigurationFlatFileRequest, type UpdateDirectAccessAgentConnectorFileHttpError, type UpdateDirectAccessAgentConnectorFileHttpResponse, type UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError, type UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse, clearCache, directAccessAgentsExport as default, getDirectAccessAgentConfiguration, getDirectAccessAgentConnectorFile, getDirectAccessAgentConnectorFiles, getDirectAccessAgentConnectorFilesWithoutQuery, patchDirectAccessAgentConfiguration, restartDirectAccessAgent, updateDirectAccessAgentConnectorFile, updateDirectAccessAgentConnectorFileWithoutQuery };