@peable.to/contracts 0.4.0 → 1.0.0

package/dist/types/resources/connect/requestLogs.d.ts

@@ -0,0 +1,236 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * One merchant API request, as Peable recorded it (`req_…`) — the request log
+ * Orbit and `peable logs tail` read. Its `id` IS the `Request-Id` that request
+ * was answered with, so the id a merchant quotes to support and the log row
+ * are the same thing.
+ *
+ * Deliberately thin: method, path (no query string), status, duration and the
+ * `Idempotency-Key` it carried. No body, no headers, no query string, no caller
+ * address — a log a merchant can read is a log that must not hold what a
+ * request carried. Kept 30 days.
+ */
+export declare const requestLogSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"request_log">;
+    livemode: z.ZodBoolean;
+    method: z.ZodEnum<{
+        GET: "GET";
+        POST: "POST";
+        DELETE: "DELETE";
+        PATCH: "PATCH";
+        PUT: "PUT";
+    }>;
+    path: z.ZodString;
+    status: z.ZodNumber;
+    duration_ms: z.ZodNumber;
+    idempotency_key: z.ZodNullable<z.ZodString>;
+    created: z.ZodNumber;
+}, z.core.$strict>;
+export type RequestLog = Expand<z.output<typeof requestLogSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        request_log: RequestLog;
+    }
+}
+/** `status=404` (one code) or `status=4xx` (a class). */
+declare const requestLogStatusFilter: z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodEnum<{
+    "2xx": "2xx";
+    "3xx": "3xx";
+    "4xx": "4xx";
+    "5xx": "5xx";
+}>]>;
+export type RequestLogStatusFilter = z.output<typeof requestLogStatusFilter>;
+export declare const listRequestLogsQuery: z.ZodObject<{
+    limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+    starting_after: z.ZodOptional<z.ZodString>;
+    ending_before: z.ZodOptional<z.ZodString>;
+    created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+        gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+    }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+        gt?: number | undefined;
+        gte?: number | undefined;
+        lt?: number | undefined;
+        lte?: number | undefined;
+    }>>]>>;
+    expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    status: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodEnum<{
+        "2xx": "2xx";
+        "3xx": "3xx";
+        "4xx": "4xx";
+        "5xx": "5xx";
+    }>]>>;
+    method: z.ZodOptional<z.ZodEnum<{
+        GET: "GET";
+        POST: "POST";
+        DELETE: "DELETE";
+        PATCH: "PATCH";
+        PUT: "PUT";
+    }>>;
+}, z.core.$strict>;
+export type RequestLogListParams = z.input<typeof listRequestLogsQuery>;
+/** The live tail's filters: the list's, without paging. */
+export declare const streamRequestLogsQuery: z.ZodObject<{
+    status: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodEnum<{
+        "2xx": "2xx";
+        "3xx": "3xx";
+        "4xx": "4xx";
+        "5xx": "5xx";
+    }>]>>;
+    method: z.ZodOptional<z.ZodEnum<{
+        GET: "GET";
+        POST: "POST";
+        DELETE: "DELETE";
+        PATCH: "PATCH";
+        PUT: "PUT";
+    }>>;
+}, z.core.$strict>;
+export type RequestLogStreamParams = z.input<typeof streamRequestLogsQuery>;
+export declare const requestLogRoutes: readonly [{
+    readonly operationId: "listRequestLogs";
+    readonly method: "get";
+    readonly path: "/v1/request_logs";
+    readonly tag: "Request logs";
+    readonly summary: "List request logs";
+    readonly description: "Your API requests of the last 30 days, newest first, filtered by `status`, `method` and `created`.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly query: z.ZodObject<{
+        limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+        starting_after: z.ZodOptional<z.ZodString>;
+        ending_before: z.ZodOptional<z.ZodString>;
+        created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+            gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+            gt?: number | undefined;
+            gte?: number | undefined;
+            lt?: number | undefined;
+            lte?: number | undefined;
+        }>>]>>;
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+        status: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodEnum<{
+            "2xx": "2xx";
+            "3xx": "3xx";
+            "4xx": "4xx";
+            "5xx": "5xx";
+        }>]>>;
+        method: z.ZodOptional<z.ZodEnum<{
+            GET: "GET";
+            POST: "POST";
+            DELETE: "DELETE";
+            PATCH: "PATCH";
+            PUT: "PUT";
+        }>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"request_log">;
+            livemode: z.ZodBoolean;
+            method: z.ZodEnum<{
+                GET: "GET";
+                POST: "POST";
+                DELETE: "DELETE";
+                PATCH: "PATCH";
+                PUT: "PUT";
+            }>;
+            path: z.ZodString;
+            status: z.ZodNumber;
+            duration_ms: z.ZodNumber;
+            idempotency_key: z.ZodNullable<z.ZodString>;
+            created: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+    readonly sdk: "requestLogs.list";
+    readonly expandable: "request_log";
+}, {
+    readonly operationId: "streamRequestLogs";
+    readonly method: "get";
+    readonly path: "/v1/request_logs/stream";
+    readonly tag: "Request logs";
+    readonly summary: "Stream request logs";
+    readonly description: "Server-Sent Events: each request as it is answered (`event: request_log`), after a `ready` event. Reconnect with `Last-Event-ID` to resume without a gap. Test mode only; a stream ends after 15 minutes.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly testModeOnly: true;
+    readonly query: z.ZodObject<{
+        status: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodEnum<{
+            "2xx": "2xx";
+            "3xx": "3xx";
+            "4xx": "4xx";
+            "5xx": "5xx";
+        }>]>>;
+        method: z.ZodOptional<z.ZodEnum<{
+            GET: "GET";
+            POST: "POST";
+            DELETE: "DELETE";
+            PATCH: "PATCH";
+            PUT: "PUT";
+        }>>;
+    }, z.core.$strict>;
+    readonly response: {
+        readonly kind: "stream";
+        readonly event: z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"request_log">;
+            livemode: z.ZodBoolean;
+            method: z.ZodEnum<{
+                GET: "GET";
+                POST: "POST";
+                DELETE: "DELETE";
+                PATCH: "PATCH";
+                PUT: "PUT";
+            }>;
+            path: z.ZodString;
+            status: z.ZodNumber;
+            duration_ms: z.ZodNumber;
+            idempotency_key: z.ZodNullable<z.ZodString>;
+            created: z.ZodNumber;
+        }, z.core.$strict>;
+    };
+    readonly sdk: "requestLogs.stream";
+}, {
+    readonly operationId: "retrieveRequestLog";
+    readonly method: "get";
+    readonly path: "/v1/request_logs/{id}";
+    readonly tag: "Request logs";
+    readonly summary: "Retrieve a request log";
+    readonly description: "By `Request-Id`; 404 once older than 30 days.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        readonly id: "The `Request-Id` (`req_…`).";
+    };
+    readonly query: z.ZodObject<{
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"request_log">;
+        livemode: z.ZodBoolean;
+        method: z.ZodEnum<{
+            GET: "GET";
+            POST: "POST";
+            DELETE: "DELETE";
+            PATCH: "PATCH";
+            PUT: "PUT";
+        }>;
+        path: z.ZodString;
+        status: z.ZodNumber;
+        duration_ms: z.ZodNumber;
+        idempotency_key: z.ZodNullable<z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "requestLogs.retrieve";
+}];
+export {};