@gscdump/contracts 4.6.0 → 4.7.0

package/dist/v1/operations.d.mts

@@ -740,12 +740,12 @@ export declare function createGscdumpV1Protocol(): {
           readonly GOOGLE_NEWS: "googleNews";
         }>>;
         dimensions: z.ZodArray<z.ZodEnum<{
-          date: "date";
           page: "page";
           query: "query";
           queryCanonical: "queryCanonical";
           country: "country";
           device: "device";
+          date: "date";
           searchAppearance: "searchAppearance";
           hour: "hour";
         }>>;
@@ -760,12 +760,12 @@ export declare function createGscdumpV1Protocol(): {
           readonly GOOGLE_NEWS: "googleNews";
         }>>;
         dimensions: z.ZodArray<z.ZodEnum<{
-          date: "date";
           page: "page";
           query: "query";
           queryCanonical: "queryCanonical";
           country: "country";
           device: "device";
+          date: "date";
           searchAppearance: "searchAppearance";
           hour: "hour";
         }>>;
@@ -897,12 +897,12 @@ export declare function createGscdumpV1Protocol(): {
           readonly GOOGLE_NEWS: "googleNews";
         }>>;
         dimensions: z.ZodArray<z.ZodEnum<{
-          date: "date";
           page: "page";
           query: "query";
           queryCanonical: "queryCanonical";
           country: "country";
           device: "device";
+          date: "date";
           searchAppearance: "searchAppearance";
           hour: "hour";
         }>>;
@@ -917,12 +917,12 @@ export declare function createGscdumpV1Protocol(): {
           readonly GOOGLE_NEWS: "googleNews";
         }>>;
         dimensions: z.ZodArray<z.ZodEnum<{
-          date: "date";
           page: "page";
           query: "query";
           queryCanonical: "queryCanonical";
           country: "country";
           device: "device";
+          date: "date";
           searchAppearance: "searchAppearance";
           hour: "hour";
         }>>;
@@ -1025,12 +1025,12 @@ export declare function createGscdumpV1Protocol(): {
     }, z.core.$strip>>;
     analyticsRowsRequest: z.ZodObject<{
       dimensions: z.ZodArray<z.ZodEnum<{
-        date: "date";
         page: "page";
         query: "query";
         queryCanonical: "queryCanonical";
         country: "country";
         device: "device";
+        date: "date";
         searchAppearance: "searchAppearance";
         hour: "hour";
       }>>;
@@ -2836,6 +2836,12 @@ export declare function createGscdumpV1Protocol(): {
               retry_indexing: "retry_indexing";
             }>;
           }, z.core.$strip>;
