@stainlessdev/xray 0.5.1

package/resources/request-logs.d.mts

@@ -0,0 +1,324 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare 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: string, params?: RequestLogRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<RequestLogRetrieveResponse>;
+    /**
+     * 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?: RequestLogListParams | null | undefined, options?: RequestOptions): PagePromise<RequestLogListResponsesCursorIDPage, RequestLogListResponse>;
+}
+export type RequestLogListResponsesCursorIDPage = CursorIDPage<RequestLogListResponse>;
+/**
+ * RequestLog represents a single HTTP request and response exchange from a service
+ * being traced by X-ray.
+ */
+export interface RequestLogRetrieveResponse {
+    /**
+     * HTTP headers sent with the request, keyed by header name.
+     */
+    request_headers: {
+        [key: string]: Array<string>;
+    };
+    /**
+     * Unique identifier for the request, often an
+     * [X-ray request ID](/guides/request-id).
+     */
+    request_id: string;
+    /**
+     * HTTP method used for the request (e.g. `GET`, `POST`).
+     */
+    request_method: string;
+    /**
+     * Full path of the HTTP request (e.g. `/v1/users/123`).
+     */
+    request_path: string;
+    /**
+     * HTTP headers sent with the response, keyed by header name.
+     */
+    response_headers: {
+        [key: string]: Array<string>;
+    };
+    /**
+     * When the request was received.
+     */
+    timestamp: string;
+    /**
+     * Total time the request took in microseconds.
+     */
+    duration_us?: number;
+    /**
+     * IP address of the client that made the request.
+     */
+    ip?: string;
+    /**
+     * Raw body of the HTTP request.
+     *
+     * This property may be large and include relatively sensitive data, so it's
+     * omitted from responses by default. Include it using the `include` query
+     * parameter like `include=request_body`.
+     */
+    request_body?: string;
+    /**
+     * Encoding applied to the request body. If the body could be interpreted as valid
+     * UTF-8, this field will contain the value `utf-8`. If not, X-ray will have
+     * encoded the body as base64 and this field will contain the value `base64`.
+     */
+    request_body_encoding?: string;
+    /**
+     * Whether the request body was truncated because it exceeded the maximum capture
+     * size.
+     */
+    request_body_truncated?: boolean;
+    /**
+     * Matched route pattern for the request (e.g. `/v1/users/{id}`) as read from the
+     * target stack's internal HTTP framework (i.e. Go's `net/http`, Express in
+     * Javascript, etc.), if available.
+     */
+    request_route?: string;
+    /**
+     * Raw body of the HTTP response.
+     *
+     * This property may be large and include relatively sensitive data, so it's
+     * omitted from responses by default. Include it using the `include` query
+     * parameter like `include=response_body`.
+     */
+    response_body?: string;
+    /**
+     * Encoding applied to the response body. If the body could be interpreted as valid
+     * UTF-8, this field will contain the value `utf-8`. If not, X-ray will have
+     * encoded the body as base64 and this field will contain the value `base64`.
+     */
+    response_body_encoding?: string;
+    /**
+     * Whether the response body was truncated because it exceeded the maximum capture
+     * size.
+     */
+    response_body_truncated?: boolean;
+    /**
+     * Name of the service that handled the request.
+     */
+    service?: string;
+    /**
+     * HTTP status code returned by the response (e.g. 200, 404).
+     */
+    status?: number;
+    /**
+     * Arbitrary customer-defined tags associated with the request, keyed by tag name.
+     */
+    tags?: {
+        [key: string]: string;
+    };
+    /**
+     * Identifier for the tenant that made the request.
+     */
+    tenant_id?: string;
+    /**
+     * Identifier for the user who made the request, if known.
+     */
+    user_id?: string;
+}
+/**
+ * RequestLog represents a single HTTP request and response exchange from a service
+ * being traced by X-ray.
+ */
+export interface RequestLogListResponse {
+    /**
+     * HTTP headers sent with the request, keyed by header name.
+     */
+    request_headers: {
+        [key: string]: Array<string>;
+    };
+    /**
+     * Unique identifier for the request, often an
+     * [X-ray request ID](/guides/request-id).
+     */
+    request_id: string;
+    /**
+     * HTTP method used for the request (e.g. `GET`, `POST`).
+     */
+    request_method: string;
+    /**
+     * Full path of the HTTP request (e.g. `/v1/users/123`).
+     */
+    request_path: string;
+    /**
+     * HTTP headers sent with the response, keyed by header name.
+     */
+    response_headers: {
+        [key: string]: Array<string>;
+    };
+    /**
+     * When the request was received.
+     */
+    timestamp: string;
+    /**
+     * Total time the request took in microseconds.
+     */
+    duration_us?: number;
+    /**
+     * IP address of the client that made the request.
+     */
+    ip?: string;
+    /**
+     * Raw body of the HTTP request.
+     *
+     * This property may be large and include relatively sensitive data, so it's
+     * omitted from responses by default. Include it using the `include` query
+     * parameter like `include=request_body`.
+     */
+    request_body?: string;
+    /**
+     * Encoding applied to the request body. If the body could be interpreted as valid
+     * UTF-8, this field will contain the value `utf-8`. If not, X-ray will have
+     * encoded the body as base64 and this field will contain the value `base64`.
+     */
+    request_body_encoding?: string;
+    /**
+     * Whether the request body was truncated because it exceeded the maximum capture
+     * size.
+     */
+    request_body_truncated?: boolean;
+    /**
+     * Matched route pattern for the request (e.g. `/v1/users/{id}`) as read from the
+     * target stack's internal HTTP framework (i.e. Go's `net/http`, Express in
+     * Javascript, etc.), if available.
+     */
+    request_route?: string;
+    /**
+     * Raw body of the HTTP response.
+     *
+     * This property may be large and include relatively sensitive data, so it's
+     * omitted from responses by default. Include it using the `include` query
+     * parameter like `include=response_body`.
+     */
+    response_body?: string;
+    /**
+     * Encoding applied to the response body. If the body could be interpreted as valid
+     * UTF-8, this field will contain the value `utf-8`. If not, X-ray will have
+     * encoded the body as base64 and this field will contain the value `base64`.
+     */
+    response_body_encoding?: string;
+    /**
+     * Whether the response body was truncated because it exceeded the maximum capture
+     * size.
+     */
+    response_body_truncated?: boolean;
+    /**
+     * Name of the service that handled the request.
+     */
+    service?: string;
+    /**
+     * HTTP status code returned by the response (e.g. 200, 404).
+     */
+    status?: number;
+    /**
+     * Arbitrary customer-defined tags associated with the request, keyed by tag name.
+     */
+    tags?: {
+        [key: string]: string;
+    };
+    /**
+     * Identifier for the tenant that made the request.
+     */
+    tenant_id?: string;
+    /**
+     * Identifier for the user who made the request, if known.
+     */
+    user_id?: string;
+}
+export interface RequestLogRetrieveParams {
+    /**
+     * Query param: Additional response properties to include, such as `request_body`
+     * and `response_body`. By default, these properties are omitted.
+     */
+    include?: Array<string>;
+    /**
+     * Query param: Optional user ID to filter request logs to.
+     */
+    user_id?: string;
+    /**
+     * Header param: Tenant ID to scope request-log reads to. Set to `*` to query
+     * across all tenants.
+     */
+    'X-Xray-Tenant-Id'?: string;
+}
+export interface RequestLogListParams extends CursorIDPageParams {
+    /**
+     * Query param: Additional response properties to include, such as `request_body`
+     * and `response_body`. By default, these properties are omitted.
+     */
+    include?: Array<string>;
+    /**
+     * Query param: Optional IP address to filter request logs by.
+     */
+    ip?: string;
+    /**
+     * Query param: Sort order for results, either "asc" (ascending, oldest first) or
+     * `desc` (descending, newest first). Defaults to `asc`.
+     */
+    order?: 'asc' | 'desc';
+    /**
+     * Query param: The HTTP method to filter request logs by (e.g. `GET`, `POST`,
+     * etc.).
+     */
+    request_method?: string;
+    /**
+     * Query param: The request path to filter request logs by (e.g.
+     * `/api/v1/users/user_123`).
+     */
+    request_path?: string;
+    /**
+     * Query param: The request route to filter request logs by (e.g.
+     * `/api/v1/users/{user_id}`).
+     */
+    request_route?: string;
+    /**
+     * Query param: Optional service name to filter request logs by.
+     */
+    service?: string;
+    /**
+     * Query param: Optional HTTP status code to filter request logs by (e.g. 200,
+     * 404).
+     */
+    status?: number;
+    /**
+     * Query param: Optional user ID to filter request logs to.
+     */
+    user_id?: string;
+    /**
+     * Header param: Tenant ID to scope request-log reads to. Set to `*` to query
+     * across all tenants.
+     */
+    'X-Xray-Tenant-Id'?: string;
+}
+export declare namespace RequestLogs {
+    export { type RequestLogRetrieveResponse as RequestLogRetrieveResponse, type RequestLogListResponse as RequestLogListResponse, type RequestLogListResponsesCursorIDPage as RequestLogListResponsesCursorIDPage, type RequestLogRetrieveParams as RequestLogRetrieveParams, type RequestLogListParams as RequestLogListParams, };
+}
+//# sourceMappingURL=request-logs.d.mts.map

