@gscdump/contracts 7.2.0 → 7.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/analytics.d.mts +2 -2
- package/dist/endpoints.d.mts +10 -4
- package/dist/index.d.mts +3 -3
- package/dist/index.mjs +2 -2
- package/dist/indexing-coverage.d.mts +18 -18
- package/dist/partner.d.mts +2 -2
- package/dist/schemas.d.mts +50 -13
- package/dist/schemas.mjs +20 -5
- package/dist/types.d.mts +12 -2
- package/dist/v1/bing-sites.d.mts +14 -14
- package/dist/v1/google-indexing.d.mts +1 -1
- package/dist/v1/operations.d.mts +102 -90
- package/dist/v1/operations.mjs +12 -7
- package/dist/v1/sitemap-evidence.d.mts +9 -9
- package/dist/v1/sitemap-submission.d.mts +10 -10
- package/package.json +1 -1
package/dist/schemas.d.mts
CHANGED
|
@@ -380,9 +380,9 @@ export declare const indexingUrlsResponseSchema: z.ZodObject<{
|
|
|
380
380
|
}, z.core.$loose>;
|
|
381
381
|
export declare const GSCDUMP_INDEXING_TRANSITION_FIELDS: readonly ["indexStatus", "coverageState", "robotsTxtState", "indexingState", "pageFetchState", "googleCanonical"];
|
|
382
382
|
export declare const gscdumpIndexingTransitionFieldSchema: z.ZodEnum<{
|
|
383
|
+
coverageState: "coverageState";
|
|
383
384
|
indexStatus: "indexStatus";
|
|
384
385
|
googleCanonical: "googleCanonical";
|
|
385
|
-
coverageState: "coverageState";
|
|
386
386
|
robotsTxtState: "robotsTxtState";
|
|
387
387
|
indexingState: "indexingState";
|
|
388
388
|
pageFetchState: "pageFetchState";
|
|
@@ -1427,8 +1427,8 @@ export declare const bulkRegisterPartnerSitesResponseSchema: z.ZodObject<{
|
|
|
1427
1427
|
status: z.ZodEnum<{
|
|
1428
1428
|
error: "error";
|
|
1429
1429
|
registered: "registered";
|
|
1430
|
-
already_exists: "already_exists";
|
|
1431
1430
|
not_found: "not_found";
|
|
1431
|
+
already_exists: "already_exists";
|
|
1432
1432
|
}>;
|
|
1433
1433
|
error: z.ZodOptional<z.ZodString>;
|
|
1434
1434
|
site: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
@@ -1796,7 +1796,30 @@ export declare const gscdumpSitemapChangesResponseSchema: z.ZodObject<{
|
|
|
1796
1796
|
}, z.core.$strict>], "_tag">;
|
|
1797
1797
|
}, z.core.$strict>>>;
|
|
1798
1798
|
}, z.core.$loose>;
|
|
1799
|
+
/** The most Sitemaps one indexing read can name in `feedpath` or `excludeFeedpath`. */
|
|
1800
|
+
export declare const INDEXING_SITEMAP_FILTER_MAX_FEEDS = 50;
|
|
1801
|
+
/**
|
|
1802
|
+
* The Sitemap filter on the indexing summary, URL and diagnostics reads.
|
|
1803
|
+
*
|
|
1804
|
+
* Without a filter, a read counts each inspected URL that any live Sitemap
|
|
1805
|
+
* lists. `feedpath` counts only URLs that the named Sitemaps list.
|
|
1806
|
+
* `excludeFeedpath` counts only URLs that some other live Sitemap lists. Each
|
|
1807
|
+
* value is a Sitemap URL as `partner.sites.sitemaps.urls.get` reports its
|
|
1808
|
+
* `feedpath`, or a path on the Site's host. A filter can only remove URLs from a
|
|
1809
|
+
* read, so a filtered count never exceeds the unfiltered count.
|
|
1810
|
+
*/
|
|
1811
|
+
export declare const indexingSitemapFilterShape: {
|
|
1812
|
+
feedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
1813
|
+
excludeFeedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
1814
|
+
};
|
|
1815
|
+
/** Refuse a read that names both `feedpath` and `excludeFeedpath`. */
|
|
1816
|
+
export declare function refineIndexingSitemapFilter(value: {
|
|
1817
|
+
feedpath?: unknown;
|
|
1818
|
+
excludeFeedpath?: unknown;
|
|
1819
|
+
}, ctx: z.RefinementCtx): void;
|
|
1799
1820
|
export declare const indexingUrlsParamsSchema: z.ZodOptional<z.ZodObject<{
|
|
1821
|
+
feedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
1822
|
+
excludeFeedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
1800
1823
|
limit: z.ZodOptional<z.ZodNumber>;
|
|
1801
1824
|
offset: z.ZodOptional<z.ZodNumber>;
|
|
1802
1825
|
status: z.ZodOptional<z.ZodEnum<{
|
|
@@ -1809,6 +1832,8 @@ export declare const indexingUrlsParamsSchema: z.ZodOptional<z.ZodObject<{
|
|
|
1809
1832
|
count: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<false>]>>;
|
|
1810
1833
|
}, z.core.$strip>>;
|
|
1811
1834
|
export declare const indexingDiagnosticsParamsSchema: z.ZodOptional<z.ZodObject<{
|
|
1835
|
+
feedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
1836
|
+
excludeFeedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
1812
1837
|
sampleIssues: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
1813
1838
|
sampleLimit: z.ZodOptional<z.ZodNumber>;
|
|
1814
1839
|
}, z.core.$strip>>;
|
|
@@ -1837,19 +1862,19 @@ export declare const gscdumpIndexingResponseSchema: z.ZodObject<{
|
|
|
1837
1862
|
_tag: z.ZodLiteral<"counted">;
|
|
1838
1863
|
capturedAt: z.ZodString;
|
|
1839
1864
|
counts: z.ZodObject<{
|
|
1840
|
-
indexed: z.ZodDefault<z.ZodNumber>;
|
|
1841
|
-
not_found: z.ZodDefault<z.ZodNumber>;
|
|
1842
|
-
redirect: z.ZodDefault<z.ZodNumber>;
|
|
1843
1865
|
unknown_to_google: z.ZodDefault<z.ZodNumber>;
|
|
1844
1866
|
discovered_not_indexed: z.ZodDefault<z.ZodNumber>;
|
|
1845
1867
|
crawled_not_indexed: z.ZodDefault<z.ZodNumber>;
|
|
1868
|
+
indexed: z.ZodDefault<z.ZodNumber>;
|
|
1846
1869
|
noindex: z.ZodDefault<z.ZodNumber>;
|
|
1847
1870
|
blocked_robots: z.ZodDefault<z.ZodNumber>;
|
|
1848
1871
|
soft_404: z.ZodDefault<z.ZodNumber>;
|
|
1872
|
+
not_found: z.ZodDefault<z.ZodNumber>;
|
|
1849
1873
|
server_error: z.ZodDefault<z.ZodNumber>;
|
|
1850
1874
|
access_denied: z.ZodDefault<z.ZodNumber>;
|
|
1851
1875
|
access_forbidden: z.ZodDefault<z.ZodNumber>;
|
|
1852
1876
|
blocked_4xx: z.ZodDefault<z.ZodNumber>;
|
|
1877
|
+
redirect: z.ZodDefault<z.ZodNumber>;
|
|
1853
1878
|
redirect_error: z.ZodDefault<z.ZodNumber>;
|
|
1854
1879
|
alternate_canonical: z.ZodDefault<z.ZodNumber>;
|
|
1855
1880
|
duplicate_no_canonical: z.ZodDefault<z.ZodNumber>;
|
|
@@ -3127,6 +3152,8 @@ export declare const analyticsEndpointSchemas: {
|
|
|
3127
3152
|
};
|
|
3128
3153
|
readonly analyticsIndexingDiagnostics: {
|
|
3129
3154
|
readonly query: z.ZodOptional<z.ZodObject<{
|
|
3155
|
+
feedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
3156
|
+
excludeFeedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
3130
3157
|
sampleIssues: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
3131
3158
|
sampleLimit: z.ZodOptional<z.ZodNumber>;
|
|
3132
3159
|
}, z.core.$strip>>;
|
|
@@ -4295,8 +4322,8 @@ export declare const partnerControlEndpointSchemas: {
|
|
|
4295
4322
|
status: z.ZodEnum<{
|
|
4296
4323
|
error: "error";
|
|
4297
4324
|
registered: "registered";
|
|
4298
|
-
already_exists: "already_exists";
|
|
4299
4325
|
not_found: "not_found";
|
|
4326
|
+
already_exists: "already_exists";
|
|
4300
4327
|
}>;
|
|
4301
4328
|
error: z.ZodOptional<z.ZodString>;
|
|
4302
4329
|
site: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
@@ -4576,19 +4603,19 @@ export declare const partnerControlEndpointSchemas: {
|
|
|
4576
4603
|
_tag: z.ZodLiteral<"counted">;
|
|
4577
4604
|
capturedAt: z.ZodString;
|
|
4578
4605
|
counts: z.ZodObject<{
|
|
4579
|
-
indexed: z.ZodDefault<z.ZodNumber>;
|
|
4580
|
-
not_found: z.ZodDefault<z.ZodNumber>;
|
|
4581
|
-
redirect: z.ZodDefault<z.ZodNumber>;
|
|
4582
4606
|
unknown_to_google: z.ZodDefault<z.ZodNumber>;
|
|
4583
4607
|
discovered_not_indexed: z.ZodDefault<z.ZodNumber>;
|
|
4584
4608
|
crawled_not_indexed: z.ZodDefault<z.ZodNumber>;
|
|
4609
|
+
indexed: z.ZodDefault<z.ZodNumber>;
|
|
4585
4610
|
noindex: z.ZodDefault<z.ZodNumber>;
|
|
4586
4611
|
blocked_robots: z.ZodDefault<z.ZodNumber>;
|
|
4587
4612
|
soft_404: z.ZodDefault<z.ZodNumber>;
|
|
4613
|
+
not_found: z.ZodDefault<z.ZodNumber>;
|
|
4588
4614
|
server_error: z.ZodDefault<z.ZodNumber>;
|
|
4589
4615
|
access_denied: z.ZodDefault<z.ZodNumber>;
|
|
4590
4616
|
access_forbidden: z.ZodDefault<z.ZodNumber>;
|
|
4591
4617
|
blocked_4xx: z.ZodDefault<z.ZodNumber>;
|
|
4618
|
+
redirect: z.ZodDefault<z.ZodNumber>;
|
|
4592
4619
|
redirect_error: z.ZodDefault<z.ZodNumber>;
|
|
4593
4620
|
alternate_canonical: z.ZodDefault<z.ZodNumber>;
|
|
4594
4621
|
duplicate_no_canonical: z.ZodDefault<z.ZodNumber>;
|
|
@@ -4687,6 +4714,8 @@ export declare const partnerControlEndpointSchemas: {
|
|
|
4687
4714
|
};
|
|
4688
4715
|
readonly getIndexingUrls: {
|
|
4689
4716
|
readonly query: z.ZodOptional<z.ZodObject<{
|
|
4717
|
+
feedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
4718
|
+
excludeFeedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
4690
4719
|
limit: z.ZodOptional<z.ZodNumber>;
|
|
4691
4720
|
offset: z.ZodOptional<z.ZodNumber>;
|
|
4692
4721
|
status: z.ZodOptional<z.ZodEnum<{
|
|
@@ -4743,6 +4772,8 @@ export declare const partnerControlEndpointSchemas: {
|
|
|
4743
4772
|
};
|
|
4744
4773
|
readonly getIndexingDiagnostics: {
|
|
4745
4774
|
readonly query: z.ZodOptional<z.ZodObject<{
|
|
4775
|
+
feedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
4776
|
+
excludeFeedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
4746
4777
|
sampleIssues: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
4747
4778
|
sampleLimit: z.ZodOptional<z.ZodNumber>;
|
|
4748
4779
|
}, z.core.$strip>>;
|
|
@@ -6121,8 +6152,8 @@ export declare const partnerEndpointSchemas: {
|
|
|
6121
6152
|
status: z.ZodEnum<{
|
|
6122
6153
|
error: "error";
|
|
6123
6154
|
registered: "registered";
|
|
6124
|
-
already_exists: "already_exists";
|
|
6125
6155
|
not_found: "not_found";
|
|
6156
|
+
already_exists: "already_exists";
|
|
6126
6157
|
}>;
|
|
6127
6158
|
error: z.ZodOptional<z.ZodString>;
|
|
6128
6159
|
site: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
@@ -6402,19 +6433,19 @@ export declare const partnerEndpointSchemas: {
|
|
|
6402
6433
|
_tag: z.ZodLiteral<"counted">;
|
|
6403
6434
|
capturedAt: z.ZodString;
|
|
6404
6435
|
counts: z.ZodObject<{
|
|
6405
|
-
indexed: z.ZodDefault<z.ZodNumber>;
|
|
6406
|
-
not_found: z.ZodDefault<z.ZodNumber>;
|
|
6407
|
-
redirect: z.ZodDefault<z.ZodNumber>;
|
|
6408
6436
|
unknown_to_google: z.ZodDefault<z.ZodNumber>;
|
|
6409
6437
|
discovered_not_indexed: z.ZodDefault<z.ZodNumber>;
|
|
6410
6438
|
crawled_not_indexed: z.ZodDefault<z.ZodNumber>;
|
|
6439
|
+
indexed: z.ZodDefault<z.ZodNumber>;
|
|
6411
6440
|
noindex: z.ZodDefault<z.ZodNumber>;
|
|
6412
6441
|
blocked_robots: z.ZodDefault<z.ZodNumber>;
|
|
6413
6442
|
soft_404: z.ZodDefault<z.ZodNumber>;
|
|
6443
|
+
not_found: z.ZodDefault<z.ZodNumber>;
|
|
6414
6444
|
server_error: z.ZodDefault<z.ZodNumber>;
|
|
6415
6445
|
access_denied: z.ZodDefault<z.ZodNumber>;
|
|
6416
6446
|
access_forbidden: z.ZodDefault<z.ZodNumber>;
|
|
6417
6447
|
blocked_4xx: z.ZodDefault<z.ZodNumber>;
|
|
6448
|
+
redirect: z.ZodDefault<z.ZodNumber>;
|
|
6418
6449
|
redirect_error: z.ZodDefault<z.ZodNumber>;
|
|
6419
6450
|
alternate_canonical: z.ZodDefault<z.ZodNumber>;
|
|
6420
6451
|
duplicate_no_canonical: z.ZodDefault<z.ZodNumber>;
|
|
@@ -6513,6 +6544,8 @@ export declare const partnerEndpointSchemas: {
|
|
|
6513
6544
|
};
|
|
6514
6545
|
readonly getIndexingUrls: {
|
|
6515
6546
|
readonly query: z.ZodOptional<z.ZodObject<{
|
|
6547
|
+
feedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
6548
|
+
excludeFeedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
6516
6549
|
limit: z.ZodOptional<z.ZodNumber>;
|
|
6517
6550
|
offset: z.ZodOptional<z.ZodNumber>;
|
|
6518
6551
|
status: z.ZodOptional<z.ZodEnum<{
|
|
@@ -6569,6 +6602,8 @@ export declare const partnerEndpointSchemas: {
|
|
|
6569
6602
|
};
|
|
6570
6603
|
readonly getIndexingDiagnostics: {
|
|
6571
6604
|
readonly query: z.ZodOptional<z.ZodObject<{
|
|
6605
|
+
feedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
6606
|
+
excludeFeedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
6572
6607
|
sampleIssues: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
6573
6608
|
sampleLimit: z.ZodOptional<z.ZodNumber>;
|
|
6574
6609
|
}, z.core.$strip>>;
|
|
@@ -7456,6 +7491,8 @@ export declare const partnerEndpointSchemas: {
|
|
|
7456
7491
|
};
|
|
7457
7492
|
readonly analyticsIndexingDiagnostics: {
|
|
7458
7493
|
readonly query: z.ZodOptional<z.ZodObject<{
|
|
7494
|
+
feedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
7495
|
+
excludeFeedpath: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
7459
7496
|
sampleIssues: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
7460
7497
|
sampleLimit: z.ZodOptional<z.ZodNumber>;
|
|
7461
7498
|
}, z.core.$strip>>;
|
package/dist/schemas.mjs
CHANGED
|
@@ -788,6 +788,19 @@ const gscdumpSitemapChangesResponseSchema = z.object({
|
|
|
788
788
|
completeness: sitemapChangesCompletenessSchema,
|
|
789
789
|
generation: z.lazy(() => gscdumpSitemapGenerationSchema).nullable()
|
|
790
790
|
}).loose();
|
|
791
|
+
const INDEXING_SITEMAP_FILTER_MAX_FEEDS = 50;
|
|
792
|
+
const indexingSitemapFeedpathsSchema = z.union([z.string().min(1).max(2048), z.array(z.string().min(1).max(2048)).min(1).max(50)]);
|
|
793
|
+
const indexingSitemapFilterShape = {
|
|
794
|
+
feedpath: indexingSitemapFeedpathsSchema.optional(),
|
|
795
|
+
excludeFeedpath: indexingSitemapFeedpathsSchema.optional()
|
|
796
|
+
};
|
|
797
|
+
function refineIndexingSitemapFilter(value, ctx) {
|
|
798
|
+
if (value.feedpath !== void 0 && value.excludeFeedpath !== void 0) ctx.addIssue({
|
|
799
|
+
code: "custom",
|
|
800
|
+
path: ["excludeFeedpath"],
|
|
801
|
+
message: "Send feedpath or excludeFeedpath, not both."
|
|
802
|
+
});
|
|
803
|
+
}
|
|
791
804
|
const indexingUrlsParamsSchema = z.object({
|
|
792
805
|
limit: z.number().optional(),
|
|
793
806
|
offset: z.number().optional(),
|
|
@@ -798,12 +811,14 @@ const indexingUrlsParamsSchema = z.object({
|
|
|
798
811
|
]).optional(),
|
|
799
812
|
issue: z.string().optional(),
|
|
800
813
|
search: z.string().optional(),
|
|
801
|
-
count: z.union([z.literal(0), z.literal(false)]).optional()
|
|
802
|
-
|
|
814
|
+
count: z.union([z.literal(0), z.literal(false)]).optional(),
|
|
815
|
+
...indexingSitemapFilterShape
|
|
816
|
+
}).superRefine(refineIndexingSitemapFilter).optional();
|
|
803
817
|
const indexingDiagnosticsParamsSchema = z.object({
|
|
804
818
|
sampleIssues: z.union([z.string(), z.array(z.string())]).optional(),
|
|
805
|
-
sampleLimit: z.number().min(1).max(25).optional()
|
|
806
|
-
|
|
819
|
+
sampleLimit: z.number().min(1).max(25).optional(),
|
|
820
|
+
...indexingSitemapFilterShape
|
|
821
|
+
}).superRefine(refineIndexingSitemapFilter).optional();
|
|
807
822
|
const gscdumpIndexingResponseSchema = z.object({
|
|
808
823
|
trend: z.array(z.object({
|
|
809
824
|
date: z.string(),
|
|
@@ -1769,4 +1784,4 @@ const partnerEndpointSchemas = {
|
|
|
1769
1784
|
...analyticsEndpointSchemas,
|
|
1770
1785
|
...partnerControlEndpointSchemas
|
|
1771
1786
|
};
|
|
1772
|
-
export { GSCDUMP_INDEXING_TRANSITION_FIELDS, SEARCH_TYPE_CAPABILITIES, addPartnerTeamMemberSchema, analyticsEndpointSchemas, backfillRangeSchema, backfillResponseSchema, bindPartnerSiteTeamSchema, bindPartnerTeamCatalogResponseSchema, bindPartnerTeamCatalogSchema, builderStateSchema, bulkFileResolutionResponseSchema, bulkRegisterPartnerSitesResponseSchema, bulkRegisterPartnerSitesSchema, canonicalDifferenceKindSchema, canonicalWebhookEventTypeSchema, countriesResponseSchema, countryRowSchema, createPartnerTeamSchema, dataDetailOptionsSchema, dataQueryOptionsSchema, gscAddAndVerifyResponseSchema, gscApiRangeSchema, gscComparisonFilterSchema, gscComparisonOrderBySchema, gscRowQueryMetaSchema, gscRowQueryResponseSchema, gscVerificationDnsRecordSchema, gscVerificationMethodSchema, gscVerificationRequestSchema, gscVerificationSiteSchema, gscVerificationTokenResponseSchema, gscdumpAnalysisBaseParamsSchema, gscdumpAnalysisBundleResponseSchema, gscdumpAnalysisMetaSchema, gscdumpAnalysisParamsSchema, gscdumpAnalysisPresetSchema, gscdumpAnalysisResponseSchema, gscdumpAnalysisSourcesResponseSchema, gscdumpAvailableSiteSchema, gscdumpCanonicalMismatchesResponseSchema, gscdumpDataDetailResponseSchema, gscdumpDataResponseSchema, gscdumpDataRowSchema, gscdumpDeletePartnerUserResponseSchema, gscdumpHealthResponseSchema, gscdumpIndexPercentParamsSchema, gscdumpIndexPercentResponseSchema, gscdumpIndexingDiagnosticsResponseSchema, gscdumpIndexingResponseSchema, gscdumpIndexingTransitionFieldSchema, gscdumpIndexingUrlsResponseSchema, gscdumpKeywordSparklinesParamsSchema, gscdumpKeywordSparklinesResponseSchema, gscdumpMetaSchema, gscdumpPageTrendParamsSchema, gscdumpPageTrendResponseSchema, gscdumpPermissionRecoverySchema, gscdumpQueryTrendParamsSchema, gscdumpQueryTrendResponseSchema, gscdumpSearchConsoleGrantOutcomeSchema, gscdumpSiteRegistrationSchema, gscdumpSiteReportResponseSchema, gscdumpSitemapChangesResponseSchema, gscdumpSitemapExportQuerySchema, gscdumpSitemapExportResponseSchema, gscdumpSitemapFeedSchema, gscdumpSitemapGenerationSchema, gscdumpSitemapMembershipEvidenceSchema, gscdumpSitemapMembershipParamsSchema, gscdumpSitemapMembershipResponseSchema, gscdumpSitemapUrlsQuerySchema, gscdumpSitemapUrlsResponseSchema, gscdumpSitemapsResponseSchema, gscdumpSyncJobsResponseSchema, gscdumpSyncProgressResponseSchema, gscdumpTeamMemberRowSchema, gscdumpTeamRoleSchema, gscdumpTeamRowSchema, gscdumpTopAssociationParamsSchema, gscdumpTopAssociationResponseSchema, gscdumpTotalsSchema, gscdumpUserMeResponseSchema, gscdumpUserRegistrationSchema, gscdumpUserSettingsSchema, gscdumpUserSiteSchema, gscdumpUserStatusSchema, indexingDiagnosticsParamsSchema, indexingDiagnosticsSchema, indexingInspectAnyResponseSchema, indexingInspectRateLimitedSchema, indexingInspectRequestSchema, indexingInspectResponseSchema, indexingInspectResultSchema, indexingIssueSchema, indexingUrlRowSchema, indexingUrlsParamsSchema, indexingUrlsResponseSchema, inspectionHistoryRecordSchema, inspectionHistoryResponseSchema, inspectionIndexSchema, inspectionRecordRawSchema, lifecycleErrorSchema, lifecycleProgressSchema, partnerControlEndpointSchemas, partnerEndpointSchemas, partnerLifecycleAccountSchema, partnerLifecycleResponseSchema, partnerLifecycleSiteSchema, partnerRealtimeEventSchema, partnerSiteTeamBindingResponseSchema, partnerSitemapActionResponseSchema, partnerSitemapActionSchema, partnerTeamCreatedResponseSchema, partnerTeamDeletedResponseSchema, partnerTeamMemberAddedResponseSchema, partnerTeamMemberRemovedResponseSchema, partnerTeamMemberRoleResponseSchema, partnerTeamMembersResponseSchema, partnerTeamRenamedResponseSchema, partnerWebhookDataSchema, partnerWebhookEnvelopeSchema, queryDimSourceResponseSchema, registerPartnerSiteSchema, registerPartnerUserSchema, renamePartnerTeamSchema, rollupEnvelopeSchema, scheduleStateSchema, searchAppearanceResponseSchema, searchAppearanceRowSchema, searchTypeSchema, searchTypeSupportsDimensions, searchTypeSupportsQueries, siteIntIdCrosswalkResponseSchema, siteListItemSchema, sitemapChangesCompletenessSchema, sitemapChangesResponseSchema, sitemapChangesTruncationReasonSchema, sourceInfoResponseSchema, teamCatalogRefSchema, updatePartnerUserTokensSchema, whoamiResponseSchema };
|
|
1787
|
+
export { GSCDUMP_INDEXING_TRANSITION_FIELDS, INDEXING_SITEMAP_FILTER_MAX_FEEDS, SEARCH_TYPE_CAPABILITIES, addPartnerTeamMemberSchema, analyticsEndpointSchemas, backfillRangeSchema, backfillResponseSchema, bindPartnerSiteTeamSchema, bindPartnerTeamCatalogResponseSchema, bindPartnerTeamCatalogSchema, builderStateSchema, bulkFileResolutionResponseSchema, bulkRegisterPartnerSitesResponseSchema, bulkRegisterPartnerSitesSchema, canonicalDifferenceKindSchema, canonicalWebhookEventTypeSchema, countriesResponseSchema, countryRowSchema, createPartnerTeamSchema, dataDetailOptionsSchema, dataQueryOptionsSchema, gscAddAndVerifyResponseSchema, gscApiRangeSchema, gscComparisonFilterSchema, gscComparisonOrderBySchema, gscRowQueryMetaSchema, gscRowQueryResponseSchema, gscVerificationDnsRecordSchema, gscVerificationMethodSchema, gscVerificationRequestSchema, gscVerificationSiteSchema, gscVerificationTokenResponseSchema, gscdumpAnalysisBaseParamsSchema, gscdumpAnalysisBundleResponseSchema, gscdumpAnalysisMetaSchema, gscdumpAnalysisParamsSchema, gscdumpAnalysisPresetSchema, gscdumpAnalysisResponseSchema, gscdumpAnalysisSourcesResponseSchema, gscdumpAvailableSiteSchema, gscdumpCanonicalMismatchesResponseSchema, gscdumpDataDetailResponseSchema, gscdumpDataResponseSchema, gscdumpDataRowSchema, gscdumpDeletePartnerUserResponseSchema, gscdumpHealthResponseSchema, gscdumpIndexPercentParamsSchema, gscdumpIndexPercentResponseSchema, gscdumpIndexingDiagnosticsResponseSchema, gscdumpIndexingResponseSchema, gscdumpIndexingTransitionFieldSchema, gscdumpIndexingUrlsResponseSchema, gscdumpKeywordSparklinesParamsSchema, gscdumpKeywordSparklinesResponseSchema, gscdumpMetaSchema, gscdumpPageTrendParamsSchema, gscdumpPageTrendResponseSchema, gscdumpPermissionRecoverySchema, gscdumpQueryTrendParamsSchema, gscdumpQueryTrendResponseSchema, gscdumpSearchConsoleGrantOutcomeSchema, gscdumpSiteRegistrationSchema, gscdumpSiteReportResponseSchema, gscdumpSitemapChangesResponseSchema, gscdumpSitemapExportQuerySchema, gscdumpSitemapExportResponseSchema, gscdumpSitemapFeedSchema, gscdumpSitemapGenerationSchema, gscdumpSitemapMembershipEvidenceSchema, gscdumpSitemapMembershipParamsSchema, gscdumpSitemapMembershipResponseSchema, gscdumpSitemapUrlsQuerySchema, gscdumpSitemapUrlsResponseSchema, gscdumpSitemapsResponseSchema, gscdumpSyncJobsResponseSchema, gscdumpSyncProgressResponseSchema, gscdumpTeamMemberRowSchema, gscdumpTeamRoleSchema, gscdumpTeamRowSchema, gscdumpTopAssociationParamsSchema, gscdumpTopAssociationResponseSchema, gscdumpTotalsSchema, gscdumpUserMeResponseSchema, gscdumpUserRegistrationSchema, gscdumpUserSettingsSchema, gscdumpUserSiteSchema, gscdumpUserStatusSchema, indexingDiagnosticsParamsSchema, indexingDiagnosticsSchema, indexingInspectAnyResponseSchema, indexingInspectRateLimitedSchema, indexingInspectRequestSchema, indexingInspectResponseSchema, indexingInspectResultSchema, indexingIssueSchema, indexingSitemapFilterShape, indexingUrlRowSchema, indexingUrlsParamsSchema, indexingUrlsResponseSchema, inspectionHistoryRecordSchema, inspectionHistoryResponseSchema, inspectionIndexSchema, inspectionRecordRawSchema, lifecycleErrorSchema, lifecycleProgressSchema, partnerControlEndpointSchemas, partnerEndpointSchemas, partnerLifecycleAccountSchema, partnerLifecycleResponseSchema, partnerLifecycleSiteSchema, partnerRealtimeEventSchema, partnerSiteTeamBindingResponseSchema, partnerSitemapActionResponseSchema, partnerSitemapActionSchema, partnerTeamCreatedResponseSchema, partnerTeamDeletedResponseSchema, partnerTeamMemberAddedResponseSchema, partnerTeamMemberRemovedResponseSchema, partnerTeamMemberRoleResponseSchema, partnerTeamMembersResponseSchema, partnerTeamRenamedResponseSchema, partnerWebhookDataSchema, partnerWebhookEnvelopeSchema, queryDimSourceResponseSchema, refineIndexingSitemapFilter, registerPartnerSiteSchema, registerPartnerUserSchema, renamePartnerTeamSchema, rollupEnvelopeSchema, scheduleStateSchema, searchAppearanceResponseSchema, searchAppearanceRowSchema, searchTypeSchema, searchTypeSupportsDimensions, searchTypeSupportsQueries, siteIntIdCrosswalkResponseSchema, siteListItemSchema, sitemapChangesCompletenessSchema, sitemapChangesResponseSchema, sitemapChangesTruncationReasonSchema, sourceInfoResponseSchema, teamCatalogRefSchema, updatePartnerUserTokensSchema, whoamiResponseSchema };
|
package/dist/types.d.mts
CHANGED
|
@@ -217,7 +217,17 @@ export interface IndexingDiagnostics {
|
|
|
217
217
|
rollupBuiltAt?: number;
|
|
218
218
|
};
|
|
219
219
|
}
|
|
220
|
-
|
|
220
|
+
/**
|
|
221
|
+
* The Sitemap filter on the indexing summary, URL and diagnostics reads. Send
|
|
222
|
+
* one key at most. `feedpath` counts only URLs that the named Sitemaps list.
|
|
223
|
+
* `excludeFeedpath` counts only URLs that some other live Sitemap lists. Each
|
|
224
|
+
* value is a Sitemap URL or a path on the Site's host.
|
|
225
|
+
*/
|
|
226
|
+
export interface IndexingSitemapFilterParams {
|
|
227
|
+
feedpath?: string | string[];
|
|
228
|
+
excludeFeedpath?: string | string[];
|
|
229
|
+
}
|
|
230
|
+
export interface IndexingDiagnosticsParams extends IndexingSitemapFilterParams {
|
|
221
231
|
sampleIssues?: string[] | string;
|
|
222
232
|
sampleLimit?: number;
|
|
223
233
|
}
|
|
@@ -1068,7 +1078,7 @@ export interface DataDetailOptions {
|
|
|
1068
1078
|
comparison?: BuilderStateWire;
|
|
1069
1079
|
searchType?: GscSearchType;
|
|
1070
1080
|
}
|
|
1071
|
-
export interface IndexingUrlsParams {
|
|
1081
|
+
export interface IndexingUrlsParams extends IndexingSitemapFilterParams {
|
|
1072
1082
|
limit?: number;
|
|
1073
1083
|
offset?: number;
|
|
1074
1084
|
status?: GscdumpIndexingUrlStatus;
|
package/dist/v1/bing-sites.d.mts
CHANGED
|
@@ -101,8 +101,8 @@ export declare const bingSiteStateV1Schemas: {
|
|
|
101
101
|
}, z.core.$strip>, z.ZodObject<{
|
|
102
102
|
readonly _tag: z.ZodLiteral<"grant-required">;
|
|
103
103
|
readonly reason: z.ZodEnum<{
|
|
104
|
-
"reauthorization-required": "reauthorization-required";
|
|
105
104
|
"grant-missing": "grant-missing";
|
|
105
|
+
"reauthorization-required": "reauthorization-required";
|
|
106
106
|
}>;
|
|
107
107
|
}, z.core.$strip>, z.ZodObject<{
|
|
108
108
|
readonly _tag: z.ZodLiteral<"reauthorization-required">;
|
|
@@ -159,8 +159,8 @@ export declare const bingSiteStateV1Schemas: {
|
|
|
159
159
|
}, z.core.$strip>, z.ZodObject<{
|
|
160
160
|
readonly _tag: z.ZodLiteral<"grant-required">;
|
|
161
161
|
readonly reason: z.ZodEnum<{
|
|
162
|
-
"reauthorization-required": "reauthorization-required";
|
|
163
162
|
"grant-missing": "grant-missing";
|
|
163
|
+
"reauthorization-required": "reauthorization-required";
|
|
164
164
|
}>;
|
|
165
165
|
}, z.core.$strip>, z.ZodObject<{
|
|
166
166
|
readonly _tag: z.ZodLiteral<"reauthorization-required">;
|
|
@@ -228,8 +228,8 @@ export declare const bingSiteV1Schemas: CompatibleResponseSchema<z.ZodObject<{
|
|
|
228
228
|
}, z.core.$strip>, z.ZodObject<{
|
|
229
229
|
readonly _tag: z.ZodLiteral<"grant-required">;
|
|
230
230
|
readonly reason: z.ZodEnum<{
|
|
231
|
-
"reauthorization-required": "reauthorization-required";
|
|
232
231
|
"grant-missing": "grant-missing";
|
|
232
|
+
"reauthorization-required": "reauthorization-required";
|
|
233
233
|
}>;
|
|
234
234
|
}, z.core.$strip>, z.ZodObject<{
|
|
235
235
|
readonly _tag: z.ZodLiteral<"reauthorization-required">;
|
|
@@ -291,8 +291,8 @@ export declare const bingSiteV1Schemas: CompatibleResponseSchema<z.ZodObject<{
|
|
|
291
291
|
}, z.core.$strip>, z.ZodObject<{
|
|
292
292
|
readonly _tag: z.ZodLiteral<"grant-required">;
|
|
293
293
|
readonly reason: z.ZodEnum<{
|
|
294
|
-
"reauthorization-required": "reauthorization-required";
|
|
295
294
|
"grant-missing": "grant-missing";
|
|
295
|
+
"reauthorization-required": "reauthorization-required";
|
|
296
296
|
}>;
|
|
297
297
|
}, z.core.$strip>, z.ZodObject<{
|
|
298
298
|
readonly _tag: z.ZodLiteral<"reauthorization-required">;
|
|
@@ -384,8 +384,8 @@ export declare const bingSitesV1Schemas: CompatibleResponseSchema<z.ZodObject<{
|
|
|
384
384
|
}, z.core.$strip>, z.ZodObject<{
|
|
385
385
|
readonly _tag: z.ZodLiteral<"grant-required">;
|
|
386
386
|
readonly reason: z.ZodEnum<{
|
|
387
|
-
"reauthorization-required": "reauthorization-required";
|
|
388
387
|
"grant-missing": "grant-missing";
|
|
388
|
+
"reauthorization-required": "reauthorization-required";
|
|
389
389
|
}>;
|
|
390
390
|
}, z.core.$strip>, z.ZodObject<{
|
|
391
391
|
readonly _tag: z.ZodLiteral<"reauthorization-required">;
|
|
@@ -458,8 +458,8 @@ export declare const bingSitesV1Schemas: CompatibleResponseSchema<z.ZodObject<{
|
|
|
458
458
|
}, z.core.$strip>, z.ZodObject<{
|
|
459
459
|
readonly _tag: z.ZodLiteral<"grant-required">;
|
|
460
460
|
readonly reason: z.ZodEnum<{
|
|
461
|
-
"reauthorization-required": "reauthorization-required";
|
|
462
461
|
"grant-missing": "grant-missing";
|
|
462
|
+
"reauthorization-required": "reauthorization-required";
|
|
463
463
|
}>;
|
|
464
464
|
}, z.core.$strip>, z.ZodObject<{
|
|
465
465
|
readonly _tag: z.ZodLiteral<"reauthorization-required">;
|
|
@@ -526,8 +526,8 @@ export declare const bingLinkResultV1Schemas: {
|
|
|
526
526
|
}, z.core.$strip>, z.ZodObject<{
|
|
527
527
|
readonly _tag: z.ZodLiteral<"grant-required">;
|
|
528
528
|
readonly reason: z.ZodEnum<{
|
|
529
|
-
"reauthorization-required": "reauthorization-required";
|
|
530
529
|
"grant-missing": "grant-missing";
|
|
530
|
+
"reauthorization-required": "reauthorization-required";
|
|
531
531
|
}>;
|
|
532
532
|
}, z.core.$strip>, z.ZodObject<{
|
|
533
533
|
readonly _tag: z.ZodLiteral<"reauthorization-required">;
|
|
@@ -542,8 +542,8 @@ export declare const bingLinkResultV1Schemas: {
|
|
|
542
542
|
}, z.core.$strip>, z.ZodObject<{
|
|
543
543
|
readonly _tag: z.ZodLiteral<"grant-required">;
|
|
544
544
|
readonly reason: z.ZodEnum<{
|
|
545
|
-
"reauthorization-required": "reauthorization-required";
|
|
546
545
|
"grant-missing": "grant-missing";
|
|
546
|
+
"reauthorization-required": "reauthorization-required";
|
|
547
547
|
}>;
|
|
548
548
|
}, z.core.$strip>, z.ZodObject<{
|
|
549
549
|
readonly _tag: z.ZodLiteral<"failed">;
|
|
@@ -608,8 +608,8 @@ export declare const bingLinkResultV1Schemas: {
|
|
|
608
608
|
}, z.core.$strip>, z.ZodObject<{
|
|
609
609
|
readonly _tag: z.ZodLiteral<"grant-required">;
|
|
610
610
|
readonly reason: z.ZodEnum<{
|
|
611
|
-
"reauthorization-required": "reauthorization-required";
|
|
612
611
|
"grant-missing": "grant-missing";
|
|
612
|
+
"reauthorization-required": "reauthorization-required";
|
|
613
613
|
}>;
|
|
614
614
|
}, z.core.$strip>, z.ZodObject<{
|
|
615
615
|
readonly _tag: z.ZodLiteral<"reauthorization-required">;
|
|
@@ -624,8 +624,8 @@ export declare const bingLinkResultV1Schemas: {
|
|
|
624
624
|
}, z.core.$strip>, z.ZodObject<{
|
|
625
625
|
readonly _tag: z.ZodLiteral<"grant-required">;
|
|
626
626
|
readonly reason: z.ZodEnum<{
|
|
627
|
-
"reauthorization-required": "reauthorization-required";
|
|
628
627
|
"grant-missing": "grant-missing";
|
|
628
|
+
"reauthorization-required": "reauthorization-required";
|
|
629
629
|
}>;
|
|
630
630
|
}, z.core.$strip>, z.ZodObject<{
|
|
631
631
|
readonly _tag: z.ZodLiteral<"failed">;
|
|
@@ -690,11 +690,11 @@ export declare const bingSitemapSubmitResultV1Schemas: {
|
|
|
690
690
|
}, z.core.$strip>, z.ZodObject<{
|
|
691
691
|
readonly _tag: z.ZodLiteral<"failed">;
|
|
692
692
|
readonly reason: z.ZodEnum<{
|
|
693
|
+
"no-sitemap-found": "no-sitemap-found";
|
|
694
|
+
"provider-unavailable": "provider-unavailable";
|
|
693
695
|
"grant-required": "grant-required";
|
|
694
696
|
"site-unverified": "site-unverified";
|
|
695
|
-
"no-sitemap-found": "no-sitemap-found";
|
|
696
697
|
throttled: "throttled";
|
|
697
|
-
"provider-unavailable": "provider-unavailable";
|
|
698
698
|
}>;
|
|
699
699
|
readonly retryable: z.ZodBoolean;
|
|
700
700
|
}, z.core.$strip>], "_tag">;
|
|
@@ -728,11 +728,11 @@ export declare const bingSitemapSubmitResultV1Schemas: {
|
|
|
728
728
|
}, z.core.$strip>, z.ZodObject<{
|
|
729
729
|
readonly _tag: z.ZodLiteral<"failed">;
|
|
730
730
|
readonly reason: z.ZodEnum<{
|
|
731
|
+
"no-sitemap-found": "no-sitemap-found";
|
|
732
|
+
"provider-unavailable": "provider-unavailable";
|
|
731
733
|
"grant-required": "grant-required";
|
|
732
734
|
"site-unverified": "site-unverified";
|
|
733
|
-
"no-sitemap-found": "no-sitemap-found";
|
|
734
735
|
throttled: "throttled";
|
|
735
|
-
"provider-unavailable": "provider-unavailable";
|
|
736
736
|
}>;
|
|
737
737
|
readonly retryable: z.ZodBoolean;
|
|
738
738
|
}, z.core.$strip>], "_tag">;
|
|
@@ -232,8 +232,8 @@ export declare const googleSubmissionRefusalSchema: z.ZodDiscriminatedUnion<[z.Z
|
|
|
232
232
|
}, z.core.$strip>, z.ZodObject<{
|
|
233
233
|
reason: z.ZodLiteral<"needs_indexing_api_grant">;
|
|
234
234
|
grant: z.ZodEnum<{
|
|
235
|
-
"reauthorization-required": "reauthorization-required";
|
|
236
235
|
missing: "missing";
|
|
236
|
+
"reauthorization-required": "reauthorization-required";
|
|
237
237
|
}>;
|
|
238
238
|
}, z.core.$strip>, z.ZodObject<{
|
|
239
239
|
reason: z.ZodLiteral<"url_outside_site">;
|