+          readonly hold: z.ZodNullable<z.ZodEnum<{
+            size_limit: "size_limit";
+            sitemap_limit: "sitemap_limit";
+            size_unknown: "size_unknown";
+            size_pending: "size_pending";
+          }>>;
           readonly latestError: z.ZodNullable<z.ZodObject<{
             readonly code: z.ZodEnum<{
               missing_refresh_token: "missing_refresh_token";
@@ -2992,6 +2998,12 @@ export declare function createGscdumpV1Protocol(): {
               retry_indexing: "retry_indexing";
             }>;
           }, z.core.$strip>;
+          readonly hold: z.ZodDefault<z.ZodNullable<z.ZodEnum<{
+            size_limit: "size_limit";
+            sitemap_limit: "sitemap_limit";
+            size_unknown: "size_unknown";
+            size_pending: "size_pending";
+          }>>>;
           readonly latestError: z.ZodNullable<z.ZodObject<{
             readonly code: z.ZodEnum<{
               missing_refresh_token: "missing_refresh_token";
@@ -3019,6 +3031,87 @@ export declare function createGscdumpV1Protocol(): {
         readonly version: z.ZodLiteral<"1.0">;
       }, z.core.$strip>;
     }, z.core.$strip>>;
+    userEntitlementsResponse: CompatibleResponseSchema<z.ZodObject<{
+      data: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        readonly mode: z.ZodLiteral<"exempt">;
+      }, z.core.$strip>, z.ZodObject<{
+        readonly meters: z.ZodObject<{
+          readonly sites: z.ZodObject<{
+            readonly used: z.ZodNumber;
+            readonly allowance: z.ZodNumber;
+          }, z.core.$strip>;
+          readonly preservedRows: z.ZodObject<{
+            readonly used: z.ZodNullable<z.ZodNumber>;
+            readonly allowance: z.ZodNumber;
+          }, z.core.$strip>;
+          readonly urlInspections: z.ZodObject<{
+            readonly used: z.ZodNumber;
+            readonly allowance: z.ZodNullable<z.ZodNumber>;
+            readonly resetsAt: z.ZodISODate;
+          }, z.core.$strip>;
+        }, z.core.$strip>;
+        readonly heldSites: z.ZodArray<z.ZodObject<{
+          readonly siteId: z.ZodString;
+          readonly hold: z.ZodEnum<{
+            size_limit: "size_limit";
+            sitemap_limit: "sitemap_limit";
+            size_unknown: "size_unknown";
+            size_pending: "size_pending";
+          }>;
+        }, z.core.$strip>>;
+        readonly mode: z.ZodLiteral<"metered">;
+        readonly phase: z.ZodEnum<{
+          beta: "beta";
+          billing: "billing";
+        }>;
+        readonly sizeLimitRowsPerDay: z.ZodNumber;
+      }, z.core.$strip>], "mode">;
+      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.ZodDiscriminatedUnion<[z.ZodObject<{
+        readonly mode: z.ZodLiteral<"exempt">;
+      }, z.core.$strip>, z.ZodObject<{
+        readonly meters: z.ZodObject<{
+          readonly sites: z.ZodObject<{
+            readonly used: z.ZodNumber;
+            readonly allowance: z.ZodNumber;
+          }, z.core.$strip>;
+          readonly preservedRows: z.ZodObject<{
+            readonly used: z.ZodNullable<z.ZodNumber>;
+            readonly allowance: z.ZodNumber;
+          }, z.core.$strip>;
+          readonly urlInspections: z.ZodObject<{
+            readonly used: z.ZodNumber;
+            readonly allowance: z.ZodNullable<z.ZodNumber>;
+            readonly resetsAt: z.ZodISODate;
+          }, z.core.$strip>;
+        }, z.core.$strip>;
+        readonly heldSites: z.ZodArray<z.ZodObject<{
+          readonly siteId: z.ZodString;
+          readonly hold: z.ZodEnum<{
+            size_limit: "size_limit";
+            sitemap_limit: "sitemap_limit";
+            size_unknown: "size_unknown";
+            size_pending: "size_pending";
+          }>;
+        }, z.core.$strip>>;
+        readonly mode: z.ZodLiteral<"metered">;
+        readonly phase: z.ZodEnum<{
+          beta: "beta";
+          billing: "billing";
+        }>;
+        readonly sizeLimitRowsPerDay: z.ZodNumber;
+      }, z.core.$strip>], "mode">;
+      meta: z.ZodObject<{
+        readonly requestId: z.ZodString;
+        readonly surface: z.ZodLiteral<"partner">;
+        readonly version: z.ZodLiteral<"1.0">;
+      }, z.core.$strip>;
+    }, z.core.$strip>>;
     registerSiteRequest: z.ZodObject<{
       externalSiteId: z.ZodOptional<z.ZodString>;
       requestedUrl: z.ZodOptional<z.ZodString>;
@@ -3034,6 +3127,7 @@ export declare function createGscdumpV1Protocol(): {
         "site.indexing.ready": "site.indexing.ready";
         "site.auth.failed": "site.auth.failed";
         "job.failed": "job.failed";
+        "user.allowance.notice": "user.allowance.notice";
       }>>>;
       enabledSearchTypes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
         readonly WEB: "web";
@@ -3462,6 +3556,12 @@ export declare function createGscdumpV1Protocol(): {
               retry_indexing: "retry_indexing";
             }>;
           }, z.core.$loose>;
