@stainlessdev/xray 0.5.1

package/src/internal/utils/values.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { XrayError } from '../../core/error';
+
+// https://url.spec.whatwg.org/#url-scheme-string
+const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
+
+export const isAbsoluteURL = (url: string): boolean => {
+  return startsWithSchemeRegexp.test(url);
+};
+
+export let isArray = (val: unknown): val is unknown[] => ((isArray = Array.isArray), isArray(val));
+export let isReadonlyArray = isArray as (val: unknown) => val is readonly unknown[];
+
+/** Returns an object if the given value isn't an object, otherwise returns as-is */
+export function maybeObj(x: unknown): object {
+  if (typeof x !== 'object') {
+    return {};
+  }
+
+  return x ?? {};
+}
+
+// https://stackoverflow.com/a/34491287
+export function isEmptyObj(obj: Object | null | undefined): boolean {
+  if (!obj) return true;
+  for (const _k in obj) return false;
+  return true;
+}
+
+// https://eslint.org/docs/latest/rules/no-prototype-builtins
+export function hasOwn<T extends object = object>(obj: T, key: PropertyKey): key is keyof T {
+  return Object.prototype.hasOwnProperty.call(obj, key);
+}
+
+export function isObj(obj: unknown): obj is Record<string, unknown> {
+  return obj != null && typeof obj === 'object' && !Array.isArray(obj);
+}
+
+export const ensurePresent = <T>(value: T | null | undefined): T => {
+  if (value == null) {
+    throw new XrayError(`Expected a value to be given but received ${value} instead.`);
+  }
+
+  return value;
+};
+
+export const validatePositiveInteger = (name: string, n: unknown): number => {
+  if (typeof n !== 'number' || !Number.isInteger(n)) {
+    throw new XrayError(`${name} must be an integer`);
+  }
+  if (n < 0) {
+    throw new XrayError(`${name} must be a positive integer`);
+  }
+  return n;
+};
+
+export const coerceInteger = (value: unknown): number => {
+  if (typeof value === 'number') return Math.round(value);
+  if (typeof value === 'string') return parseInt(value, 10);
+
+  throw new XrayError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceFloat = (value: unknown): number => {
+  if (typeof value === 'number') return value;
+  if (typeof value === 'string') return parseFloat(value);
+
+  throw new XrayError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceBoolean = (value: unknown): boolean => {
+  if (typeof value === 'boolean') return value;
+  if (typeof value === 'string') return value === 'true';
+  return Boolean(value);
+};
+
+export const maybeCoerceInteger = (value: unknown): number | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceInteger(value);
+};
+
+export const maybeCoerceFloat = (value: unknown): number | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceFloat(value);
+};
+
+export const maybeCoerceBoolean = (value: unknown): boolean | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceBoolean(value);
+};
+
+export const safeJSON = (text: string) => {
+  try {
+    return JSON.parse(text);
+  } catch (err) {
+    return undefined;
+  }
+};

package/src/internal/utils.ts

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './utils/values';
+export * from './utils/base64';
+export * from './utils/env';
+export * from './utils/log';
+export * from './utils/uuid';
+export * from './utils/sleep';
+export * from './utils/query';

package/src/lib/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store custom files to expand the SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

package/src/pagination.ts

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

package/src/resource.ts

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

package/src/resources/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  RequestLogs,
+  type RequestLogRetrieveResponse,
+  type RequestLogListResponse,
+  type RequestLogRetrieveParams,
+  type RequestLogListParams,
+  type RequestLogListResponsesCursorIDPage,
+} from './request-logs';

package/src/resources/request-logs.ts

@@ -0,0 +1,405 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from '../core/pagination';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+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: string,
+    params: RequestLogRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RequestLogRetrieveResponse> {
+    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: RequestLogListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<RequestLogListResponsesCursorIDPage, RequestLogListResponse> {
+    const { 'X-Xray-Tenant-Id': xXrayTenantID, ...query } = params ?? {};
+    return this._client.getAPIList('/v1/request_logs', CursorIDPage<RequestLogListResponse>, {
+      query,
+      ...options,
+      headers: buildHeaders([
+        { ...(xXrayTenantID != null ? { 'X-Xray-Tenant-Id': xXrayTenantID } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+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,
+  };
+}

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

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

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '0.5.1'; // x-release-please-version

package/uploads.d.mts

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

package/uploads.d.mts.map

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

package/uploads.d.ts

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

package/uploads.d.ts.map

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

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}

package/uploads.mjs

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

package/uploads.mjs.map

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

package/version.d.mts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.5.1";
+//# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.5.1";
+//# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+exports.VERSION = '0.5.1'; // x-release-please-version
+//# sourceMappingURL=version.js.map

package/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -0,0 +1,2 @@
+export const VERSION = '0.5.1'; // x-release-please-version
+//# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}