@stainlessdev/xray 0.5.1

package/resources/request-logs.js

@@ -0,0 +1,62 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestLogs = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const headers_1 = require("../internal/headers.js");
+const path_1 = require("../internal/utils/path.js");
+class RequestLogs extends resource_1.APIResource {
+    /**
+     * Retrieve a specific request log by its [request ID](/guides/request-id).
+     *
+     * Results are limited in accordance with X-ray's
+     * [tenancy model](/guides/tenancy/). Callers may want to set `X-Xray-Tenant-Id` to
+     * a specific tenant ID to query logs for that tenant, or omit it to query across
+     * all non-tenanted logs.
+     */
+    retrieve(requestID, params = {}, options) {
+        const { 'X-Xray-Tenant-Id': xXrayTenantID, ...query } = params ?? {};
+        return this._client.get((0, path_1.path) `/v1/request_logs/${requestID}`, {
+            query,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xXrayTenantID != null ? { 'X-Xray-Tenant-Id': xXrayTenantID } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * List request logs by time and using a variety of optional filters.
+     *
+     * This is one of X-ray's most common API endpoints, returning a collection of
+     * request logs and accepting a variety of optional filters to narrow down results.
+     * For example, an integration might query for all request logs from a specific
+     * endpoint by invoking it with `request_method=GET` and
+     * `request_route=/api/v1/users/{user_id}`, or query via a customer-defined tag
+     * with `tags[sensitivity]=high`.
+     *
+     * The endpoint is paginated, ordered by `timestamp` and `request_id`. Order
+     * defaults to ascending (oldest first) but can be set to descending with the
+     * `order` query parameter. Many integrations will be querying for recent request
+     * logs, so setting `order=desc` is the more conventional form.
+     *
+     * Results are limited in accordance with X-ray's
+     * [tenancy model](/guides/tenancy/). Callers may want to set `X-Xray-Tenant-Id` to
+     * a specific tenant ID to query logs for that tenant, or omit it to query across
+     * all non-tenanted logs.
+     */
+    list(params = {}, options) {
+        const { 'X-Xray-Tenant-Id': xXrayTenantID, ...query } = params ?? {};
+        return this._client.getAPIList('/v1/request_logs', (pagination_1.CursorIDPage), {
+            query,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xXrayTenantID != null ? { 'X-Xray-Tenant-Id': xXrayTenantID } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.RequestLogs = RequestLogs;
+//# sourceMappingURL=request-logs.js.map

package/resources/request-logs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-logs.js","sourceRoot":"","sources":["../src/resources/request-logs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAwF;AACxF,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;OAOG;IACH,QAAQ,CACN,SAAiB,EACjB,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,kBAAkB,EAAE,aAAa,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oBAAoB,SAAS,EAAE,EAAE;YAC3D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,aAAa,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAClF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,kBAAkB,EAAE,aAAa,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,yBAAoC,CAAA,EAAE;YACvF,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,aAAa,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAClF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA3DD,kCA2DC"}

package/resources/request-logs.mjs

@@ -0,0 +1,58 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { CursorIDPage } from "../core/pagination.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class RequestLogs extends APIResource {
+    /**
+     * Retrieve a specific request log by its [request ID](/guides/request-id).
+     *
+     * Results are limited in accordance with X-ray's
+     * [tenancy model](/guides/tenancy/). Callers may want to set `X-Xray-Tenant-Id` to
+     * a specific tenant ID to query logs for that tenant, or omit it to query across
+     * all non-tenanted logs.
+     */
+    retrieve(requestID, params = {}, options) {
+        const { 'X-Xray-Tenant-Id': xXrayTenantID, ...query } = params ?? {};
+        return this._client.get(path `/v1/request_logs/${requestID}`, {
+            query,
+            ...options,
+            headers: buildHeaders([
+                { ...(xXrayTenantID != null ? { 'X-Xray-Tenant-Id': xXrayTenantID } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * List request logs by time and using a variety of optional filters.
+     *
+     * This is one of X-ray's most common API endpoints, returning a collection of
+     * request logs and accepting a variety of optional filters to narrow down results.
+     * For example, an integration might query for all request logs from a specific
+     * endpoint by invoking it with `request_method=GET` and
+     * `request_route=/api/v1/users/{user_id}`, or query via a customer-defined tag
+     * with `tags[sensitivity]=high`.
+     *
+     * The endpoint is paginated, ordered by `timestamp` and `request_id`. Order
+     * defaults to ascending (oldest first) but can be set to descending with the
+     * `order` query parameter. Many integrations will be querying for recent request
+     * logs, so setting `order=desc` is the more conventional form.
+     *
+     * Results are limited in accordance with X-ray's
+     * [tenancy model](/guides/tenancy/). Callers may want to set `X-Xray-Tenant-Id` to
+     * a specific tenant ID to query logs for that tenant, or omit it to query across
+     * all non-tenanted logs.
+     */
+    list(params = {}, options) {
+        const { 'X-Xray-Tenant-Id': xXrayTenantID, ...query } = params ?? {};
+        return this._client.getAPIList('/v1/request_logs', (CursorIDPage), {
+            query,
+            ...options,
+            headers: buildHeaders([
+                { ...(xXrayTenantID != null ? { 'X-Xray-Tenant-Id': xXrayTenantID } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=request-logs.mjs.map

package/resources/request-logs.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-logs.mjs","sourceRoot":"","sources":["../src/resources/request-logs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAwC;OACtD,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;OAOG;IACH,QAAQ,CACN,SAAiB,EACjB,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,kBAAkB,EAAE,aAAa,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,SAAS,EAAE,EAAE;YAC3D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,aAAa,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAClF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,kBAAkB,EAAE,aAAa,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,YAAoC,CAAA,EAAE;YACvF,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,aAAa,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAClF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources.d.mts

@@ -0,0 +1,2 @@
+export * from "./resources/index.mjs";
+//# sourceMappingURL=resources.d.mts.map

package/resources.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.d.mts","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}

package/resources.d.ts

@@ -0,0 +1,2 @@
+export * from "./resources/index.js";
+//# sourceMappingURL=resources.d.ts.map

package/resources.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}

package/resources.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+tslib_1.__exportStar(require("./resources/index.js"), exports);
+//# sourceMappingURL=resources.js.map

package/resources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.js","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":";;;AAAA,+DAAkC"}

package/resources.mjs

@@ -0,0 +1,2 @@
+export * from "./resources/index.mjs";
+//# sourceMappingURL=resources.mjs.map

package/resources.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.mjs","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}

package/src/api-promise.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/api-promise instead */
+export * from './core/api-promise';