package/resources/request-logs.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-logs.d.mts","sourceRoot":"","sources":["../src/resources/request-logs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OAEtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;OAOG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAYzC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CACF,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,sBAAsB,CAAC;CAW5E;AAED,MAAM,MAAM,mCAAmC,GAAG,YAAY,CAAC,sBAAsB,CAAC,CAAC;AAEvF;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,eAAe,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC;IAElD;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC;IAEnD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,eAAe,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC;IAElD;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC;IAEnD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB;IAC9D;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAEvB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/request-logs.d.ts

@@ -0,0 +1,324 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare 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: string, params?: RequestLogRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<RequestLogRetrieveResponse>;
+    /**
+     * 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?: RequestLogListParams | null | undefined, options?: RequestOptions): PagePromise<RequestLogListResponsesCursorIDPage, RequestLogListResponse>;
+}
+export type RequestLogListResponsesCursorIDPage = CursorIDPage<RequestLogListResponse>;
+/**
+ * RequestLog represents a single HTTP request and response exchange from a service
+ * being traced by X-ray.
+ */
+export interface RequestLogRetrieveResponse {
+    /**
+     * HTTP headers sent with the request, keyed by header name.
+     */
+    request_headers: {
+        [key: string]: Array<string>;
+    };
+    /**
+     * Unique identifier for the request, often an
+     * [X-ray request ID](/guides/request-id).
+     */
+    request_id: string;
+    /**
+     * HTTP method used for the request (e.g. `GET`, `POST`).
+     */
+    request_method: string;
+    /**
+     * Full path of the HTTP request (e.g. `/v1/users/123`).
+     */
+    request_path: string;
+    /**
+     * HTTP headers sent with the response, keyed by header name.
+     */
+    response_headers: {
+        [key: string]: Array<string>;
+    };
+    /**
+     * When the request was received.
+     */
+    timestamp: string;
+    /**
+     * Total time the request took in microseconds.
+     */
+    duration_us?: number;
+    /**
+     * IP address of the client that made the request.
+     */
+    ip?: string;
+    /**
+     * Raw body of the HTTP request.
+     *
+     * This property may be large and include relatively sensitive data, so it's
+     * omitted from responses by default. Include it using the `include` query
+     * parameter like `include=request_body`.
+     */
+    request_body?: string;
+    /**
+     * Encoding applied to the request body. If the body could be interpreted as valid
+     * UTF-8, this field will contain the value `utf-8`. If not, X-ray will have
+     * encoded the body as base64 and this field will contain the value `base64`.
+     */
+    request_body_encoding?: string;
+    /**
+     * Whether the request body was truncated because it exceeded the maximum capture
+     * size.
+     */
+    request_body_truncated?: boolean;
+    /**
+     * Matched route pattern for the request (e.g. `/v1/users/{id}`) as read from the
+     * target stack's internal HTTP framework (i.e. Go's `net/http`, Express in
+     * Javascript, etc.), if available.
+     */
+    request_route?: string;
+    /**
+     * Raw body of the HTTP response.
+     *
+     * This property may be large and include relatively sensitive data, so it's
+     * omitted from responses by default. Include it using the `include` query
+     * parameter like `include=response_body`.
+     */
+    response_body?: string;
+    /**
+     * Encoding applied to the response body. If the body could be interpreted as valid
+     * UTF-8, this field will contain the value `utf-8`. If not, X-ray will have
+     * encoded the body as base64 and this field will contain the value `base64`.
+     */
+    response_body_encoding?: string;
+    /**
+     * Whether the response body was truncated because it exceeded the maximum capture
+     * size.
+     */
+    response_body_truncated?: boolean;
+    /**
+     * Name of the service that handled the request.
+     */
+    service?: string;
+    /**
+     * HTTP status code returned by the response (e.g. 200, 404).
+     */
+    status?: number;
+    /**
+     * Arbitrary customer-defined tags associated with the request, keyed by tag name.
+     */
+    tags?: {
+        [key: string]: string;
+    };
+    /**
+     * Identifier for the tenant that made the request.
+     */
+    tenant_id?: string;
+    /**
+     * Identifier for the user who made the request, if known.
+     */
+    user_id?: string;
+}
+/**
+ * RequestLog represents a single HTTP request and response exchange from a service
+ * being traced by X-ray.
+ */
+export interface RequestLogListResponse {
+    /**
+     * HTTP headers sent with the request, keyed by header name.
+     */
+    request_headers: {
+        [key: string]: Array<string>;
+    };
+    /**
+     * Unique identifier for the request, often an
+     * [X-ray request ID](/guides/request-id).
+     */
+    request_id: string;
+    /**
+     * HTTP method used for the request (e.g. `GET`, `POST`).
+     */
+    request_method: string;
+    /**
+     * Full path of the HTTP request (e.g. `/v1/users/123`).
+     */
+    request_path: string;
+    /**
+     * HTTP headers sent with the response, keyed by header name.
+     */
+    response_headers: {
+        [key: string]: Array<string>;
+    };
+    /**
+     * When the request was received.
+     */
+    timestamp: string;
+    /**
+     * Total time the request took in microseconds.
+     */
+    duration_us?: number;
+    /**
+     * IP address of the client that made the request.
+     */
+    ip?: string;
+    /**
+     * Raw body of the HTTP request.
+     *
+     * This property may be large and include relatively sensitive data, so it's
+     * omitted from responses by default. Include it using the `include` query
+     * parameter like `include=request_body`.
+     */
+    request_body?: string;
+    /**
+     * Encoding applied to the request body. If the body could be interpreted as valid
+     * UTF-8, this field will contain the value `utf-8`. If not, X-ray will have
+     * encoded the body as base64 and this field will contain the value `base64`.
+     */
+    request_body_encoding?: string;
+    /**
+     * Whether the request body was truncated because it exceeded the maximum capture
+     * size.
+     */
+    request_body_truncated?: boolean;
+    /**
+     * Matched route pattern for the request (e.g. `/v1/users/{id}`) as read from the
+     * target stack's internal HTTP framework (i.e. Go's `net/http`, Express in
+     * Javascript, etc.), if available.
+     */
+    request_route?: string;
+    /**
+     * Raw body of the HTTP response.
+     *
+     * This property may be large and include relatively sensitive data, so it's
+     * omitted from responses by default. Include it using the `include` query
+     * parameter like `include=response_body`.
+     */
+    response_body?: string;
+    /**
+     * Encoding applied to the response body. If the body could be interpreted as valid
+     * UTF-8, this field will contain the value `utf-8`. If not, X-ray will have
+     * encoded the body as base64 and this field will contain the value `base64`.
+     */
+    response_body_encoding?: string;
+    /**
+     * Whether the response body was truncated because it exceeded the maximum capture
+     * size.
+     */
+    response_body_truncated?: boolean;
+    /**
+     * Name of the service that handled the request.
+     */
+    service?: string;
+    /**
+     * HTTP status code returned by the response (e.g. 200, 404).
+     */
+    status?: number;
+    /**
+     * Arbitrary customer-defined tags associated with the request, keyed by tag name.
+     */
+    tags?: {
+        [key: string]: string;
+    };
+    /**
+     * Identifier for the tenant that made the request.
+     */
+    tenant_id?: string;
+    /**
+     * Identifier for the user who made the request, if known.
+     */
+    user_id?: string;
+}
+export interface RequestLogRetrieveParams {
+    /**
+     * Query param: Additional response properties to include, such as `request_body`
+     * and `response_body`. By default, these properties are omitted.
+     */
+    include?: Array<string>;
+    /**
+     * Query param: Optional user ID to filter request logs to.
+     */
+    user_id?: string;
+    /**
+     * Header param: Tenant ID to scope request-log reads to. Set to `*` to query
+     * across all tenants.
+     */
+    'X-Xray-Tenant-Id'?: string;
+}
+export interface RequestLogListParams extends CursorIDPageParams {
+    /**
+     * Query param: Additional response properties to include, such as `request_body`
+     * and `response_body`. By default, these properties are omitted.
+     */
+    include?: Array<string>;
+    /**
+     * Query param: Optional IP address to filter request logs by.
+     */
+    ip?: string;
+    /**
+     * Query param: Sort order for results, either "asc" (ascending, oldest first) or
+     * `desc` (descending, newest first). Defaults to `asc`.
+     */
+    order?: 'asc' | 'desc';
+    /**
+     * Query param: The HTTP method to filter request logs by (e.g. `GET`, `POST`,
+     * etc.).
+     */
+    request_method?: string;
+    /**
+     * Query param: The request path to filter request logs by (e.g.
+     * `/api/v1/users/user_123`).
+     */
+    request_path?: string;
+    /**
+     * Query param: The request route to filter request logs by (e.g.
+     * `/api/v1/users/{user_id}`).
+     */
+    request_route?: string;
+    /**
+     * Query param: Optional service name to filter request logs by.
+     */
+    service?: string;
+    /**
+     * Query param: Optional HTTP status code to filter request logs by (e.g. 200,
+     * 404).
+     */
+    status?: number;
+    /**
+     * Query param: Optional user ID to filter request logs to.
+     */
+    user_id?: string;
+    /**
+     * Header param: Tenant ID to scope request-log reads to. Set to `*` to query
+     * across all tenants.
+     */
+    'X-Xray-Tenant-Id'?: string;
+}
+export declare namespace RequestLogs {
+    export { type RequestLogRetrieveResponse as RequestLogRetrieveResponse, type RequestLogListResponse as RequestLogListResponse, type RequestLogListResponsesCursorIDPage as RequestLogListResponsesCursorIDPage, type RequestLogRetrieveParams as RequestLogRetrieveParams, type RequestLogListParams as RequestLogListParams, };
+}
+//# sourceMappingURL=request-logs.d.ts.map

package/resources/request-logs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-logs.d.ts","sourceRoot":"","sources":["../src/resources/request-logs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OAEtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;OAOG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAYzC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CACF,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,sBAAsB,CAAC;CAW5E;AAED,MAAM,MAAM,mCAAmC,GAAG,YAAY,CAAC,sBAAsB,CAAC,CAAC;AAEvF;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,eAAe,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC;IAElD;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC;IAEnD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,eAAe,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC;IAElD;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC;IAEnD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB;IAC9D;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAEvB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}