auth0 3.4.0 → 4.0.0-beta.1

package/dist/esm/management/__generated/managers/log-streams-manager.js

@@ -0,0 +1,365 @@
+import * as runtime from '../../../lib/runtime.js';
+const { BaseAPI } = runtime;
+/**
+ *
+ */
+export class LogStreamsManager extends BaseAPI {
+    /**
+     * Delete a log stream.
+     *
+     * Delete log stream
+     *
+     * @throws {RequiredError}
+     */
+    async delete(requestParameters, initOverrides) {
+        runtime.validateRequiredRequestParams(requestParameters, ['id']);
+        const response = await this.request({
+            path: `/log-streams/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
+            method: 'DELETE',
+        }, initOverrides);
+        return runtime.VoidApiResponse.fromResponse(response);
+    }
+    /**
+     * Retrieve details on <a href="https://auth0.com/docs/logs/streams">log streams</a>.
+     * <h5>Sample Response</h5><pre><code>[{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "eventbridge",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"awsAccountId": "string",
+     * 		"awsRegion": "string",
+     * 		"awsPartnerEventSource": "string"
+     * 	}
+     * }, {
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "http",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"httpContentFormat": "JSONLINES|JSONARRAY",
+     * 		"httpContentType": "string",
+     * 		"httpEndpoint": "string",
+     * 		"httpAuthorization": "string"
+     * 	}
+     * },
+     * {
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "eventgrid",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"azureSubscriptionId": "string",
+     * 		"azureResourceGroup": "string",
+     * 		"azureRegion": "string",
+     * 		"azurePartnerTopic": "string"
+     * 	}
+     * },
+     * {
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "splunk",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"splunkDomain": "string",
+     * 		"splunkToken": "string",
+     * 		"splunkPort": "string",
+     * 		"splunkSecure": "boolean"
+     * 	}
+     * },
+     * {
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "sumo",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"sumoSourceAddress": "string",
+     * 	}
+     * },
+     * {
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "datadog",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"datadogRegion": "string",
+     * 		"datadogApiKey": "string"
+     * 	}
+     * }]</code></pre>
+     *
+     * Get log streams
+     *
+     * @throws {RequiredError}
+     */
+    async getAll(initOverrides) {
+        const response = await this.request({
+            path: `/log-streams`,
+            method: 'GET',
+        }, initOverrides);
+        return runtime.JSONApiResponse.fromResponse(response);
+    }
+    /**
+     * Retrieve a log stream configuration and status.
+     * <h5>Sample responses</h5><h5>Amazon EventBridge Log Stream</h5><pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "eventbridge",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"awsAccountId": "string",
+     * 		"awsRegion": "string",
+     * 		"awsPartnerEventSource": "string"
+     * 	}
+     * }</code></pre> <h5>HTTP Log Stream</h5><pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "http",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"httpContentFormat": "JSONLINES|JSONARRAY",
+     * 		"httpContentType": "string",
+     * 		"httpEndpoint": "string",
+     * 		"httpAuthorization": "string"
+     * 	}
+     * }</code></pre> <h5>Datadog Log Stream</h5><pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "datadog",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"datadogRegion": "string",
+     * 		"datadogApiKey": "string"
+     * 	}
+     * }</code></pre> <h5>Splunk Log Stream</h5><pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "splunk",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"splunkDomain": "string",
+     * 		"splunkToken": "string",
+     * 		"splunkPort": "string",
+     * 		"splunkSecure": "boolean"
+     * 	}
+     * }</code></pre> <h5>Sumo Logic Log Stream</h5><pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "sumo",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"sumoSourceAddress": "string",
+     * 	}
+     * }</code></pre> <h5>Status</h5> The <code>status</code> of a log stream maybe any of the following:
+     * 1. <code>active</code> - Stream is currently enabled.
+     * 2. <code>paused</code> - Stream is currently user disabled and will not attempt log delivery.
+     * 3. <code>suspended</code> - Stream is currently disabled because of errors and will not attempt log delivery.
+     *
+     * Get log stream by ID
+     *
+     * @throws {RequiredError}
+     */
+    async get(requestParameters, initOverrides) {
+        runtime.validateRequiredRequestParams(requestParameters, ['id']);
+        const response = await this.request({
+            path: `/log-streams/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
+            method: 'GET',
+        }, initOverrides);
+        return runtime.JSONApiResponse.fromResponse(response);
+    }
+    /**
+     * Update a log stream.
+     * <h4>Examples of how to use the PATCH endpoint.</h4> The following fields may be updated in a PATCH operation: <ul><li>name</li><li>status</li><li>sink</li></ul> Note: For log streams of type <code>eventbridge</code> and <code>eventgrid</code>, updating the <code>sink</code> is not permitted.
+     * <h5>Update the status of a log stream</h5><pre><code>{
+     * 	"status": "active|paused"
+     * }</code></pre>
+     * <h5>Update the name of a log stream</h5><pre><code>{
+     * 	"name": "string"
+     * }</code></pre>
+     * <h5>Update the sink properties of a stream of type <code>http</code></h5><pre><code>{
+     *   "sink": {
+     *     "httpEndpoint": "string",
+     *     "httpContentType": "string",
+     *     "httpContentFormat": "JSONARRAY|JSONLINES",
+     *     "httpAuthorization": "string"
+     *   }
+     * }</code></pre>
+     * <h5>Update the sink properties of a stream of type <code>datadog</code></h5><pre><code>{
+     *   "sink": {
+     * 		"datadogRegion": "string",
+     * 		"datadogApiKey": "string"
+     *   }
+     * }</code></pre>
+     * <h5>Update the sink properties of a stream of type <code>splunk</code></h5><pre><code>{
+     *   "sink": {
+     *     "splunkDomain": "string",
+     *     "splunkToken": "string",
+     *     "splunkPort": "string",
+     *     "splunkSecure": "boolean"
+     *   }
+     * }</code></pre>
+     * <h5>Update the sink properties of a stream of type <code>sumo</code></h5><pre><code>{
+     *   "sink": {
+     *     "sumoSourceAddress": "string"
+     *   }
+     * }</code></pre>
+     * Update a log stream
+     *
+     * @throws {RequiredError}
+     */
+    async update(requestParameters, bodyParameters, initOverrides) {
+        runtime.validateRequiredRequestParams(requestParameters, ['id']);
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        const response = await this.request({
+            path: `/log-streams/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
+            method: 'PATCH',
+            headers: headerParameters,
+            body: bodyParameters,
+        }, initOverrides);
+        return runtime.JSONApiResponse.fromResponse(response);
+    }
+    /**
+     * Create a log stream.
+     * <h5>Log Stream Types</h5> The <code>type</code> of log stream being created determines the properties required in the <code>sink</code> payload.
+     * <h5>HTTP Stream</h5> For an <code>http</code> Stream, the <code>sink</code> properties are listed in the payload below
+     * Request: <pre><code>{
+     * 	"name": "string",
+     * 	"type": "http",
+     * 	"sink": {
+     * 		"httpEndpoint": "string",
+     * 		"httpContentType": "string",
+     * 		"httpContentFormat": "JSONLINES|JSONARRAY",
+     * 		"httpAuthorization": "string"
+     * 	}
+     * }</code></pre>
+     * Response: <pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "http",
+     * 	"status": "active",
+     * 	"sink": {
+     * 		"httpEndpoint": "string",
+     * 		"httpContentType": "string",
+     * 		"httpContentFormat": "JSONLINES|JSONARRAY",
+     * 		"httpAuthorization": "string"
+     * 	}
+     * }</code></pre>
+     * <h5>Amazon EventBridge Stream</h5> For an <code>eventbridge</code> Stream, the <code>sink</code> properties are listed in the payload below
+     * Request: <pre><code>{
+     * 	"name": "string",
+     * 	"type": "eventbridge",
+     * 	"sink": {
+     * 		"awsRegion": "string",
+     * 		"awsAccountId": "string"
+     * 	}
+     * }</code></pre>
+     * The response will include an additional field <code>awsPartnerEventSource</code> in the <code>sink</code>: <pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "eventbridge",
+     * 	"status": "active",
+     * 	"sink": {
+     * 		"awsAccountId": "string",
+     * 		"awsRegion": "string",
+     * 		"awsPartnerEventSource": "string"
+     * 	}
+     * }</code></pre>
+     * <h5>Azure Event Grid Stream</h5> For an <code>Azure Event Grid</code> Stream, the <code>sink</code> properties are listed in the payload below
+     * Request: <pre><code>{
+     * 	"name": "string",
+     * 	"type": "eventgrid",
+     * 	"sink": {
+     * 		"azureSubscriptionId": "string",
+     * 		"azureResourceGroup": "string",
+     * 		"azureRegion": "string"
+     * 	}
+     * }</code></pre>
+     * Response: <pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "http",
+     * 	"status": "active",
+     * 	"sink": {
+     * 		"azureSubscriptionId": "string",
+     * 		"azureResourceGroup": "string",
+     * 		"azureRegion": "string",
+     * 		"azurePartnerTopic": "string"
+     * 	}
+     * }</code></pre>
+     * <h5>Datadog Stream</h5> For a <code>Datadog</code> Stream, the <code>sink</code> properties are listed in the payload below
+     * Request: <pre><code>{
+     * 	"name": "string",
+     * 	"type": "datadog",
+     * 	"sink": {
+     * 		"datadogRegion": "string",
+     * 		"datadogApiKey": "string"
+     * 	}
+     * }</code></pre>
+     * Response: <pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "datadog",
+     * 	"status": "active",
+     * 	"sink": {
+     * 		"datadogRegion": "string",
+     * 		"datadogApiKey": "string"
+     * 	}
+     * }</code></pre>
+     * <h5>Splunk Stream</h5> For a <code>Splunk</code> Stream, the <code>sink</code> properties are listed in the payload below
+     * Request: <pre><code>{
+     * 	"name": "string",
+     * 	"type": "splunk",
+     * 	"sink": {
+     * 		"splunkDomain": "string",
+     * 		"splunkToken": "string",
+     * 		"splunkPort": "string",
+     * 		"splunkSecure": "boolean"
+     * 	}
+     * }</code></pre>
+     * Response: <pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "splunk",
+     * 	"status": "active",
+     * 	"sink": {
+     * 		"splunkDomain": "string",
+     * 		"splunkToken": "string",
+     * 		"splunkPort": "string",
+     * 		"splunkSecure": "boolean"
+     * 	}
+     * }</code></pre>
+     * <h5>Sumo Logic Stream</h5> For a <code>Sumo Logic</code> Stream, the <code>sink</code> properties are listed in the payload below
+     * Request: <pre><code>{
+     * 	"name": "string",
+     * 	"type": "sumo",
+     * 	"sink": {
+     * 		"sumoSourceAddress": "string",
+     * 	}
+     * }</code></pre>
+     * Response: <pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "sumo",
+     * 	"status": "active",
+     * 	"sink": {
+     * 		"sumoSourceAddress": "string",
+     * 	}
+     * }</code></pre>
+     *
+     * Create a log stream
+     *
+     * @throws {RequiredError}
+     */
+    async create(bodyParameters, initOverrides) {
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        const response = await this.request({
+            path: `/log-streams`,
+            method: 'POST',
+            headers: headerParameters,
+            body: bodyParameters,
+        }, initOverrides);
+        return runtime.JSONApiResponse.fromResponse(response);
+    }
+}
+//# sourceMappingURL=log-streams-manager.js.map

package/dist/esm/management/__generated/managers/log-streams-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log-streams-manager.js","sourceRoot":"","sources":["../../../../../src/management/__generated/managers/log-streams-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAWnD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,OAAO;IAC5C;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,iBAA8C,EAC9C,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,mBAAmB,CAAC,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3F,MAAM,EAAE,QAAQ;SACjB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuEG;IACH,KAAK,CAAC,MAAM,CACV,aAA4B;QAE5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,cAAc;YACpB,MAAM,EAAE,KAAK;SACd,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;IACH,KAAK,CAAC,GAAG,CACP,iBAA2C,EAC3C,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,mBAAmB,CAAC,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3F,MAAM,EAAE,KAAK;SACd,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,KAAK,CAAC,MAAM,CACV,iBAAsD,EACtD,cAA0C,EAC1C,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjE,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,mBAAmB,CAAC,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3F,MAAM,EAAE,OAAO;YACf,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE,cAAc;SACrB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmIG;IACH,KAAK,CAAC,MAAM,CACV,cAAqC,EACrC,aAA4B;QAE5B,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,cAAc;YACpB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE,cAAc;SACrB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;CACF"}

package/dist/esm/management/__generated/managers/logs-manager.js

@@ -0,0 +1,68 @@
+import * as runtime from '../../../lib/runtime.js';
+const { BaseAPI } = runtime;
+/**
+ *
+ */
+export class LogsManager extends BaseAPI {
+    async getAll(requestParameters = {}, initOverrides) {
+        const queryParameters = runtime.applyQueryParams(requestParameters, [
+            {
+                key: 'page',
+                config: {},
+            },
+            {
+                key: 'per_page',
+                config: {},
+            },
+            {
+                key: 'sort',
+                config: {},
+            },
+            {
+                key: 'fields',
+                config: {},
+            },
+            {
+                key: 'include_fields',
+                config: {},
+            },
+            {
+                key: 'include_totals',
+                config: {},
+            },
+            {
+                key: 'from',
+                config: {},
+            },
+            {
+                key: 'take',
+                config: {},
+            },
+            {
+                key: 'q',
+                config: {},
+            },
+        ]);
+        const response = await this.request({
+            path: `/logs`,
+            method: 'GET',
+            query: queryParameters,
+        }, initOverrides);
+        return runtime.JSONApiResponse.fromResponse(response);
+    }
+    /**
+     * Retrieve an individual log event.
+     * Get a log event by id
+     *
+     * @throws {RequiredError}
+     */
+    async get(requestParameters, initOverrides) {
+        runtime.validateRequiredRequestParams(requestParameters, ['id']);
+        const response = await this.request({
+            path: `/logs/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
+            method: 'GET',
+        }, initOverrides);
+        return runtime.JSONApiResponse.fromResponse(response);
+    }
+}
+//# sourceMappingURL=logs-manager.js.map

package/dist/esm/management/__generated/managers/logs-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logs-manager.js","sourceRoot":"","sources":["../../../../../src/management/__generated/managers/logs-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAUnD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,OAAO;IA4CtC,KAAK,CAAC,MAAM,CACV,oBAAoC,EAAE,EACtC,aAA4B;QAE5B,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,EAAE;YAClE;gBACE,GAAG,EAAE,MAAM;gBACX,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,UAAU;gBACf,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,MAAM;gBACX,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,QAAQ;gBACb,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,MAAM;gBACX,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,MAAM;gBACX,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,GAAG;gBACR,MAAM,EAAE,EAAE;aACX;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,eAAe;SACvB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CACP,iBAAqC,EACrC,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;YACpF,MAAM,EAAE,KAAK;SACd,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;CACF"}