@augno/sdk 0.1.6

package/src/resources/core/core.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as AuditEventsAPI from './audit-events';
+import {
+  AuditEvent,
+  AuditEventListParams,
+  AuditEventRetrieveParams,
+  AuditEvents,
+  AuditFieldChange,
+  ListAuditEvent,
+  ListAuditFieldChange,
+  ListObjectType,
+} from './audit-events';
+import * as EmailLogsAPI from './email-logs';
+import { EmailLog, EmailLogListParams, EmailLogRetrieveParams, EmailLogs, ListEmailLog } from './email-logs';
+import * as RequestLogsAPI from './request-logs';
+import {
+  Actor,
+  ListRequestLog,
+  RequestLog,
+  RequestLogListParams,
+  RequestLogRetrieveParams,
+  RequestLogs,
+} from './request-logs';
+import * as SandboxesAPI from './sandboxes';
+import {
+  CreateSandboxRequest,
+  ListSandbox,
+  Sandbox,
+  SandboxCreateParams,
+  SandboxDeleteResponse,
+  SandboxListParams,
+  SandboxRetrieveParams,
+  Sandboxes,
+} from './sandboxes';
+import * as AddressesAPI from './addresses/addresses';
+import {
+  AddressRetrieveSuggestionsParams,
+  AddressSuggestion,
+  Addresses,
+  ListAddressSuggestion,
+} from './addresses/addresses';
+
+export class Core extends APIResource {
+  sandboxes: SandboxesAPI.Sandboxes = new SandboxesAPI.Sandboxes(this._client);
+  requestLogs: RequestLogsAPI.RequestLogs = new RequestLogsAPI.RequestLogs(this._client);
+  auditEvents: AuditEventsAPI.AuditEvents = new AuditEventsAPI.AuditEvents(this._client);
+  addresses: AddressesAPI.Addresses = new AddressesAPI.Addresses(this._client);
+  emailLogs: EmailLogsAPI.EmailLogs = new EmailLogsAPI.EmailLogs(this._client);
+}
+
+Core.Sandboxes = Sandboxes;
+Core.RequestLogs = RequestLogs;
+Core.AuditEvents = AuditEvents;
+Core.Addresses = Addresses;
+Core.EmailLogs = EmailLogs;
+
+export declare namespace Core {
+  export {
+    Sandboxes as Sandboxes,
+    type CreateSandboxRequest as CreateSandboxRequest,
+    type ListSandbox as ListSandbox,
+    type Sandbox as Sandbox,
+    type SandboxDeleteResponse as SandboxDeleteResponse,
+    type SandboxCreateParams as SandboxCreateParams,
+    type SandboxRetrieveParams as SandboxRetrieveParams,
+    type SandboxListParams as SandboxListParams,
+  };
+
+  export {
+    RequestLogs as RequestLogs,
+    type Actor as Actor,
+    type ListRequestLog as ListRequestLog,
+    type RequestLog as RequestLog,
+    type RequestLogRetrieveParams as RequestLogRetrieveParams,
+    type RequestLogListParams as RequestLogListParams,
+  };
+
+  export {
+    AuditEvents as AuditEvents,
+    type AuditEvent as AuditEvent,
+    type AuditFieldChange as AuditFieldChange,
+    type ListAuditEvent as ListAuditEvent,
+    type ListAuditFieldChange as ListAuditFieldChange,
+    type ListObjectType as ListObjectType,
+    type AuditEventRetrieveParams as AuditEventRetrieveParams,
+    type AuditEventListParams as AuditEventListParams,
+  };
+
+  export {
+    Addresses as Addresses,
+    type AddressSuggestion as AddressSuggestion,
+    type ListAddressSuggestion as ListAddressSuggestion,
+    type AddressRetrieveSuggestionsParams as AddressRetrieveSuggestionsParams,
+  };
+
+  export {
+    EmailLogs as EmailLogs,
+    type EmailLog as EmailLog,
+    type ListEmailLog as ListEmailLog,
+    type EmailLogRetrieveParams as EmailLogRetrieveParams,
+    type EmailLogListParams as EmailLogListParams,
+  };
+}