+          hold: z.ZodDefault<z.ZodNullable<z.ZodEnum<{
+            size_limit: "size_limit";
+            sitemap_limit: "sitemap_limit";
+            size_unknown: "size_unknown";
+            size_pending: "size_pending";
+          }>>>;
           latestError: z.ZodNullable<z.ZodObject<{
             code: z.ZodEnum<{
               missing_refresh_token: "missing_refresh_token";
@@ -3619,6 +3719,12 @@ export declare function createGscdumpV1Protocol(): {
               retry_indexing: "retry_indexing";
             }>;
           }, z.core.$loose>;
+          hold: z.ZodDefault<z.ZodNullable<z.ZodEnum<{
+            size_limit: "size_limit";
+            sitemap_limit: "sitemap_limit";
+            size_unknown: "size_unknown";
+            size_pending: "size_pending";
+          }>>>;
           latestError: z.ZodNullable<z.ZodObject<{
             code: z.ZodEnum<{
               missing_refresh_token: "missing_refresh_token";
@@ -3972,6 +4078,12 @@ export declare function createGscdumpV1Protocol(): {
                     retry_indexing: "retry_indexing";
                   }>;
                 }, z.core.$strip>;
+                readonly hold: z.ZodNullable<z.ZodEnum<{
+                  size_limit: "size_limit";
+                  sitemap_limit: "sitemap_limit";
+                  size_unknown: "size_unknown";
+                  size_pending: "size_pending";
+                }>>;
                 readonly latestError: z.ZodNullable<z.ZodObject<{
                   readonly code: z.ZodEnum<{
                     missing_refresh_token: "missing_refresh_token";
@@ -4128,6 +4240,12 @@ export declare function createGscdumpV1Protocol(): {
                     retry_indexing: "retry_indexing";
                   }>;
                 }, z.core.$strip>;
+                readonly hold: z.ZodDefault<z.ZodNullable<z.ZodEnum<{
+                  size_limit: "size_limit";
+                  sitemap_limit: "sitemap_limit";
+                  size_unknown: "size_unknown";
+                  size_pending: "size_pending";
+                }>>>;
                 readonly latestError: z.ZodNullable<z.ZodObject<{
                   readonly code: z.ZodEnum<{
                     missing_refresh_token: "missing_refresh_token";
@@ -4238,6 +4356,213 @@ export declare function createGscdumpV1Protocol(): {
         readonly method: "GET";
         readonly path: "/users/{userId}/lifecycle";
       };
+      readonly getUserEntitlements: {
+        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 ["users:read"];
+          readonly ownership: readonly [{
+            readonly credential: "user_key";
+            readonly rule: "self";
+          }, {
+            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.ZodDiscriminatedUnion<[z.ZodObject<{
+              readonly mode: z.ZodLiteral<"exempt">;
+            }, z.core.$strip>, z.ZodObject<{
+              readonly meters: z.ZodObject<{
+                readonly sites: z.ZodObject<{
+                  readonly used: z.ZodNumber;
+                  readonly allowance: z.ZodNumber;
+                }, z.core.$strip>;
+                readonly preservedRows: z.ZodObject<{
+                  readonly used: z.ZodNullable<z.ZodNumber>;
+                  readonly allowance: z.ZodNumber;
+                }, z.core.$strip>;
+                readonly urlInspections: z.ZodObject<{
+                  readonly used: z.ZodNumber;
+                  readonly allowance: z.ZodNullable<z.ZodNumber>;
+                  readonly resetsAt: z.ZodISODate;
+                }, z.core.$strip>;
+              }, z.core.$strip>;
+              readonly heldSites: z.ZodArray<z.ZodObject<{
+                readonly siteId: z.ZodString;
+                readonly hold: z.ZodEnum<{
+                  size_limit: "size_limit";
+                  sitemap_limit: "sitemap_limit";
+                  size_unknown: "size_unknown";
+                  size_pending: "size_pending";
+                }>;
+              }, z.core.$strip>>;
+              readonly mode: z.ZodLiteral<"metered">;
+              readonly phase: z.ZodEnum<{
+                beta: "beta";
+                billing: "billing";
+              }>;
+              readonly sizeLimitRowsPerDay: z.ZodNumber;
+            }, z.core.$strip>], "mode">;
+            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.ZodDiscriminatedUnion<[z.ZodObject<{
+              readonly mode: z.ZodLiteral<"exempt">;
+            }, z.core.$strip>, z.ZodObject<{
+              readonly meters: z.ZodObject<{
+                readonly sites: z.ZodObject<{
+                  readonly used: z.ZodNumber;
+                  readonly allowance: z.ZodNumber;
+                }, z.core.$strip>;
+                readonly preservedRows: z.ZodObject<{
+                  readonly used: z.ZodNullable<z.ZodNumber>;
+                  readonly allowance: z.ZodNumber;
+                }, z.core.$strip>;
+                readonly urlInspections: z.ZodObject<{
+                  readonly used: z.ZodNumber;
+                  readonly allowance: z.ZodNullable<z.ZodNumber>;
+                  readonly resetsAt: z.ZodISODate;
+                }, z.core.$strip>;
+              }, z.core.$strip>;
+              readonly heldSites: z.ZodArray<z.ZodObject<{
+                readonly siteId: z.ZodString;
+                readonly hold: z.ZodEnum<{
+                  size_limit: "size_limit";
+                  sitemap_limit: "sitemap_limit";
+                  size_unknown: "size_unknown";
+                  size_pending: "size_pending";
+                }>;
+              }, z.core.$strip>>;
+              readonly mode: z.ZodLiteral<"metered">;
+              readonly phase: z.ZodEnum<{
+                beta: "beta";
+                billing: "billing";
+              }>;
+              readonly sizeLimitRowsPerDay: z.ZodNumber;
+            }, z.core.$strip>], "mode">;
+            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 type: "user.sites";
+            readonly idFrom: "params.userId";
+          }];
+          readonly changes: readonly [];
+        };
+        readonly lifecycle: {
+          readonly introduced: "4.7.0";
+        };
+        readonly docs: {
+          readonly summary: "Get user entitlements";
+          readonly description: "Returns the Meters that apply to the user's partner Sites. If the partner is exempt, the response is `{ mode: \"exempt\" }` and no free allowance applies. If the partner is metered, the response gives the usage of the user's Billing owner against each free allowance, the size limit in query×page rows per day, and the held Sites the user can read. `urlInspections.allowance` is `null` when URL Inspections have no cap. `urlInspections.resetsAt` is the first UTC day of the next usage month.";
+          readonly tags: readonly ["Users"];
+          readonly examples: {
+            readonly request: {
+              readonly params: {
+                readonly userId: "u_01";
+              };
+            };
+            readonly response: {
+              readonly data: {
+                readonly mode: "metered";
+                readonly phase: "beta";
+                readonly meters: {
+                  readonly sites: {
+                    readonly used: 2;
+                    readonly allowance: 3;
+                  };
+                  readonly preservedRows: {
+                    readonly used: 120000;
+                    readonly allowance: 250000;
+                  };
+                  readonly urlInspections: {
+                    readonly used: 310;
+                    readonly allowance: 5000;
+                    readonly resetsAt: "2026-11-01";
+                  };
+                };
+                readonly sizeLimitRowsPerDay: 2500;
+                readonly heldSites: readonly [{
+                  readonly siteId: "s_02";
+                  readonly hold: "size_limit";
+                }];
+              };
+              readonly meta: {
+                readonly requestId: "req_01";
+                readonly surface: "partner";
+                readonly version: "1.0";
+              };
+            };
+          };
+        };
+        readonly id: "partner.users.entitlements.get";
+        readonly method: "GET";
+        readonly path: "/users/{userId}/entitlements";
+      };
       readonly listAvailableSites: {
         readonly visibility: "public";
         readonly semantics: {
@@ -4450,6 +4775,7 @@ export declare function createGscdumpV1Protocol(): {
               "site.indexing.ready": "site.indexing.ready";
               "site.auth.failed": "site.auth.failed";
               "job.failed": "job.failed";
+              "user.allowance.notice": "user.allowance.notice";
             }>>>;
             enabledSearchTypes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
               readonly WEB: "web";
@@ -4592,6 +4918,12 @@ export declare function createGscdumpV1Protocol(): {
                     retry_indexing: "retry_indexing";
                   }>;
                 }, z.core.$loose>;
+                hold: z.ZodDefault<z.ZodNullable<z.ZodEnum<{
+                  size_limit: "size_limit";
+                  sitemap_limit: "sitemap_limit";
+                  size_unknown: "size_unknown";
+                  size_pending: "size_pending";
+                }>>>;
                 latestError: z.ZodNullable<z.ZodObject<{
                   code: z.ZodEnum<{
                     missing_refresh_token: "missing_refresh_token";
@@ -4749,6 +5081,12 @@ export declare function createGscdumpV1Protocol(): {
                     retry_indexing: "retry_indexing";
                   }>;
                 }, z.core.$loose>;
+                hold: z.ZodDefault<z.ZodNullable<z.ZodEnum<{
+                  size_limit: "size_limit";
+                  sitemap_limit: "sitemap_limit";
+                  size_unknown: "size_unknown";
+                  size_pending: "size_pending";
+                }>>>;
                 latestError: z.ZodNullable<z.ZodObject<{
                   code: z.ZodEnum<{
                     missing_refresh_token: "missing_refresh_token";
@@ -15599,12 +15937,12 @@ export declare function createGscdumpV1Protocol(): {
           }, z.core.$strict>;
           readonly body: z.ZodObject<{
             dimensions: z.ZodArray<z.ZodEnum<{
-              date: "date";
               page: "page";
               query: "query";
               queryCanonical: "queryCanonical";
               country: "country";
               device: "device";
+              date: "date";
               searchAppearance: "searchAppearance";
               hour: "hour";
             }>>;
@@ -15802,12 +16140,12 @@ export declare function createGscdumpV1Protocol(): {
                 readonly GOOGLE_NEWS: "googleNews";
               }>>;
               dimensions: z.ZodArray<z.ZodEnum<{
-                date: "date";
                 page: "page";
                 query: "query";
                 queryCanonical: "queryCanonical";
                 country: "country";
                 device: "device";
+                date: "date";
                 searchAppearance: "searchAppearance";
                 hour: "hour";
               }>>;
@@ -15822,12 +16160,12 @@ export declare function createGscdumpV1Protocol(): {
                 readonly GOOGLE_NEWS: "googleNews";
               }>>;
               dimensions: z.ZodArray<z.ZodEnum<{
-                date: "date";
                 page: "page";
                 query: "query";
                 queryCanonical: "queryCanonical";
                 country: "country";
                 device: "device";
+                date: "date";
                 searchAppearance: "searchAppearance";
                 hour: "hour";
               }>>;
@@ -16063,12 +16401,12 @@ export declare function createGscdumpV1Protocol(): {
                 readonly GOOGLE_NEWS: "googleNews";
               }>>;
               dimensions: z.ZodArray<z.ZodEnum<{
-                date: "date";
                 page: "page";
                 query: "query";
                 queryCanonical: "queryCanonical";
                 country: "country";
                 device: "device";
+                date: "date";
                 searchAppearance: "searchAppearance";
                 hour: "hour";
               }>>;
@@ -16083,12 +16421,12 @@ export declare function createGscdumpV1Protocol(): {
                 readonly GOOGLE_NEWS: "googleNews";
               }>>;
               dimensions: z.ZodArray<z.ZodEnum<{
-                date: "date";
                 page: "page";
                 query: "query";
                 queryCanonical: "queryCanonical";
                 country: "country";
                 device: "device";
+                date: "date";
                 searchAppearance: "searchAppearance";
                 hour: "hour";
               }>>;
@@ -16604,4 +16942,6 @@ export type PartnerSitemapsV1Response = z.infer<GscdumpV1Protocol['schemas']['si
 export type PartnerSitemapChangesV1Response = z.infer<GscdumpV1Protocol['schemas']['sitemapChangesResponse']['client']>;
 export type PartnerSiteRegistrationV1Response = z.infer<GscdumpV1Protocol['schemas']['siteRegistrationResponse']['client']>;
 export type PartnerSiteDeletionV1Response = z.infer<GscdumpV1Protocol['schemas']['siteDeletionResponse']['client']>;
-export type PartnerUserLifecycleV1Response = z.infer<GscdumpV1Protocol['schemas']['lifecycleResponse']['client']>;
+export type PartnerUserLifecycleV1Response = z.infer<GscdumpV1Protocol['schemas']['lifecycleResponse']['client']>;
+export type PartnerUserEntitlementsV1Response = z.infer<GscdumpV1Protocol['schemas']['userEntitlementsResponse']['client']>;
+export type PartnerUserEntitlementsV1 = PartnerUserEntitlementsV1Response['data'];