@gscdump/contracts 7.11.0 → 7.12.0

package/dist/v1/operations.d.mts

@@ -2203,8 +2203,8 @@ export declare function createGscdumpV1Protocol(): {
           readonly observedAt: z.ZodISODateTime;
           readonly providerEvidenceAt: z.ZodISODateTime;
           readonly freshness: z.ZodEnum<{
-            current: "current";
             stale: "stale";
+            current: "current";
           }>;
           readonly discoveryTime: z.ZodNullable<z.ZodISODateTime>;
           readonly lastCrawlTime: z.ZodNullable<z.ZodISODateTime>;
@@ -2260,8 +2260,8 @@ export declare function createGscdumpV1Protocol(): {
           readonly observedAt: z.ZodISODateTime;
           readonly providerEvidenceAt: z.ZodISODateTime;
           readonly freshness: z.ZodEnum<{
-            current: "current";
             stale: "stale";
+            current: "current";
           }>;
           readonly discoveryTime: z.ZodNullable<z.ZodISODateTime>;
           readonly lastCrawlTime: z.ZodNullable<z.ZodISODateTime>;
@@ -7950,8 +7950,8 @@ export declare function createGscdumpV1Protocol(): {
                 readonly observedAt: z.ZodISODateTime;
                 readonly providerEvidenceAt: z.ZodISODateTime;
                 readonly freshness: z.ZodEnum<{
-                  current: "current";
                   stale: "stale";
+                  current: "current";
                 }>;
                 readonly discoveryTime: z.ZodNullable<z.ZodISODateTime>;
                 readonly lastCrawlTime: z.ZodNullable<z.ZodISODateTime>;
@@ -8007,8 +8007,8 @@ export declare function createGscdumpV1Protocol(): {
                 readonly observedAt: z.ZodISODateTime;
                 readonly providerEvidenceAt: z.ZodISODateTime;
                 readonly freshness: z.ZodEnum<{
-                  current: "current";
                   stale: "stale";
+                  current: "current";
                 }>;
                 readonly discoveryTime: z.ZodNullable<z.ZodISODateTime>;
                 readonly lastCrawlTime: z.ZodNullable<z.ZodISODateTime>;
@@ -13868,8 +13868,8 @@ export declare function createGscdumpV1Protocol(): {
               readonly skipped: z.ZodArray<z.ZodObject<{
                 url: z.ZodString;
                 reason: z.ZodEnum<{
-                  domain_mismatch: "domain_mismatch";
                   rate_limited: "rate_limited";
+                  domain_mismatch: "domain_mismatch";
                 }>;
               }, z.core.$strict>>;
             }, z.core.$strip>;
@@ -13920,8 +13920,8 @@ export declare function createGscdumpV1Protocol(): {
               readonly skipped: z.ZodArray<z.ZodObject<{
                 url: z.ZodString;
                 reason: z.ZodEnum<{
-                  domain_mismatch: "domain_mismatch";
                   rate_limited: "rate_limited";
+                  domain_mismatch: "domain_mismatch";
                 }>;
               }, z.core.$strict>>;
             }, z.core.$strip>;
@@ -18894,6 +18894,165 @@ export declare function createGscdumpV1Protocol(): {
         readonly method: "GET";
         readonly path: "/users/{userId}/sites/crosswalk";
       };
+      readonly getUserIntegrationActivity: {
+        readonly visibility: "public";
+        readonly semantics: {
+          readonly kind: "query";
+          readonly sideEffects: "none";
+          readonly idempotent: true;
+          readonly retry: "idempotent";
+          readonly readConsistency: "primary";
+        };
+        readonly auth: {
+          readonly credentials: readonly ["partner_key"];
+          readonly scopes: readonly ["users:read"];
+          readonly ownership: readonly [{
+            readonly credential: "partner_key";
+            readonly rule: "linked_user";
+          }];
+        };
+        readonly request: {
+          readonly params: z.ZodObject<{
+            userId: z.ZodString;
+          }, z.core.$strict>;
+          readonly query: null;
+          readonly headers: z.ZodObject<{
+            'x-request-id': z.ZodOptional<z.ZodString>;
+          }, z.core.$strict>;
+          readonly body: null;
+        };
+        readonly responses: {
+          readonly 200: CompatibleResponseSchema<z.ZodObject<{
+            data: z.ZodObject<{
+              readonly measuredAt: z.ZodISODateTime;
+              readonly activities: z.ZodArray<z.ZodObject<{
+                readonly surface: z.ZodEnum<{
+                  unknown: "unknown";
+                  cli: "cli";
+                  mcp: "mcp";
+                  api: "api";
+                }>;
+                readonly client: z.ZodString;
+                readonly label: z.ZodString;
+                readonly configuredUsers: z.ZodNullable<z.ZodNumber>;
+                readonly successfulUsers: z.ZodNullable<z.ZodNumber>;
+                readonly successfulCalls: z.ZodNullable<z.ZodNumber>;
+                readonly firstObservedAt: z.ZodNullable<z.ZodISODateTime>;
+                readonly lastObservedAt: z.ZodNullable<z.ZodISODateTime>;
+                readonly coverage: z.ZodEnum<{
+                  unavailable: "unavailable";
+                  retained: "retained";
+                }>;
+                readonly note: z.ZodString;
+              }, z.core.$strip>>;
+            }, z.core.$strip>;
+            meta: z.ZodObject<{
+              readonly requestId: z.ZodString;
+              readonly surface: z.ZodLiteral<"partner">;
+              readonly version: z.ZodLiteral<"1.0">;
+            }, z.core.$strip>;
+          }, z.core.$strip>, z.ZodObject<{
+            data: z.ZodObject<{
+              readonly measuredAt: z.ZodISODateTime;
+              readonly activities: z.ZodArray<z.ZodObject<{
+                readonly surface: z.ZodEnum<{
+                  unknown: "unknown";
+                  cli: "cli";
+                  mcp: "mcp";
+                  api: "api";
+                }>;
+                readonly client: z.ZodString;
+                readonly label: z.ZodString;
+                readonly configuredUsers: z.ZodNullable<z.ZodNumber>;
+                readonly successfulUsers: z.ZodNullable<z.ZodNumber>;
+                readonly successfulCalls: z.ZodNullable<z.ZodNumber>;
+                readonly firstObservedAt: z.ZodNullable<z.ZodISODateTime>;
+                readonly lastObservedAt: z.ZodNullable<z.ZodISODateTime>;
+                readonly coverage: z.ZodEnum<{
+                  unavailable: "unavailable";
+                  retained: "retained";
+                }>;
+                readonly note: z.ZodString;
+              }, z.core.$strip>>;
+            }, z.core.$strip>;
+            meta: z.ZodObject<{
+              readonly requestId: z.ZodString;
+              readonly surface: z.ZodLiteral<"partner">;
+              readonly version: z.ZodLiteral<"1.0">;
+            }, z.core.$strip>;
+          }, z.core.$strip>>;
+        };
+        readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
+        readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
+          readonly error: z.ZodObject<{
+            code: z.ZodEnum<{
+              internal_error: "internal_error";
+              invalid_request: "invalid_request";
+              unauthorized: "unauthorized";
+              forbidden: "forbidden";
+              user_not_found: "user_not_found";
+              rate_limited: "rate_limited";
+              contract_violation: "contract_violation";
+            }>;
+            message: z.ZodString;
+            requestId: z.ZodString;
+            retryable: z.ZodBoolean;
+            details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
+          }, z.core.$strict>;
+        }, z.core.$strip>, z.ZodObject<{
+          readonly error: z.ZodObject<{
+            code: z.ZodEnum<{
+              internal_error: "internal_error";
+              invalid_request: "invalid_request";
+              unauthorized: "unauthorized";
+              forbidden: "forbidden";
+              user_not_found: "user_not_found";
+              rate_limited: "rate_limited";
+              contract_violation: "contract_violation";
+            }>;
+            message: z.ZodString;
+            requestId: z.ZodString;
+            retryable: z.ZodBoolean;
+            details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
+          }, z.core.$loose>;
+        }, z.core.$strip>>;
+        readonly resources: {
+          readonly reads: readonly [{
+            readonly type: "partner.user";
+            readonly idFrom: "params.userId";
+          }];
+          readonly changes: readonly [];
+        };
+        readonly lifecycle: {
+          readonly introduced: "7.12.0";
+        };
+        readonly docs: {
+          readonly summary: "Read partner integration activity";
+          readonly description: "Reads retained activity attributed to credentials issued by this partner. Unknown counts remain null.";
+          readonly tags: readonly ["Users"];
+          readonly examples: {
+            readonly request: {
+              readonly params: {
+                readonly userId: "u_01";
+              };
+            };
+            readonly response: {
+              readonly data: {
+                readonly measuredAt: "2026-11-10T00:00:00.000Z";
+                readonly activities: readonly [];
+              };
+              readonly meta: {
+                readonly requestId: "req_01";
+                readonly surface: "partner";
+                readonly version: "1.0";
+              };
+            };
+          };
+        };
+        readonly id: "partner.users.integration_activity.get";
+        readonly method: "GET";
+        readonly path: "/users/{userId}/integration-activity";
+      };
       readonly deleteUser: {
         readonly visibility: "public";
         readonly semantics: {
@@ -22794,6 +22953,339 @@ export declare function createGscdumpV1Protocol(): {
       };
     }>;
     analytics: HttpV1Surface<{
+      readonly runReport: {
+        readonly visibility: "public";
+        readonly semantics: {
+          readonly kind: "query";
+          readonly sideEffects: "none";
+          readonly idempotent: true;
+          readonly retry: "idempotent";
+          readonly readConsistency: "primary";
+        };
+        readonly auth: {
+          readonly credentials: readonly ["user_key", "partner_key"];
+          readonly scopes: readonly ["analytics:execute"];
+          readonly ownership: readonly [{
+            readonly credential: "user_key";
+            readonly rule: "authorized_site";
+          }, {
+            readonly credential: "partner_key";
+            readonly rule: "authorized_site";
+          }];
+        };
+        readonly request: {
+          readonly params: z.ZodObject<{
+            siteId: z.ZodString;
+          }, z.core.$strict>;
+          readonly query: null;
+          readonly headers: z.ZodObject<{
+            'x-request-id': z.ZodOptional<z.ZodString>;
+          }, z.core.$strict>;
+          readonly body: z.ZodObject<{
+            reportId: z.ZodEnum<{
+              health: "health";
+              risks: "risks";
+              opportunities: "opportunities";
+              movers: "movers";
+              growth: "growth";
+              triage: "triage";
+              brand: "brand";
+              "pre-publish": "pre-publish";
+            }>;
+            period: z.ZodOptional<z.ZodEnum<{
+              custom: "custom";
+              "last-7d": "last-7d";
+              "last-28d": "last-28d";
+              "last-30d": "last-30d";
+              "last-90d": "last-90d";
+              "last-180d": "last-180d";
+              "last-365d": "last-365d";
+              mtd: "mtd";
+              qtd: "qtd";
+              ytd: "ytd";
+              "last-quarter": "last-quarter";
+            }>>;
+            comparison: z.ZodOptional<z.ZodEnum<{
+              none: "none";
+              "prev-period": "prev-period";
+              yoy: "yoy";
+            }>>;
+            start: z.ZodOptional<z.ZodISODate>;
+            end: z.ZodOptional<z.ZodISODate>;
+            target: z.ZodOptional<z.ZodString>;
+            targetKind: z.ZodOptional<z.ZodEnum<{
+              page: "page";
+              query: "query";
+            }>>;
+            brandTerms: z.ZodOptional<z.ZodString>;
+            topic: z.ZodOptional<z.ZodString>;
+            maxFindings: z.ZodOptional<z.ZodNumber>;
+            minClicksChange: z.ZodOptional<z.ZodNumber>;
+            force: z.ZodDefault<z.ZodBoolean>;
+          }, z.core.$strict>;
+        };
+        readonly responses: {
+          readonly 200: CompatibleResponseSchema<z.ZodObject<{
+            data: z.ZodObject<{
+              readonly site: z.ZodString;
+              readonly generatedAt: z.ZodISODateTime;
+              readonly cached: z.ZodBoolean;
+              readonly window: z.ZodObject<{
+                start: z.ZodISODate;
+                end: z.ZodISODate;
+                days: z.ZodNumber;
+                comparison: z.ZodOptional<z.ZodObject<{
+                  start: z.ZodISODate;
+                  end: z.ZodISODate;
+                }, z.core.$strict>>;
+              }, z.core.$strict>;
+              readonly meta: z.ZodObject<{
+                durationMs: z.ZodNumber;
+                rowsScanned: z.ZodNumber;
+                degraded: z.ZodBoolean;
+                steps: z.ZodArray<z.ZodObject<{
+                  key: z.ZodString;
+                  type: z.ZodString;
+                  status: z.ZodEnum<{
+                    error: "error";
+                    skipped: "skipped";
+                    pending: "pending";
+                    done: "done";
+                    running: "running";
+                  }>;
+                  error: z.ZodOptional<z.ZodString>;
+                  coverage: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                    kind: z.ZodLiteral<"complete">;
+                  }, z.core.$strict>, z.ZodObject<{
+                    kind: z.ZodLiteral<"truncated">;
+                    fetched: z.ZodNumber;
+                  }, z.core.$strict>], "kind">>;
+                }, z.core.$strict>>;
+              }, z.core.$strict>;
+              readonly sections: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                title: z.ZodString;
+                summary: z.ZodObject<{
+                  delta: z.ZodOptional<z.ZodNumber>;
+                  direction: z.ZodOptional<z.ZodEnum<{
+                    flat: "flat";
+                    up: "up";
+                    down: "down";
+                  }>>;
+                  magnitudeLabel: z.ZodOptional<z.ZodString>;
+                }, z.core.$strict>;
+                coverage: z.ZodEnum<{
+                  partial: "partial";
+                  full: "full";
+                }>;
+                truncated: z.ZodOptional<z.ZodObject<{
+                  kept: z.ZodNumber;
+                  total: z.ZodNumber;
+                }, z.core.$strict>>;
+                dataUnavailable: z.ZodOptional<z.ZodLiteral<true>>;
+                findings: z.ZodArray<z.ZodObject<{
+                  entity: z.ZodObject<{
+                    kind: z.ZodEnum<{
+                      page: "page";
+                      query: "query";
+                    }>;
+                    value: z.ZodString;
+                  }, z.core.$strict>;
+                  metrics: z.ZodRecord<z.ZodString, z.ZodNumber>;
+                  delta: z.ZodOptional<z.ZodObject<{
+                    metric: z.ZodString;
+                    prior: z.ZodNumber;
+                    current: z.ZodNumber;
+                    pct: z.ZodNumber;
+                  }, z.core.$strict>>;
+                  why: z.ZodOptional<z.ZodString>;
+                }, z.core.$strict>>;
+              }, z.core.$strict>>;
+            }, z.core.$strip>;
+            meta: z.ZodObject<{
+              readonly requestId: z.ZodString;
+              readonly surface: z.ZodEnum<{
+                realtime: "realtime";
+                partner: "partner";
+                analytics: "analytics";
+              }>;
+              readonly version: z.ZodLiteral<"1.0">;
+            }, z.core.$strip>;
+          }, z.core.$strip>, z.ZodObject<{
+            data: z.ZodObject<{
+              readonly site: z.ZodString;
+              readonly generatedAt: z.ZodISODateTime;
+              readonly cached: z.ZodBoolean;
+              readonly window: z.ZodObject<{
+                start: z.ZodISODate;
+                end: z.ZodISODate;
+                days: z.ZodNumber;
+                comparison: z.ZodOptional<z.ZodObject<{
+                  start: z.ZodISODate;
+                  end: z.ZodISODate;
+                }, z.core.$strict>>;
+              }, z.core.$strict>;
+              readonly meta: z.ZodObject<{
+                durationMs: z.ZodNumber;
+                rowsScanned: z.ZodNumber;
+                degraded: z.ZodBoolean;
+                steps: z.ZodArray<z.ZodObject<{
+                  key: z.ZodString;
+                  type: z.ZodString;
+                  status: z.ZodEnum<{
+                    error: "error";
+                    skipped: "skipped";
+                    pending: "pending";
+                    done: "done";
+                    running: "running";
+                  }>;
+                  error: z.ZodOptional<z.ZodString>;
+                  coverage: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                    kind: z.ZodLiteral<"complete">;
+                  }, z.core.$strict>, z.ZodObject<{
+                    kind: z.ZodLiteral<"truncated">;
+                    fetched: z.ZodNumber;
+                  }, z.core.$strict>], "kind">>;
+                }, z.core.$strict>>;
+              }, z.core.$strict>;
+              readonly sections: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                title: z.ZodString;
+                summary: z.ZodObject<{
+                  delta: z.ZodOptional<z.ZodNumber>;
+                  direction: z.ZodOptional<z.ZodEnum<{
+                    flat: "flat";
+                    up: "up";
+                    down: "down";
+                  }>>;
+                  magnitudeLabel: z.ZodOptional<z.ZodString>;
+                }, z.core.$strict>;
+                coverage: z.ZodEnum<{
+                  partial: "partial";
+                  full: "full";
+                }>;
+                truncated: z.ZodOptional<z.ZodObject<{
+                  kept: z.ZodNumber;
+                  total: z.ZodNumber;
+                }, z.core.$strict>>;
+                dataUnavailable: z.ZodOptional<z.ZodLiteral<true>>;
+                findings: z.ZodArray<z.ZodObject<{
+                  entity: z.ZodObject<{
+                    kind: z.ZodEnum<{
+                      page: "page";
+                      query: "query";
+                    }>;
+                    value: z.ZodString;
+                  }, z.core.$strict>;
+                  metrics: z.ZodRecord<z.ZodString, z.ZodNumber>;
+                  delta: z.ZodOptional<z.ZodObject<{
+                    metric: z.ZodString;
+                    prior: z.ZodNumber;
+                    current: z.ZodNumber;
+                    pct: z.ZodNumber;
+                  }, z.core.$strict>>;
+                  why: z.ZodOptional<z.ZodString>;
+                }, z.core.$strict>>;
+              }, z.core.$strict>>;
+            }, z.core.$strip>;
+            meta: z.ZodObject<{
+              readonly requestId: z.ZodString;
+              readonly surface: z.ZodEnum<{
+                realtime: "realtime";
+                partner: "partner";
+                analytics: "analytics";
+              }>;
+              readonly version: z.ZodLiteral<"1.0">;
+            }, z.core.$strip>;
+          }, z.core.$strip>>;
+        };
+        readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "site_not_found", "rate_limited", "internal_error", "contract_violation"];
+        readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
+          readonly error: z.ZodObject<{
+            code: z.ZodEnum<{
+              internal_error: "internal_error";
+              invalid_request: "invalid_request";
+              unauthorized: "unauthorized";
+              forbidden: "forbidden";
+              site_not_found: "site_not_found";
+              rate_limited: "rate_limited";
+              contract_violation: "contract_violation";
+            }>;
+            message: z.ZodString;
+            requestId: z.ZodString;
+            retryable: z.ZodBoolean;
+            details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
+          }, z.core.$strict>;
+        }, z.core.$strip>, z.ZodObject<{
+          readonly error: z.ZodObject<{
+            code: z.ZodEnum<{
+              internal_error: "internal_error";
+              invalid_request: "invalid_request";
+              unauthorized: "unauthorized";
+              forbidden: "forbidden";
+              site_not_found: "site_not_found";
+              rate_limited: "rate_limited";
+              contract_violation: "contract_violation";
+            }>;
+            message: z.ZodString;
+            requestId: z.ZodString;
+            retryable: z.ZodBoolean;
+            details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
+          }, z.core.$loose>;
+        }, z.core.$strip>>;
+        readonly resources: {
+          readonly reads: readonly [{
+            readonly type: "site.analytics";
+            readonly idFrom: "params.siteId";
+          }];
+          readonly changes: readonly [];
+        };
+        readonly lifecycle: {
+          readonly introduced: "7.12.0";
+        };
+        readonly docs: {
+          readonly summary: "Run a retained search evidence report";
+          readonly description: "Returns deterministic report evidence, coverage, and capture clocks without advice or severity.";
+          readonly tags: readonly ["Analytics reports"];
+          readonly examples: {
+            readonly request: {
+              readonly params: {
+                readonly siteId: "s_01";
+              };
+              readonly body: {
+                readonly reportId: "health";
+              };
+            };
+            readonly response: {
+              readonly data: {
+                readonly site: "https://example.com/";
+                readonly generatedAt: "2026-11-10T00:00:00.000Z";
+                readonly cached: false;
+                readonly window: {
+                  readonly start: "2026-10-01";
+                  readonly end: "2026-10-28";
+                  readonly days: 28;
+                };
+                readonly meta: {
+                  readonly durationMs: 1;
+                  readonly rowsScanned: 0;
+                  readonly degraded: false;
+                  readonly steps: readonly [];
+                };
+                readonly sections: readonly [];
+              };
+              readonly meta: {
+                readonly requestId: "req_01";
+                readonly surface: "analytics";
+                readonly version: "1.0";
+              };
+            };
+          };
+        };
+        readonly id: "analytics.reports.run";
+        readonly method: "POST";
+        readonly path: "/sites/{siteId}/reports/run";
+      };
       readonly queryRows: {
         readonly visibility: "public";
         readonly semantics: {