@gscdump/contracts 3.2.0 → 3.4.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/v1/bing.d.mts +48 -0
- package/dist/v1/bing.mjs +92 -0
- package/dist/v1/http.d.mts +3 -2
- package/dist/v1/http.mjs +2 -1
- package/dist/v1/index.d.mts +3 -2
- package/dist/v1/index.mjs +2 -1
- package/dist/v1/operations.d.mts +495 -1
- package/dist/v1/operations.mjs +133 -0
- package/dist/v1/route-catalog.d.mts +10 -0
- package/dist/v1/route-catalog.mjs +10 -0
- package/package.json +2 -2
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
declare const bingCnameVerificationV1Schema: z.ZodObject<{
|
|
3
|
+
_tag: z.ZodLiteral<"cname">;
|
|
4
|
+
name: z.ZodString;
|
|
5
|
+
value: z.ZodLiteral<"verify.bing.com">;
|
|
6
|
+
}, z.core.$strict>;
|
|
7
|
+
declare const bingConnectionV1Schema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
8
|
+
_tag: z.ZodLiteral<"disconnected">;
|
|
9
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
10
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
11
|
+
_tag: z.ZodLiteral<"verification-required">;
|
|
12
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
13
|
+
remoteSiteUrl: z.ZodURL;
|
|
14
|
+
verified: z.ZodLiteral<false>;
|
|
15
|
+
verification: z.ZodObject<{
|
|
16
|
+
_tag: z.ZodLiteral<"cname">;
|
|
17
|
+
name: z.ZodString;
|
|
18
|
+
value: z.ZodLiteral<"verify.bing.com">;
|
|
19
|
+
}, z.core.$strict>;
|
|
20
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
21
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
22
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
23
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
24
|
+
_tag: z.ZodLiteral<"connected">;
|
|
25
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
26
|
+
remoteSiteUrl: z.ZodURL;
|
|
27
|
+
verified: z.ZodLiteral<true>;
|
|
28
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
29
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
30
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
31
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
32
|
+
_tag: z.ZodLiteral<"reauthorization-required">;
|
|
33
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
34
|
+
remoteSiteUrl: z.ZodURL;
|
|
35
|
+
verified: z.ZodBoolean;
|
|
36
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
37
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
38
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
39
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
40
|
+
_tag: z.ZodLiteral<"unavailable">;
|
|
41
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
42
|
+
remoteSiteUrl: z.ZodURL;
|
|
43
|
+
verified: z.ZodLiteral<true>;
|
|
44
|
+
reason: z.ZodLiteral<"permission-lost">;
|
|
45
|
+
}, z.core.$strict>], "_tag">;
|
|
46
|
+
type BingCnameVerificationV1 = z.infer<typeof bingCnameVerificationV1Schema>;
|
|
47
|
+
type BingConnectionV1 = z.infer<typeof bingConnectionV1Schema>;
|
|
48
|
+
export { BingCnameVerificationV1, BingConnectionV1, bingCnameVerificationV1Schema, bingConnectionV1Schema };
|
package/dist/v1/bing.mjs
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
const bingSearchEngineSchema = z.literal("bing");
|
|
3
|
+
const bingRemoteSiteUrlSchema = z.url();
|
|
4
|
+
const bingVerifiedMetadataShape = {
|
|
5
|
+
scopes: z.array(z.string().min(1)),
|
|
6
|
+
tokenExpiresAt: z.iso.datetime().nullable(),
|
|
7
|
+
lastEvidenceAt: z.iso.datetime().nullable()
|
|
8
|
+
};
|
|
9
|
+
const bingCnameVerificationV1Schema = z.strictObject({
|
|
10
|
+
_tag: z.literal("cname"),
|
|
11
|
+
name: z.string().min(1).max(63).regex(/^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/),
|
|
12
|
+
value: z.literal("verify.bing.com")
|
|
13
|
+
});
|
|
14
|
+
const bingConnectionV1Schema = z.discriminatedUnion("_tag", [
|
|
15
|
+
z.strictObject({
|
|
16
|
+
_tag: z.literal("disconnected"),
|
|
17
|
+
searchEngine: bingSearchEngineSchema
|
|
18
|
+
}),
|
|
19
|
+
z.strictObject({
|
|
20
|
+
_tag: z.literal("verification-required"),
|
|
21
|
+
searchEngine: bingSearchEngineSchema,
|
|
22
|
+
remoteSiteUrl: bingRemoteSiteUrlSchema,
|
|
23
|
+
verified: z.literal(false),
|
|
24
|
+
verification: bingCnameVerificationV1Schema
|
|
25
|
+
}),
|
|
26
|
+
z.strictObject({
|
|
27
|
+
_tag: z.literal("connected"),
|
|
28
|
+
searchEngine: bingSearchEngineSchema,
|
|
29
|
+
remoteSiteUrl: bingRemoteSiteUrlSchema,
|
|
30
|
+
verified: z.literal(true),
|
|
31
|
+
...bingVerifiedMetadataShape
|
|
32
|
+
}),
|
|
33
|
+
z.strictObject({
|
|
34
|
+
_tag: z.literal("reauthorization-required"),
|
|
35
|
+
searchEngine: bingSearchEngineSchema,
|
|
36
|
+
remoteSiteUrl: bingRemoteSiteUrlSchema,
|
|
37
|
+
verified: z.boolean(),
|
|
38
|
+
...bingVerifiedMetadataShape
|
|
39
|
+
}),
|
|
40
|
+
z.strictObject({
|
|
41
|
+
_tag: z.literal("unavailable"),
|
|
42
|
+
searchEngine: bingSearchEngineSchema,
|
|
43
|
+
remoteSiteUrl: bingRemoteSiteUrlSchema,
|
|
44
|
+
verified: z.literal(true),
|
|
45
|
+
reason: z.literal("permission-lost"),
|
|
46
|
+
...bingVerifiedMetadataShape
|
|
47
|
+
})
|
|
48
|
+
]);
|
|
49
|
+
const bingCnameVerificationV1ClientSchema = z.looseObject({
|
|
50
|
+
_tag: z.literal("cname"),
|
|
51
|
+
name: z.string().min(1).max(63).regex(/^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/),
|
|
52
|
+
value: z.literal("verify.bing.com")
|
|
53
|
+
});
|
|
54
|
+
const bingConnectionV1Schemas = {
|
|
55
|
+
producer: bingConnectionV1Schema,
|
|
56
|
+
client: z.discriminatedUnion("_tag", [
|
|
57
|
+
z.looseObject({
|
|
58
|
+
_tag: z.literal("disconnected"),
|
|
59
|
+
searchEngine: bingSearchEngineSchema
|
|
60
|
+
}),
|
|
61
|
+
z.looseObject({
|
|
62
|
+
_tag: z.literal("verification-required"),
|
|
63
|
+
searchEngine: bingSearchEngineSchema,
|
|
64
|
+
remoteSiteUrl: bingRemoteSiteUrlSchema,
|
|
65
|
+
verified: z.literal(false),
|
|
66
|
+
verification: bingCnameVerificationV1ClientSchema
|
|
67
|
+
}),
|
|
68
|
+
z.looseObject({
|
|
69
|
+
_tag: z.literal("connected"),
|
|
70
|
+
searchEngine: bingSearchEngineSchema,
|
|
71
|
+
remoteSiteUrl: bingRemoteSiteUrlSchema,
|
|
72
|
+
verified: z.literal(true),
|
|
73
|
+
...bingVerifiedMetadataShape
|
|
74
|
+
}),
|
|
75
|
+
z.looseObject({
|
|
76
|
+
_tag: z.literal("reauthorization-required"),
|
|
77
|
+
searchEngine: bingSearchEngineSchema,
|
|
78
|
+
remoteSiteUrl: bingRemoteSiteUrlSchema,
|
|
79
|
+
verified: z.boolean(),
|
|
80
|
+
...bingVerifiedMetadataShape
|
|
81
|
+
}),
|
|
82
|
+
z.looseObject({
|
|
83
|
+
_tag: z.literal("unavailable"),
|
|
84
|
+
searchEngine: bingSearchEngineSchema,
|
|
85
|
+
remoteSiteUrl: bingRemoteSiteUrlSchema,
|
|
86
|
+
verified: z.literal(true),
|
|
87
|
+
reason: z.literal("permission-lost"),
|
|
88
|
+
...bingVerifiedMetadataShape
|
|
89
|
+
})
|
|
90
|
+
])
|
|
91
|
+
};
|
|
92
|
+
export { bingCnameVerificationV1Schema, bingConnectionV1Schema, bingConnectionV1Schemas };
|
package/dist/v1/http.d.mts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { UnknownHttpV1OperationError, isUnknownHttpV1OperationError } from "./http-operation-error.mjs";
|
|
2
2
|
import { GSCDUMP_HTTP_V1_VERSION } from "./version.mjs";
|
|
3
3
|
import { CompatibleResponseSchema, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, HttpV1Credential, HttpV1ErrorCode, HttpV1Method, HttpV1OperationDefinition, HttpV1OperationEntry, HttpV1OperationRequest, HttpV1OwnershipRule, HttpV1ProtocolLike, HttpV1ProtocolOperation, HttpV1Registry, HttpV1RegistryOperationEntry, HttpV1RegistryOperationId, HttpV1RegistryPathOptions, HttpV1RegistryPathParams, HttpV1RequestSchemas, HttpV1ResourceReference, HttpV1ResourceType, HttpV1Scope, HttpV1Semantics, HttpV1Surface, HttpV1SurfaceName, HttpV1Visibility, ResolvedHttpV1Operation, buildHttpOperationPath, createHttpV1Registry, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, listHttpOperations, resolveHttpOperation } from "./http-core.mjs";
|
|
4
|
-
import {
|
|
5
|
-
|
|
4
|
+
import { BingCnameVerificationV1, BingConnectionV1, bingCnameVerificationV1Schema, bingConnectionV1Schema } from "./bing.mjs";
|
|
5
|
+
import { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerBingConnectionV1Response, PartnerBingIndexingEvidenceV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, createGscdumpV1Protocol } from "./operations.mjs";
|
|
6
|
+
export { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, type BingCnameVerificationV1, type BingConnectionV1, CompatibleResponseSchema, GSCDUMP_HTTP_V1_VERSION, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, HttpV1Credential, HttpV1ErrorCode, HttpV1Method, HttpV1OperationDefinition, HttpV1OperationEntry, HttpV1OperationRequest, HttpV1OwnershipRule, HttpV1ProtocolLike, HttpV1ProtocolOperation, HttpV1Registry, HttpV1RegistryOperationEntry, HttpV1RegistryOperationId, HttpV1RegistryPathOptions, HttpV1RegistryPathParams, HttpV1RequestSchemas, HttpV1ResourceReference, HttpV1ResourceType, HttpV1Scope, HttpV1Semantics, HttpV1Surface, HttpV1SurfaceName, HttpV1Visibility, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerBingConnectionV1Response, PartnerBingIndexingEvidenceV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, ResolvedHttpV1Operation, type UnknownHttpV1OperationError, bingCnameVerificationV1Schema, bingConnectionV1Schema, buildHttpOperationPath, createGscdumpV1Protocol, createHttpV1Registry, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, isUnknownHttpV1OperationError, listHttpOperations, resolveHttpOperation };
|
package/dist/v1/http.mjs
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
+
import { bingCnameVerificationV1Schema, bingConnectionV1Schema } from "./bing.mjs";
|
|
1
2
|
import { isUnknownHttpV1OperationError } from "./http-operation-error.mjs";
|
|
2
3
|
import { GSCDUMP_HTTP_V1_VERSION } from "./version.mjs";
|
|
3
4
|
import { HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, buildHttpOperationPath, createHttpV1Registry, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, listHttpOperations, resolveHttpOperation } from "./http-core.mjs";
|
|
4
5
|
import { createGscdumpV1Protocol } from "./operations.mjs";
|
|
5
|
-
export { GSCDUMP_HTTP_V1_VERSION, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, buildHttpOperationPath, createGscdumpV1Protocol, createHttpV1Registry, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, isUnknownHttpV1OperationError, listHttpOperations, resolveHttpOperation };
|
|
6
|
+
export { GSCDUMP_HTTP_V1_VERSION, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, bingCnameVerificationV1Schema, bingConnectionV1Schema, buildHttpOperationPath, createGscdumpV1Protocol, createHttpV1Registry, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, isUnknownHttpV1OperationError, listHttpOperations, resolveHttpOperation };
|
package/dist/v1/index.d.mts
CHANGED
|
@@ -2,7 +2,8 @@ import { UnknownHttpV1OperationError, isUnknownHttpV1OperationError } from "./ht
|
|
|
2
2
|
import { GSCDUMP_HTTP_V1_VERSION } from "./version.mjs";
|
|
3
3
|
import { CompatibleResponseSchema, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, HttpV1Credential, HttpV1ErrorCode, HttpV1Method, HttpV1OperationDefinition, HttpV1OperationEntry, HttpV1OperationRequest, HttpV1OwnershipRule, HttpV1ProtocolLike, HttpV1ProtocolOperation, HttpV1Registry, HttpV1RegistryOperationEntry, HttpV1RegistryOperationId, HttpV1RegistryPathOptions, HttpV1RegistryPathParams, HttpV1RequestSchemas, HttpV1ResourceReference, HttpV1ResourceType, HttpV1Scope, HttpV1Semantics, HttpV1Surface, HttpV1SurfaceName, HttpV1Visibility, ResolvedHttpV1Operation, buildHttpOperationPath, createHttpV1Registry, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, listHttpOperations, resolveHttpOperation } from "./http-core.mjs";
|
|
4
4
|
import { GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_MAX_CONNECTION_SECONDS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_PROTOCOL_VERSION, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, GSCDUMP_REALTIME_TICKET_TTL_SECONDS, REALTIME_V1_EVENT_NAMES, REALTIME_V1_EVENT_SEMANTICS, REALTIME_V1_RESOURCE_TYPES, RealtimeTicketV1Response, RealtimeV1ClientFrame, RealtimeV1Cursor, RealtimeV1Event, RealtimeV1ResourceChange, RealtimeV1Schemas, RealtimeV1ServerFrame, RealtimeV1StreamHead, RealtimeV1StreamId, RealtimeV1TicketClaims, RealtimeV1TicketRequest, createRealtimeV1Schemas } from "./realtime.mjs";
|
|
5
|
-
import {
|
|
5
|
+
import { BingCnameVerificationV1, BingConnectionV1, bingCnameVerificationV1Schema, bingConnectionV1Schema } from "./bing.mjs";
|
|
6
|
+
import { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerBingConnectionV1Response, PartnerBingIndexingEvidenceV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, createGscdumpV1Protocol } from "./operations.mjs";
|
|
6
7
|
import "./http.mjs";
|
|
7
8
|
import { ContractDocument, createGscdumpV1Documents, serializeContractDocument } from "./documents.mjs";
|
|
8
|
-
export { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, CompatibleResponseSchema, ContractDocument, GSCDUMP_HTTP_V1_VERSION, GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_MAX_CONNECTION_SECONDS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_PROTOCOL_VERSION, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, GSCDUMP_REALTIME_TICKET_TTL_SECONDS, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, HttpV1Credential, HttpV1ErrorCode, HttpV1Method, HttpV1OperationDefinition, HttpV1OperationEntry, HttpV1OperationRequest, HttpV1OwnershipRule, HttpV1ProtocolLike, HttpV1ProtocolOperation, HttpV1Registry, HttpV1RegistryOperationEntry, HttpV1RegistryOperationId, HttpV1RegistryPathOptions, HttpV1RegistryPathParams, HttpV1RequestSchemas, HttpV1ResourceReference, HttpV1ResourceType, HttpV1Scope, HttpV1Semantics, HttpV1Surface, HttpV1SurfaceName, HttpV1Visibility, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerBingIndexingEvidenceV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, REALTIME_V1_EVENT_NAMES, REALTIME_V1_EVENT_SEMANTICS, REALTIME_V1_RESOURCE_TYPES, RealtimeTicketV1Response, RealtimeV1ClientFrame, RealtimeV1Cursor, RealtimeV1Event, RealtimeV1ResourceChange, RealtimeV1Schemas, RealtimeV1ServerFrame, RealtimeV1StreamHead, RealtimeV1StreamId, RealtimeV1TicketClaims, RealtimeV1TicketRequest, ResolvedHttpV1Operation, type UnknownHttpV1OperationError, buildHttpOperationPath, createGscdumpV1Documents, createGscdumpV1Protocol, createHttpV1Registry, createRealtimeV1Schemas, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, isUnknownHttpV1OperationError, listHttpOperations, resolveHttpOperation, serializeContractDocument };
|
|
9
|
+
export { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, type BingCnameVerificationV1, type BingConnectionV1, CompatibleResponseSchema, ContractDocument, GSCDUMP_HTTP_V1_VERSION, GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_MAX_CONNECTION_SECONDS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_PROTOCOL_VERSION, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, GSCDUMP_REALTIME_TICKET_TTL_SECONDS, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, HttpV1Credential, HttpV1ErrorCode, HttpV1Method, HttpV1OperationDefinition, HttpV1OperationEntry, HttpV1OperationRequest, HttpV1OwnershipRule, HttpV1ProtocolLike, HttpV1ProtocolOperation, HttpV1Registry, HttpV1RegistryOperationEntry, HttpV1RegistryOperationId, HttpV1RegistryPathOptions, HttpV1RegistryPathParams, HttpV1RequestSchemas, HttpV1ResourceReference, HttpV1ResourceType, HttpV1Scope, HttpV1Semantics, HttpV1Surface, HttpV1SurfaceName, HttpV1Visibility, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerBingConnectionV1Response, PartnerBingIndexingEvidenceV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, REALTIME_V1_EVENT_NAMES, REALTIME_V1_EVENT_SEMANTICS, REALTIME_V1_RESOURCE_TYPES, RealtimeTicketV1Response, RealtimeV1ClientFrame, RealtimeV1Cursor, RealtimeV1Event, RealtimeV1ResourceChange, RealtimeV1Schemas, RealtimeV1ServerFrame, RealtimeV1StreamHead, RealtimeV1StreamId, RealtimeV1TicketClaims, RealtimeV1TicketRequest, ResolvedHttpV1Operation, type UnknownHttpV1OperationError, bingCnameVerificationV1Schema, bingConnectionV1Schema, buildHttpOperationPath, createGscdumpV1Documents, createGscdumpV1Protocol, createHttpV1Registry, createRealtimeV1Schemas, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, isUnknownHttpV1OperationError, listHttpOperations, resolveHttpOperation, serializeContractDocument };
|
package/dist/v1/index.mjs
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { bingCnameVerificationV1Schema, bingConnectionV1Schema } from "./bing.mjs";
|
|
1
2
|
import { isUnknownHttpV1OperationError } from "./http-operation-error.mjs";
|
|
2
3
|
import { GSCDUMP_HTTP_V1_VERSION } from "./version.mjs";
|
|
3
4
|
import { HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, buildHttpOperationPath, createHttpV1Registry, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, listHttpOperations, resolveHttpOperation } from "./http-core.mjs";
|
|
@@ -5,4 +6,4 @@ import { GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REAL
|
|
|
5
6
|
import { createGscdumpV1Protocol } from "./operations.mjs";
|
|
6
7
|
import { createGscdumpV1Documents, serializeContractDocument } from "./documents.mjs";
|
|
7
8
|
import "./http.mjs";
|
|
8
|
-
export { GSCDUMP_HTTP_V1_VERSION, GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_MAX_CONNECTION_SECONDS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_PROTOCOL_VERSION, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, GSCDUMP_REALTIME_TICKET_TTL_SECONDS, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, REALTIME_V1_EVENT_NAMES, REALTIME_V1_EVENT_SEMANTICS, REALTIME_V1_RESOURCE_TYPES, buildHttpOperationPath, createGscdumpV1Documents, createGscdumpV1Protocol, createHttpV1Registry, createRealtimeV1Schemas, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, isUnknownHttpV1OperationError, listHttpOperations, resolveHttpOperation, serializeContractDocument };
|
|
9
|
+
export { GSCDUMP_HTTP_V1_VERSION, GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_MAX_CONNECTION_SECONDS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_PROTOCOL_VERSION, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, GSCDUMP_REALTIME_TICKET_TTL_SECONDS, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, REALTIME_V1_EVENT_NAMES, REALTIME_V1_EVENT_SEMANTICS, REALTIME_V1_RESOURCE_TYPES, bingCnameVerificationV1Schema, bingConnectionV1Schema, buildHttpOperationPath, createGscdumpV1Documents, createGscdumpV1Protocol, createHttpV1Registry, createRealtimeV1Schemas, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, isUnknownHttpV1OperationError, listHttpOperations, resolveHttpOperation, serializeContractDocument };
|
package/dist/v1/operations.d.mts
CHANGED
|
@@ -1960,6 +1960,97 @@ declare function createGscdumpV1Protocol(): {
|
|
|
1960
1960
|
readonly version: z.ZodLiteral<"1.0">;
|
|
1961
1961
|
}, z.core.$strip>;
|
|
1962
1962
|
}, z.core.$strip>>;
|
|
1963
|
+
bingConnectionResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
1964
|
+
data: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
1965
|
+
_tag: z.ZodLiteral<"disconnected">;
|
|
1966
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
1967
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1968
|
+
_tag: z.ZodLiteral<"verification-required">;
|
|
1969
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
1970
|
+
remoteSiteUrl: z.ZodURL;
|
|
1971
|
+
verified: z.ZodLiteral<false>;
|
|
1972
|
+
verification: z.ZodObject<{
|
|
1973
|
+
_tag: z.ZodLiteral<"cname">;
|
|
1974
|
+
name: z.ZodString;
|
|
1975
|
+
value: z.ZodLiteral<"verify.bing.com">;
|
|
1976
|
+
}, z.core.$strict>;
|
|
1977
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1978
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
1979
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1980
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1981
|
+
_tag: z.ZodLiteral<"connected">;
|
|
1982
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
1983
|
+
remoteSiteUrl: z.ZodURL;
|
|
1984
|
+
verified: z.ZodLiteral<true>;
|
|
1985
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1986
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
1987
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1988
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1989
|
+
_tag: z.ZodLiteral<"reauthorization-required">;
|
|
1990
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
1991
|
+
remoteSiteUrl: z.ZodURL;
|
|
1992
|
+
verified: z.ZodBoolean;
|
|
1993
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1994
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
1995
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1996
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1997
|
+
_tag: z.ZodLiteral<"unavailable">;
|
|
1998
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
1999
|
+
remoteSiteUrl: z.ZodURL;
|
|
2000
|
+
verified: z.ZodLiteral<true>;
|
|
2001
|
+
reason: z.ZodLiteral<"permission-lost">;
|
|
2002
|
+
}, z.core.$strict>], "_tag">;
|
|
2003
|
+
meta: z.ZodObject<{
|
|
2004
|
+
readonly requestId: z.ZodString;
|
|
2005
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
2006
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
2007
|
+
}, z.core.$strip>;
|
|
2008
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
2009
|
+
data: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
2010
|
+
_tag: z.ZodLiteral<"disconnected">;
|
|
2011
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
2012
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
2013
|
+
_tag: z.ZodLiteral<"verification-required">;
|
|
2014
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
2015
|
+
remoteSiteUrl: z.ZodURL;
|
|
2016
|
+
verified: z.ZodLiteral<false>;
|
|
2017
|
+
verification: z.ZodObject<{
|
|
2018
|
+
_tag: z.ZodLiteral<"cname">;
|
|
2019
|
+
name: z.ZodString;
|
|
2020
|
+
value: z.ZodLiteral<"verify.bing.com">;
|
|
2021
|
+
}, z.core.$loose>;
|
|
2022
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
2023
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
2024
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2025
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2026
|
+
_tag: z.ZodLiteral<"connected">;
|
|
2027
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
2028
|
+
remoteSiteUrl: z.ZodURL;
|
|
2029
|
+
verified: z.ZodLiteral<true>;
|
|
2030
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
2031
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
2032
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2033
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2034
|
+
_tag: z.ZodLiteral<"reauthorization-required">;
|
|
2035
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
2036
|
+
remoteSiteUrl: z.ZodURL;
|
|
2037
|
+
verified: z.ZodBoolean;
|
|
2038
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
2039
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
2040
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2041
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2042
|
+
_tag: z.ZodLiteral<"unavailable">;
|
|
2043
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
2044
|
+
remoteSiteUrl: z.ZodURL;
|
|
2045
|
+
verified: z.ZodLiteral<true>;
|
|
2046
|
+
reason: z.ZodLiteral<"permission-lost">;
|
|
2047
|
+
}, z.core.$loose>], "_tag">;
|
|
2048
|
+
meta: z.ZodObject<{
|
|
2049
|
+
readonly requestId: z.ZodString;
|
|
2050
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
2051
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
2052
|
+
}, z.core.$strip>;
|
|
2053
|
+
}, z.core.$strip>>;
|
|
1963
2054
|
lifecycleResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
1964
2055
|
data: z.ZodObject<{
|
|
1965
2056
|
readonly userId: z.ZodString;
|
|
@@ -5171,6 +5262,408 @@ declare function createGscdumpV1Protocol(): {
|
|
|
5171
5262
|
readonly method: "GET";
|
|
5172
5263
|
readonly path: "/sites/{siteId}/indexing/bing/evidence";
|
|
5173
5264
|
};
|
|
5265
|
+
readonly getSiteBingConnection: {
|
|
5266
|
+
readonly visibility: "public";
|
|
5267
|
+
readonly semantics: {
|
|
5268
|
+
readonly kind: "query";
|
|
5269
|
+
readonly sideEffects: "none";
|
|
5270
|
+
readonly idempotent: true;
|
|
5271
|
+
readonly retry: "idempotent";
|
|
5272
|
+
readonly readConsistency: "primary";
|
|
5273
|
+
};
|
|
5274
|
+
readonly auth: {
|
|
5275
|
+
readonly credentials: readonly ["user_key", "partner_key"];
|
|
5276
|
+
readonly scopes: readonly ["indexing:read"];
|
|
5277
|
+
readonly ownership: readonly [{
|
|
5278
|
+
readonly credential: "user_key";
|
|
5279
|
+
readonly rule: "authorized_site";
|
|
5280
|
+
}, {
|
|
5281
|
+
readonly credential: "partner_key";
|
|
5282
|
+
readonly rule: "authorized_site";
|
|
5283
|
+
}];
|
|
5284
|
+
};
|
|
5285
|
+
readonly request: {
|
|
5286
|
+
readonly params: z.ZodObject<{
|
|
5287
|
+
siteId: z.ZodString;
|
|
5288
|
+
}, z.core.$strict>;
|
|
5289
|
+
readonly query: null;
|
|
5290
|
+
readonly headers: z.ZodObject<{
|
|
5291
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
5292
|
+
}, z.core.$strict>;
|
|
5293
|
+
readonly body: null;
|
|
5294
|
+
};
|
|
5295
|
+
readonly responses: {
|
|
5296
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
5297
|
+
data: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
5298
|
+
_tag: z.ZodLiteral<"disconnected">;
|
|
5299
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5300
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
5301
|
+
_tag: z.ZodLiteral<"verification-required">;
|
|
5302
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5303
|
+
remoteSiteUrl: z.ZodURL;
|
|
5304
|
+
verified: z.ZodLiteral<false>;
|
|
5305
|
+
verification: z.ZodObject<{
|
|
5306
|
+
_tag: z.ZodLiteral<"cname">;
|
|
5307
|
+
name: z.ZodString;
|
|
5308
|
+
value: z.ZodLiteral<"verify.bing.com">;
|
|
5309
|
+
}, z.core.$strict>;
|
|
5310
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
5311
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
5312
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5313
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5314
|
+
_tag: z.ZodLiteral<"connected">;
|
|
5315
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5316
|
+
remoteSiteUrl: z.ZodURL;
|
|
5317
|
+
verified: z.ZodLiteral<true>;
|
|
5318
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
5319
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
5320
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5321
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5322
|
+
_tag: z.ZodLiteral<"reauthorization-required">;
|
|
5323
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5324
|
+
remoteSiteUrl: z.ZodURL;
|
|
5325
|
+
verified: z.ZodBoolean;
|
|
5326
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
5327
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
5328
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5329
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5330
|
+
_tag: z.ZodLiteral<"unavailable">;
|
|
5331
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5332
|
+
remoteSiteUrl: z.ZodURL;
|
|
5333
|
+
verified: z.ZodLiteral<true>;
|
|
5334
|
+
reason: z.ZodLiteral<"permission-lost">;
|
|
5335
|
+
}, z.core.$strict>], "_tag">;
|
|
5336
|
+
meta: z.ZodObject<{
|
|
5337
|
+
readonly requestId: z.ZodString;
|
|
5338
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
5339
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
5340
|
+
}, z.core.$strip>;
|
|
5341
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
5342
|
+
data: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
5343
|
+
_tag: z.ZodLiteral<"disconnected">;
|
|
5344
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5345
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
5346
|
+
_tag: z.ZodLiteral<"verification-required">;
|
|
5347
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5348
|
+
remoteSiteUrl: z.ZodURL;
|
|
5349
|
+
verified: z.ZodLiteral<false>;
|
|
5350
|
+
verification: z.ZodObject<{
|
|
5351
|
+
_tag: z.ZodLiteral<"cname">;
|
|
5352
|
+
name: z.ZodString;
|
|
5353
|
+
value: z.ZodLiteral<"verify.bing.com">;
|
|
5354
|
+
}, z.core.$loose>;
|
|
5355
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
5356
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
5357
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5358
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5359
|
+
_tag: z.ZodLiteral<"connected">;
|
|
5360
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5361
|
+
remoteSiteUrl: z.ZodURL;
|
|
5362
|
+
verified: z.ZodLiteral<true>;
|
|
5363
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
5364
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
5365
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5366
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5367
|
+
_tag: z.ZodLiteral<"reauthorization-required">;
|
|
5368
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5369
|
+
remoteSiteUrl: z.ZodURL;
|
|
5370
|
+
verified: z.ZodBoolean;
|
|
5371
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
5372
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
5373
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5374
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5375
|
+
_tag: z.ZodLiteral<"unavailable">;
|
|
5376
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5377
|
+
remoteSiteUrl: z.ZodURL;
|
|
5378
|
+
verified: z.ZodLiteral<true>;
|
|
5379
|
+
reason: z.ZodLiteral<"permission-lost">;
|
|
5380
|
+
}, z.core.$loose>], "_tag">;
|
|
5381
|
+
meta: z.ZodObject<{
|
|
5382
|
+
readonly requestId: z.ZodString;
|
|
5383
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
5384
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
5385
|
+
}, z.core.$strip>;
|
|
5386
|
+
}, z.core.$strip>>;
|
|
5387
|
+
};
|
|
5388
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "site_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
5389
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
5390
|
+
readonly error: z.ZodObject<{
|
|
5391
|
+
code: z.ZodEnum<{
|
|
5392
|
+
internal_error: "internal_error";
|
|
5393
|
+
invalid_request: "invalid_request";
|
|
5394
|
+
unauthorized: "unauthorized";
|
|
5395
|
+
forbidden: "forbidden";
|
|
5396
|
+
site_not_found: "site_not_found";
|
|
5397
|
+
rate_limited: "rate_limited";
|
|
5398
|
+
contract_violation: "contract_violation";
|
|
5399
|
+
}>;
|
|
5400
|
+
message: z.ZodString;
|
|
5401
|
+
requestId: z.ZodString;
|
|
5402
|
+
retryable: z.ZodBoolean;
|
|
5403
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
5404
|
+
}, z.core.$strict>;
|
|
5405
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
5406
|
+
readonly error: z.ZodObject<{
|
|
5407
|
+
code: z.ZodEnum<{
|
|
5408
|
+
internal_error: "internal_error";
|
|
5409
|
+
invalid_request: "invalid_request";
|
|
5410
|
+
unauthorized: "unauthorized";
|
|
5411
|
+
forbidden: "forbidden";
|
|
5412
|
+
site_not_found: "site_not_found";
|
|
5413
|
+
rate_limited: "rate_limited";
|
|
5414
|
+
contract_violation: "contract_violation";
|
|
5415
|
+
}>;
|
|
5416
|
+
message: z.ZodString;
|
|
5417
|
+
requestId: z.ZodString;
|
|
5418
|
+
retryable: z.ZodBoolean;
|
|
5419
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
5420
|
+
}, z.core.$loose>;
|
|
5421
|
+
}, z.core.$strip>>;
|
|
5422
|
+
readonly resources: {
|
|
5423
|
+
readonly reads: readonly [{
|
|
5424
|
+
readonly type: "site.auth";
|
|
5425
|
+
readonly idFrom: "params.siteId";
|
|
5426
|
+
}, {
|
|
5427
|
+
readonly type: "site.indexing";
|
|
5428
|
+
readonly idFrom: "params.siteId";
|
|
5429
|
+
}];
|
|
5430
|
+
readonly changes: readonly [];
|
|
5431
|
+
};
|
|
5432
|
+
readonly lifecycle: {
|
|
5433
|
+
readonly introduced: "1.6.0";
|
|
5434
|
+
};
|
|
5435
|
+
readonly docs: {
|
|
5436
|
+
readonly summary: "Get Bing connection";
|
|
5437
|
+
readonly description: "Returns the Bing connection state and any CNAME record required to verify the Site.";
|
|
5438
|
+
readonly tags: readonly ["Indexing"];
|
|
5439
|
+
readonly examples: {
|
|
5440
|
+
readonly request: {
|
|
5441
|
+
readonly params: {
|
|
5442
|
+
readonly siteId: "s_01";
|
|
5443
|
+
};
|
|
5444
|
+
};
|
|
5445
|
+
readonly response: {
|
|
5446
|
+
readonly data: {
|
|
5447
|
+
readonly _tag: "disconnected";
|
|
5448
|
+
readonly searchEngine: "bing";
|
|
5449
|
+
};
|
|
5450
|
+
readonly meta: {
|
|
5451
|
+
readonly requestId: "req_01";
|
|
5452
|
+
readonly surface: "partner";
|
|
5453
|
+
readonly version: "1.0";
|
|
5454
|
+
};
|
|
5455
|
+
};
|
|
5456
|
+
};
|
|
5457
|
+
};
|
|
5458
|
+
readonly id: "partner.sites.indexing.bing.connection.get";
|
|
5459
|
+
readonly method: "GET";
|
|
5460
|
+
readonly path: "/sites/{siteId}/indexing/bing/connection";
|
|
5461
|
+
};
|
|
5462
|
+
readonly verifySiteBingConnection: {
|
|
5463
|
+
readonly visibility: "public";
|
|
5464
|
+
readonly semantics: {
|
|
5465
|
+
readonly kind: "mutation";
|
|
5466
|
+
readonly sideEffects: "state";
|
|
5467
|
+
readonly idempotent: true;
|
|
5468
|
+
readonly retry: "idempotent";
|
|
5469
|
+
readonly readConsistency: null;
|
|
5470
|
+
};
|
|
5471
|
+
readonly auth: {
|
|
5472
|
+
readonly credentials: readonly ["user_key", "partner_key"];
|
|
5473
|
+
readonly scopes: readonly ["sites:write"];
|
|
5474
|
+
readonly ownership: readonly [{
|
|
5475
|
+
readonly credential: "user_key";
|
|
5476
|
+
readonly rule: "authorized_site";
|
|
5477
|
+
}, {
|
|
5478
|
+
readonly credential: "partner_key";
|
|
5479
|
+
readonly rule: "authorized_site";
|
|
5480
|
+
}];
|
|
5481
|
+
};
|
|
5482
|
+
readonly request: {
|
|
5483
|
+
readonly params: z.ZodObject<{
|
|
5484
|
+
siteId: z.ZodString;
|
|
5485
|
+
}, z.core.$strict>;
|
|
5486
|
+
readonly query: null;
|
|
5487
|
+
readonly headers: z.ZodObject<{
|
|
5488
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
5489
|
+
}, z.core.$strict>;
|
|
5490
|
+
readonly body: null;
|
|
5491
|
+
};
|
|
5492
|
+
readonly responses: {
|
|
5493
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
5494
|
+
data: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
5495
|
+
_tag: z.ZodLiteral<"disconnected">;
|
|
5496
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5497
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
5498
|
+
_tag: z.ZodLiteral<"verification-required">;
|
|
5499
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5500
|
+
remoteSiteUrl: z.ZodURL;
|
|
5501
|
+
verified: z.ZodLiteral<false>;
|
|
5502
|
+
verification: z.ZodObject<{
|
|
5503
|
+
_tag: z.ZodLiteral<"cname">;
|
|
5504
|
+
name: z.ZodString;
|
|
5505
|
+
value: z.ZodLiteral<"verify.bing.com">;
|
|
5506
|
+
}, z.core.$strict>;
|
|
5507
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
5508
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
5509
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5510
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5511
|
+
_tag: z.ZodLiteral<"connected">;
|
|
5512
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5513
|
+
remoteSiteUrl: z.ZodURL;
|
|
5514
|
+
verified: z.ZodLiteral<true>;
|
|
5515
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
5516
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
5517
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5518
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5519
|
+
_tag: z.ZodLiteral<"reauthorization-required">;
|
|
5520
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5521
|
+
remoteSiteUrl: z.ZodURL;
|
|
5522
|
+
verified: z.ZodBoolean;
|
|
5523
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
5524
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
5525
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5526
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5527
|
+
_tag: z.ZodLiteral<"unavailable">;
|
|
5528
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5529
|
+
remoteSiteUrl: z.ZodURL;
|
|
5530
|
+
verified: z.ZodLiteral<true>;
|
|
5531
|
+
reason: z.ZodLiteral<"permission-lost">;
|
|
5532
|
+
}, z.core.$strict>], "_tag">;
|
|
5533
|
+
meta: z.ZodObject<{
|
|
5534
|
+
readonly requestId: z.ZodString;
|
|
5535
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
5536
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
5537
|
+
}, z.core.$strip>;
|
|
5538
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
5539
|
+
data: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
5540
|
+
_tag: z.ZodLiteral<"disconnected">;
|
|
5541
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5542
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
5543
|
+
_tag: z.ZodLiteral<"verification-required">;
|
|
5544
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5545
|
+
remoteSiteUrl: z.ZodURL;
|
|
5546
|
+
verified: z.ZodLiteral<false>;
|
|
5547
|
+
verification: z.ZodObject<{
|
|
5548
|
+
_tag: z.ZodLiteral<"cname">;
|
|
5549
|
+
name: z.ZodString;
|
|
5550
|
+
value: z.ZodLiteral<"verify.bing.com">;
|
|
5551
|
+
}, z.core.$loose>;
|
|
5552
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
5553
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
5554
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5555
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5556
|
+
_tag: z.ZodLiteral<"connected">;
|
|
5557
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5558
|
+
remoteSiteUrl: z.ZodURL;
|
|
5559
|
+
verified: z.ZodLiteral<true>;
|
|
5560
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
5561
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
5562
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5563
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5564
|
+
_tag: z.ZodLiteral<"reauthorization-required">;
|
|
5565
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5566
|
+
remoteSiteUrl: z.ZodURL;
|
|
5567
|
+
verified: z.ZodBoolean;
|
|
5568
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
5569
|
+
scopes: z.ZodArray<z.ZodString>;
|
|
5570
|
+
tokenExpiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5571
|
+
lastEvidenceAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5572
|
+
_tag: z.ZodLiteral<"unavailable">;
|
|
5573
|
+
searchEngine: z.ZodLiteral<"bing">;
|
|
5574
|
+
remoteSiteUrl: z.ZodURL;
|
|
5575
|
+
verified: z.ZodLiteral<true>;
|
|
5576
|
+
reason: z.ZodLiteral<"permission-lost">;
|
|
5577
|
+
}, z.core.$loose>], "_tag">;
|
|
5578
|
+
meta: z.ZodObject<{
|
|
5579
|
+
readonly requestId: z.ZodString;
|
|
5580
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
5581
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
5582
|
+
}, z.core.$strip>;
|
|
5583
|
+
}, z.core.$strip>>;
|
|
5584
|
+
};
|
|
5585
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "site_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
5586
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
5587
|
+
readonly error: z.ZodObject<{
|
|
5588
|
+
code: z.ZodEnum<{
|
|
5589
|
+
internal_error: "internal_error";
|
|
5590
|
+
invalid_request: "invalid_request";
|
|
5591
|
+
unauthorized: "unauthorized";
|
|
5592
|
+
forbidden: "forbidden";
|
|
5593
|
+
site_not_found: "site_not_found";
|
|
5594
|
+
rate_limited: "rate_limited";
|
|
5595
|
+
contract_violation: "contract_violation";
|
|
5596
|
+
}>;
|
|
5597
|
+
message: z.ZodString;
|
|
5598
|
+
requestId: z.ZodString;
|
|
5599
|
+
retryable: z.ZodBoolean;
|
|
5600
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
5601
|
+
}, z.core.$strict>;
|
|
5602
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
5603
|
+
readonly error: z.ZodObject<{
|
|
5604
|
+
code: z.ZodEnum<{
|
|
5605
|
+
internal_error: "internal_error";
|
|
5606
|
+
invalid_request: "invalid_request";
|
|
5607
|
+
unauthorized: "unauthorized";
|
|
5608
|
+
forbidden: "forbidden";
|
|
5609
|
+
site_not_found: "site_not_found";
|
|
5610
|
+
rate_limited: "rate_limited";
|
|
5611
|
+
contract_violation: "contract_violation";
|
|
5612
|
+
}>;
|
|
5613
|
+
message: z.ZodString;
|
|
5614
|
+
requestId: z.ZodString;
|
|
5615
|
+
retryable: z.ZodBoolean;
|
|
5616
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
5617
|
+
}, z.core.$loose>;
|
|
5618
|
+
}, z.core.$strip>>;
|
|
5619
|
+
readonly resources: {
|
|
5620
|
+
readonly reads: readonly [{
|
|
5621
|
+
readonly type: "site.auth";
|
|
5622
|
+
readonly idFrom: "params.siteId";
|
|
5623
|
+
}];
|
|
5624
|
+
readonly changes: readonly [{
|
|
5625
|
+
readonly type: "site.auth";
|
|
5626
|
+
readonly idFrom: "params.siteId";
|
|
5627
|
+
}, {
|
|
5628
|
+
readonly type: "site.indexing";
|
|
5629
|
+
readonly idFrom: "params.siteId";
|
|
5630
|
+
}];
|
|
5631
|
+
};
|
|
5632
|
+
readonly lifecycle: {
|
|
5633
|
+
readonly introduced: "1.6.0";
|
|
5634
|
+
};
|
|
5635
|
+
readonly docs: {
|
|
5636
|
+
readonly summary: "Check Bing Site verification";
|
|
5637
|
+
readonly description: "Asks Bing to verify the Site. If Bing confirms ownership, it enables the connection and queues initial sync work.";
|
|
5638
|
+
readonly tags: readonly ["Indexing"];
|
|
5639
|
+
readonly examples: {
|
|
5640
|
+
readonly request: {
|
|
5641
|
+
readonly params: {
|
|
5642
|
+
readonly siteId: "s_01";
|
|
5643
|
+
};
|
|
5644
|
+
};
|
|
5645
|
+
readonly response: {
|
|
5646
|
+
readonly data: {
|
|
5647
|
+
readonly _tag: "connected";
|
|
5648
|
+
readonly searchEngine: "bing";
|
|
5649
|
+
readonly remoteSiteUrl: "https://example.com/";
|
|
5650
|
+
readonly verified: true;
|
|
5651
|
+
readonly scopes: readonly ["webmaster.read"];
|
|
5652
|
+
readonly tokenExpiresAt: null;
|
|
5653
|
+
readonly lastEvidenceAt: null;
|
|
5654
|
+
};
|
|
5655
|
+
readonly meta: {
|
|
5656
|
+
readonly requestId: "req_01";
|
|
5657
|
+
readonly surface: "partner";
|
|
5658
|
+
readonly version: "1.0";
|
|
5659
|
+
};
|
|
5660
|
+
};
|
|
5661
|
+
};
|
|
5662
|
+
};
|
|
5663
|
+
readonly id: "partner.sites.indexing.bing.connection.verify";
|
|
5664
|
+
readonly method: "POST";
|
|
5665
|
+
readonly path: "/sites/{siteId}/indexing/bing/connection/verify";
|
|
5666
|
+
};
|
|
5174
5667
|
readonly listSiteIndexingTransitions: {
|
|
5175
5668
|
readonly visibility: "public";
|
|
5176
5669
|
readonly semantics: {
|
|
@@ -12927,6 +13420,7 @@ type PartnerAvailableSitesV1Response = z.infer<GscdumpV1Protocol['schemas']['ava
|
|
|
12927
13420
|
type PartnerIndexingV1Response = z.infer<GscdumpV1Protocol['schemas']['indexingSummaryResponse']['client']>;
|
|
12928
13421
|
type PartnerIndexingUrlsV1Response = z.infer<GscdumpV1Protocol['schemas']['indexingUrlsResponse']['client']>;
|
|
12929
13422
|
type PartnerBingIndexingEvidenceV1Response = z.infer<GscdumpV1Protocol['schemas']['bingIndexingEvidenceResponse']['client']>;
|
|
13423
|
+
type PartnerBingConnectionV1Response = z.infer<GscdumpV1Protocol['schemas']['bingConnectionResponse']['client']>;
|
|
12930
13424
|
type PartnerIndexingTransitionsV1Response = z.infer<GscdumpV1Protocol['schemas']['indexingTransitionsResponse']['client']>;
|
|
12931
13425
|
type PartnerIndexingDiagnosticsV1Response = z.infer<GscdumpV1Protocol['schemas']['indexingDiagnosticsResponse']['client']>;
|
|
12932
13426
|
type PartnerSitemapsV1Response = z.infer<GscdumpV1Protocol['schemas']['sitemapsResponse']['client']>;
|
|
@@ -12934,4 +13428,4 @@ type PartnerSitemapChangesV1Response = z.infer<GscdumpV1Protocol['schemas']['sit
|
|
|
12934
13428
|
type PartnerSiteRegistrationV1Response = z.infer<GscdumpV1Protocol['schemas']['siteRegistrationResponse']['client']>;
|
|
12935
13429
|
type PartnerSiteDeletionV1Response = z.infer<GscdumpV1Protocol['schemas']['siteDeletionResponse']['client']>;
|
|
12936
13430
|
type PartnerUserLifecycleV1Response = z.infer<GscdumpV1Protocol['schemas']['lifecycleResponse']['client']>;
|
|
12937
|
-
export { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerBingIndexingEvidenceV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, createGscdumpV1Protocol };
|
|
13431
|
+
export { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerBingConnectionV1Response, PartnerBingIndexingEvidenceV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, createGscdumpV1Protocol };
|
package/dist/v1/operations.mjs
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { addPartnerTeamMemberSchema, bindPartnerSiteTeamSchema, bindPartnerTeamCatalogResponseSchema, bindPartnerTeamCatalogSchema, builderStateSchema, createPartnerTeamSchema, gscComparisonFilterSchema, gscdumpAnalysisBundleResponseSchema, gscdumpAnalysisPresetSchema, gscdumpAnalysisResponseSchema, gscdumpAvailableSiteSchema, gscdumpCanonicalMismatchesResponseSchema, gscdumpDataDetailResponseSchema, gscdumpDataResponseSchema, gscdumpDeletePartnerUserResponseSchema, gscdumpIndexPercentResponseSchema, gscdumpIndexingDiagnosticsResponseSchema, gscdumpIndexingResponseSchema, gscdumpIndexingTransitionFieldSchema, gscdumpKeywordSparklinesResponseSchema, gscdumpPageTrendResponseSchema, gscdumpQueryTrendResponseSchema, gscdumpSiteRegistrationSchema, gscdumpSitemapChangesResponseSchema, gscdumpSitemapExportQuerySchema, gscdumpSitemapExportResponseSchema, gscdumpSitemapMembershipParamsSchema, gscdumpSitemapMembershipResponseSchema, gscdumpSitemapUrlsQuerySchema, gscdumpSitemapUrlsResponseSchema, gscdumpSitemapsResponseSchema, gscdumpTeamRoleSchema, gscdumpTopAssociationResponseSchema, gscdumpUserRegistrationSchema, indexingUrlsResponseSchema, partnerSiteTeamBindingResponseSchema, partnerSitemapActionResponseSchema, partnerSitemapActionSchema, partnerTeamCreatedResponseSchema, partnerTeamDeletedResponseSchema, partnerTeamMemberAddedResponseSchema, partnerTeamMemberRemovedResponseSchema, partnerTeamMemberRoleResponseSchema, partnerTeamMembersResponseSchema, partnerTeamRenamedResponseSchema, registerPartnerSiteSchema, registerPartnerUserSchema, renamePartnerTeamSchema, searchTypeSchema, siteIntIdCrosswalkResponseSchema, sitemapChangesTruncationReasonSchema, teamCatalogRefSchema, updatePartnerUserTokensSchema } from "../schemas.mjs";
|
|
2
|
+
import { bingConnectionV1Schemas } from "./bing.mjs";
|
|
2
3
|
import "./version.mjs";
|
|
3
4
|
import { HTTP_V1_ERROR_CODES, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse } from "./http-core.mjs";
|
|
4
5
|
import { GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, REALTIME_V1_EVENT_SEMANTICS, createRealtimeV1Schemas } from "./realtime.mjs";
|
|
@@ -256,6 +257,7 @@ function createGscdumpV1Protocol() {
|
|
|
256
257
|
])),
|
|
257
258
|
pagination: bingIndexingEvidencePagination.client
|
|
258
259
|
}), partnerResponseMeta);
|
|
260
|
+
const bingConnectionResponse = defineSuccessResponse(bingConnectionV1Schemas, partnerResponseMeta);
|
|
259
261
|
const indexingTransition = defineResponseObject({
|
|
260
262
|
url: z.string(),
|
|
261
263
|
field: gscdumpIndexingTransitionFieldSchema,
|
|
@@ -1254,6 +1256,136 @@ function createGscdumpV1Protocol() {
|
|
|
1254
1256
|
}
|
|
1255
1257
|
}
|
|
1256
1258
|
}),
|
|
1259
|
+
getSiteBingConnection: defineHttpOperation({
|
|
1260
|
+
...gscdumpV1OperationRoute("partner.sites.indexing.bing.connection.get"),
|
|
1261
|
+
visibility: "public",
|
|
1262
|
+
semantics: {
|
|
1263
|
+
kind: "query",
|
|
1264
|
+
sideEffects: "none",
|
|
1265
|
+
idempotent: true,
|
|
1266
|
+
retry: "idempotent",
|
|
1267
|
+
readConsistency: "primary"
|
|
1268
|
+
},
|
|
1269
|
+
auth: {
|
|
1270
|
+
credentials: ["user_key", "partner_key"],
|
|
1271
|
+
scopes: ["indexing:read"],
|
|
1272
|
+
ownership: [{
|
|
1273
|
+
credential: "user_key",
|
|
1274
|
+
rule: "authorized_site"
|
|
1275
|
+
}, {
|
|
1276
|
+
credential: "partner_key",
|
|
1277
|
+
rule: "authorized_site"
|
|
1278
|
+
}]
|
|
1279
|
+
},
|
|
1280
|
+
request: {
|
|
1281
|
+
params: z.strictObject({ siteId: realtimeSchemas.publicSiteId }),
|
|
1282
|
+
query: null,
|
|
1283
|
+
headers: requestHeaders,
|
|
1284
|
+
body: null
|
|
1285
|
+
},
|
|
1286
|
+
responses: { 200: bingConnectionResponse },
|
|
1287
|
+
errors: partnerSiteErrors,
|
|
1288
|
+
errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
|
|
1289
|
+
resources: {
|
|
1290
|
+
reads: [{
|
|
1291
|
+
type: "site.auth",
|
|
1292
|
+
idFrom: "params.siteId"
|
|
1293
|
+
}, {
|
|
1294
|
+
type: "site.indexing",
|
|
1295
|
+
idFrom: "params.siteId"
|
|
1296
|
+
}],
|
|
1297
|
+
changes: []
|
|
1298
|
+
},
|
|
1299
|
+
lifecycle: { introduced: "1.6.0" },
|
|
1300
|
+
docs: {
|
|
1301
|
+
summary: "Get Bing connection",
|
|
1302
|
+
description: "Returns the Bing connection state and any CNAME record required to verify the Site.",
|
|
1303
|
+
tags: ["Indexing"],
|
|
1304
|
+
examples: {
|
|
1305
|
+
request: { params: { siteId: "s_01" } },
|
|
1306
|
+
response: {
|
|
1307
|
+
data: {
|
|
1308
|
+
_tag: "disconnected",
|
|
1309
|
+
searchEngine: "bing"
|
|
1310
|
+
},
|
|
1311
|
+
meta: {
|
|
1312
|
+
requestId: "req_01",
|
|
1313
|
+
surface: "partner",
|
|
1314
|
+
version: "1.0"
|
|
1315
|
+
}
|
|
1316
|
+
}
|
|
1317
|
+
}
|
|
1318
|
+
}
|
|
1319
|
+
}),
|
|
1320
|
+
verifySiteBingConnection: defineHttpOperation({
|
|
1321
|
+
...gscdumpV1OperationRoute("partner.sites.indexing.bing.connection.verify"),
|
|
1322
|
+
visibility: "public",
|
|
1323
|
+
semantics: {
|
|
1324
|
+
kind: "mutation",
|
|
1325
|
+
sideEffects: "state",
|
|
1326
|
+
idempotent: true,
|
|
1327
|
+
retry: "idempotent",
|
|
1328
|
+
readConsistency: null
|
|
1329
|
+
},
|
|
1330
|
+
auth: {
|
|
1331
|
+
credentials: ["user_key", "partner_key"],
|
|
1332
|
+
scopes: ["sites:write"],
|
|
1333
|
+
ownership: [{
|
|
1334
|
+
credential: "user_key",
|
|
1335
|
+
rule: "authorized_site"
|
|
1336
|
+
}, {
|
|
1337
|
+
credential: "partner_key",
|
|
1338
|
+
rule: "authorized_site"
|
|
1339
|
+
}]
|
|
1340
|
+
},
|
|
1341
|
+
request: {
|
|
1342
|
+
params: z.strictObject({ siteId: realtimeSchemas.publicSiteId }),
|
|
1343
|
+
query: null,
|
|
1344
|
+
headers: requestHeaders,
|
|
1345
|
+
body: null
|
|
1346
|
+
},
|
|
1347
|
+
responses: { 200: bingConnectionResponse },
|
|
1348
|
+
errors: partnerSiteErrors,
|
|
1349
|
+
errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
|
|
1350
|
+
resources: {
|
|
1351
|
+
reads: [{
|
|
1352
|
+
type: "site.auth",
|
|
1353
|
+
idFrom: "params.siteId"
|
|
1354
|
+
}],
|
|
1355
|
+
changes: [{
|
|
1356
|
+
type: "site.auth",
|
|
1357
|
+
idFrom: "params.siteId"
|
|
1358
|
+
}, {
|
|
1359
|
+
type: "site.indexing",
|
|
1360
|
+
idFrom: "params.siteId"
|
|
1361
|
+
}]
|
|
1362
|
+
},
|
|
1363
|
+
lifecycle: { introduced: "1.6.0" },
|
|
1364
|
+
docs: {
|
|
1365
|
+
summary: "Check Bing Site verification",
|
|
1366
|
+
description: "Asks Bing to verify the Site. If Bing confirms ownership, it enables the connection and queues initial sync work.",
|
|
1367
|
+
tags: ["Indexing"],
|
|
1368
|
+
examples: {
|
|
1369
|
+
request: { params: { siteId: "s_01" } },
|
|
1370
|
+
response: {
|
|
1371
|
+
data: {
|
|
1372
|
+
_tag: "connected",
|
|
1373
|
+
searchEngine: "bing",
|
|
1374
|
+
remoteSiteUrl: "https://example.com/",
|
|
1375
|
+
verified: true,
|
|
1376
|
+
scopes: ["webmaster.read"],
|
|
1377
|
+
tokenExpiresAt: null,
|
|
1378
|
+
lastEvidenceAt: null
|
|
1379
|
+
},
|
|
1380
|
+
meta: {
|
|
1381
|
+
requestId: "req_01",
|
|
1382
|
+
surface: "partner",
|
|
1383
|
+
version: "1.0"
|
|
1384
|
+
}
|
|
1385
|
+
}
|
|
1386
|
+
}
|
|
1387
|
+
}
|
|
1388
|
+
}),
|
|
1257
1389
|
listSiteIndexingTransitions: defineHttpOperation({
|
|
1258
1390
|
...gscdumpV1OperationRoute("partner.sites.indexing.transitions.list"),
|
|
1259
1391
|
visibility: "public",
|
|
@@ -4301,6 +4433,7 @@ function createGscdumpV1Protocol() {
|
|
|
4301
4433
|
indexingUrlsResponse,
|
|
4302
4434
|
bingIndexingEvidenceQuery,
|
|
4303
4435
|
bingIndexingEvidenceResponse,
|
|
4436
|
+
bingConnectionResponse,
|
|
4304
4437
|
lifecycleResponse,
|
|
4305
4438
|
registerSiteRequest,
|
|
4306
4439
|
sitemapChangesQuery,
|
|
@@ -56,6 +56,16 @@ declare const GSCDUMP_V1_ROUTE_CATALOG: {
|
|
|
56
56
|
readonly method: "GET";
|
|
57
57
|
readonly template: "/sites/{siteId}/indexing/bing/evidence";
|
|
58
58
|
};
|
|
59
|
+
readonly 'partner.sites.indexing.bing.connection.get': {
|
|
60
|
+
readonly surface: "partner";
|
|
61
|
+
readonly method: "GET";
|
|
62
|
+
readonly template: "/sites/{siteId}/indexing/bing/connection";
|
|
63
|
+
};
|
|
64
|
+
readonly 'partner.sites.indexing.bing.connection.verify': {
|
|
65
|
+
readonly surface: "partner";
|
|
66
|
+
readonly method: "POST";
|
|
67
|
+
readonly template: "/sites/{siteId}/indexing/bing/connection/verify";
|
|
68
|
+
};
|
|
59
69
|
readonly 'partner.sites.indexing.transitions.list': {
|
|
60
70
|
readonly surface: "partner";
|
|
61
71
|
readonly method: "GET";
|
|
@@ -43,6 +43,16 @@ const GSCDUMP_V1_ROUTE_CATALOG = {
|
|
|
43
43
|
method: "GET",
|
|
44
44
|
template: "/sites/{siteId}/indexing/bing/evidence"
|
|
45
45
|
},
|
|
46
|
+
"partner.sites.indexing.bing.connection.get": {
|
|
47
|
+
surface: "partner",
|
|
48
|
+
method: "GET",
|
|
49
|
+
template: "/sites/{siteId}/indexing/bing/connection"
|
|
50
|
+
},
|
|
51
|
+
"partner.sites.indexing.bing.connection.verify": {
|
|
52
|
+
surface: "partner",
|
|
53
|
+
method: "POST",
|
|
54
|
+
template: "/sites/{siteId}/indexing/bing/connection/verify"
|
|
55
|
+
},
|
|
46
56
|
"partner.sites.indexing.transitions.list": {
|
|
47
57
|
surface: "partner",
|
|
48
58
|
method: "GET",
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gscdump/contracts",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.4.0",
|
|
5
5
|
"description": "Shared gscdump.com API, webhook, realtime, and lifecycle contracts.",
|
|
6
6
|
"author": {
|
|
7
7
|
"name": "Harlan Wilton",
|
|
@@ -85,7 +85,7 @@
|
|
|
85
85
|
},
|
|
86
86
|
"devDependencies": {
|
|
87
87
|
"typescript": "^7.0.2",
|
|
88
|
-
"vitest": "^4.1.
|
|
88
|
+
"vitest": "^4.1.11"
|
|
89
89
|
},
|
|
90
90
|
"scripts": {
|
|
91
91
|
"build": "obuild",
|