package/src/resources/core/email-logs.ts

@@ -0,0 +1,156 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as RequestLogsAPI from './request-logs';
+import * as APIKeysAPI from '../auth/api-keys/api-keys';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * View email logs for accounts.
+ */
+export class EmailLogs extends APIResource {
+  /**
+   * Returns an email log by ID.
+   *
+   * @example
+   * ```ts
+   * const emailLog = await client.core.emailLogs.retrieve(
+   *   'eml_017b80707ada92dddff8a2c3a0',
+   * );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: EmailLogRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EmailLog> {
+    return this._client.get(path`/v1/core/email-logs/${id}`, { query, ...options });
+  }
+
+  /**
+   * Returns a paginated list of email logs for the current account.
+   *
+   * @example
+   * ```ts
+   * const listEmailLog = await client.core.emailLogs.list();
+   * ```
+   */
+  list(
+    query: EmailLogListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListEmailLog> {
+    return this._client.get('/v1/core/email-logs', { query, ...options });
+  }
+}
+
+/**
+ * Email log entry.
+ */
+export interface EmailLog {
+  /**
+   * Email log ID.
+   */
+  id: string;
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * Filename of any attachment.
+   */
+  filename: string | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'email_log';
+
+  /**
+   * Recipient email addresses.
+   */
+  recipients: Array<string>;
+
+  /**
+   * Email send status.
+   */
+  send_status: 'sent' | 'pending';
+
+  /**
+   * Reference to an actor (user, API key, or agent).
+   */
+  sent_by: RequestLogsAPI.Actor | null;
+
+  /**
+   * Email subject line.
+   */
+  subject: string | null;
+
+  /**
+   * Last updated timestamp.
+   */
+  updated_at: string;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListEmailLog {
+  /**
+   * Resources in this page.
+   */
+  data: Array<EmailLog>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+export interface EmailLogRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'sent_by'>;
+}
+
+export interface EmailLogListParams {
+  /**
+   * Cursor token used to retrieve the next or previous page of results.
+   */
+  cursor?: string;
+
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'sent_by'>;
+
+  /**
+   * Maximum number of results per page (default: 100, max: 1000).
+   */
+  limit?: number;
+
+  /**
+   * Search query used to filter results.
+   */
+  q?: string;
+}
+
+export declare namespace EmailLogs {
+  export {
+    type EmailLog as EmailLog,
+    type ListEmailLog as ListEmailLog,
+    type EmailLogRetrieveParams as EmailLogRetrieveParams,
+    type EmailLogListParams as EmailLogListParams,
+  };
+}

package/src/resources/core/index.ts

@@ -0,0 +1,44 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Addresses,
+  type AddressSuggestion,
+  type ListAddressSuggestion,
+  type AddressRetrieveSuggestionsParams,
+} from './addresses/index';
+export {
+  AuditEvents,
+  type AuditEvent,
+  type AuditFieldChange,
+  type ListAuditEvent,
+  type ListAuditFieldChange,
+  type ListObjectType,
+  type AuditEventRetrieveParams,
+  type AuditEventListParams,
+} from './audit-events';
+export { Core } from './core';
+export {
+  EmailLogs,
+  type EmailLog,
+  type ListEmailLog,
+  type EmailLogRetrieveParams,
+  type EmailLogListParams,
+} from './email-logs';
+export {
+  RequestLogs,
+  type Actor,
+  type ListRequestLog,
+  type RequestLog,
+  type RequestLogRetrieveParams,
+  type RequestLogListParams,
+} from './request-logs';
+export {
+  Sandboxes,
+  type CreateSandboxRequest,
+  type ListSandbox,
+  type Sandbox,
+  type SandboxDeleteResponse,
+  type SandboxCreateParams,
+  type SandboxRetrieveParams,
+  type SandboxListParams,
+} from './sandboxes';

package/src/resources/core/request-logs.ts

@@ -0,0 +1,366 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as APIKeysAPI from '../auth/api-keys/api-keys';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * List and retrieve request logs.
+ */
+export class RequestLogs extends APIResource {
+  /**
+   * Returns a request log by ID.
+   *
+   * @example
+   * ```ts
+   * const requestLog = await client.core.requestLogs.retrieve(
+   *   'rq_01304bffe90e8cce9690cbefd4',
+   * );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: RequestLogRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RequestLog> {
+    return this._client.get(path`/v1/core/request-logs/${id}`, { query, ...options });
+  }
+
+  /**
+   * Returns a paginated list of request logs.
+   *
+   * @example
+   * ```ts
+   * const listRequestLog = await client.core.requestLogs.list();
+   * ```
+   */
+  list(
+    query: RequestLogListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListRequestLog> {
+    return this._client.get('/v1/core/request-logs', { query, ...options });
+  }
+}
+
+/**
+ * Reference to an actor (user, API key, or agent).
+ */
+export interface Actor {
+  /**
+   * Actor ID.
+   */
+  id: string;
+
+  /**
+   * Human-readable handle (`email` for users, `redacted_value` for API keys, `slug`
+   * for agents).
+   */
+  handle: string | null;
+
+  /**
+   * Display name.
+   */
+  name: string | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'actor';
+
+  /**
+   * Role resource.
+   */
+  role: APIKeysAPI.Role | null;
+
+  /**
+   * Actor type.
+   */
+  type: 'user' | 'api_key' | 'agent';
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListRequestLog {
+  /**
+   * Resources in this page.
+   */
+  data: Array<RequestLog>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * RequestLog is an API request log entry.
+ */
+export interface RequestLog {
+  /**
+   * Request log ID.
+   */
+  id: string;
+
+  /**
+   * Account with optional branding and portal sub-resources.
+   */
+  account: APIKeysAPI.Account | null;
+
+  /**
+   * Reference to an actor (user, API key, or agent).
+   */
+  actor: Actor | null;
+
+  /**
+   * API version used.
+   */
+  api_version: string | null;
+
+  /**
+   * Client IP address.
+   */
+  client_ip: string | null;
+
+  /**
+   * When the log entry was created.
+   */
+  created_at: string;
+
+  /**
+   * API error code.
+   */
+  error_code: string | null;
+
+  /**
+   * Error message.
+   */
+  error_message: string | null;
+
+  /**
+   * Request host. Usually `api.augno.com`.
+   */
+  host: string;
+
+  /**
+   * User-provided idempotency key.
+   */
+  idempotency_key: string | null;
+
+  /**
+   * Request latency in microseconds.
+   */
+  latency_us: number;
+
+  /**
+   * HTTP method.
+   */
+  method: string;
+
+  /**
+   * _Normalized_ route template. For example `PATCH /v1/sales/customers/{id}` is the
+   * normalized route for a request route `PUT /v1/sales/customers/ac_...`.
+   */
+  normalized_route: string;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'request_log';
+
+  /**
+   * When the request occurred.
+   */
+  occurred_at: string;
+
+  /**
+   * Non-normalized request path.
+   */
+  path: string;
+
+  /**
+   * Query parameters. Encoded as a JSON value (object, array, string, number,
+   * boolean, or null), not a JSON-encoded string.
+   */
+  query_params: unknown | null;
+
+  /**
+   * Referrer header.
+   */
+  referrer: string | null;
+
+  /**
+   * Request body. Encoded as a JSON value (object, array, string, number, boolean,
+   * or null), not a JSON-encoded string.
+   */
+  request_body: unknown | null;
+
+  /**
+   * Response body. Encoded as a JSON value (object, array, string, number, boolean,
+   * or null), not a JSON-encoded string.
+   */
+  response_body: unknown | null;
+
+  /**
+   * HTTP status code.
+   */
+  status_code: number;
+
+  /**
+   * User agent.
+   */
+  user_agent: string | null;
+}
+
+export interface RequestLogRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<
+    | 'account'
+    | 'actor'
+    | 'actor.role'
+    | 'actor.role.permissions'
+    | 'query_params'
+    | 'request_body'
+    | 'response_body'
+  >;
+}
+
+export interface RequestLogListParams {
+  /**
+   * Filter by the account ID _targeted_ by the request. The actor may be operating
+   * on behalf of a separate account.
+   */
+  account_ids?: Array<string>;
+
+  /**
+   * Filter by the actor identifier. `account_user.id` when `identity_type`=`user`,
+   * or an `api_key.id` when `identity_type`=`api_key`.
+   */
+  actor_ids?: Array<string>;
+
+  /**
+   * Filter by the actor type.
+   */
+  actor_types?: Array<'user' | 'api_key' | 'agent'>;
+
+  /**
+   * Cursor token used to retrieve the next or previous page of results.
+   */
+  cursor?: string;
+
+  /**
+   * Restricts results to request logs on or before this timestamp.
+   */
+  end_date?: string;
+
+  /**
+   * Filter by API error code.
+   */
+  error_codes?: Array<
+    | 'expired_token'
+    | 'api_key_expired'
+    | 'api_key_revoked'
+    | 'invalid_credentials'
+    | 'insufficient_permissions'
+    | 'payment_required'
+    | 'validation_failed'
+    | 'missing_field'
+    | 'invalid_format'
+    | 'method_not_allowed'
+    | 'resource_not_found'
+    | 'resource_exists'
+    | 'resource_conflict'
+    | 'resource_gone'
+    | 'idempotency_in_progress'
+    | 'limit_exceeded'
+    | 'registration_closed'
+    | 'rate_limit_exceeded'
+    | 'parameter_missing'
+    | 'parameter_invalid'
+    | 'parameter_unknown'
+    | 'parameters_exclusive'
+    | 'internal_error'
+    | 'service_unavailable'
+    | 'external_service_error'
+    | 'timeout'
+    | 'connection_error'
+    | 'request_timeout'
+    | 'client_closed_request'
+    | 'api_version_required'
+    | 'api_version_invalid'
+    | 'api_version_too_old'
+  >;
+
+  /**
+   * Filter by the request host. Typically, `api.augno.com`.
+   */
+  hosts?: Array<string>;
+
+  /**
+   * Filter by the user-provided idempotency key.
+   */
+  idempotency_key?: string;
+
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'account' | 'actor' | 'actor.role'>;
+
+  /**
+   * Maximum number of results per page (default: 100, max: 1000).
+   */
+  limit?: number;
+
+  /**
+   * Filter by the HTTP method.
+   */
+  methods?: Array<'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS'>;
+
+  /**
+   * Filter by the minimum latency in microseconds.
+   */
+  min_latency_us?: number;
+
+  /**
+   * Filter by the _normalized_ route template. For example
+   * `PATCH /v1/sales/customers/{id}` is the normalized route for a request route
+   * `PUT /v1/sales/customers/ac_...`.
+   */
+  normalized_routes?: Array<string>;
+
+  /**
+   * Search query used to filter results.
+   */
+  q?: string;
+
+  /**
+   * Restricts results to request logs on or after this timestamp.
+   */
+  start_date?: string;
+
+  /**
+   * Filter by the HTTP status code.
+   */
+  status_codes?: Array<number>;
+}
+
+export declare namespace RequestLogs {
+  export {
+    type Actor as Actor,
+    type ListRequestLog as ListRequestLog,
+    type RequestLog as RequestLog,
+    type RequestLogRetrieveParams as RequestLogRetrieveParams,
+    type RequestLogListParams as RequestLogListParams,
+  };
+}