@gleanwork/api-client 0.13.1 → 0.13.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -1
- package/dist/commonjs/__tests__/messages.test.js +1 -1
- package/dist/commonjs/__tests__/messages.test.js.map +1 -1
- package/dist/commonjs/__tests__/summarize.test.js +4 -3
- package/dist/commonjs/__tests__/summarize.test.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/models/components/agentsinsightsv2response.d.ts +4 -0
- package/dist/commonjs/models/components/agentsinsightsv2response.d.ts.map +1 -1
- package/dist/commonjs/models/components/agentsinsightsv2response.js +4 -0
- package/dist/commonjs/models/components/agentsinsightsv2response.js.map +1 -1
- package/dist/commonjs/models/components/chatmessagefragment.d.ts +1 -1
- package/dist/commonjs/models/components/debugdatasourcestatusresponse.d.ts +3 -1
- package/dist/commonjs/models/components/debugdatasourcestatusresponse.d.ts.map +1 -1
- package/dist/commonjs/models/components/debugdatasourcestatusresponse.js.map +1 -1
- package/dist/commonjs/models/components/peragentinsight.d.ts +10 -0
- package/dist/commonjs/models/components/peragentinsight.d.ts.map +1 -1
- package/dist/commonjs/models/components/peragentinsight.js +4 -0
- package/dist/commonjs/models/components/peragentinsight.js.map +1 -1
- package/dist/esm/__tests__/messages.test.js +1 -1
- package/dist/esm/__tests__/messages.test.js.map +1 -1
- package/dist/esm/__tests__/summarize.test.js +4 -3
- package/dist/esm/__tests__/summarize.test.js.map +1 -1
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/models/components/agentsinsightsv2response.d.ts +4 -0
- package/dist/esm/models/components/agentsinsightsv2response.d.ts.map +1 -1
- package/dist/esm/models/components/agentsinsightsv2response.js +4 -0
- package/dist/esm/models/components/agentsinsightsv2response.js.map +1 -1
- package/dist/esm/models/components/chatmessagefragment.d.ts +1 -1
- package/dist/esm/models/components/debugdatasourcestatusresponse.d.ts +3 -1
- package/dist/esm/models/components/debugdatasourcestatusresponse.d.ts.map +1 -1
- package/dist/esm/models/components/debugdatasourcestatusresponse.js.map +1 -1
- package/dist/esm/models/components/peragentinsight.d.ts +10 -0
- package/dist/esm/models/components/peragentinsight.d.ts.map +1 -1
- package/dist/esm/models/components/peragentinsight.js +4 -0
- package/dist/esm/models/components/peragentinsight.js.map +1 -1
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/__tests__/messages.test.ts +1 -1
- package/src/__tests__/summarize.test.ts +4 -3
- package/src/lib/config.ts +3 -3
- package/src/models/components/agentsinsightsv2response.ts +8 -0
- package/src/models/components/chatmessagefragment.ts +1 -1
- package/src/models/components/debugdatasourcestatusresponse.ts +3 -1
- package/src/models/components/peragentinsight.ts +14 -0
- package/.devcontainer/README.md +0 -35
- package/docs/sdks/activity/README.md +0 -242
- package/docs/sdks/agents/README.md +0 -498
- package/docs/sdks/announcements/README.md +0 -137560
- package/docs/sdks/answers/README.md +0 -4966
- package/docs/sdks/chat/README.md +0 -967
- package/docs/sdks/clientauthentication/README.md +0 -98
- package/docs/sdks/clientdocuments/README.md +0 -457
- package/docs/sdks/clientshortcuts/README.md +0 -9340
- package/docs/sdks/collections/README.md +0 -4148
- package/docs/sdks/datasource/README.md +0 -98
- package/docs/sdks/datasources/README.md +0 -211
- package/docs/sdks/entities/README.md +0 -225
- package/docs/sdks/indexingauthentication/README.md +0 -93
- package/docs/sdks/indexingdocuments/README.md +0 -983
- package/docs/sdks/indexingshortcuts/README.md +0 -251
- package/docs/sdks/insights/README.md +0 -94
- package/docs/sdks/messages/README.md +0 -102
- package/docs/sdks/people/README.md +0 -1052
- package/docs/sdks/permissions/README.md +0 -1198
- package/docs/sdks/pins/README.md +0 -506
- package/docs/sdks/policies/README.md +0 -478
- package/docs/sdks/reports/README.md +0 -290
- package/docs/sdks/search/README.md +0 -986
- package/docs/sdks/tools/README.md +0 -208
- package/docs/sdks/verification/README.md +0 -276
- package/docs/sdks/visibilityoverrides/README.md +0 -192
- package/examples/README.md +0 -31
- package/src/__tests__/mockserver/README.md +0 -52
|
@@ -1,478 +0,0 @@
|
|
|
1
|
-
# Policies
|
|
2
|
-
(*client.governance.data.policies*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [retrieve](#retrieve) - Gets specified policy
|
|
9
|
-
* [update](#update) - Updates an existing policy
|
|
10
|
-
* [list](#list) - Lists policies
|
|
11
|
-
* [create](#create) - Creates new policy
|
|
12
|
-
* [download](#download) - Downloads violations CSV for policy
|
|
13
|
-
|
|
14
|
-
## retrieve
|
|
15
|
-
|
|
16
|
-
Fetches the specified policy version, or the latest if no version is provided.
|
|
17
|
-
|
|
18
|
-
### Example Usage
|
|
19
|
-
|
|
20
|
-
<!-- UsageSnippet language="typescript" operationID="getpolicy" method="get" path="/rest/api/v1/governance/data/policies/{id}" -->
|
|
21
|
-
```typescript
|
|
22
|
-
import { Glean } from "@gleanwork/api-client";
|
|
23
|
-
|
|
24
|
-
const glean = new Glean({
|
|
25
|
-
apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
|
|
26
|
-
});
|
|
27
|
-
|
|
28
|
-
async function run() {
|
|
29
|
-
const result = await glean.client.governance.data.policies.retrieve("<id>");
|
|
30
|
-
|
|
31
|
-
console.log(result);
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
run();
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
### Standalone function
|
|
38
|
-
|
|
39
|
-
The standalone function version of this method:
|
|
40
|
-
|
|
41
|
-
```typescript
|
|
42
|
-
import { GleanCore } from "@gleanwork/api-client/core.js";
|
|
43
|
-
import { clientGovernanceDataPoliciesRetrieve } from "@gleanwork/api-client/funcs/clientGovernanceDataPoliciesRetrieve.js";
|
|
44
|
-
|
|
45
|
-
// Use `GleanCore` for best tree-shaking performance.
|
|
46
|
-
// You can create one instance of it to use across an application.
|
|
47
|
-
const glean = new GleanCore({
|
|
48
|
-
apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
|
|
49
|
-
});
|
|
50
|
-
|
|
51
|
-
async function run() {
|
|
52
|
-
const res = await clientGovernanceDataPoliciesRetrieve(glean, "<id>");
|
|
53
|
-
if (res.ok) {
|
|
54
|
-
const { value: result } = res;
|
|
55
|
-
console.log(result);
|
|
56
|
-
} else {
|
|
57
|
-
console.log("clientGovernanceDataPoliciesRetrieve failed:", res.error);
|
|
58
|
-
}
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
run();
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
### React hooks and utilities
|
|
65
|
-
|
|
66
|
-
This method can be used in React components through the following hooks and
|
|
67
|
-
associated utilities.
|
|
68
|
-
|
|
69
|
-
> Check out [this guide][hook-guide] for information about each of the utilities
|
|
70
|
-
> below and how to get started using React hooks.
|
|
71
|
-
|
|
72
|
-
[hook-guide]: ../../../REACT_QUERY.md
|
|
73
|
-
|
|
74
|
-
```tsx
|
|
75
|
-
import {
|
|
76
|
-
// Query hooks for fetching data.
|
|
77
|
-
useClientGovernanceDataPoliciesRetrieve,
|
|
78
|
-
useClientGovernanceDataPoliciesRetrieveSuspense,
|
|
79
|
-
|
|
80
|
-
// Utility for prefetching data during server-side rendering and in React
|
|
81
|
-
// Server Components that will be immediately available to client components
|
|
82
|
-
// using the hooks.
|
|
83
|
-
prefetchClientGovernanceDataPoliciesRetrieve,
|
|
84
|
-
|
|
85
|
-
// Utilities to invalidate the query cache for this query in response to
|
|
86
|
-
// mutations and other user actions.
|
|
87
|
-
invalidateClientGovernanceDataPoliciesRetrieve,
|
|
88
|
-
invalidateAllClientGovernanceDataPoliciesRetrieve,
|
|
89
|
-
} from "@gleanwork/api-client/react-query/clientGovernanceDataPoliciesRetrieve.js";
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
### Parameters
|
|
93
|
-
|
|
94
|
-
| Parameter | Type | Required | Description |
|
|
95
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
96
|
-
| `id` | *string* | :heavy_check_mark: | The id of the policy to fetch. |
|
|
97
|
-
| `version` | *number* | :heavy_minus_sign: | The version of the policy to fetch. Each time a policy is updated, the older version is still stored. If this is left empty, the latest policy is fetched. |
|
|
98
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
99
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
100
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
101
|
-
|
|
102
|
-
### Response
|
|
103
|
-
|
|
104
|
-
**Promise\<[components.GetDlpReportResponse](../../models/components/getdlpreportresponse.md)\>**
|
|
105
|
-
|
|
106
|
-
### Errors
|
|
107
|
-
|
|
108
|
-
| Error Type | Status Code | Content Type |
|
|
109
|
-
| ----------------- | ----------------- | ----------------- |
|
|
110
|
-
| errors.GleanError | 4XX, 5XX | \*/\* |
|
|
111
|
-
|
|
112
|
-
## update
|
|
113
|
-
|
|
114
|
-
Updates an existing policy.
|
|
115
|
-
|
|
116
|
-
### Example Usage
|
|
117
|
-
|
|
118
|
-
<!-- UsageSnippet language="typescript" operationID="updatepolicy" method="post" path="/rest/api/v1/governance/data/policies/{id}" -->
|
|
119
|
-
```typescript
|
|
120
|
-
import { Glean } from "@gleanwork/api-client";
|
|
121
|
-
|
|
122
|
-
const glean = new Glean({
|
|
123
|
-
apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
|
|
124
|
-
});
|
|
125
|
-
|
|
126
|
-
async function run() {
|
|
127
|
-
const result = await glean.client.governance.data.policies.update({}, "<id>");
|
|
128
|
-
|
|
129
|
-
console.log(result);
|
|
130
|
-
}
|
|
131
|
-
|
|
132
|
-
run();
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
### Standalone function
|
|
136
|
-
|
|
137
|
-
The standalone function version of this method:
|
|
138
|
-
|
|
139
|
-
```typescript
|
|
140
|
-
import { GleanCore } from "@gleanwork/api-client/core.js";
|
|
141
|
-
import { clientGovernanceDataPoliciesUpdate } from "@gleanwork/api-client/funcs/clientGovernanceDataPoliciesUpdate.js";
|
|
142
|
-
|
|
143
|
-
// Use `GleanCore` for best tree-shaking performance.
|
|
144
|
-
// You can create one instance of it to use across an application.
|
|
145
|
-
const glean = new GleanCore({
|
|
146
|
-
apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
|
|
147
|
-
});
|
|
148
|
-
|
|
149
|
-
async function run() {
|
|
150
|
-
const res = await clientGovernanceDataPoliciesUpdate(glean, {}, "<id>");
|
|
151
|
-
if (res.ok) {
|
|
152
|
-
const { value: result } = res;
|
|
153
|
-
console.log(result);
|
|
154
|
-
} else {
|
|
155
|
-
console.log("clientGovernanceDataPoliciesUpdate failed:", res.error);
|
|
156
|
-
}
|
|
157
|
-
}
|
|
158
|
-
|
|
159
|
-
run();
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
### React hooks and utilities
|
|
163
|
-
|
|
164
|
-
This method can be used in React components through the following hooks and
|
|
165
|
-
associated utilities.
|
|
166
|
-
|
|
167
|
-
> Check out [this guide][hook-guide] for information about each of the utilities
|
|
168
|
-
> below and how to get started using React hooks.
|
|
169
|
-
|
|
170
|
-
[hook-guide]: ../../../REACT_QUERY.md
|
|
171
|
-
|
|
172
|
-
```tsx
|
|
173
|
-
import {
|
|
174
|
-
// Mutation hook for triggering the API call.
|
|
175
|
-
useClientGovernanceDataPoliciesUpdateMutation
|
|
176
|
-
} from "@gleanwork/api-client/react-query/clientGovernanceDataPoliciesUpdate.js";
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
### Parameters
|
|
180
|
-
|
|
181
|
-
| Parameter | Type | Required | Description |
|
|
182
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
183
|
-
| `id` | *string* | :heavy_check_mark: | The id of the policy to fetch. |
|
|
184
|
-
| `updateDlpReportRequest` | [components.UpdateDlpReportRequest](../../models/components/updatedlpreportrequest.md) | :heavy_check_mark: | N/A |
|
|
185
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
186
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
187
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
188
|
-
|
|
189
|
-
### Response
|
|
190
|
-
|
|
191
|
-
**Promise\<[components.UpdateDlpReportResponse](../../models/components/updatedlpreportresponse.md)\>**
|
|
192
|
-
|
|
193
|
-
### Errors
|
|
194
|
-
|
|
195
|
-
| Error Type | Status Code | Content Type |
|
|
196
|
-
| ----------------- | ----------------- | ----------------- |
|
|
197
|
-
| errors.GleanError | 4XX, 5XX | \*/\* |
|
|
198
|
-
|
|
199
|
-
## list
|
|
200
|
-
|
|
201
|
-
Lists policies with filtering.
|
|
202
|
-
|
|
203
|
-
### Example Usage
|
|
204
|
-
|
|
205
|
-
<!-- UsageSnippet language="typescript" operationID="listpolicies" method="get" path="/rest/api/v1/governance/data/policies" -->
|
|
206
|
-
```typescript
|
|
207
|
-
import { Glean } from "@gleanwork/api-client";
|
|
208
|
-
|
|
209
|
-
const glean = new Glean({
|
|
210
|
-
apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
|
|
211
|
-
});
|
|
212
|
-
|
|
213
|
-
async function run() {
|
|
214
|
-
const result = await glean.client.governance.data.policies.list();
|
|
215
|
-
|
|
216
|
-
console.log(result);
|
|
217
|
-
}
|
|
218
|
-
|
|
219
|
-
run();
|
|
220
|
-
```
|
|
221
|
-
|
|
222
|
-
### Standalone function
|
|
223
|
-
|
|
224
|
-
The standalone function version of this method:
|
|
225
|
-
|
|
226
|
-
```typescript
|
|
227
|
-
import { GleanCore } from "@gleanwork/api-client/core.js";
|
|
228
|
-
import { clientGovernanceDataPoliciesList } from "@gleanwork/api-client/funcs/clientGovernanceDataPoliciesList.js";
|
|
229
|
-
|
|
230
|
-
// Use `GleanCore` for best tree-shaking performance.
|
|
231
|
-
// You can create one instance of it to use across an application.
|
|
232
|
-
const glean = new GleanCore({
|
|
233
|
-
apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
|
|
234
|
-
});
|
|
235
|
-
|
|
236
|
-
async function run() {
|
|
237
|
-
const res = await clientGovernanceDataPoliciesList(glean);
|
|
238
|
-
if (res.ok) {
|
|
239
|
-
const { value: result } = res;
|
|
240
|
-
console.log(result);
|
|
241
|
-
} else {
|
|
242
|
-
console.log("clientGovernanceDataPoliciesList failed:", res.error);
|
|
243
|
-
}
|
|
244
|
-
}
|
|
245
|
-
|
|
246
|
-
run();
|
|
247
|
-
```
|
|
248
|
-
|
|
249
|
-
### React hooks and utilities
|
|
250
|
-
|
|
251
|
-
This method can be used in React components through the following hooks and
|
|
252
|
-
associated utilities.
|
|
253
|
-
|
|
254
|
-
> Check out [this guide][hook-guide] for information about each of the utilities
|
|
255
|
-
> below and how to get started using React hooks.
|
|
256
|
-
|
|
257
|
-
[hook-guide]: ../../../REACT_QUERY.md
|
|
258
|
-
|
|
259
|
-
```tsx
|
|
260
|
-
import {
|
|
261
|
-
// Query hooks for fetching data.
|
|
262
|
-
useClientGovernanceDataPoliciesList,
|
|
263
|
-
useClientGovernanceDataPoliciesListSuspense,
|
|
264
|
-
|
|
265
|
-
// Utility for prefetching data during server-side rendering and in React
|
|
266
|
-
// Server Components that will be immediately available to client components
|
|
267
|
-
// using the hooks.
|
|
268
|
-
prefetchClientGovernanceDataPoliciesList,
|
|
269
|
-
|
|
270
|
-
// Utilities to invalidate the query cache for this query in response to
|
|
271
|
-
// mutations and other user actions.
|
|
272
|
-
invalidateClientGovernanceDataPoliciesList,
|
|
273
|
-
invalidateAllClientGovernanceDataPoliciesList,
|
|
274
|
-
} from "@gleanwork/api-client/react-query/clientGovernanceDataPoliciesList.js";
|
|
275
|
-
```
|
|
276
|
-
|
|
277
|
-
### Parameters
|
|
278
|
-
|
|
279
|
-
| Parameter | Type | Required | Description |
|
|
280
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
281
|
-
| `autoHide` | *boolean* | :heavy_minus_sign: | Filter to return reports with a given value of auto-hide. |
|
|
282
|
-
| `frequency` | *string* | :heavy_minus_sign: | Filter to return reports with a given frequency. |
|
|
283
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
284
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
285
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
286
|
-
|
|
287
|
-
### Response
|
|
288
|
-
|
|
289
|
-
**Promise\<[components.ListDlpReportsResponse](../../models/components/listdlpreportsresponse.md)\>**
|
|
290
|
-
|
|
291
|
-
### Errors
|
|
292
|
-
|
|
293
|
-
| Error Type | Status Code | Content Type |
|
|
294
|
-
| ----------------- | ----------------- | ----------------- |
|
|
295
|
-
| errors.GleanError | 4XX, 5XX | \*/\* |
|
|
296
|
-
|
|
297
|
-
## create
|
|
298
|
-
|
|
299
|
-
Creates a new policy with specified specifications and returns its id.
|
|
300
|
-
|
|
301
|
-
### Example Usage
|
|
302
|
-
|
|
303
|
-
<!-- UsageSnippet language="typescript" operationID="createpolicy" method="post" path="/rest/api/v1/governance/data/policies" -->
|
|
304
|
-
```typescript
|
|
305
|
-
import { Glean } from "@gleanwork/api-client";
|
|
306
|
-
|
|
307
|
-
const glean = new Glean({
|
|
308
|
-
apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
|
|
309
|
-
});
|
|
310
|
-
|
|
311
|
-
async function run() {
|
|
312
|
-
const result = await glean.client.governance.data.policies.create({});
|
|
313
|
-
|
|
314
|
-
console.log(result);
|
|
315
|
-
}
|
|
316
|
-
|
|
317
|
-
run();
|
|
318
|
-
```
|
|
319
|
-
|
|
320
|
-
### Standalone function
|
|
321
|
-
|
|
322
|
-
The standalone function version of this method:
|
|
323
|
-
|
|
324
|
-
```typescript
|
|
325
|
-
import { GleanCore } from "@gleanwork/api-client/core.js";
|
|
326
|
-
import { clientGovernanceDataPoliciesCreate } from "@gleanwork/api-client/funcs/clientGovernanceDataPoliciesCreate.js";
|
|
327
|
-
|
|
328
|
-
// Use `GleanCore` for best tree-shaking performance.
|
|
329
|
-
// You can create one instance of it to use across an application.
|
|
330
|
-
const glean = new GleanCore({
|
|
331
|
-
apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
|
|
332
|
-
});
|
|
333
|
-
|
|
334
|
-
async function run() {
|
|
335
|
-
const res = await clientGovernanceDataPoliciesCreate(glean, {});
|
|
336
|
-
if (res.ok) {
|
|
337
|
-
const { value: result } = res;
|
|
338
|
-
console.log(result);
|
|
339
|
-
} else {
|
|
340
|
-
console.log("clientGovernanceDataPoliciesCreate failed:", res.error);
|
|
341
|
-
}
|
|
342
|
-
}
|
|
343
|
-
|
|
344
|
-
run();
|
|
345
|
-
```
|
|
346
|
-
|
|
347
|
-
### React hooks and utilities
|
|
348
|
-
|
|
349
|
-
This method can be used in React components through the following hooks and
|
|
350
|
-
associated utilities.
|
|
351
|
-
|
|
352
|
-
> Check out [this guide][hook-guide] for information about each of the utilities
|
|
353
|
-
> below and how to get started using React hooks.
|
|
354
|
-
|
|
355
|
-
[hook-guide]: ../../../REACT_QUERY.md
|
|
356
|
-
|
|
357
|
-
```tsx
|
|
358
|
-
import {
|
|
359
|
-
// Mutation hook for triggering the API call.
|
|
360
|
-
useClientGovernanceDataPoliciesCreateMutation
|
|
361
|
-
} from "@gleanwork/api-client/react-query/clientGovernanceDataPoliciesCreate.js";
|
|
362
|
-
```
|
|
363
|
-
|
|
364
|
-
### Parameters
|
|
365
|
-
|
|
366
|
-
| Parameter | Type | Required | Description |
|
|
367
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
368
|
-
| `request` | [components.CreateDlpReportRequest](../../models/components/createdlpreportrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
369
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
370
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
371
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
372
|
-
|
|
373
|
-
### Response
|
|
374
|
-
|
|
375
|
-
**Promise\<[components.CreateDlpReportResponse](../../models/components/createdlpreportresponse.md)\>**
|
|
376
|
-
|
|
377
|
-
### Errors
|
|
378
|
-
|
|
379
|
-
| Error Type | Status Code | Content Type |
|
|
380
|
-
| ----------------- | ----------------- | ----------------- |
|
|
381
|
-
| errors.GleanError | 4XX, 5XX | \*/\* |
|
|
382
|
-
|
|
383
|
-
## download
|
|
384
|
-
|
|
385
|
-
Downloads CSV violations report for a specific policy id. This does not support continuous policies.
|
|
386
|
-
|
|
387
|
-
### Example Usage
|
|
388
|
-
|
|
389
|
-
<!-- UsageSnippet language="typescript" operationID="downloadpolicycsv" method="get" path="/rest/api/v1/governance/data/policies/{id}/download" -->
|
|
390
|
-
```typescript
|
|
391
|
-
import { Glean } from "@gleanwork/api-client";
|
|
392
|
-
|
|
393
|
-
const glean = new Glean({
|
|
394
|
-
apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
|
|
395
|
-
});
|
|
396
|
-
|
|
397
|
-
async function run() {
|
|
398
|
-
const result = await glean.client.governance.data.policies.download("<id>");
|
|
399
|
-
|
|
400
|
-
console.log(result);
|
|
401
|
-
}
|
|
402
|
-
|
|
403
|
-
run();
|
|
404
|
-
```
|
|
405
|
-
|
|
406
|
-
### Standalone function
|
|
407
|
-
|
|
408
|
-
The standalone function version of this method:
|
|
409
|
-
|
|
410
|
-
```typescript
|
|
411
|
-
import { GleanCore } from "@gleanwork/api-client/core.js";
|
|
412
|
-
import { clientGovernanceDataPoliciesDownload } from "@gleanwork/api-client/funcs/clientGovernanceDataPoliciesDownload.js";
|
|
413
|
-
|
|
414
|
-
// Use `GleanCore` for best tree-shaking performance.
|
|
415
|
-
// You can create one instance of it to use across an application.
|
|
416
|
-
const glean = new GleanCore({
|
|
417
|
-
apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
|
|
418
|
-
});
|
|
419
|
-
|
|
420
|
-
async function run() {
|
|
421
|
-
const res = await clientGovernanceDataPoliciesDownload(glean, "<id>");
|
|
422
|
-
if (res.ok) {
|
|
423
|
-
const { value: result } = res;
|
|
424
|
-
console.log(result);
|
|
425
|
-
} else {
|
|
426
|
-
console.log("clientGovernanceDataPoliciesDownload failed:", res.error);
|
|
427
|
-
}
|
|
428
|
-
}
|
|
429
|
-
|
|
430
|
-
run();
|
|
431
|
-
```
|
|
432
|
-
|
|
433
|
-
### React hooks and utilities
|
|
434
|
-
|
|
435
|
-
This method can be used in React components through the following hooks and
|
|
436
|
-
associated utilities.
|
|
437
|
-
|
|
438
|
-
> Check out [this guide][hook-guide] for information about each of the utilities
|
|
439
|
-
> below and how to get started using React hooks.
|
|
440
|
-
|
|
441
|
-
[hook-guide]: ../../../REACT_QUERY.md
|
|
442
|
-
|
|
443
|
-
```tsx
|
|
444
|
-
import {
|
|
445
|
-
// Query hooks for fetching data.
|
|
446
|
-
useClientGovernanceDataPoliciesDownload,
|
|
447
|
-
useClientGovernanceDataPoliciesDownloadSuspense,
|
|
448
|
-
|
|
449
|
-
// Utility for prefetching data during server-side rendering and in React
|
|
450
|
-
// Server Components that will be immediately available to client components
|
|
451
|
-
// using the hooks.
|
|
452
|
-
prefetchClientGovernanceDataPoliciesDownload,
|
|
453
|
-
|
|
454
|
-
// Utilities to invalidate the query cache for this query in response to
|
|
455
|
-
// mutations and other user actions.
|
|
456
|
-
invalidateClientGovernanceDataPoliciesDownload,
|
|
457
|
-
invalidateAllClientGovernanceDataPoliciesDownload,
|
|
458
|
-
} from "@gleanwork/api-client/react-query/clientGovernanceDataPoliciesDownload.js";
|
|
459
|
-
```
|
|
460
|
-
|
|
461
|
-
### Parameters
|
|
462
|
-
|
|
463
|
-
| Parameter | Type | Required | Description |
|
|
464
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
465
|
-
| `id` | *string* | :heavy_check_mark: | The id of the policy to download violations for. |
|
|
466
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
467
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
468
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
469
|
-
|
|
470
|
-
### Response
|
|
471
|
-
|
|
472
|
-
**Promise\<[string](../../models/.md)\>**
|
|
473
|
-
|
|
474
|
-
### Errors
|
|
475
|
-
|
|
476
|
-
| Error Type | Status Code | Content Type |
|
|
477
|
-
| ----------------- | ----------------- | ----------------- |
|
|
478
|
-
| errors.GleanError | 4XX, 5XX | \*/\* |
|