@qlik/api 2.2.0 → 2.3.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/analytics/change-stores.d.ts +386 -0
- package/analytics/change-stores.js +123 -0
- package/analytics.d.ts +14 -0
- package/analytics.js +13 -0
- package/api-keys.d.ts +362 -3
- package/api-keys.js +2 -3
- package/apps.d.ts +2673 -3
- package/apps.js +2 -3
- package/assistants.d.ts +1370 -3
- package/assistants.js +2 -3
- package/audits.d.ts +318 -3
- package/audits.js +4 -4
- package/auth-types.d.ts +1 -1
- package/auth-types.js +1 -2
- package/auth.d.ts +94 -2
- package/auth.js +63 -3
- package/automation-connections.d.ts +366 -3
- package/automation-connections.js +2 -3
- package/automation-connectors.d.ts +84 -3
- package/automation-connectors.js +2 -3
- package/automations.d.ts +805 -3
- package/automations.js +2 -3
- package/automl-deployments.d.ts +101 -3
- package/automl-deployments.js +2 -3
- package/automl-predictions.d.ts +238 -3
- package/automl-predictions.js +2 -3
- package/banners.d.ts +184 -3
- package/banners.js +2 -3
- package/brands.d.ts +670 -3
- package/brands.js +2 -3
- package/chunks/{auth-Cle0_tmz.js → auth-BowS4SUR.js} +1 -5
- package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
- package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
- package/chunks/{auth-functions-BmZgZYSs.js → interceptors-DipDBQQ5.js} +258 -54
- package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-B7lGscuQ.js} +3 -3
- package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-DhdyFZ0F.js} +1 -5
- package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-QhLPeQr5.js} +7 -7
- package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
- package/chunks/{qix-DjxuPCX0.js → qix-RCUslia8.js} +11 -10
- package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-WAS4NVTf.js} +48 -50
- package/collections.d.ts +582 -3
- package/collections.js +2 -3
- package/conditions.d.ts +662 -3
- package/conditions.js +2 -3
- package/consumption.d.ts +182 -3
- package/consumption.js +2 -3
- package/core/ip-policies.d.ts +328 -4
- package/core/ip-policies.js +108 -5
- package/core.d.ts +13 -4
- package/core.js +3 -4
- package/csp-origins.d.ts +273 -3
- package/csp-origins.js +2 -3
- package/csrf-token.d.ts +62 -3
- package/csrf-token.js +2 -3
- package/data-alerts.d.ts +1004 -3
- package/data-alerts.js +2 -3
- package/data-assets.d.ts +207 -3
- package/data-assets.js +2 -3
- package/data-connections.d.ts +678 -3
- package/data-connections.js +2 -3
- package/data-credentials.d.ts +292 -3
- package/data-credentials.js +2 -3
- package/data-files.d.ts +860 -3
- package/data-files.js +2 -3
- package/data-qualities.d.ts +175 -3
- package/data-qualities.js +2 -3
- package/data-sets.d.ts +424 -3
- package/data-sets.js +2 -3
- package/data-sources.d.ts +348 -3
- package/data-sources.js +2 -3
- package/data-stores.d.ts +537 -3
- package/data-stores.js +2 -3
- package/dcaas.d.ts +192 -3
- package/dcaas.js +2 -3
- package/di-projects.d.ts +812 -4
- package/di-projects.js +25 -4
- package/direct-access-agents.d.ts +710 -4
- package/direct-access-agents.js +37 -5
- package/docs/authentication.md +1 -1
- package/encryption.d.ts +372 -3
- package/encryption.js +2 -3
- package/extensions.d.ts +295 -3
- package/extensions.js +2 -3
- package/global-types.d.ts +1 -1
- package/global-types.js +0 -2
- package/glossaries.d.ts +1223 -3
- package/glossaries.js +2 -3
- package/groups.d.ts +510 -3
- package/groups.js +2 -3
- package/identity-providers.d.ts +711 -3
- package/identity-providers.js +2 -3
- package/index.d.ts +78 -69
- package/index.js +28 -10
- package/interceptors.d.ts +52 -3
- package/interceptors.js +1 -2
- package/invoke-fetch-types.d.ts +1 -1
- package/items.d.ts +536 -3
- package/items.js +2 -3
- package/knowledgebases.d.ts +976 -3
- package/knowledgebases.js +2 -3
- package/licenses.d.ts +663 -3
- package/licenses.js +2 -3
- package/lineage-graphs.d.ts +704 -3
- package/lineage-graphs.js +2 -3
- package/ml.d.ts +2808 -3
- package/ml.js +2 -3
- package/notes.d.ts +110 -3
- package/notes.js +2 -3
- package/notifications.d.ts +98 -3
- package/notifications.js +2 -3
- package/oauth-callback.iife.js +1151 -0
- package/oauth-clients.d.ts +562 -3
- package/oauth-clients.js +2 -3
- package/oauth-tokens.d.ts +126 -3
- package/oauth-tokens.js +2 -3
- package/package.json +6 -4
- package/qix.d.ts +3 -3
- package/qix.js +38 -3
- package/questions.d.ts +364 -3
- package/questions.js +2 -3
- package/quotas.d.ts +112 -3
- package/quotas.js +2 -3
- package/reload-tasks.d.ts +249 -3
- package/reload-tasks.js +2 -3
- package/reloads.d.ts +260 -3
- package/reloads.js +2 -3
- package/report-templates.d.ts +287 -3
- package/report-templates.js +2 -3
- package/reports.d.ts +863 -3
- package/reports.js +2 -3
- package/roles.d.ts +312 -3
- package/roles.js +2 -3
- package/sharing-tasks.d.ts +1164 -3
- package/sharing-tasks.js +2 -3
- package/spaces.d.ts +779 -3
- package/spaces.js +2 -3
- package/tasks.d.ts +564 -3
- package/tasks.js +2 -3
- package/temp-contents.d.ts +167 -3
- package/temp-contents.js +2 -3
- package/tenants.d.ts +360 -3
- package/tenants.js +2 -3
- package/themes.d.ts +270 -3
- package/themes.js +2 -3
- package/transports.d.ts +435 -4
- package/transports.js +20 -5
- package/ui-config.d.ts +274 -3
- package/ui-config.js +2 -3
- package/users.d.ts +674 -3
- package/users.js +2 -3
- package/web-integrations.d.ts +294 -3
- package/web-integrations.js +2 -3
- package/web-notifications.d.ts +273 -3
- package/web-notifications.js +2 -3
- package/webhooks.d.ts +505 -3
- package/webhooks.js +2 -3
- package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
- package/chunks/apps-BwpXUGDb.d.ts +0 -2673
- package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
- package/chunks/audits-DakwzT97.d.ts +0 -316
- package/chunks/auth-6mptVm5Q.d.ts +0 -95
- package/chunks/auth-D11iO7ZV.js +0 -65
- package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
- package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
- package/chunks/automations-BGy83EBO.d.ts +0 -797
- package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
- package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
- package/chunks/banners-CgBRnZGv.d.ts +0 -184
- package/chunks/brands-DCgk6Gqx.d.ts +0 -671
- package/chunks/collections-BpYjcpIY.d.ts +0 -582
- package/chunks/conditions-CJJG7Uph.d.ts +0 -662
- package/chunks/consumption-DerFk437.d.ts +0 -182
- package/chunks/core-DQXNZdnf.d.ts +0 -12
- package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
- package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
- package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
- package/chunks/data-assets-CJDcssoX.d.ts +0 -207
- package/chunks/data-connections-VSB13K6g.d.ts +0 -678
- package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
- package/chunks/data-files-CVzn9M6V.d.ts +0 -860
- package/chunks/data-qualities-DBrot957.d.ts +0 -176
- package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
- package/chunks/data-sources-IsAaof_C.d.ts +0 -346
- package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
- package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
- package/chunks/di-projects-DVQTxASr.d.ts +0 -777
- package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
- package/chunks/encryption-BjA6xbCO.d.ts +0 -372
- package/chunks/extensions-OO0WtInj.d.ts +0 -294
- package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
- package/chunks/groups-C86-UG7S.d.ts +0 -511
- package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
- package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
- package/chunks/interceptors-DTYm37AU.js +0 -104
- package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
- package/chunks/ip-policies-DXlf172B.js +0 -108
- package/chunks/items-C-jzqvFW.d.ts +0 -536
- package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
- package/chunks/licenses-xzjnkitW.d.ts +0 -663
- package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
- package/chunks/ml-Abt2MUva.d.ts +0 -2809
- package/chunks/notes-BZxuyDgt.d.ts +0 -111
- package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
- package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
- package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
- package/chunks/qix-CYQsLyGQ.js +0 -40
- package/chunks/questions-BVp0tvNs.d.ts +0 -364
- package/chunks/quotas-CfAebRJd.d.ts +0 -113
- package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
- package/chunks/reloads-CwmagnFx.d.ts +0 -260
- package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
- package/chunks/reports-DzNC6Uq3.d.ts +0 -861
- package/chunks/roles-BYFIY6E7.d.ts +0 -312
- package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
- package/chunks/spaces-BK823t-b.d.ts +0 -780
- package/chunks/tasks-COKDfShO.d.ts +0 -564
- package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
- package/chunks/tenants-Bhn86519.d.ts +0 -361
- package/chunks/themes-v9NbhiBo.d.ts +0 -269
- package/chunks/transports-CqEiFxD3.d.ts +0 -362
- package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
- package/chunks/users-BSOBU_fg.d.ts +0 -675
- package/chunks/web-integrations-MisPAHod.d.ts +0 -295
- package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
- package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
- /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
- /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
- /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
- /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
- /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
- /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
package/consumption.d.ts
CHANGED
|
@@ -1,4 +1,183 @@
|
|
|
1
|
-
import "./chunks/auth-types-
|
|
2
|
-
import "./chunks/invoke-fetch-
|
|
3
|
-
|
|
1
|
+
import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
|
|
2
|
+
import "./chunks/invoke-fetch-C1Z0RJYU.js";
|
|
3
|
+
|
|
4
|
+
//#region src/public/rest/consumption.d.ts
|
|
5
|
+
type Enforcement = {
|
|
6
|
+
/** Resource action type to be blocked */
|
|
7
|
+
actionToBlock?: string;
|
|
8
|
+
/** Resource type to be blocked */
|
|
9
|
+
resourceType?: string;
|
|
10
|
+
};
|
|
11
|
+
/**
|
|
12
|
+
* @example
|
|
13
|
+
* {
|
|
14
|
+
* errors: [
|
|
15
|
+
* {
|
|
16
|
+
* code: "HTTP-123",
|
|
17
|
+
* title: "short error message"
|
|
18
|
+
* }
|
|
19
|
+
* ],
|
|
20
|
+
* traceId: "7975401f3954aa47"
|
|
21
|
+
* }
|
|
22
|
+
*/
|
|
23
|
+
type ErrorResponse = {
|
|
24
|
+
errors?: SingleErrorResponse[];
|
|
25
|
+
traceId?: string;
|
|
26
|
+
};
|
|
27
|
+
type ExecutionResponse = {
|
|
28
|
+
blocked?: boolean;
|
|
29
|
+
/** RFC3339 timestamp when a block event was last emitted for this execution. */
|
|
30
|
+
blockedEventTime?: string;
|
|
31
|
+
/** The capacity limit. */
|
|
32
|
+
capacityLimit?: number;
|
|
33
|
+
closeToOverage?: boolean;
|
|
34
|
+
/** The id of the consumption report */
|
|
35
|
+
consumptionReportId?: string;
|
|
36
|
+
/** The field to determine if a resource should be visible on the client. */
|
|
37
|
+
customerFacing?: boolean;
|
|
38
|
+
/** Contains a list of resources that are blocked when quota for this is reached. */
|
|
39
|
+
enforcement?: Enforcement[];
|
|
40
|
+
/** The global usage. */
|
|
41
|
+
globalUsage?: number;
|
|
42
|
+
/** The guardrail limit. */
|
|
43
|
+
guardrailLimit?: number;
|
|
44
|
+
/** The local usage. */
|
|
45
|
+
localUsage?: number;
|
|
46
|
+
overage?: boolean;
|
|
47
|
+
/** RFC3339 timestamp when a overage event was last emitted for this execution. */
|
|
48
|
+
overageEventTime?: string;
|
|
49
|
+
/** The end of the associated period. */
|
|
50
|
+
periodEnd?: string;
|
|
51
|
+
/** The start of the associated period. */
|
|
52
|
+
periodStart?: string;
|
|
53
|
+
periodType?: "day" | "month" | "year" | "" | "fixed" | "minute";
|
|
54
|
+
/** The resource action. */
|
|
55
|
+
resourceAction?: "report.generated" | "reload" | "scheduledReload" | "executed" | "aggregation" | "import" | "updated" | "deployed" | "3rd_party_executed" | "standard_executed";
|
|
56
|
+
/** The resource id. */
|
|
57
|
+
resourceId?: string;
|
|
58
|
+
/** The resource type. */
|
|
59
|
+
resourceType?: "app" | "automations" | "space" | "data.volume.consumption";
|
|
60
|
+
scope?: ("user" | "tenant" | "resourceId" | "resourceType" | "resourceAction")[];
|
|
61
|
+
/** The map to the resource scope. */
|
|
62
|
+
scopeMapping?: string;
|
|
63
|
+
segments?: Record<string, unknown>[];
|
|
64
|
+
/** The resource task description. */
|
|
65
|
+
taskDescription?: string;
|
|
66
|
+
/** The resource task name. */
|
|
67
|
+
taskName?: string;
|
|
68
|
+
/** The tenant id. */
|
|
69
|
+
tenantId?: string;
|
|
70
|
+
/** Unit of measurement for the resource consumption */
|
|
71
|
+
unit?: string;
|
|
72
|
+
/** The RFC3339 timestamp when the resource was updated. */
|
|
73
|
+
updateTime?: string;
|
|
74
|
+
/** The user id. */
|
|
75
|
+
userId?: string;
|
|
76
|
+
};
|
|
77
|
+
type ExecutionsByTenantList = StandardListResponseProps & {
|
|
78
|
+
closeToOverage?: boolean;
|
|
79
|
+
data?: ExecutionResponse[];
|
|
80
|
+
globalUsageAvailable?: boolean;
|
|
81
|
+
links?: ListLinks;
|
|
82
|
+
overage?: boolean;
|
|
83
|
+
};
|
|
84
|
+
type ListLinks = {
|
|
85
|
+
next?: Page;
|
|
86
|
+
prev?: Page;
|
|
87
|
+
/** Object with Href to a particular element or set of elements */
|
|
88
|
+
self?: Self;
|
|
89
|
+
};
|
|
90
|
+
type Page = {
|
|
91
|
+
/** URL to particular set of elements */
|
|
92
|
+
href?: string;
|
|
93
|
+
/** Page unique token */
|
|
94
|
+
token?: string;
|
|
95
|
+
/** Page type, can be next or prev */
|
|
96
|
+
type?: "prev" | "next";
|
|
97
|
+
};
|
|
98
|
+
/**
|
|
99
|
+
* Object with Href to a particular element or set of elements
|
|
100
|
+
*/
|
|
101
|
+
type Self = {
|
|
102
|
+
href?: string;
|
|
103
|
+
};
|
|
104
|
+
type SingleErrorResponse = {
|
|
105
|
+
/** Error code specific to usage-tracker. */
|
|
106
|
+
readonly code?: string;
|
|
107
|
+
/** Error cause. */
|
|
108
|
+
readonly detail?: string;
|
|
109
|
+
/** meta properties for an error. */
|
|
110
|
+
meta?: unknown;
|
|
111
|
+
/** Error title. */
|
|
112
|
+
readonly title?: string;
|
|
113
|
+
};
|
|
114
|
+
/**
|
|
115
|
+
* properties that should be added to every list response
|
|
116
|
+
*/
|
|
117
|
+
type StandardListResponseProps = {
|
|
118
|
+
/** count of entries on the currently shown page */
|
|
119
|
+
currentPageCount: number;
|
|
120
|
+
/** total count of entries in the collection as a whole */
|
|
121
|
+
totalCount: number;
|
|
122
|
+
};
|
|
123
|
+
/**
|
|
124
|
+
* Retrieves the list of executions on an specific tenant
|
|
125
|
+
*
|
|
126
|
+
* @param query an object with query parameters
|
|
127
|
+
* @throws GetConsumptionExecutionsHttpError
|
|
128
|
+
*/
|
|
129
|
+
declare function getConsumptionExecutions(query: {
|
|
130
|
+
actionToBlock?: string;
|
|
131
|
+
/** The advanced filtering to use for the query. Refer to [RFC 7644](https://datatracker.ietf.org/doc/rfc7644/) for the syntax.
|
|
132
|
+
*
|
|
133
|
+
* example `taskName eq "automation_run_ended" or taskName eq "report_triggered" or or taskName eq "dataVolumeAggregated"`
|
|
134
|
+
*
|
|
135
|
+
* The following fields are supported: `scope`, `resourcetype`, `resourceaction`, `resourceid`, `capacitylimit`,
|
|
136
|
+
* `localusage`, `globalusage`, `overage`, `blocked`, `periodstart`, `periodend`, `consumptionreportid`, `blockedeventtime`,
|
|
137
|
+
* `overageeventtime`, `taskname`, `taskdescription`, `userid`, `tenantid`, `customerfacing`, `actiontoblock` */
|
|
138
|
+
filter?: string;
|
|
139
|
+
/** Limit the returned result set */
|
|
140
|
+
limit?: number;
|
|
141
|
+
/** Offset for pagination - how many elements to skip */
|
|
142
|
+
offset?: number;
|
|
143
|
+
/** The cursor to the page of data. */
|
|
144
|
+
page?: string;
|
|
145
|
+
/** Specifies which periods to include regardless of the period type, start and end specified */
|
|
146
|
+
periodsToInclude?: ("current" | "previous")[];
|
|
147
|
+
sort?: ("periodstart" | "-periodstart" | "+periodstart" | "periodend" | "-periodend" | "+periodend")[];
|
|
148
|
+
}, options?: ApiCallOptions): Promise<GetConsumptionExecutionsHttpResponse>;
|
|
149
|
+
type GetConsumptionExecutionsHttpResponse = {
|
|
150
|
+
data: ExecutionsByTenantList;
|
|
151
|
+
headers: Headers;
|
|
152
|
+
status: 200;
|
|
153
|
+
prev?: (options?: ApiCallOptions) => Promise<GetConsumptionExecutionsHttpResponse>;
|
|
154
|
+
next?: (options?: ApiCallOptions) => Promise<GetConsumptionExecutionsHttpResponse>;
|
|
155
|
+
};
|
|
156
|
+
type GetConsumptionExecutionsHttpError = {
|
|
157
|
+
data: ErrorResponse;
|
|
158
|
+
headers: Headers;
|
|
159
|
+
status: number;
|
|
160
|
+
};
|
|
161
|
+
/**
|
|
162
|
+
* Clears the cache for consumption api requests.
|
|
163
|
+
*/
|
|
164
|
+
declare function clearCache(): void;
|
|
165
|
+
type ConsumptionAPI = {
|
|
166
|
+
/**
|
|
167
|
+
* Retrieves the list of executions on an specific tenant
|
|
168
|
+
*
|
|
169
|
+
* @param query an object with query parameters
|
|
170
|
+
* @throws GetConsumptionExecutionsHttpError
|
|
171
|
+
*/
|
|
172
|
+
getConsumptionExecutions: typeof getConsumptionExecutions;
|
|
173
|
+
/**
|
|
174
|
+
* Clears the cache for consumption api requests.
|
|
175
|
+
*/
|
|
176
|
+
clearCache: typeof clearCache;
|
|
177
|
+
};
|
|
178
|
+
/**
|
|
179
|
+
* Functions for the consumption api
|
|
180
|
+
*/
|
|
181
|
+
declare const consumptionExport: ConsumptionAPI;
|
|
182
|
+
//#endregion
|
|
4
183
|
export { ConsumptionAPI, Enforcement, ErrorResponse, ExecutionResponse, ExecutionsByTenantList, GetConsumptionExecutionsHttpError, GetConsumptionExecutionsHttpResponse, ListLinks, Page, Self, SingleErrorResponse, StandardListResponseProps, clearCache, consumptionExport as default, getConsumptionExecutions };
|
package/consumption.js
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import "./chunks/
|
|
2
|
-
import "./chunks/
|
|
3
|
-
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
|
|
1
|
+
import "./chunks/public-runtime-modules-QhLPeQr5.js";
|
|
2
|
+
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
|
|
4
3
|
|
|
5
4
|
//#region src/public/rest/consumption.ts
|
|
6
5
|
/**
|
package/core/ip-policies.d.ts
CHANGED
|
@@ -1,4 +1,328 @@
|
|
|
1
|
-
import "../chunks/auth-types-
|
|
2
|
-
import "../chunks/invoke-fetch-
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
import { y as ApiCallOptions } from "../chunks/auth-types-YrlH_R9f.js";
|
|
2
|
+
import "../chunks/invoke-fetch-C1Z0RJYU.js";
|
|
3
|
+
|
|
4
|
+
//#region src/public/rest/core/ip-policies.d.ts
|
|
5
|
+
declare namespace ip_policies_d_exports {
|
|
6
|
+
export { CreateIPPolicy, CreateIpPolicyHttpError, CreateIpPolicyHttpResponse, DeleteIpPolicyHttpError, DeleteIpPolicyHttpResponse, Error, Errors, GetIpPoliciesHttpError, GetIpPoliciesHttpResponse, GetIpPolicyHttpError, GetIpPolicyHttpResponse, IPPolicyListItem, IPPolicyResource, IpPoliciesAPI, JSONPatch, JSONPatchArray, Link, Links, ListIPPoliciesResult, PatchIpPolicyHttpError, PatchIpPolicyHttpResponse, clearCache, createIpPolicy, ipPoliciesExport as default, deleteIpPolicy, getIpPolicies, getIpPolicy, patchIpPolicy };
|
|
7
|
+
}
|
|
8
|
+
type CreateIPPolicy = {
|
|
9
|
+
/** An array of allowed IP IPv4 addresses, either as plain IP addresses, or as CIDR ranges. */
|
|
10
|
+
allowedIps: string[];
|
|
11
|
+
/** Indicates whether the IP policy is enabled. */
|
|
12
|
+
enabled?: boolean;
|
|
13
|
+
/** The descriptive name for the IP policy. */
|
|
14
|
+
name?: string;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* An error object describing the error.
|
|
18
|
+
*/
|
|
19
|
+
type Error = {
|
|
20
|
+
/** The error code. */
|
|
21
|
+
code: string;
|
|
22
|
+
/** A human-readable explanation specific to this occurrence of the problem. */
|
|
23
|
+
detail?: string;
|
|
24
|
+
/** Additional properties relating to the error. */
|
|
25
|
+
meta?: unknown;
|
|
26
|
+
/** References to the source of the error. */
|
|
27
|
+
source?: {
|
|
28
|
+
/** The URI query parameter that caused the error. */
|
|
29
|
+
parameter?: string;
|
|
30
|
+
/** A JSON Pointer to the property that caused the error. */
|
|
31
|
+
pointer?: string;
|
|
32
|
+
};
|
|
33
|
+
/** Summary of the problem. */
|
|
34
|
+
title: string;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* The error response object describing the error from the handling of an HTTP request.
|
|
38
|
+
* @example
|
|
39
|
+
* {
|
|
40
|
+
* errors: [
|
|
41
|
+
* {
|
|
42
|
+
* code: "CODE-10402",
|
|
43
|
+
* title: "Not Found"
|
|
44
|
+
* }
|
|
45
|
+
* ],
|
|
46
|
+
* traceId: "0000000000000000200ba0714061b982"
|
|
47
|
+
* }
|
|
48
|
+
*/
|
|
49
|
+
type Errors = {
|
|
50
|
+
/** An array of errors related to the operation. */
|
|
51
|
+
errors?: Error[];
|
|
52
|
+
/** A unique identifier for tracing the error. */
|
|
53
|
+
traceId?: string;
|
|
54
|
+
};
|
|
55
|
+
type IPPolicyListItem = {
|
|
56
|
+
/** An array of allowed IP addresses. */
|
|
57
|
+
allowedIps?: string[];
|
|
58
|
+
/** The timestamp for when the resource was created. */
|
|
59
|
+
createdAt?: string;
|
|
60
|
+
/** The user ID of the user who created the IP policy. */
|
|
61
|
+
createdBy?: string;
|
|
62
|
+
/** Indicates whether the IP policy can be deleted. */
|
|
63
|
+
deletable?: boolean;
|
|
64
|
+
/** Indicates whether the IP policy can be updated. */
|
|
65
|
+
editable?: boolean;
|
|
66
|
+
/** Indicates whether the IP policy is enabled. */
|
|
67
|
+
enabled?: boolean;
|
|
68
|
+
/** The unique identifier for the IP policy. */
|
|
69
|
+
readonly id: string;
|
|
70
|
+
/** The descriptive name for the IP policy. */
|
|
71
|
+
name?: string;
|
|
72
|
+
/** The tenant unique identifier associated with the given IP policy. */
|
|
73
|
+
tenantId?: string;
|
|
74
|
+
/** Indicates whether the IP policy can be enabled/disabled. */
|
|
75
|
+
toggleable?: boolean;
|
|
76
|
+
/** The timestamp for when the resource was last updated. */
|
|
77
|
+
updatedAt?: string;
|
|
78
|
+
/** The user ID of the user who last updated the IP policy. */
|
|
79
|
+
updatedBy?: string;
|
|
80
|
+
};
|
|
81
|
+
type IPPolicyResource = {
|
|
82
|
+
/** An array of allowed public IPv4 addresses. */
|
|
83
|
+
allowedIps: string[];
|
|
84
|
+
/** The timestamp for when the IP policy was created. */
|
|
85
|
+
createdAt: string;
|
|
86
|
+
/** The user ID of the user who created the IP policy. */
|
|
87
|
+
createdBy: string;
|
|
88
|
+
/** Indicates whether the IP policy can be deleted. */
|
|
89
|
+
deletable: boolean;
|
|
90
|
+
/** Indicates whether the IP policy can be updated. */
|
|
91
|
+
editable: boolean;
|
|
92
|
+
/** Indicates whether the IP policy is enabled. */
|
|
93
|
+
enabled: boolean;
|
|
94
|
+
/** The unique identifier for the IP policy. */
|
|
95
|
+
readonly id: string;
|
|
96
|
+
/** The descriptive name for the IP policy. */
|
|
97
|
+
name: string;
|
|
98
|
+
/** The tenant unique identifier associated with the given IP policy. */
|
|
99
|
+
tenantId: string;
|
|
100
|
+
/** Indicates whether the IP policy can be enabled/disabled.. */
|
|
101
|
+
toggleable: boolean;
|
|
102
|
+
/** The timestamp for when the IP policy was last updated. */
|
|
103
|
+
updatedAt: string;
|
|
104
|
+
/** The user ID of the user who last updated the IP policy. */
|
|
105
|
+
updatedBy: string;
|
|
106
|
+
};
|
|
107
|
+
/**
|
|
108
|
+
* A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
|
|
109
|
+
*/
|
|
110
|
+
type JSONPatch = {
|
|
111
|
+
/** The operation to be performed. */
|
|
112
|
+
op: "replace";
|
|
113
|
+
/** A JSON Pointer. */
|
|
114
|
+
path: "/enabled" | "/name" | "/allowedIps";
|
|
115
|
+
/** The value to be used for this operation. */
|
|
116
|
+
value: string | boolean | string[];
|
|
117
|
+
};
|
|
118
|
+
/**
|
|
119
|
+
* An array of JSON Patch documents
|
|
120
|
+
* @example
|
|
121
|
+
* [
|
|
122
|
+
* {
|
|
123
|
+
* op: "replace",
|
|
124
|
+
* path: "/name",
|
|
125
|
+
* value: "New name"
|
|
126
|
+
* },
|
|
127
|
+
* {
|
|
128
|
+
* op: "replace",
|
|
129
|
+
* path: "/allowedIps",
|
|
130
|
+
* value: [
|
|
131
|
+
* "61.254.213.0/24",
|
|
132
|
+
* "22.46.216.142"
|
|
133
|
+
* ]
|
|
134
|
+
* },
|
|
135
|
+
* {
|
|
136
|
+
* op: "replace",
|
|
137
|
+
* path: "/enabled",
|
|
138
|
+
* value: true
|
|
139
|
+
* }
|
|
140
|
+
* ]
|
|
141
|
+
*/
|
|
142
|
+
type JSONPatchArray = JSONPatch[];
|
|
143
|
+
/**
|
|
144
|
+
* A link
|
|
145
|
+
*/
|
|
146
|
+
type Link = {
|
|
147
|
+
href: string;
|
|
148
|
+
};
|
|
149
|
+
/**
|
|
150
|
+
* Contains pagination links. self is a link to the current results page, next is a link to the next results page and prev is a link to the previous results page
|
|
151
|
+
*/
|
|
152
|
+
type Links = {
|
|
153
|
+
/** A link */
|
|
154
|
+
next?: Link;
|
|
155
|
+
/** A link */
|
|
156
|
+
prev?: Link;
|
|
157
|
+
/** A link */
|
|
158
|
+
self: Link;
|
|
159
|
+
};
|
|
160
|
+
type ListIPPoliciesResult = {
|
|
161
|
+
/** An array of IP policies. */
|
|
162
|
+
data: IPPolicyListItem[];
|
|
163
|
+
/** Contains pagination links. self is a link to the current results page, next is a link to the next results page and prev is a link to the previous results page */
|
|
164
|
+
links: Links;
|
|
165
|
+
/** Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true. */
|
|
166
|
+
totalResults?: number;
|
|
167
|
+
};
|
|
168
|
+
/**
|
|
169
|
+
* Returns a list of IP policies present in the tenant. The user must be assigned the `TenantAdmin` role.
|
|
170
|
+
*
|
|
171
|
+
* @param query an object with query parameters
|
|
172
|
+
* @throws GetIpPoliciesHttpError
|
|
173
|
+
*/
|
|
174
|
+
declare function getIpPolicies(query: {
|
|
175
|
+
/** A comma-separated list of fields to limit in the response. */
|
|
176
|
+
fields?: string;
|
|
177
|
+
/** The advanced filtering to use for the query. Refer to [RFC 7644](https://datatracker.ietf.org/doc/rfc7644/) for the syntax. All conditional statements within this query parameter are case insensitive.
|
|
178
|
+
*
|
|
179
|
+
* field "enabled" supports following operators: eq
|
|
180
|
+
*
|
|
181
|
+
* field "id" supports following operators: eq, ne
|
|
182
|
+
*
|
|
183
|
+
* field "name" supports following operators: eq, co
|
|
184
|
+
*
|
|
185
|
+
* field "tenantId" supports following operators: eq */
|
|
186
|
+
filter?: string;
|
|
187
|
+
/** The number of IP policies to retrieve. */
|
|
188
|
+
limit?: number;
|
|
189
|
+
/** The page cursor. Takes precedence over other parameters. */
|
|
190
|
+
page?: string;
|
|
191
|
+
/** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
|
|
192
|
+
sort?: "enabled" | "+enabled" | "-enabled" | "createdAt" | "+createdAt" | "-createdAt" | "updatedAt" | "+updatedAt" | "-updatedAt" | "name" | "+name" | "-name";
|
|
193
|
+
/** Determines whether to return a count of the total records matched in the query. Defaults to false. */
|
|
194
|
+
totalResults?: boolean;
|
|
195
|
+
}, options?: ApiCallOptions): Promise<GetIpPoliciesHttpResponse>;
|
|
196
|
+
type GetIpPoliciesHttpResponse = {
|
|
197
|
+
data: ListIPPoliciesResult;
|
|
198
|
+
headers: Headers;
|
|
199
|
+
status: 200;
|
|
200
|
+
prev?: (options?: ApiCallOptions) => Promise<GetIpPoliciesHttpResponse>;
|
|
201
|
+
next?: (options?: ApiCallOptions) => Promise<GetIpPoliciesHttpResponse>;
|
|
202
|
+
};
|
|
203
|
+
type GetIpPoliciesHttpError = {
|
|
204
|
+
data: Errors;
|
|
205
|
+
headers: Headers;
|
|
206
|
+
status: 400 | 401 | 429 | 500;
|
|
207
|
+
};
|
|
208
|
+
/**
|
|
209
|
+
* Creates a new IPv4 IP policy in the tenant. If this is the first enabled policy, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role. IPv6 IP addresses are not currently supported.
|
|
210
|
+
*
|
|
211
|
+
* @param body an object with the body content
|
|
212
|
+
* @throws CreateIpPolicyHttpError
|
|
213
|
+
*/
|
|
214
|
+
declare function createIpPolicy(body: CreateIPPolicy, options?: ApiCallOptions): Promise<CreateIpPolicyHttpResponse>;
|
|
215
|
+
type CreateIpPolicyHttpResponse = {
|
|
216
|
+
data: IPPolicyResource;
|
|
217
|
+
headers: Headers;
|
|
218
|
+
status: 201;
|
|
219
|
+
};
|
|
220
|
+
type CreateIpPolicyHttpError = {
|
|
221
|
+
data: Errors;
|
|
222
|
+
headers: Headers;
|
|
223
|
+
status: 400 | 404 | 429 | 500;
|
|
224
|
+
};
|
|
225
|
+
/**
|
|
226
|
+
* Deletes an IP policy by ID. If this is the last enabled policy in the tenant, IP allowlisting will be disabled and access will be permitted via all IP addresses. The user's IP address must be present in at least one other policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role.
|
|
227
|
+
*
|
|
228
|
+
* @param id The unique identifier for the IP policy.
|
|
229
|
+
* @throws DeleteIpPolicyHttpError
|
|
230
|
+
*/
|
|
231
|
+
declare function deleteIpPolicy(id: string, options?: ApiCallOptions): Promise<DeleteIpPolicyHttpResponse>;
|
|
232
|
+
type DeleteIpPolicyHttpResponse = {
|
|
233
|
+
data: void;
|
|
234
|
+
headers: Headers;
|
|
235
|
+
status: 204;
|
|
236
|
+
};
|
|
237
|
+
type DeleteIpPolicyHttpError = {
|
|
238
|
+
data: Errors;
|
|
239
|
+
headers: Headers;
|
|
240
|
+
status: 401 | 403 | 404 | 429 | 500;
|
|
241
|
+
};
|
|
242
|
+
/**
|
|
243
|
+
* Retrieves details for a specific IP policy by policy ID.
|
|
244
|
+
*
|
|
245
|
+
* @param id The IP policy unique identifier
|
|
246
|
+
* @throws GetIpPolicyHttpError
|
|
247
|
+
*/
|
|
248
|
+
declare function getIpPolicy(id: string, options?: ApiCallOptions): Promise<GetIpPolicyHttpResponse>;
|
|
249
|
+
type GetIpPolicyHttpResponse = {
|
|
250
|
+
data: IPPolicyResource;
|
|
251
|
+
headers: Headers;
|
|
252
|
+
status: 200;
|
|
253
|
+
};
|
|
254
|
+
type GetIpPolicyHttpError = {
|
|
255
|
+
data: Errors;
|
|
256
|
+
headers: Headers;
|
|
257
|
+
status: 401 | 404 | 429 | 500;
|
|
258
|
+
};
|
|
259
|
+
/**
|
|
260
|
+
* Updates the IP policy. If this is the first enabled policy in the tenant, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role.
|
|
261
|
+
*
|
|
262
|
+
* @param id The unique identifier for the IP policy.
|
|
263
|
+
* @param body an object with the body content
|
|
264
|
+
* @throws PatchIpPolicyHttpError
|
|
265
|
+
*/
|
|
266
|
+
declare function patchIpPolicy(id: string, body: JSONPatchArray, options?: ApiCallOptions): Promise<PatchIpPolicyHttpResponse>;
|
|
267
|
+
type PatchIpPolicyHttpResponse = {
|
|
268
|
+
data: void;
|
|
269
|
+
headers: Headers;
|
|
270
|
+
status: 204;
|
|
271
|
+
};
|
|
272
|
+
type PatchIpPolicyHttpError = {
|
|
273
|
+
data: Errors;
|
|
274
|
+
headers: Headers;
|
|
275
|
+
status: 400 | 401 | 403 | 404 | 429 | 500;
|
|
276
|
+
};
|
|
277
|
+
/**
|
|
278
|
+
* Clears the cache for core/ip-policies api requests.
|
|
279
|
+
*/
|
|
280
|
+
declare function clearCache(): void;
|
|
281
|
+
type IpPoliciesAPI = {
|
|
282
|
+
/**
|
|
283
|
+
* Returns a list of IP policies present in the tenant. The user must be assigned the `TenantAdmin` role.
|
|
284
|
+
*
|
|
285
|
+
* @param query an object with query parameters
|
|
286
|
+
* @throws GetIpPoliciesHttpError
|
|
287
|
+
*/
|
|
288
|
+
getIpPolicies: typeof getIpPolicies;
|
|
289
|
+
/**
|
|
290
|
+
* Creates a new IPv4 IP policy in the tenant. If this is the first enabled policy, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role. IPv6 IP addresses are not currently supported.
|
|
291
|
+
*
|
|
292
|
+
* @param body an object with the body content
|
|
293
|
+
* @throws CreateIpPolicyHttpError
|
|
294
|
+
*/
|
|
295
|
+
createIpPolicy: typeof createIpPolicy;
|
|
296
|
+
/**
|
|
297
|
+
* Deletes an IP policy by ID. If this is the last enabled policy in the tenant, IP allowlisting will be disabled and access will be permitted via all IP addresses. The user's IP address must be present in at least one other policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role.
|
|
298
|
+
*
|
|
299
|
+
* @param id The unique identifier for the IP policy.
|
|
300
|
+
* @throws DeleteIpPolicyHttpError
|
|
301
|
+
*/
|
|
302
|
+
deleteIpPolicy: typeof deleteIpPolicy;
|
|
303
|
+
/**
|
|
304
|
+
* Retrieves details for a specific IP policy by policy ID.
|
|
305
|
+
*
|
|
306
|
+
* @param id The IP policy unique identifier
|
|
307
|
+
* @throws GetIpPolicyHttpError
|
|
308
|
+
*/
|
|
309
|
+
getIpPolicy: typeof getIpPolicy;
|
|
310
|
+
/**
|
|
311
|
+
* Updates the IP policy. If this is the first enabled policy in the tenant, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role.
|
|
312
|
+
*
|
|
313
|
+
* @param id The unique identifier for the IP policy.
|
|
314
|
+
* @param body an object with the body content
|
|
315
|
+
* @throws PatchIpPolicyHttpError
|
|
316
|
+
*/
|
|
317
|
+
patchIpPolicy: typeof patchIpPolicy;
|
|
318
|
+
/**
|
|
319
|
+
* Clears the cache for ip-policies api requests.
|
|
320
|
+
*/
|
|
321
|
+
clearCache: typeof clearCache;
|
|
322
|
+
};
|
|
323
|
+
/**
|
|
324
|
+
* Functions for the ip-policies api
|
|
325
|
+
*/
|
|
326
|
+
declare const ipPoliciesExport: IpPoliciesAPI;
|
|
327
|
+
//#endregion
|
|
328
|
+
export { CreateIPPolicy, CreateIpPolicyHttpError, CreateIpPolicyHttpResponse, DeleteIpPolicyHttpError, DeleteIpPolicyHttpResponse, Error, Errors, GetIpPoliciesHttpError, GetIpPoliciesHttpResponse, GetIpPolicyHttpError, GetIpPolicyHttpResponse, IPPolicyListItem, IPPolicyResource, IpPoliciesAPI, JSONPatch, JSONPatchArray, Link, Links, ListIPPoliciesResult, PatchIpPolicyHttpError, PatchIpPolicyHttpResponse, clearCache, createIpPolicy, ipPoliciesExport as default, deleteIpPolicy, getIpPolicies, getIpPolicy, patchIpPolicy, ip_policies_d_exports as t };
|
package/core/ip-policies.js
CHANGED
|
@@ -1,6 +1,109 @@
|
|
|
1
|
-
import "../chunks/
|
|
2
|
-
import "../chunks/public-runtime-modules-
|
|
3
|
-
import "../chunks/invoke-fetch-
|
|
4
|
-
import { a as getIpPolicy, c as patchIpPolicy, i as getIpPolicies, n as createIpPolicy, o as ip_policies_default, r as deleteIpPolicy, t as clearCache } from "../chunks/ip-policies-DXlf172B.js";
|
|
1
|
+
import { t as __exportAll } from "../chunks/chunk-D3vHIbds.js";
|
|
2
|
+
import "../chunks/public-runtime-modules-QhLPeQr5.js";
|
|
3
|
+
import { n as invokeFetch, t as clearApiCache } from "../chunks/invoke-fetch-B7lGscuQ.js";
|
|
5
4
|
|
|
6
|
-
|
|
5
|
+
//#region src/public/rest/core/ip-policies.ts
|
|
6
|
+
var ip_policies_exports = /* @__PURE__ */ __exportAll({
|
|
7
|
+
clearCache: () => clearCache,
|
|
8
|
+
createIpPolicy: () => createIpPolicy,
|
|
9
|
+
default: () => ip_policies_default,
|
|
10
|
+
deleteIpPolicy: () => deleteIpPolicy,
|
|
11
|
+
getIpPolicies: () => getIpPolicies,
|
|
12
|
+
getIpPolicy: () => getIpPolicy,
|
|
13
|
+
patchIpPolicy: () => patchIpPolicy
|
|
14
|
+
});
|
|
15
|
+
/**
|
|
16
|
+
* Returns a list of IP policies present in the tenant. The user must be assigned the `TenantAdmin` role.
|
|
17
|
+
*
|
|
18
|
+
* @param query an object with query parameters
|
|
19
|
+
* @throws GetIpPoliciesHttpError
|
|
20
|
+
*/
|
|
21
|
+
async function getIpPolicies(query, options) {
|
|
22
|
+
return invokeFetch("core/ip-policies", {
|
|
23
|
+
method: "get",
|
|
24
|
+
pathTemplate: "/api/core/ip-policies",
|
|
25
|
+
query,
|
|
26
|
+
options
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Creates a new IPv4 IP policy in the tenant. If this is the first enabled policy, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role. IPv6 IP addresses are not currently supported.
|
|
31
|
+
*
|
|
32
|
+
* @param body an object with the body content
|
|
33
|
+
* @throws CreateIpPolicyHttpError
|
|
34
|
+
*/
|
|
35
|
+
async function createIpPolicy(body, options) {
|
|
36
|
+
return invokeFetch("core/ip-policies", {
|
|
37
|
+
method: "post",
|
|
38
|
+
pathTemplate: "/api/core/ip-policies",
|
|
39
|
+
body,
|
|
40
|
+
contentType: "application/json",
|
|
41
|
+
options
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Deletes an IP policy by ID. If this is the last enabled policy in the tenant, IP allowlisting will be disabled and access will be permitted via all IP addresses. The user's IP address must be present in at least one other policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role.
|
|
46
|
+
*
|
|
47
|
+
* @param id The unique identifier for the IP policy.
|
|
48
|
+
* @throws DeleteIpPolicyHttpError
|
|
49
|
+
*/
|
|
50
|
+
async function deleteIpPolicy(id, options) {
|
|
51
|
+
return invokeFetch("core/ip-policies", {
|
|
52
|
+
method: "delete",
|
|
53
|
+
pathTemplate: "/api/core/ip-policies/{id}",
|
|
54
|
+
pathVariables: { id },
|
|
55
|
+
options
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Retrieves details for a specific IP policy by policy ID.
|
|
60
|
+
*
|
|
61
|
+
* @param id The IP policy unique identifier
|
|
62
|
+
* @throws GetIpPolicyHttpError
|
|
63
|
+
*/
|
|
64
|
+
async function getIpPolicy(id, options) {
|
|
65
|
+
return invokeFetch("core/ip-policies", {
|
|
66
|
+
method: "get",
|
|
67
|
+
pathTemplate: "/api/core/ip-policies/{id}",
|
|
68
|
+
pathVariables: { id },
|
|
69
|
+
options
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Updates the IP policy. If this is the first enabled policy in the tenant, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role.
|
|
74
|
+
*
|
|
75
|
+
* @param id The unique identifier for the IP policy.
|
|
76
|
+
* @param body an object with the body content
|
|
77
|
+
* @throws PatchIpPolicyHttpError
|
|
78
|
+
*/
|
|
79
|
+
async function patchIpPolicy(id, body, options) {
|
|
80
|
+
return invokeFetch("core/ip-policies", {
|
|
81
|
+
method: "patch",
|
|
82
|
+
pathTemplate: "/api/core/ip-policies/{id}",
|
|
83
|
+
pathVariables: { id },
|
|
84
|
+
body,
|
|
85
|
+
contentType: "application/json",
|
|
86
|
+
options
|
|
87
|
+
});
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* Clears the cache for core/ip-policies api requests.
|
|
91
|
+
*/
|
|
92
|
+
function clearCache() {
|
|
93
|
+
return clearApiCache("core/ip-policies");
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Functions for the ip-policies api
|
|
97
|
+
*/
|
|
98
|
+
const ipPoliciesExport = {
|
|
99
|
+
getIpPolicies,
|
|
100
|
+
createIpPolicy,
|
|
101
|
+
deleteIpPolicy,
|
|
102
|
+
getIpPolicy,
|
|
103
|
+
patchIpPolicy,
|
|
104
|
+
clearCache
|
|
105
|
+
};
|
|
106
|
+
var ip_policies_default = ipPoliciesExport;
|
|
107
|
+
|
|
108
|
+
//#endregion
|
|
109
|
+
export { clearCache, createIpPolicy, ip_policies_default as default, deleteIpPolicy, getIpPolicies, getIpPolicy, patchIpPolicy, ip_policies_exports as t };
|
package/core.d.ts
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
|
-
import "./chunks/auth-types-
|
|
2
|
-
import "./chunks/invoke-fetch-
|
|
3
|
-
import {
|
|
4
|
-
|
|
1
|
+
import "./chunks/auth-types-YrlH_R9f.js";
|
|
2
|
+
import "./chunks/invoke-fetch-C1Z0RJYU.js";
|
|
3
|
+
import ipPoliciesExport, { t as ip_policies_d_exports } from "./core/ip-policies.js";
|
|
4
|
+
|
|
5
|
+
//#region src/public/rest/core.d.ts
|
|
6
|
+
type CoreAPI = {};
|
|
7
|
+
/**
|
|
8
|
+
* Functions for the core api
|
|
9
|
+
*/
|
|
10
|
+
declare const coreExport: CoreAPI & {
|
|
11
|
+
ipPolicies: typeof ipPoliciesExport;
|
|
12
|
+
};
|
|
13
|
+
//#endregion
|
|
5
14
|
export { CoreAPI, coreExport as default, ip_policies_d_exports as ipPolicies };
|
package/core.js
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import "./chunks/
|
|
2
|
-
import "./chunks/
|
|
3
|
-
import "./
|
|
4
|
-
import { o as ip_policies_default, s as ip_policies_exports } from "./chunks/ip-policies-DXlf172B.js";
|
|
1
|
+
import "./chunks/public-runtime-modules-QhLPeQr5.js";
|
|
2
|
+
import "./chunks/invoke-fetch-B7lGscuQ.js";
|
|
3
|
+
import ip_policies_default, { t as ip_policies_exports } from "./core/ip-policies.js";
|
|
5
4
|
|
|
6
5
|
//#region src/public/rest/core.ts
|
|
7
6
|
/**
|